REST Resource: projects.locations.mirroringEndpointGroupAssociations

Resource: MirroringEndpointGroupAssociation

An endpoint group association represents a link between a network and an endpoint group in the organization.

Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable mirroring by itself. To enable mirroring, the user must also create a network firewall policy containing mirroring rules and associate it with the network.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "mirroringEndpointGroup": string,
  "network": string,
  "locationsDetails": [
    {
      object (LocationDetails)
    }
  ],
  "state": enum (State),
  "reconciling": boolean
}
Fields
name

string

Immutable. Identifier. The resource name of this endpoint group association, for example: projects/123456789/locations/global/mirroringEndpointGroupAssociations/my-eg-association. See https://google.aip.dev/122 for more details.

createTime

string (Timestamp format)

Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Optional. Labels are key/value pairs that help to organize and filter resources.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

mirroringEndpointGroup

string

Immutable. The endpoint group that this association is connected to, for example: projects/123456789/locations/global/mirroringEndpointGroups/my-eg. See https://google.aip.dev/124.

network

string

Immutable. The VPC network that is associated. for example: projects/123456789/global/networks/my-network. See https://google.aip.dev/124.

locationsDetails[]

object (LocationDetails)

Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself.

state

enum (State)

Output only. Current state of the endpoint group association.

reconciling

boolean

Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128.

LocationDetails

Contains details about the state of an association in a specific cloud location.

JSON representation
{
  "location": string,
  "state": enum (State)
}
Fields
location

string

Output only. The cloud location, e.g. "us-central1-a" or "asia-south1".

state

enum (State)

Output only. The current state of the association in this location.

State

The state of association.

Enums
STATE_UNSPECIFIED Not set.
ACTIVE The association is ready and in sync with the linked endpoint group.
OUT_OF_SYNC The association is out of sync with the linked endpoint group. In most cases, this is a result of a transient issue within the system (e.g. an inaccessible location) and the system is expected to recover automatically.

Methods

create

Creates an association in a given project and location.

delete

Deletes an association.

get

Gets a specific association.

list

Lists associations in a given project and location.

patch

Updates an association.