computeVpnTunnel.typescript.md

computeVpnTunnel Submodule

Constructs

ComputeVpnTunnel

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel google_compute_vpn_tunnel}.

Initializers

import { computeVpnTunnel } from '@cdktf/provider-google'

new computeVpnTunnel.ComputeVpnTunnel(scope: Construct, id: string, config: ComputeVpnTunnelConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	ComputeVpnTunnelConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: ComputeVpnTunnelConfig

---

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.
resetDescription	No description.
resetId	No description.
resetIkeVersion	No description.
resetLabels	No description.
resetLocalTrafficSelector	No description.
resetPeerExternalGateway	No description.
resetPeerExternalGatewayInterface	No description.
resetPeerGcpGateway	No description.
resetPeerIp	No description.
resetProject	No description.
resetRegion	No description.
resetRemoteTrafficSelector	No description.
resetRouter	No description.
resetTargetVpnGateway	No description.
resetTimeouts	No description.
resetVpnGateway	No description.
resetVpnGatewayInterface	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• 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.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

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

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• 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.

id^Required

• 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.

moveTarget^Required

• Type: string

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

---

index^Optional

• 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".

id^Required

• Type: string

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

---

putTimeouts

public putTimeouts(value: ComputeVpnTunnelTimeouts): void

value^Required

• Type: ComputeVpnTunnelTimeouts

---

resetDescription

public resetDescription(): void

resetId

public resetId(): void

resetIkeVersion

public resetIkeVersion(): void

resetLabels

public resetLabels(): void

resetLocalTrafficSelector

public resetLocalTrafficSelector(): void

resetPeerExternalGateway

public resetPeerExternalGateway(): void

resetPeerExternalGatewayInterface

public resetPeerExternalGatewayInterface(): void

resetPeerGcpGateway

public resetPeerGcpGateway(): void

resetPeerIp

public resetPeerIp(): void

resetProject

public resetProject(): void

resetRegion

public resetRegion(): void

resetRemoteTrafficSelector

public resetRemoteTrafficSelector(): void

resetRouter

public resetRouter(): void

resetTargetVpnGateway

public resetTargetVpnGateway(): void

resetTimeouts

public resetTimeouts(): void

resetVpnGateway

public resetVpnGateway(): void

resetVpnGatewayInterface

public resetVpnGatewayInterface(): 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 ComputeVpnTunnel resource upon running "cdktf plan ".

---

isConstruct

import { computeVpnTunnel } from '@cdktf/provider-google'

computeVpnTunnel.ComputeVpnTunnel.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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { computeVpnTunnel } from '@cdktf/provider-google'

computeVpnTunnel.ComputeVpnTunnel.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { computeVpnTunnel } from '@cdktf/provider-google'

computeVpnTunnel.ComputeVpnTunnel.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { computeVpnTunnel } from '@cdktf/provider-google'

computeVpnTunnel.ComputeVpnTunnel.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing ComputeVpnTunnel that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the ComputeVpnTunnel 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.
creationTimestamp	string	No description.
detailedStatus	string	No description.
effectiveLabels	cdktf.StringMap	No description.
labelFingerprint	string	No description.
selfLink	string	No description.
sharedSecretHash	string	No description.
terraformLabels	cdktf.StringMap	No description.
timeouts	ComputeVpnTunnelTimeoutsOutputReference	No description.
tunnelId	string	No description.
descriptionInput	string	No description.
idInput	string	No description.
ikeVersionInput	number	No description.
labelsInput	{[ key: string ]: string}	No description.
localTrafficSelectorInput	string[]	No description.
nameInput	string	No description.
peerExternalGatewayInput	string	No description.
peerExternalGatewayInterfaceInput	number	No description.
peerGcpGatewayInput	string	No description.
peerIpInput	string	No description.
projectInput	string	No description.
regionInput	string	No description.
remoteTrafficSelectorInput	string[]	No description.
routerInput	string	No description.
sharedSecretInput	string	No description.
targetVpnGatewayInput	string	No description.
timeoutsInput	cdktf.IResolvable | ComputeVpnTunnelTimeouts	No description.
vpnGatewayInput	string	No description.
vpnGatewayInterfaceInput	number	No description.
description	string	No description.
id	string	No description.
ikeVersion	number	No description.
labels	{[ key: string ]: string}	No description.
localTrafficSelector	string[]	No description.
name	string	No description.
peerExternalGateway	string	No description.
peerExternalGatewayInterface	number	No description.
peerGcpGateway	string	No description.
peerIp	string	No description.
project	string	No description.
region	string	No description.
remoteTrafficSelector	string[]	No description.
router	string	No description.
sharedSecret	string	No description.
targetVpnGateway	string	No description.
vpnGateway	string	No description.
vpnGatewayInterface	number	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

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

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

creationTimestamp^Required

public readonly creationTimestamp: string;

• Type: string

---

detailedStatus^Required

public readonly detailedStatus: string;

• Type: string

---

effectiveLabels^Required

public readonly effectiveLabels: StringMap;

• Type: cdktf.StringMap

---

labelFingerprint^Required

public readonly labelFingerprint: string;

• Type: string

---

selfLink^Required

public readonly selfLink: string;

• Type: string

---

sharedSecretHash^Required

public readonly sharedSecretHash: string;

• Type: string

---

terraformLabels^Required

public readonly terraformLabels: StringMap;

• Type: cdktf.StringMap

---

timeouts^Required

public readonly timeouts: ComputeVpnTunnelTimeoutsOutputReference;

• Type: ComputeVpnTunnelTimeoutsOutputReference

---

tunnelId^Required

public readonly tunnelId: string;

• Type: string

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

ikeVersionInput^Optional

public readonly ikeVersionInput: number;

• Type: number

---

labelsInput^Optional

public readonly labelsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

localTrafficSelectorInput^Optional

public readonly localTrafficSelectorInput: string[];

• Type: string[]

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

peerExternalGatewayInput^Optional

public readonly peerExternalGatewayInput: string;

• Type: string

---

peerExternalGatewayInterfaceInput^Optional

public readonly peerExternalGatewayInterfaceInput: number;

• Type: number

---

peerGcpGatewayInput^Optional

public readonly peerGcpGatewayInput: string;

• Type: string

---

peerIpInput^Optional

public readonly peerIpInput: string;

• Type: string

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

remoteTrafficSelectorInput^Optional

public readonly remoteTrafficSelectorInput: string[];

• Type: string[]

---

routerInput^Optional

public readonly routerInput: string;

• Type: string

---

sharedSecretInput^Optional

public readonly sharedSecretInput: string;

• Type: string

---

targetVpnGatewayInput^Optional

public readonly targetVpnGatewayInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | ComputeVpnTunnelTimeouts;

• Type: cdktf.IResolvable | ComputeVpnTunnelTimeouts

---

vpnGatewayInput^Optional

public readonly vpnGatewayInput: string;

• Type: string

---

vpnGatewayInterfaceInput^Optional

public readonly vpnGatewayInterfaceInput: number;

• Type: number

---

description^Required

public readonly description: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

ikeVersion^Required

public readonly ikeVersion: number;

• Type: number

---

labels^Required

public readonly labels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

localTrafficSelector^Required

public readonly localTrafficSelector: string[];

• Type: string[]

---

name^Required

public readonly name: string;

• Type: string

---

peerExternalGateway^Required

public readonly peerExternalGateway: string;

• Type: string

---

peerExternalGatewayInterface^Required

public readonly peerExternalGatewayInterface: number;

• Type: number

---

peerGcpGateway^Required

public readonly peerGcpGateway: string;

• Type: string

---

peerIp^Required

public readonly peerIp: string;

• Type: string

---

project^Required

public readonly project: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

remoteTrafficSelector^Required

public readonly remoteTrafficSelector: string[];

• Type: string[]

---

router^Required

public readonly router: string;

• Type: string

---

sharedSecret^Required

public readonly sharedSecret: string;

• Type: string

---

targetVpnGateway^Required

public readonly targetVpnGateway: string;

• Type: string

---

vpnGateway^Required

public readonly vpnGateway: string;

• Type: string

---

vpnGatewayInterface^Required

public readonly vpnGatewayInterface: number;

• Type: number

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ComputeVpnTunnelConfig

Initializer

import { computeVpnTunnel } from '@cdktf/provider-google'

const computeVpnTunnelConfig: computeVpnTunnel.ComputeVpnTunnelConfig = { ... }

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.
sharedSecret	string	Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.
description	string	An optional description of this resource.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#id ComputeVpnTunnel#id}.
ikeVersion	number	IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway.
labels	{[ key: string ]: string}	Labels to apply to this VpnTunnel.
localTrafficSelector	string[]	Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
peerExternalGateway	string	URL of the peer side external VPN gateway to which this VPN tunnel is connected.
peerExternalGatewayInterface	number	The interface ID of the external VPN gateway to which this VPN tunnel is connected.
peerGcpGateway	string	URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.
peerIp	string	IP address of the peer VPN gateway. Only IPv4 is supported.
project	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#project ComputeVpnTunnel#project}.
region	string	The region where the tunnel is located. If unset, is set to the region of 'target_vpn_gateway'.
remoteTrafficSelector	string[]	Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway.
router	string	URL of router resource to be used for dynamic routing.
targetVpnGateway	string	URL of the Target VPN gateway with which this VPN tunnel is associated.
timeouts	ComputeVpnTunnelTimeouts	timeouts block.
vpnGateway	string	URL of the VPN gateway with which this VPN tunnel is associated.
vpnGatewayInterface	number	The interface ID of the VPN gateway with which this VPN tunnel is associated.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

name^Required

public readonly name: string;

• Type: string

Name of the resource.

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/6.33.0/docs/resources/compute_vpn_tunnel#name ComputeVpnTunnel#name}

---

sharedSecret^Required

public readonly sharedSecret: string;

• Type: string

Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#shared_secret ComputeVpnTunnel#shared_secret}

---

description^Optional

public readonly description: string;

• Type: string

An optional description of this resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#description ComputeVpnTunnel#description}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#id ComputeVpnTunnel#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.

---

ikeVersion^Optional

public readonly ikeVersion: number;

• Type: number

IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway.

Acceptable IKE versions are 1 or 2. Default version is 2.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#ike_version ComputeVpnTunnel#ike_version}

---

labels^Optional

public readonly labels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Labels to apply to this VpnTunnel.

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/6.33.0/docs/resources/compute_vpn_tunnel#labels ComputeVpnTunnel#labels}

---

localTrafficSelector^Optional

public readonly localTrafficSelector: string[];

• Type: string[]

Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway.

The value should be a CIDR formatted string, for example '192.168.0.0/16'. The ranges should be disjoint. Only IPv4 is supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#local_traffic_selector ComputeVpnTunnel#local_traffic_selector}

---

peerExternalGateway^Optional

public readonly peerExternalGateway: string;

• Type: string

URL of the peer side external VPN gateway to which this VPN tunnel is connected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#peer_external_gateway ComputeVpnTunnel#peer_external_gateway}

---

peerExternalGatewayInterface^Optional

public readonly peerExternalGatewayInterface: number;

• Type: number

The interface ID of the external VPN gateway to which this VPN tunnel is connected.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#peer_external_gateway_interface ComputeVpnTunnel#peer_external_gateway_interface}

---

peerGcpGateway^Optional

public readonly peerGcpGateway: string;

• Type: string

URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.

If provided, the VPN tunnel will automatically use the same vpn_gateway_interface ID in the peer GCP VPN gateway. This field must reference a 'google_compute_ha_vpn_gateway' resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#peer_gcp_gateway ComputeVpnTunnel#peer_gcp_gateway}

---

peerIp^Optional

public readonly peerIp: string;

• Type: string

IP address of the peer VPN gateway. Only IPv4 is supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#peer_ip ComputeVpnTunnel#peer_ip}

---

project^Optional

public readonly project: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#project ComputeVpnTunnel#project}.

---

region^Optional

public readonly region: string;

• Type: string

The region where the tunnel is located. If unset, is set to the region of 'target_vpn_gateway'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#region ComputeVpnTunnel#region}

---

remoteTrafficSelector^Optional

public readonly remoteTrafficSelector: string[];

• Type: string[]

Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway.

The value should be a CIDR formatted string, for example '192.168.0.0/16'. The ranges should be disjoint. Only IPv4 is supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#remote_traffic_selector ComputeVpnTunnel#remote_traffic_selector}

---

router^Optional

public readonly router: string;

• Type: string

URL of router resource to be used for dynamic routing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#router ComputeVpnTunnel#router}

---

targetVpnGateway^Optional

public readonly targetVpnGateway: string;

• Type: string

URL of the Target VPN gateway with which this VPN tunnel is associated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#target_vpn_gateway ComputeVpnTunnel#target_vpn_gateway}

---

timeouts^Optional

public readonly timeouts: ComputeVpnTunnelTimeouts;

• Type: ComputeVpnTunnelTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#timeouts ComputeVpnTunnel#timeouts}

---

vpnGateway^Optional

public readonly vpnGateway: string;

• Type: string

URL of the VPN gateway with which this VPN tunnel is associated.

This must be used if a High Availability VPN gateway resource is created. This field must reference a 'google_compute_ha_vpn_gateway' resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#vpn_gateway ComputeVpnTunnel#vpn_gateway}

---

vpnGatewayInterface^Optional

public readonly vpnGatewayInterface: number;

• Type: number

The interface ID of the VPN gateway with which this VPN tunnel is associated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#vpn_gateway_interface ComputeVpnTunnel#vpn_gateway_interface}

---

ComputeVpnTunnelTimeouts

Initializer

import { computeVpnTunnel } from '@cdktf/provider-google'

const computeVpnTunnelTimeouts: computeVpnTunnel.ComputeVpnTunnelTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#create ComputeVpnTunnel#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#delete ComputeVpnTunnel#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#update ComputeVpnTunnel#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#create ComputeVpnTunnel#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#delete ComputeVpnTunnel#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.33.0/docs/resources/compute_vpn_tunnel#update ComputeVpnTunnel#update}.

---

Classes

ComputeVpnTunnelTimeoutsOutputReference

Initializers

import { computeVpnTunnel } from '@cdktf/provider-google'

new computeVpnTunnel.ComputeVpnTunnelTimeoutsOutputReference(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.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• 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}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

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

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

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

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

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

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• 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 | ComputeVpnTunnelTimeouts	No description.

---

creationStack^Required

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ComputeVpnTunnelTimeouts;

• Type: cdktf.IResolvable | ComputeVpnTunnelTimeouts

---