Skip to content

Latest commit

 

History

History
2700 lines (1688 loc) · 141 KB

googleComputeInterconnectAttachment.typescript.md

File metadata and controls

2700 lines (1688 loc) · 141 KB

googleComputeInterconnectAttachment Submodule

Constructs

GoogleComputeInterconnectAttachment

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment google_compute_interconnect_attachment}.

Initializers

import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

new googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachment(scope: Construct, id: string, config: GoogleComputeInterconnectAttachmentConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GoogleComputeInterconnectAttachmentConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
putTimeouts No description.
resetAdminEnabled No description.
resetBandwidth No description.
resetCandidateSubnets No description.
resetDescription No description.
resetEdgeAvailabilityDomain No description.
resetEncryption No description.
resetId No description.
resetInterconnect No description.
resetIpsecInternalAddresses No description.
resetLabels No description.
resetMtu No description.
resetProject No description.
resetRegion No description.
resetStackType No description.
resetSubnetLength No description.
resetTimeouts No description.
resetType No description.
resetVlanTag8021Q No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


resetOverrideLogicalId
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

moveFromId
public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


moveTo
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


moveToId
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".


putTimeouts
public putTimeouts(value: GoogleComputeInterconnectAttachmentTimeouts): void
valueRequired

resetAdminEnabled
public resetAdminEnabled(): void
resetBandwidth
public resetBandwidth(): void
resetCandidateSubnets
public resetCandidateSubnets(): void
resetDescription
public resetDescription(): void
resetEdgeAvailabilityDomain
public resetEdgeAvailabilityDomain(): void
resetEncryption
public resetEncryption(): void
resetId
public resetId(): void
resetInterconnect
public resetInterconnect(): void
resetIpsecInternalAddresses
public resetIpsecInternalAddresses(): void
resetLabels
public resetLabels(): void
resetMtu
public resetMtu(): void
resetProject
public resetProject(): void
resetRegion
public resetRegion(): void
resetStackType
public resetStackType(): void
resetSubnetLength
public resetSubnetLength(): void
resetTimeouts
public resetTimeouts(): void
resetType
public resetType(): void
resetVlanTag8021Q
public resetVlanTag8021Q(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a GoogleComputeInterconnectAttachment resource upon running "cdktf plan ".

isConstruct
import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachment.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.


isTerraformElement
import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachment.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachment.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachment.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a GoogleComputeInterconnectAttachment resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

The construct id used in the generated config for the GoogleComputeInterconnectAttachment to import.


importFromIdRequired
  • Type: string

The id of the existing GoogleComputeInterconnectAttachment that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the GoogleComputeInterconnectAttachment to import is found.


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
cloudRouterIpAddress string No description.
cloudRouterIpv6Address string No description.
creationTimestamp string No description.
customerRouterIpAddress string No description.
customerRouterIpv6Address string No description.
effectiveLabels cdktf.StringMap No description.
googleReferenceId string No description.
labelFingerprint string No description.
pairingKey string No description.
partnerAsn string No description.
privateInterconnectInfo GoogleComputeInterconnectAttachmentPrivateInterconnectInfoList No description.
selfLink string No description.
state string No description.
terraformLabels cdktf.StringMap No description.
timeouts GoogleComputeInterconnectAttachmentTimeoutsOutputReference No description.
adminEnabledInput boolean | cdktf.IResolvable No description.
bandwidthInput string No description.
candidateSubnetsInput string[] No description.
descriptionInput string No description.
edgeAvailabilityDomainInput string No description.
encryptionInput string No description.
idInput string No description.
interconnectInput string No description.
ipsecInternalAddressesInput string[] No description.
labelsInput {[ key: string ]: string} No description.
mtuInput string No description.
nameInput string No description.
projectInput string No description.
regionInput string No description.
routerInput string No description.
stackTypeInput string No description.
subnetLengthInput number No description.
timeoutsInput cdktf.IResolvable | GoogleComputeInterconnectAttachmentTimeouts No description.
typeInput string No description.
vlanTag8021QInput number No description.
adminEnabled boolean | cdktf.IResolvable No description.
bandwidth string No description.
candidateSubnets string[] No description.
description string No description.
edgeAvailabilityDomain string No description.
encryption string No description.
id string No description.
interconnect string No description.
ipsecInternalAddresses string[] No description.
labels {[ key: string ]: string} No description.
mtu string No description.
name string No description.
project string No description.
region string No description.
router string No description.
stackType string No description.
subnetLength number No description.
type string No description.
vlanTag8021Q number No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

terraformMetaArgumentsRequired
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

cloudRouterIpAddressRequired
public readonly cloudRouterIpAddress: string;
  • Type: string

cloudRouterIpv6AddressRequired
public readonly cloudRouterIpv6Address: string;
  • Type: string

creationTimestampRequired
public readonly creationTimestamp: string;
  • Type: string

customerRouterIpAddressRequired
public readonly customerRouterIpAddress: string;
  • Type: string

customerRouterIpv6AddressRequired
public readonly customerRouterIpv6Address: string;
  • Type: string

effectiveLabelsRequired
public readonly effectiveLabels: StringMap;
  • Type: cdktf.StringMap

googleReferenceIdRequired
public readonly googleReferenceId: string;
  • Type: string

labelFingerprintRequired
public readonly labelFingerprint: string;
  • Type: string

pairingKeyRequired
public readonly pairingKey: string;
  • Type: string

partnerAsnRequired
public readonly partnerAsn: string;
  • Type: string

privateInterconnectInfoRequired
public readonly privateInterconnectInfo: GoogleComputeInterconnectAttachmentPrivateInterconnectInfoList;

selfLinkRequired
public readonly selfLink: string;
  • Type: string

stateRequired
public readonly state: string;
  • Type: string

terraformLabelsRequired
public readonly terraformLabels: StringMap;
  • Type: cdktf.StringMap

timeoutsRequired
public readonly timeouts: GoogleComputeInterconnectAttachmentTimeoutsOutputReference;

adminEnabledInputOptional
public readonly adminEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

bandwidthInputOptional
public readonly bandwidthInput: string;
  • Type: string

candidateSubnetsInputOptional
public readonly candidateSubnetsInput: string[];
  • Type: string[]

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

edgeAvailabilityDomainInputOptional
public readonly edgeAvailabilityDomainInput: string;
  • Type: string

encryptionInputOptional
public readonly encryptionInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

interconnectInputOptional
public readonly interconnectInput: string;
  • Type: string

ipsecInternalAddressesInputOptional
public readonly ipsecInternalAddressesInput: string[];
  • Type: string[]

labelsInputOptional
public readonly labelsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

mtuInputOptional
public readonly mtuInput: string;
  • Type: string

nameInputOptional
public readonly nameInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

regionInputOptional
public readonly regionInput: string;
  • Type: string

routerInputOptional
public readonly routerInput: string;
  • Type: string

stackTypeInputOptional
public readonly stackTypeInput: string;
  • Type: string

subnetLengthInputOptional
public readonly subnetLengthInput: number;
  • Type: number

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | GoogleComputeInterconnectAttachmentTimeouts;

typeInputOptional
public readonly typeInput: string;
  • Type: string

vlanTag8021QInputOptional
public readonly vlanTag8021QInput: number;
  • Type: number

adminEnabledRequired
public readonly adminEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

bandwidthRequired
public readonly bandwidth: string;
  • Type: string

candidateSubnetsRequired
public readonly candidateSubnets: string[];
  • Type: string[]

descriptionRequired
public readonly description: string;
  • Type: string

edgeAvailabilityDomainRequired
public readonly edgeAvailabilityDomain: string;
  • Type: string

encryptionRequired
public readonly encryption: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

interconnectRequired
public readonly interconnect: string;
  • Type: string

ipsecInternalAddressesRequired
public readonly ipsecInternalAddresses: string[];
  • Type: string[]

labelsRequired
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

mtuRequired
public readonly mtu: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

regionRequired
public readonly region: string;
  • Type: string

routerRequired
public readonly router: string;
  • Type: string

stackTypeRequired
public readonly stackType: string;
  • Type: string

subnetLengthRequired
public readonly subnetLength: number;
  • Type: number

typeRequired
public readonly type: string;
  • Type: string

vlanTag8021QRequired
public readonly vlanTag8021Q: number;
  • Type: number

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

GoogleComputeInterconnectAttachmentConfig

Initializer

import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

const googleComputeInterconnectAttachmentConfig: googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachmentConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
name string Name of the resource.
router string URL of the cloud router to be used for dynamic routing.
adminEnabled boolean | cdktf.IResolvable Whether the VLAN attachment is enabled or disabled. When using PARTNER type this will Pre-Activate the interconnect attachment.
bandwidth string Provisioned bandwidth capacity for the interconnect attachment.
candidateSubnets string[] Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment.
description string An optional description of this resource.
edgeAvailabilityDomain string Desired availability domain for the attachment.
encryption string Indicates the user-supplied encryption option of this interconnect attachment.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#id GoogleComputeInterconnectAttachment#id}.
interconnect string URL of the underlying Interconnect object that this attachment's traffic will traverse through.
ipsecInternalAddresses string[] URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC.
labels {[ key: string ]: string} Labels for this resource.
mtu string Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#project GoogleComputeInterconnectAttachment#project}.
region string Region where the regional interconnect attachment resides.
stackType string The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not.
subnetLength number Length of the IPv4 subnet mask.
timeouts GoogleComputeInterconnectAttachmentTimeouts timeouts block.
type string The type of InterconnectAttachment you wish to create. Defaults to DEDICATED. Possible values: ["DEDICATED", "PARTNER", "PARTNER_PROVIDER"].
vlanTag8021Q number The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. When using PARTNER type this will be managed upstream.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

nameRequired
public readonly name: string;
  • Type: 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?' 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#name GoogleComputeInterconnectAttachment#name}


routerRequired
public readonly router: string;
  • Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#router GoogleComputeInterconnectAttachment#router}


adminEnabledOptional
public readonly adminEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Whether the VLAN attachment is enabled or disabled. When using PARTNER type this will Pre-Activate the interconnect attachment.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#admin_enabled GoogleComputeInterconnectAttachment#admin_enabled}


bandwidthOptional
public readonly bandwidth: string;
  • Type: 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, Defaults to BPS_10G Possible values: ["BPS_50M", "BPS_100M", "BPS_200M", "BPS_300M", "BPS_400M", "BPS_500M", "BPS_1G", "BPS_2G", "BPS_5G", "BPS_10G", "BPS_20G", "BPS_50G", "BPS_100G"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#bandwidth GoogleComputeInterconnectAttachment#bandwidth}


candidateSubnetsOptional
public readonly candidateSubnets: string[];
  • Type: string[]

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#candidate_subnets GoogleComputeInterconnectAttachment#candidate_subnets}


descriptionOptional
public readonly description: string;
  • Type: string

An optional description of this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#description GoogleComputeInterconnectAttachment#description}


edgeAvailabilityDomainOptional
public readonly edgeAvailabilityDomain: string;
  • Type: string

Desired availability domain for the attachment.

Only available for type PARTNER, at creation time. For improved reliability, customers should configure a pair of attachments with 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#edge_availability_domain GoogleComputeInterconnectAttachment#edge_availability_domain}


encryptionOptional
public readonly encryption: string;
  • Type: string

Indicates the user-supplied encryption option of this interconnect attachment.

Can only be specified at attachment creation for PARTNER or DEDICATED attachments.

  • 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. Default value: "NONE" Possible values: ["NONE", "IPSEC"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#encryption GoogleComputeInterconnectAttachment#encryption}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#id GoogleComputeInterconnectAttachment#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


interconnectOptional
public readonly interconnect: string;
  • Type: string

URL of the underlying Interconnect object that this attachment's traffic will traverse through.

Required if type is DEDICATED, must not be set if type is PARTNER.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#interconnect GoogleComputeInterconnectAttachment#interconnect}


ipsecInternalAddressesOptional
public readonly ipsecInternalAddresses: string[];
  • Type: string[]

URL of addresses that have been reserved for the interconnect attachment, Used only for interconnect attachment that has the encryption option as IPSEC.

The addresses must be RFC 1918 IP address ranges. When creating HA VPN gateway over the interconnect attachment, if the attachment is configured to use an RFC 1918 IP address, then the VPN gateway's IP address will be allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this interconnect attachment, then an RFC 1918 IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this interconnect attachment. If this field is not specified for interconnect attachment that has encryption option as IPSEC, later on when creating HA VPN gateway on this interconnect attachment, the HA VPN gateway's IP address will be allocated from regional external IP address pool.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#ipsec_internal_addresses GoogleComputeInterconnectAttachment#ipsec_internal_addresses}


labelsOptional
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

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.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#labels GoogleComputeInterconnectAttachment#labels}


mtuOptional
public readonly mtu: string;
  • Type: string

Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment.

Currently, only 1440 and 1500 are allowed. If not specified, the value will default to 1440.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#mtu GoogleComputeInterconnectAttachment#mtu}


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#project GoogleComputeInterconnectAttachment#project}.


regionOptional
public readonly region: string;
  • Type: string

Region where the regional interconnect attachment resides.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#region GoogleComputeInterconnectAttachment#region}


stackTypeOptional
public readonly stackType: string;
  • Type: 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. Possible values: ["IPV4_IPV6", "IPV4_ONLY"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#stack_type GoogleComputeInterconnectAttachment#stack_type}


subnetLengthOptional
public readonly subnetLength: number;
  • Type: number

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#subnet_length GoogleComputeInterconnectAttachment#subnet_length}


timeoutsOptional
public readonly timeouts: GoogleComputeInterconnectAttachmentTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#timeouts GoogleComputeInterconnectAttachment#timeouts}


typeOptional
public readonly type: string;
  • Type: string

The type of InterconnectAttachment you wish to create. Defaults to DEDICATED. Possible values: ["DEDICATED", "PARTNER", "PARTNER_PROVIDER"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#type GoogleComputeInterconnectAttachment#type}


vlanTag8021QOptional
public readonly vlanTag8021Q: number;
  • Type: number

The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. When using PARTNER type this will be managed upstream.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#vlan_tag8021q GoogleComputeInterconnectAttachment#vlan_tag8021q}


GoogleComputeInterconnectAttachmentPrivateInterconnectInfo

Initializer

import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

const googleComputeInterconnectAttachmentPrivateInterconnectInfo: googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachmentPrivateInterconnectInfo = { ... }

GoogleComputeInterconnectAttachmentTimeouts

Initializer

import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

const googleComputeInterconnectAttachmentTimeouts: googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachmentTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#create GoogleComputeInterconnectAttachment#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#delete GoogleComputeInterconnectAttachment#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#update GoogleComputeInterconnectAttachment#update}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#create GoogleComputeInterconnectAttachment#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#delete GoogleComputeInterconnectAttachment#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.24.0/docs/resources/google_compute_interconnect_attachment#update GoogleComputeInterconnectAttachment#update}.


Classes

GoogleComputeInterconnectAttachmentPrivateInterconnectInfoList

Initializers

import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

new googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachmentPrivateInterconnectInfoList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
wrapsSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

allWithMapKey
public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: string

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
public get(index: number): GoogleComputeInterconnectAttachmentPrivateInterconnectInfoOutputReference
indexRequired
  • Type: number

the index of the item to return.


Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

GoogleComputeInterconnectAttachmentPrivateInterconnectInfoOutputReference

Initializers

import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

new googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachmentPrivateInterconnectInfoOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
complexObjectIndex number the index of this item in the list.
complexObjectIsFromSet boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
tag8021Q number No description.
internalValue GoogleComputeInterconnectAttachmentPrivateInterconnectInfo No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

tag8021QRequired
public readonly tag8021Q: number;
  • Type: number

internalValueOptional
public readonly internalValue: GoogleComputeInterconnectAttachmentPrivateInterconnectInfo;

GoogleComputeInterconnectAttachmentTimeoutsOutputReference

Initializers

import { googleComputeInterconnectAttachment } from '@cdktf/provider-google-beta'

new googleComputeInterconnectAttachment.GoogleComputeInterconnectAttachmentTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCreate No description.
resetDelete No description.
resetUpdate No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate
public resetCreate(): void
resetDelete
public resetDelete(): void
resetUpdate
public resetUpdate(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
createInput string No description.
deleteInput string No description.
updateInput string No description.
create string No description.
delete string No description.
update string No description.
internalValue cdktf.IResolvable | GoogleComputeInterconnectAttachmentTimeouts No description.

creationStackRequired
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
public readonly fqn: string;
  • Type: string

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | GoogleComputeInterconnectAttachmentTimeouts;