gcp_compute_interconnect_attachment

admin_enabled

Type: BOOLEAN
Provider name: adminEnabled
Description: Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.

ancestors

Type: UNORDERED_LIST_STRING

bandwidth

Type: STRING
Provider name: bandwidth
Description: 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
Possible values:

• BPS_100M - 100 Mbit/s
  
• BPS_10G - 10 Gbit/s
  
• BPS_1G - 1 Gbit/s
  
• BPS_200M - 200 Mbit/s
  
• BPS_20G - 20 Gbit/s
  
• BPS_2G - 2 Gbit/s
  
• BPS_300M - 300 Mbit/s
  
• BPS_400M - 400 Mbit/s
  
• BPS_500M - 500 Mbit/s
  
• BPS_50G - 50 Gbit/s
  
• BPS_50M - 50 Mbit/s
  
• BPS_5G - 5 Gbit/s
  

candidate_ipv6_subnets

Type: UNORDERED_LIST_STRING
Provider name: candidateIpv6Subnets
Description: This field is not available.

candidate_subnets

Type: UNORDERED_LIST_STRING
Provider name: candidateSubnets
Description: 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.

cloud_router_ip_address

Type: STRING
Provider name: cloudRouterIpAddress
Description: [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

cloud_router_ipv6_address

Type: STRING
Provider name: cloudRouterIpv6Address
Description: [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.

cloud_router_ipv6_interface_id

Type: STRING
Provider name: cloudRouterIpv6InterfaceId
Description: This field is not available.

configuration_constraints

Type: STRUCT
Provider name: configurationConstraints
Description: [Output Only] Constraints for this attachment, if any. The attachment does not work if these constraints are not met.

• bgp_md5
  Type: STRING
  Provider name: bgpMd5
  Description: [Output Only] Whether the attachment’s BGP session requires/allows/disallows BGP MD5 authentication. This can take one of the following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED. For example, a Cross-Cloud Interconnect connection to a remote cloud provider that requires BGP MD5 authentication has the interconnectRemoteLocation attachment_configuration_constraints.bgp_md5 field set to MD5_REQUIRED, and that property is propagated to the attachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is returned if MD5 is requested.
  Possible values:
  
  • MD5_OPTIONAL - MD5_OPTIONAL: BGP MD5 authentication is supported and can optionally be configured.
    
  • MD5_REQUIRED - MD5_REQUIRED: BGP MD5 authentication must be configured.
    
  • MD5_UNSUPPORTED - MD5_UNSUPPORTED: BGP MD5 authentication must not be configured
    
• bgp_peer_asn_ranges
  Type: UNORDERED_LIST_STRUCT
  Provider name: bgpPeerAsnRanges
  Description: [Output Only] List of ASN ranges that the remote location is known to support. Formatted as an array of inclusive ranges {min: min-value, max: max-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}] allows the peer ASN to be 123 or anything in the range 64512-65534. This field is only advisory. Although the API accepts other ranges, these are the ranges that we recommend.
  
  • max
    Type: INT32
    Provider name: max
    
  • min
    Type: INT32
    Provider name: min
    

creation_timestamp

Type: TIMESTAMP
Provider name: creationTimestamp
Description: [Output Only] Creation timestamp in RFC3339 text format.

customer_router_ip_address

Type: STRING
Provider name: customerRouterIpAddress
Description: [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

customer_router_ipv6_address

Type: STRING
Provider name: customerRouterIpv6Address
Description: [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.

customer_router_ipv6_interface_id

Type: STRING
Provider name: customerRouterIpv6InterfaceId
Description: This field is not available.

dataplane_version

Type: INT32
Provider name: dataplaneVersion
Description: [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.

description

Type: STRING
Provider name: description
Description: An optional description of this resource.

edge_availability_domain

Type: STRING
Provider name: edgeAvailabilityDomain
Description: 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.
Possible values:

• AVAILABILITY_DOMAIN_1
• AVAILABILITY_DOMAIN_2
• AVAILABILITY_DOMAIN_ANY

encryption

Type: STRING
Provider name: encryption
Description: 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.
Possible values:

• IPSEC - The interconnect attachment will carry only encrypted traffic that is encrypted by an IPsec device such as HA VPN gateway; VMs cannot directly send traffic to or receive traffic from such an interconnect attachment. To use HA VPN over Cloud Interconnect, the interconnect attachment must be created with this option.
  
• NONE - This is the default value, which means the Interconnect Attachment will carry unencrypted traffic. VMs will be able to send traffic to or receive traffic from such interconnect attachment.
  

google_reference_id

Type: STRING
Provider name: googleReferenceId
Description: [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.

id

Type: STRING
Provider name: id
Description: [Output Only] The unique identifier for the resource. This identifier is defined by the server.

interconnect

Type: STRING
Provider name: interconnect
Description: URL of the underlying Interconnect object that this attachment’s traffic will traverse through.

ipsec_internal_addresses

Type: UNORDERED_LIST_STRING
Provider name: ipsecInternalAddresses
Description: 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

Type: STRING
Provider name: kind
Description: [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.

labels

Type: UNORDERED_LIST_STRING

mtu

Type: INT32
Provider name: mtu
Description: 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.

name

Type: STRING
Provider name: name
Description: 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.

operational_status

Type: STRING
Provider name: operationalStatus
Description: [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.
Possible values:

• OS_ACTIVE - Indicates that attachment has been turned up and is ready to use.
  
• OS_UNPROVISIONED - Indicates that attachment is not ready to use yet, because turnup is not complete.
  

organization_id

Type: STRING

pairing_key

Type: STRING
Provider name: pairingKey
Description: [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form “XXXXX/region/domain”

parent

Type: STRING

partner_asn

Type: INT64
Provider name: partnerAsn
Description: 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.

partner_metadata

Type: STRUCT
Provider name: partnerMetadata
Description: Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED.

• interconnect_name
  Type: STRING
  Provider name: interconnectName
  Description: Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner’s portal. For instance “Chicago 1”. This value may be validated to match approved Partner values.
  
• partner_name
  Type: STRING
  Provider name: partnerName
  Description: Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.
  
• portal_url
  Type: STRING
  Provider name: portalUrl
  Description: URL of the Partner’s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.
  

private_interconnect_info

Type: STRUCT
Provider name: privateInterconnectInfo
Description: [Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED.

• tag8021q
  Type: INT32
  Provider name: tag8021q
  Description: [Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.
  

project_id

Type: STRING

project_number

Type: STRING

region

Type: STRING
Provider name: region
Description: [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.

remote_service

Type: STRING
Provider name: remoteService
Description: [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.

resource_name

Type: STRING

router

Type: STRING
Provider name: router
Description: 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.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: [Output Only] Reserved for future use.

self_link

Type: STRING
Provider name: selfLink
Description: [Output Only] Server-defined URL for the resource.

stack_type

Type: STRING
Provider name: stackType
Description: 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.
Possible values:

• IPV4_IPV6 - The interconnect attachment can have both IPv4 and IPv6 addresses.
  
• IPV4_ONLY - The interconnect attachment will only be assigned IPv4 addresses.
  

state

Type: STRING
Provider name: state
Description: [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.
Possible values:

• ACTIVE - Indicates that attachment has been turned up and is ready to use.
  
• DEFUNCT - The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was wiped out, or because the other side of a Partner attachment was deleted.
  
• PARTNER_REQUEST_RECEIVED - A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it.
  
• PENDING_CUSTOMER - PARTNER or PARTNER_PROVIDER attachment that is waiting for the customer to activate.
  
• PENDING_PARTNER - A newly created PARTNER attachment that has not yet been configured on the Partner side.
  
• STATE_UNSPECIFIED
• UNPROVISIONED - Indicates that attachment is not ready to use yet, because turnup is not complete.
  

subnet_length

Type: INT32
Provider name: subnetLength
Description: 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.

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: type
Description: 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.
Possible values:

• DEDICATED - Attachment to a dedicated interconnect.
  
• PARTNER - Attachment to a partner interconnect, created by the customer.
  
• PARTNER_PROVIDER - Attachment to a partner interconnect, created by the partner.
  

vlan_tag8021q

Type: INT32
Provider name: vlanTag8021q
Description: The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time.