`computeHaVpnGateway` Submodule

Constructs

ComputeHaVpnGateway

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway google_compute_ha_vpn_gateway}.

Initializers

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

new computeHaVpnGateway.ComputeHaVpnGateway(scope: Construct, id: string, config: ComputeHaVpnGatewayConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`ComputeHaVpnGatewayConfig`	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: ComputeHaVpnGatewayConfig

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.
`putVpnInterfaces`	No description.
`resetDescription`	No description.
`resetGatewayIpVersion`	No description.
`resetId`	No description.
`resetLabels`	No description.
`resetProject`	No description.
`resetRegion`	No description.
`resetStackType`	No description.
`resetTimeouts`	No description.
`resetVpnInterfaces`	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: ComputeHaVpnGatewayTimeouts): void

`value`^Required

Type: ComputeHaVpnGatewayTimeouts

`putVpnInterfaces`

public putVpnInterfaces(value: IResolvable | ComputeHaVpnGatewayVpnInterfaces[]): void

`value`^Required

Type: cdktf.IResolvable | ComputeHaVpnGatewayVpnInterfaces[]

`resetDescription`

public resetDescription(): void

`resetGatewayIpVersion`

public resetGatewayIpVersion(): void

`resetId`

public resetId(): void

`resetLabels`

public resetLabels(): void

`resetProject`

public resetProject(): void

`resetRegion`

public resetRegion(): void

`resetStackType`

public resetStackType(): void

`resetTimeouts`

public resetTimeouts(): void

`resetVpnInterfaces`

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

`isConstruct`

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

computeHaVpnGateway.ComputeHaVpnGateway.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 { computeHaVpnGateway } from '@cdktf/provider-google'

computeHaVpnGateway.ComputeHaVpnGateway.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

computeHaVpnGateway.ComputeHaVpnGateway.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

computeHaVpnGateway.ComputeHaVpnGateway.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ComputeHaVpnGateway 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 ComputeHaVpnGateway to import.

`importFromId`^Required

Type: string

The id of the existing ComputeHaVpnGateway that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#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 ComputeHaVpnGateway 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.
`effectiveLabels`	`cdktf.StringMap`	No description.
`labelFingerprint`	`string`	No description.
`selfLink`	`string`	No description.
`terraformLabels`	`cdktf.StringMap`	No description.
`timeouts`	`ComputeHaVpnGatewayTimeoutsOutputReference`	No description.
`vpnInterfaces`	`ComputeHaVpnGatewayVpnInterfacesList`	No description.
`descriptionInput`	`string`	No description.
`gatewayIpVersionInput`	`string`	No description.
`idInput`	`string`	No description.
`labelsInput`	`{[ key: string ]: string}`	No description.
`nameInput`	`string`	No description.
`networkInput`	`string`	No description.
`projectInput`	`string`	No description.
`regionInput`	`string`	No description.
`stackTypeInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| ComputeHaVpnGatewayTimeouts`	No description.
`vpnInterfacesInput`	`cdktf.IResolvable \| ComputeHaVpnGatewayVpnInterfaces[]`	No description.
`description`	`string`	No description.
`gatewayIpVersion`	`string`	No description.
`id`	`string`	No description.
`labels`	`{[ key: string ]: string}`	No description.
`name`	`string`	No description.
`network`	`string`	No description.
`project`	`string`	No description.
`region`	`string`	No description.
`stackType`	`string`	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[]

`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

`terraformLabels`^Required

public readonly terraformLabels: StringMap;

Type: cdktf.StringMap

`timeouts`^Required

public readonly timeouts: ComputeHaVpnGatewayTimeoutsOutputReference;

Type: ComputeHaVpnGatewayTimeoutsOutputReference

`vpnInterfaces`^Required

public readonly vpnInterfaces: ComputeHaVpnGatewayVpnInterfacesList;

Type: ComputeHaVpnGatewayVpnInterfacesList

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`gatewayIpVersionInput`^Optional

public readonly gatewayIpVersionInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`labelsInput`^Optional

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

Type: {[ key: string ]: string}

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`networkInput`^Optional

public readonly networkInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`regionInput`^Optional

public readonly regionInput: string;

Type: string

`stackTypeInput`^Optional

public readonly stackTypeInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | ComputeHaVpnGatewayTimeouts;

Type: cdktf.IResolvable | ComputeHaVpnGatewayTimeouts

`vpnInterfacesInput`^Optional

public readonly vpnInterfacesInput: IResolvable | ComputeHaVpnGatewayVpnInterfaces[];

Type: cdktf.IResolvable | ComputeHaVpnGatewayVpnInterfaces[]

`description`^Required

public readonly description: string;

Type: string

`gatewayIpVersion`^Required

public readonly gatewayIpVersion: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`labels`^Required

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

Type: {[ key: string ]: string}

`name`^Required

public readonly name: string;

Type: string

`network`^Required

public readonly network: string;

Type: string

`project`^Required

public readonly project: string;

Type: string

`region`^Required

public readonly region: string;

Type: string

`stackType`^Required

public readonly stackType: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

ComputeHaVpnGatewayConfig

Initializer

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

const computeHaVpnGatewayConfig: computeHaVpnGateway.ComputeHaVpnGatewayConfig = { ... }

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.
`network`	`string`	The network this VPN gateway is accepting traffic for.
`description`	`string`	An optional description of this resource.
`gatewayIpVersion`	`string`	The IP family of the gateway IPs for the HA-VPN gateway interfaces.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#id ComputeHaVpnGateway#id}.
`labels`	`{[ key: string ]: string}`	Labels for this resource.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#project ComputeHaVpnGateway#project}.
`region`	`string`	The region this gateway should sit in.
`stackType`	`string`	The stack type for this VPN gateway to identify the IP protocols that are enabled.
`timeouts`	`ComputeHaVpnGatewayTimeouts`	timeouts block.
`vpnInterfaces`	`cdktf.IResolvable \| ComputeHaVpnGatewayVpnInterfaces[]`	vpn_interfaces block.

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

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/6.35.0/docs/resources/compute_ha_vpn_gateway#name ComputeHaVpnGateway#name}

`network`^Required

public readonly network: string;

Type: string

The network this VPN gateway is accepting traffic for.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#network ComputeHaVpnGateway#network}

`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.35.0/docs/resources/compute_ha_vpn_gateway#description ComputeHaVpnGateway#description}

`gatewayIpVersion`^Optional

public readonly gatewayIpVersion: string;

Type: string

The IP family of the gateway IPs for the HA-VPN gateway interfaces.

If not specified, IPV4 will be used. Default value: "IPV4" Possible values: ["IPV4", "IPV6"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#gateway_ip_version ComputeHaVpnGateway#gateway_ip_version}

`id`^Optional

public readonly id: string;

Type: string

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

`labels`^Optional

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/6.35.0/docs/resources/compute_ha_vpn_gateway#labels ComputeHaVpnGateway#labels}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#project ComputeHaVpnGateway#project}.

`region`^Optional

public readonly region: string;

Type: string

The region this gateway should sit in.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#region ComputeHaVpnGateway#region}

`stackType`^Optional

public readonly stackType: string;

Type: string

The stack type for this VPN gateway to identify the IP protocols that are enabled.

If not specified, IPV4_ONLY will be used. Default value: "IPV4_ONLY" Possible values: ["IPV4_ONLY", "IPV4_IPV6", "IPV6_ONLY"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#stack_type ComputeHaVpnGateway#stack_type}

`timeouts`^Optional

public readonly timeouts: ComputeHaVpnGatewayTimeouts;

Type: ComputeHaVpnGatewayTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#timeouts ComputeHaVpnGateway#timeouts}

`vpnInterfaces`^Optional

public readonly vpnInterfaces: IResolvable | ComputeHaVpnGatewayVpnInterfaces[];

Type: cdktf.IResolvable | ComputeHaVpnGatewayVpnInterfaces[]

vpn_interfaces block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#vpn_interfaces ComputeHaVpnGateway#vpn_interfaces}

ComputeHaVpnGatewayTimeouts

Initializer

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

const computeHaVpnGatewayTimeouts: computeHaVpnGateway.ComputeHaVpnGatewayTimeouts = { ... }

Properties

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

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#create ComputeHaVpnGateway#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#delete ComputeHaVpnGateway#delete}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#update ComputeHaVpnGateway#update}.

ComputeHaVpnGatewayVpnInterfaces

Initializer

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

const computeHaVpnGatewayVpnInterfaces: computeHaVpnGateway.ComputeHaVpnGatewayVpnInterfaces = { ... }

Properties

Name	Type	Description
`id`	`number`	The numeric ID of this VPN gateway interface.
`interconnectAttachment`	`string`	URL of the interconnect attachment resource.

`id`^Optional

public readonly id: number;

Type: number

The numeric ID of this VPN gateway interface.

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

`interconnectAttachment`^Optional

public readonly interconnectAttachment: string;

Type: string

URL of the interconnect attachment resource.

When the value of this field is present, the VPN Gateway will be used for IPsec-encrypted Cloud Interconnect; all Egress or Ingress traffic for this VPN Gateway interface will go through the specified interconnect attachment resource.

Not currently available publicly.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/compute_ha_vpn_gateway#interconnect_attachment ComputeHaVpnGateway#interconnect_attachment}

Classes

ComputeHaVpnGatewayTimeoutsOutputReference

Initializers

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

new computeHaVpnGateway.ComputeHaVpnGatewayTimeoutsOutputReference(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 \| ComputeHaVpnGatewayTimeouts`	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 | ComputeHaVpnGatewayTimeouts;

Type: cdktf.IResolvable | ComputeHaVpnGatewayTimeouts

ComputeHaVpnGatewayVpnInterfacesList

Initializers

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

new computeHaVpnGateway.ComputeHaVpnGatewayVpnInterfacesList(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).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

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.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): 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.

`get`

public get(index: number): ComputeHaVpnGatewayVpnInterfacesOutputReference

`index`^Required

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.
`internalValue`	`cdktf.IResolvable \| ComputeHaVpnGatewayVpnInterfaces[]`	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

`internalValue`^Optional

public readonly internalValue: IResolvable | ComputeHaVpnGatewayVpnInterfaces[];

Type: cdktf.IResolvable | ComputeHaVpnGatewayVpnInterfaces[]

ComputeHaVpnGatewayVpnInterfacesOutputReference

Initializers

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

new computeHaVpnGateway.ComputeHaVpnGatewayVpnInterfacesOutputReference(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).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

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.
`resetId`	No description.
`resetInterconnectAttachment`	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.

`resetId`

public resetId(): void

`resetInterconnectAttachment`

public resetInterconnectAttachment(): 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.
`ipAddress`	`string`	No description.
`idInput`	`number`	No description.
`interconnectAttachmentInput`	`string`	No description.
`id`	`number`	No description.
`interconnectAttachment`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| ComputeHaVpnGatewayVpnInterfaces`	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

`ipAddress`^Required

public readonly ipAddress: string;

Type: string

`idInput`^Optional

public readonly idInput: number;

Type: number

`interconnectAttachmentInput`^Optional

public readonly interconnectAttachmentInput: string;

Type: string

`id`^Required

public readonly id: number;

Type: number

`interconnectAttachment`^Required

public readonly interconnectAttachment: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | ComputeHaVpnGatewayVpnInterfaces;

Type: cdktf.IResolvable | ComputeHaVpnGatewayVpnInterfaces

Files

computeHaVpnGateway.typescript.md

Latest commit

History

computeHaVpnGateway.typescript.md

File metadata and controls

computeHaVpnGateway Submodule

Constructs