interconnect_attachments

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

Overview

Name	`interconnect_attachments`
Type	Resource
Id	`google.compute.interconnect_attachments`

Fields

Name	Datatype	Description
`id`	`string`	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
`name`	`string`	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. 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.
`description`	`string`	An optional description of this resource.
`adminEnabled`	`boolean`	Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.
`bandwidth`	`string`	Provisioned 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
`candidateIpv6Subnets`	`array`	This field is not available.
`candidateSubnets`	`array`	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.
`cloudRouterIpAddress`	`string`	[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
`cloudRouterIpv6Address`	`string`	[Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.
`cloudRouterIpv6InterfaceId`	`string`	This field is not available.
`configurationConstraints`	`object`
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 text format.
`customerRouterIpAddress`	`string`	[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
`customerRouterIpv6Address`	`string`	[Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.
`customerRouterIpv6InterfaceId`	`string`	This field is not available.
`dataplaneVersion`	`integer`	[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.
`edgeAvailabilityDomain`	`string`	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.
`encryption`	`string`	Indicates 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.
`googleReferenceId`	`string`	[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.
`interconnect`	`string`	URL of the underlying Interconnect object that this attachment's traffic will traverse through.
`ipsecInternalAddresses`	`array`	A 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.
`kind`	`string`	[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.
`labelFingerprint`	`string`	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 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment.
`labels`	`object`	Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
`mtu`	`integer`	Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440.
`operationalStatus`	`string`	[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.
`pairingKey`	`string`	[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"
`partnerAsn`	`string`	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.
`partnerMetadata`	`object`	Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments.
`privateInterconnectInfo`	`object`	Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.
`region`	`string`	[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.
`remoteService`	`string`	[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.
`router`	`string`	URL 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.
`satisfiesPzs`	`boolean`	[Output Only] Reserved for future use.
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.
`stackType`	`string`	The 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.
`state`	`string`	[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.
`subnetLength`	`integer`	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.
`type`	`string`	The 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.
`vlanTag8021q`	`integer`	The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.

Methods

Name	Accessible by	Required Params	Description
`aggregated_list`	`SELECT`	`project`	Retrieves an aggregated list of interconnect attachments. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
`get`	`SELECT`	`interconnectAttachment, project, region`	Returns the specified interconnect attachment.
`list`	`SELECT`	`project, region`	Retrieves the list of interconnect attachments contained within the specified region.
`insert`	`INSERT`	`project, region`	Creates an InterconnectAttachment in the specified project using the data included in the request.
`delete`	`DELETE`	`interconnectAttachment, project, region`	Deletes the specified interconnect attachment.
`patch`	`UPDATE`	`interconnectAttachment, project, region`	Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
`set_labels`	`EXEC`	`project, region, resource`	Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.

`SELECT` examples

Retrieves an aggregated list of interconnect attachments. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

`INSERT` example

Use the following StackQL query and manifest file to create a new interconnect_attachments resource.

All Properties
Manifest

/*+ create */
INSERT INTO google.compute.interconnect_attachments (
project,
region,
description,
name,
interconnect,
router,
region,
googleReferenceId,
mtu,
privateInterconnectInfo,
operationalStatus,
cloudRouterIpAddress,
customerRouterIpAddress,
type,
pairingKey,
adminEnabled,
vlanTag8021q,
edgeAvailabilityDomain,
candidateSubnets,
bandwidth,
partnerMetadata,
labels,
labelFingerprint,
state,
partnerAsn,
encryption,
ipsecInternalAddresses,
dataplaneVersion,
satisfiesPzs,
stackType,
cloudRouterIpv6Address,
customerRouterIpv6Address,
candidateIpv6Subnets,
cloudRouterIpv6InterfaceId,
customerRouterIpv6InterfaceId,
subnetLength,
remoteService,
configurationConstraints
)
SELECT 
'{{ project }}',
'{{ region }}',
'{{ description }}',
'{{ name }}',
'{{ interconnect }}',
'{{ router }}',
'{{ region }}',
'{{ googleReferenceId }}',
'{{ mtu }}',
'{{ privateInterconnectInfo }}',
'{{ operationalStatus }}',
'{{ cloudRouterIpAddress }}',
'{{ customerRouterIpAddress }}',
'{{ type }}',
'{{ pairingKey }}',
{{ adminEnabled }},
'{{ vlanTag8021q }}',
'{{ edgeAvailabilityDomain }}',
'{{ candidateSubnets }}',
'{{ bandwidth }}',
'{{ partnerMetadata }}',
'{{ labels }}',
'{{ labelFingerprint }}',
'{{ state }}',
'{{ partnerAsn }}',
'{{ encryption }}',
'{{ ipsecInternalAddresses }}',
'{{ dataplaneVersion }}',
{{ satisfiesPzs }},
'{{ stackType }}',
'{{ cloudRouterIpv6Address }}',
'{{ customerRouterIpv6Address }}',
'{{ candidateIpv6Subnets }}',
'{{ cloudRouterIpv6InterfaceId }}',
'{{ customerRouterIpv6InterfaceId }}',
'{{ subnetLength }}',
'{{ remoteService }}',
'{{ configurationConstraints }}'
;

- name: your_resource_model_name
  props:
    - name: kind
      value: string
    - name: description
      value: string
    - name: selfLink
      value: string
    - name: id
      value: string
    - name: creationTimestamp
      value: string
    - name: name
      value: string
    - name: interconnect
      value: string
    - name: router
      value: string
    - name: region
      value: string
    - name: googleReferenceId
      value: string
    - name: mtu
      value: integer
    - name: privateInterconnectInfo
      value:
        - name: tag8021q
          value: integer
    - name: operationalStatus
      value: string
    - name: cloudRouterIpAddress
      value: string
    - name: customerRouterIpAddress
      value: string
    - name: type
      value: string
    - name: pairingKey
      value: string
    - name: adminEnabled
      value: boolean
    - name: vlanTag8021q
      value: integer
    - name: edgeAvailabilityDomain
      value: string
    - name: candidateSubnets
      value:
        - string
    - name: bandwidth
      value: string
    - name: partnerMetadata
      value:
        - name: partnerName
          value: string
        - name: interconnectName
          value: string
        - name: portalUrl
          value: string
    - name: labels
      value: object
    - name: labelFingerprint
      value: string
    - name: state
      value: string
    - name: partnerAsn
      value: string
    - name: encryption
      value: string
    - name: ipsecInternalAddresses
      value:
        - string
    - name: dataplaneVersion
      value: integer
    - name: satisfiesPzs
      value: boolean
    - name: stackType
      value: string
    - name: cloudRouterIpv6Address
      value: string
    - name: customerRouterIpv6Address
      value: string
    - name: candidateIpv6Subnets
      value:
        - string
    - name: cloudRouterIpv6InterfaceId
      value: string
    - name: customerRouterIpv6InterfaceId
      value: string
    - name: subnetLength
      value: integer
    - name: remoteService
      value: string
    - name: configurationConstraints
      value:
        - name: bgpMd5
          value: string
        - name: bgpPeerAsnRanges
          value:
            - - name: min
                value: integer
              - name: max
                value: integer

`UPDATE` example

Updates a interconnect_attachments resource.

/*+ update */
UPDATE google.compute.interconnect_attachments
SET 
description = '{{ description }}',
name = '{{ name }}',
interconnect = '{{ interconnect }}',
router = '{{ router }}',
region = '{{ region }}',
googleReferenceId = '{{ googleReferenceId }}',
mtu = '{{ mtu }}',
privateInterconnectInfo = '{{ privateInterconnectInfo }}',
operationalStatus = '{{ operationalStatus }}',
cloudRouterIpAddress = '{{ cloudRouterIpAddress }}',
customerRouterIpAddress = '{{ customerRouterIpAddress }}',
type = '{{ type }}',
pairingKey = '{{ pairingKey }}',
adminEnabled = true|false,
vlanTag8021q = '{{ vlanTag8021q }}',
edgeAvailabilityDomain = '{{ edgeAvailabilityDomain }}',
candidateSubnets = '{{ candidateSubnets }}',
bandwidth = '{{ bandwidth }}',
partnerMetadata = '{{ partnerMetadata }}',
labels = '{{ labels }}',
labelFingerprint = '{{ labelFingerprint }}',
state = '{{ state }}',
partnerAsn = '{{ partnerAsn }}',
encryption = '{{ encryption }}',
ipsecInternalAddresses = '{{ ipsecInternalAddresses }}',
dataplaneVersion = '{{ dataplaneVersion }}',
satisfiesPzs = true|false,
stackType = '{{ stackType }}',
cloudRouterIpv6Address = '{{ cloudRouterIpv6Address }}',
customerRouterIpv6Address = '{{ customerRouterIpv6Address }}',
candidateIpv6Subnets = '{{ candidateIpv6Subnets }}',
cloudRouterIpv6InterfaceId = '{{ cloudRouterIpv6InterfaceId }}',
customerRouterIpv6InterfaceId = '{{ customerRouterIpv6InterfaceId }}',
subnetLength = '{{ subnetLength }}',
remoteService = '{{ remoteService }}',
configurationConstraints = '{{ configurationConstraints }}'
WHERE 
interconnectAttachment = '{{ interconnectAttachment }}'
AND project = '{{ project }}'
AND region = '{{ region }}';

`DELETE` example

Deletes the specified interconnect_attachments resource.

/*+ delete */
DELETE FROM google.compute.interconnect_attachments
WHERE interconnectAttachment = '{{ interconnectAttachment }}'
AND project = '{{ project }}'
AND region = '{{ region }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

DELETE example​