Skip to main content

interconnect_attachments

Creates, updates, deletes, gets or lists an interconnect_attachments resource.

Overview​

Nameinterconnect_attachments
TypeResource
Idgoogle.compute.interconnect_attachments

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstring (uint64)Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
namestringName of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
adminEnabledbooleanDetermines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
attachmentGroupstringOutput only. [Output Only] URL of the AttachmentGroup that includes this Attachment.
bandwidthstringProvisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s - BPS_100G: 100 Gbit/s - BPS_400G: 400 Gbit/s (BPS_100G, BPS_100M, BPS_10G, BPS_1G, BPS_200M, BPS_20G, BPS_2G, BPS_300M, BPS_400G, BPS_400M, BPS_500M, BPS_50G, BPS_50M, BPS_5G)
candidateCloudRouterIpAddressstringSingle IPv4 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ip_address and candidate_customer_router_ip_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ip_address and candidate_customer_router_ip_address must be the same. - Max prefix length is 31.
candidateCloudRouterIpv6AddressstringSingle IPv6 address + prefix length to be configured on the cloud router interface for this interconnect attachment. - Both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address fields must be set or both must be unset. - Prefix length of both candidate_cloud_router_ipv6_address and candidate_customer_router_ipv6_address must be the same. - Max prefix length is 126.
candidateCustomerRouterIpAddressstringSingle IPv4 address + prefix length to be configured on the customer router interface for this interconnect attachment.
candidateCustomerRouterIpv6AddressstringSingle IPv6 address + prefix length to be configured on the customer router interface for this interconnect attachment.
candidateIpv6SubnetsarrayThis field is not available.
candidateSubnetsarrayInput only. Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.
cloudRouterIpAddressstringOutput only. [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
cloudRouterIpv6AddressstringOutput only. [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
cloudRouterIpv6InterfaceIdstringThis field is not available.
configurationConstraintsobjectOutput only. [Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met. (id: InterconnectAttachmentConfigurationConstraints)
creationTimestampstringOutput only. [Output Only] Creation timestamp inRFC3339 text format.
customerRouterIpAddressstringOutput only. [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
customerRouterIpv6AddressstringOutput only. [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
customerRouterIpv6InterfaceIdstringThis field is not available.
dataplaneVersioninteger (int32)Output only. [Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1.
descriptionstringAn optional description of this resource.
edgeAvailabilityDomainstringInput only. Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. (AVAILABILITY_DOMAIN_1, AVAILABILITY_DOMAIN_2, AVAILABILITY_DOMAIN_ANY)
encryptionstringIndicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use HA VPN over Cloud Interconnect, the VLAN attachment must be created with this option. (IPSEC, NONE)
googleReferenceIdstringOutput only. [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.
interconnectstringURL of the underlying Interconnect object that this attachment's traffic will traverse through.
ipsecInternalAddressesarrayA list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool.
kindstringOutput only. [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments. (default: compute#interconnectAttachment)
l2ForwardingobjectL2 Interconnect Attachment related config. This field is required if the type is L2_DEDICATED. The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) within L2 packets are mapped to the destination appliances IP addresses. The packet is then encapsulated with the appliance IP address and sent to the edge appliance. (id: InterconnectAttachmentL2Forwarding)
labelFingerprintstring (byte)A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
labelsobjectLabels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.
mtuinteger (int32)Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Valid values are 1440, 1460, 1500, and 8896. If not specified, the value will default to 1440.
operationalStatusstringOutput only. [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. (OS_ACTIVE, OS_UNPROVISIONED)
pairingKeystring[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain"
paramsobjectInput only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. (id: InterconnectAttachmentParams)
partnerAsnstring (int64)Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.
partnerMetadataobjectInformational metadata about Partner attachments from Partners to display to customers. Output only for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED. (id: InterconnectAttachmentPartnerMetadata)
privateInterconnectInfoobjectOutput only. [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED. (id: InterconnectAttachmentPrivateInfo)
regionstringOutput only. [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
remoteServicestringOutput only. [Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: "Amazon Web Services" "Microsoft Azure". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field.
routerstringURL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured.
satisfiesPzsbooleanOutput only. [Output Only] Reserved for future use.
selfLinkstringOutput only. [Output Only] Server-defined URL for the resource.
stackTypestringThe stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. (IPV4_IPV6, IPV4_ONLY)
statestringOutput only. [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. (ACTIVE, DEFUNCT, PARTNER_REQUEST_RECEIVED, PENDING_CUSTOMER, PENDING_PARTNER, STATE_UNSPECIFIED, UNPROVISIONED)
subnetLengthinteger (int32)Input only. Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility.
typestringThe type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect. (DEDICATED, L2_DEDICATED, PARTNER, PARTNER_PROVIDER)
vlanTag8021qinteger (int32)The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject, region, interconnectAttachmentReturns the specified interconnect attachment.
listselectproject, regionreturnPartialSuccess, maxResults, pageToken, filter, orderByRetrieves the list of interconnect attachments contained within
the specified region.
aggregated_listselectprojectreturnPartialSuccess, includeAllScopes, orderBy, filter, serviceProjectNumber, maxResults, pageTokenRetrieves an aggregated list of interconnect attachments.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.
insertinsertproject, regionrequestId, validateOnlyCreates an InterconnectAttachment in the specified project using the data
included in the request.
patchupdateproject, region, interconnectAttachmentrequestIdUpdates the specified interconnect attachment with the data included in the
request. This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules.
deletedeleteproject, region, interconnectAttachmentrequestIdDeletes the specified interconnect attachment.
set_labelsexecproject, region, resourcerequestIdSets the labels on an InterconnectAttachment. To learn more about labels,
read the Labeling
Resources documentation.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
interconnectAttachmentstring
projectstring
regionstring
resourcestring
filterstring
includeAllScopesboolean
maxResultsinteger (uint32)
orderBystring
pageTokenstring
requestIdstring
returnPartialSuccessboolean
serviceProjectNumberstring (int64)
validateOnlyboolean

SELECT examples​

Returns the specified interconnect attachment.

SELECT
id,
name,
adminEnabled,
attachmentGroup,
bandwidth,
candidateCloudRouterIpAddress,
candidateCloudRouterIpv6Address,
candidateCustomerRouterIpAddress,
candidateCustomerRouterIpv6Address,
candidateIpv6Subnets,
candidateSubnets,
cloudRouterIpAddress,
cloudRouterIpv6Address,
cloudRouterIpv6InterfaceId,
configurationConstraints,
creationTimestamp,
customerRouterIpAddress,
customerRouterIpv6Address,
customerRouterIpv6InterfaceId,
dataplaneVersion,
description,
edgeAvailabilityDomain,
encryption,
googleReferenceId,
interconnect,
ipsecInternalAddresses,
kind,
l2Forwarding,
labelFingerprint,
labels,
mtu,
operationalStatus,
pairingKey,
params,
partnerAsn,
partnerMetadata,
privateInterconnectInfo,
region,
remoteService,
router,
satisfiesPzs,
selfLink,
stackType,
state,
subnetLength,
type,
vlanTag8021q
FROM google.compute.interconnect_attachments
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND interconnectAttachment = '{{ interconnectAttachment }}' -- required
;

INSERT examples​

Creates an InterconnectAttachment in the specified project using the data
included in the request.

INSERT INTO google.compute.interconnect_attachments (
data__params,
data__type,
data__labelFingerprint,
data__l2Forwarding,
data__subnetLength,
data__interconnect,
data__labels,
data__mtu,
data__candidateSubnets,
data__cloudRouterIpv6InterfaceId,
data__vlanTag8021q,
data__pairingKey,
data__bandwidth,
data__adminEnabled,
data__candidateCloudRouterIpv6Address,
data__candidateCloudRouterIpAddress,
data__stackType,
data__candidateCustomerRouterIpv6Address,
data__encryption,
data__name,
data__router,
data__candidateCustomerRouterIpAddress,
data__description,
data__partnerMetadata,
data__edgeAvailabilityDomain,
data__customerRouterIpv6InterfaceId,
data__candidateIpv6Subnets,
data__partnerAsn,
data__ipsecInternalAddresses,
project,
region,
requestId,
validateOnly
)
SELECT 
'{{ params }}',
'{{ type }}',
'{{ labelFingerprint }}',
'{{ l2Forwarding }}',
{{ subnetLength }},
'{{ interconnect }}',
'{{ labels }}',
{{ mtu }},
'{{ candidateSubnets }}',
'{{ cloudRouterIpv6InterfaceId }}',
{{ vlanTag8021q }},
'{{ pairingKey }}',
'{{ bandwidth }}',
{{ adminEnabled }},
'{{ candidateCloudRouterIpv6Address }}',
'{{ candidateCloudRouterIpAddress }}',
'{{ stackType }}',
'{{ candidateCustomerRouterIpv6Address }}',
'{{ encryption }}',
'{{ name }}',
'{{ router }}',
'{{ candidateCustomerRouterIpAddress }}',
'{{ description }}',
'{{ partnerMetadata }}',
'{{ edgeAvailabilityDomain }}',
'{{ customerRouterIpv6InterfaceId }}',
'{{ candidateIpv6Subnets }}',
'{{ partnerAsn }}',
'{{ ipsecInternalAddresses }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

UPDATE examples​

Updates the specified interconnect attachment with the data included in the
request. This method supportsPATCH
semantics and uses theJSON merge
patch format and processing rules.

UPDATE google.compute.interconnect_attachments
SET 
data__params = '{{ params }}',
data__type = '{{ type }}',
data__labelFingerprint = '{{ labelFingerprint }}',
data__l2Forwarding = '{{ l2Forwarding }}',
data__subnetLength = {{ subnetLength }},
data__interconnect = '{{ interconnect }}',
data__labels = '{{ labels }}',
data__mtu = {{ mtu }},
data__candidateSubnets = '{{ candidateSubnets }}',
data__cloudRouterIpv6InterfaceId = '{{ cloudRouterIpv6InterfaceId }}',
data__vlanTag8021q = {{ vlanTag8021q }},
data__pairingKey = '{{ pairingKey }}',
data__bandwidth = '{{ bandwidth }}',
data__adminEnabled = {{ adminEnabled }},
data__candidateCloudRouterIpv6Address = '{{ candidateCloudRouterIpv6Address }}',
data__candidateCloudRouterIpAddress = '{{ candidateCloudRouterIpAddress }}',
data__stackType = '{{ stackType }}',
data__candidateCustomerRouterIpv6Address = '{{ candidateCustomerRouterIpv6Address }}',
data__encryption = '{{ encryption }}',
data__name = '{{ name }}',
data__router = '{{ router }}',
data__candidateCustomerRouterIpAddress = '{{ candidateCustomerRouterIpAddress }}',
data__description = '{{ description }}',
data__partnerMetadata = '{{ partnerMetadata }}',
data__edgeAvailabilityDomain = '{{ edgeAvailabilityDomain }}',
data__customerRouterIpv6InterfaceId = '{{ customerRouterIpv6InterfaceId }}',
data__candidateIpv6Subnets = '{{ candidateIpv6Subnets }}',
data__partnerAsn = '{{ partnerAsn }}',
data__ipsecInternalAddresses = '{{ ipsecInternalAddresses }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND interconnectAttachment = '{{ interconnectAttachment }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples​

Deletes the specified interconnect attachment.

DELETE FROM google.compute.interconnect_attachments
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND interconnectAttachment = '{{ interconnectAttachment }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods​

Sets the labels on an InterconnectAttachment. To learn more about labels,
read the Labeling
Resources documentation.

EXEC google.compute.interconnect_attachments.set_labels 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@resource='{{ resource }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"labels": "{{ labels }}", 
"labelFingerprint": "{{ labelFingerprint }}"
}'
;