`vpcAccessConnector` Submodule

Constructs

VpcAccessConnector

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector google_vpc_access_connector}.

Initializers

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

new vpcAccessConnector.VpcAccessConnector(scope: Construct, id: string, config: VpcAccessConnectorConfig)

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

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".
`putSubnet`	No description.
`putTimeouts`	No description.
`resetId`	No description.
`resetIpCidrRange`	No description.
`resetMachineType`	No description.
`resetMaxInstances`	No description.
`resetMaxThroughput`	No description.
`resetMinInstances`	No description.
`resetMinThroughput`	No description.
`resetNetwork`	No description.
`resetProject`	No description.
`resetRegion`	No description.
`resetSubnet`	No description.
`resetTimeouts`	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".

`putSubnet`

public putSubnet(value: VpcAccessConnectorSubnet): void

`value`^Required

Type: VpcAccessConnectorSubnet

`putTimeouts`

public putTimeouts(value: VpcAccessConnectorTimeouts): void

`value`^Required

Type: VpcAccessConnectorTimeouts

`resetId`

public resetId(): void

`resetIpCidrRange`

public resetIpCidrRange(): void

`resetMachineType`

public resetMachineType(): void

`resetMaxInstances`

public resetMaxInstances(): void

`resetMaxThroughput`

public resetMaxThroughput(): void

`resetMinInstances`

public resetMinInstances(): void

`resetMinThroughput`

public resetMinThroughput(): void

`resetNetwork`

public resetNetwork(): void

`resetProject`

public resetProject(): void

`resetRegion`

public resetRegion(): void

`resetSubnet`

public resetSubnet(): void

`resetTimeouts`

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

`isConstruct`

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

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

vpcAccessConnector.VpcAccessConnector.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

vpcAccessConnector.VpcAccessConnector.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

vpcAccessConnector.VpcAccessConnector.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing VpcAccessConnector that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#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 VpcAccessConnector 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.
`connectedProjects`	`string[]`	No description.
`selfLink`	`string`	No description.
`state`	`string`	No description.
`subnet`	`VpcAccessConnectorSubnetOutputReference`	No description.
`timeouts`	`VpcAccessConnectorTimeoutsOutputReference`	No description.
`idInput`	`string`	No description.
`ipCidrRangeInput`	`string`	No description.
`machineTypeInput`	`string`	No description.
`maxInstancesInput`	`number`	No description.
`maxThroughputInput`	`number`	No description.
`minInstancesInput`	`number`	No description.
`minThroughputInput`	`number`	No description.
`nameInput`	`string`	No description.
`networkInput`	`string`	No description.
`projectInput`	`string`	No description.
`regionInput`	`string`	No description.
`subnetInput`	`VpcAccessConnectorSubnet`	No description.
`timeoutsInput`	`cdktf.IResolvable \| VpcAccessConnectorTimeouts`	No description.
`id`	`string`	No description.
`ipCidrRange`	`string`	No description.
`machineType`	`string`	No description.
`maxInstances`	`number`	No description.
`maxThroughput`	`number`	No description.
`minInstances`	`number`	No description.
`minThroughput`	`number`	No description.
`name`	`string`	No description.
`network`	`string`	No description.
`project`	`string`	No description.
`region`	`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[]

`connectedProjects`^Required

public readonly connectedProjects: string[];

Type: string[]

`selfLink`^Required

public readonly selfLink: string;

Type: string

`state`^Required

public readonly state: string;

Type: string

`subnet`^Required

public readonly subnet: VpcAccessConnectorSubnetOutputReference;

Type: VpcAccessConnectorSubnetOutputReference

`timeouts`^Required

public readonly timeouts: VpcAccessConnectorTimeoutsOutputReference;

Type: VpcAccessConnectorTimeoutsOutputReference

`idInput`^Optional

public readonly idInput: string;

Type: string

`ipCidrRangeInput`^Optional

public readonly ipCidrRangeInput: string;

Type: string

`machineTypeInput`^Optional

public readonly machineTypeInput: string;

Type: string

`maxInstancesInput`^Optional

public readonly maxInstancesInput: number;

Type: number

`maxThroughputInput`^Optional

public readonly maxThroughputInput: number;

Type: number

`minInstancesInput`^Optional

public readonly minInstancesInput: number;

Type: number

`minThroughputInput`^Optional

public readonly minThroughputInput: number;

Type: number

`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

`subnetInput`^Optional

public readonly subnetInput: VpcAccessConnectorSubnet;

Type: VpcAccessConnectorSubnet

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | VpcAccessConnectorTimeouts;

Type: cdktf.IResolvable | VpcAccessConnectorTimeouts

`id`^Required

public readonly id: string;

Type: string

`ipCidrRange`^Required

public readonly ipCidrRange: string;

Type: string

`machineType`^Required

public readonly machineType: string;

Type: string

`maxInstances`^Required

public readonly maxInstances: number;

Type: number

`maxThroughput`^Required

public readonly maxThroughput: number;

Type: number

`minInstances`^Required

public readonly minInstances: number;

Type: number

`minThroughput`^Required

public readonly minThroughput: number;

Type: number

`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

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

VpcAccessConnectorConfig

Initializer

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

const vpcAccessConnectorConfig: vpcAccessConnector.VpcAccessConnectorConfig = { ... }

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`	The name of the resource (Max 25 characters).
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#id VpcAccessConnector#id}.
`ipCidrRange`	`string`	The range of internal addresses that follows RFC 4632 notation. Example: '10.132.0.0/28'.
`machineType`	`string`	Machine type of VM Instance underlying connector. Default is e2-micro.
`maxInstances`	`number`	Maximum value of instances in autoscaling group underlying the connector.
`maxThroughput`	`number`	Maximum throughput of the connector in Mbps, must be greater than 'min_throughput'.
`minInstances`	`number`	Minimum value of instances in autoscaling group underlying the connector.
`minThroughput`	`number`	Minimum throughput of the connector in Mbps.
`network`	`string`	Name or self_link of the VPC network. Required if 'ip_cidr_range' is set.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#project VpcAccessConnector#project}.
`region`	`string`	Region where the VPC Access connector resides. If it is not provided, the provider region is used.
`subnet`	`VpcAccessConnectorSubnet`	subnet block.
`timeouts`	`VpcAccessConnectorTimeouts`	timeouts 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

The name of the resource (Max 25 characters).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#name VpcAccessConnector#name}

`id`^Optional

public readonly id: string;

Type: string

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

`ipCidrRange`^Optional

public readonly ipCidrRange: string;

Type: string

The range of internal addresses that follows RFC 4632 notation. Example: '10.132.0.0/28'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#ip_cidr_range VpcAccessConnector#ip_cidr_range}

`machineType`^Optional

public readonly machineType: string;

Type: string

Machine type of VM Instance underlying connector. Default is e2-micro.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#machine_type VpcAccessConnector#machine_type}

`maxInstances`^Optional

public readonly maxInstances: number;

Type: number

Maximum value of instances in autoscaling group underlying the connector.

Value must be between 3 and 10, inclusive. Must be higher than the value specified by min_instances. Required alongside 'min_instances' if not using 'min_throughput'/'max_throughput'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#max_instances VpcAccessConnector#max_instances}

`maxThroughput`^Optional

public readonly maxThroughput: number;

Type: number

Maximum throughput of the connector in Mbps, must be greater than 'min_throughput'.

Default is 300. Refers to the expected throughput when using an e2-micro machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by min_throughput. Only one of 'max_throughput' and 'max_instances' can be specified. The use of max_throughput is discouraged in favor of max_instances.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#max_throughput VpcAccessConnector#max_throughput}

`minInstances`^Optional

public readonly minInstances: number;

Type: number

Minimum value of instances in autoscaling group underlying the connector.

Value must be between 2 and 9, inclusive. Must be lower than the value specified by max_instances. Required alongside 'max_instances' if not using 'min_throughput'/'max_throughput'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#min_instances VpcAccessConnector#min_instances}

`minThroughput`^Optional

public readonly minThroughput: number;

Type: number

Minimum throughput of the connector in Mbps.

Default and min is 200. Refers to the expected throughput when using an e2-micro machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by max_throughput. Only one of 'min_throughput' and 'min_instances' can be specified. The use of min_throughput is discouraged in favor of min_instances.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#min_throughput VpcAccessConnector#min_throughput}

`network`^Optional

public readonly network: string;

Type: string

Name or self_link of the VPC network. Required if 'ip_cidr_range' is set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#network VpcAccessConnector#network}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#project VpcAccessConnector#project}.

`region`^Optional

public readonly region: string;

Type: string

Region where the VPC Access connector resides. If it is not provided, the provider region is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#region VpcAccessConnector#region}

`subnet`^Optional

public readonly subnet: VpcAccessConnectorSubnet;

Type: VpcAccessConnectorSubnet

subnet block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#subnet VpcAccessConnector#subnet}

`timeouts`^Optional

public readonly timeouts: VpcAccessConnectorTimeouts;

Type: VpcAccessConnectorTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#timeouts VpcAccessConnector#timeouts}

VpcAccessConnectorSubnet

Initializer

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

const vpcAccessConnectorSubnet: vpcAccessConnector.VpcAccessConnectorSubnet = { ... }

Properties

Name	Type	Description
`name`	`string`	Subnet name (relative, not fully qualified).
`projectId`	`string`	Project in which the subnet exists.

`name`^Optional

public readonly name: string;

Type: string

Subnet name (relative, not fully qualified).

E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}"

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#name VpcAccessConnector#name}

`projectId`^Optional

public readonly projectId: string;

Type: string

Project in which the subnet exists.

If not set, this project is assumed to be the project for which the connector create request was issued.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#project_id VpcAccessConnector#project_id}

VpcAccessConnectorTimeouts

Initializer

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

const vpcAccessConnectorTimeouts: vpcAccessConnector.VpcAccessConnectorTimeouts = { ... }

Properties

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

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#create VpcAccessConnector#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#delete VpcAccessConnector#delete}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.50.0/docs/resources/vpc_access_connector#update VpcAccessConnector#update}.

Classes

VpcAccessConnectorSubnetOutputReference

Initializers

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

new vpcAccessConnector.VpcAccessConnectorSubnetOutputReference(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.
`resetName`	No description.
`resetProjectId`	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.

`resetName`

public resetName(): void

`resetProjectId`

public resetProjectId(): 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.
`nameInput`	`string`	No description.
`projectIdInput`	`string`	No description.
`name`	`string`	No description.
`projectId`	`string`	No description.
`internalValue`	`VpcAccessConnectorSubnet`	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

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`projectIdInput`^Optional

public readonly projectIdInput: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`projectId`^Required

public readonly projectId: string;

Type: string

`internalValue`^Optional

public readonly internalValue: VpcAccessConnectorSubnet;

Type: VpcAccessConnectorSubnet

VpcAccessConnectorTimeoutsOutputReference

Initializers

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

new vpcAccessConnector.VpcAccessConnectorTimeoutsOutputReference(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 \| VpcAccessConnectorTimeouts`	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 | VpcAccessConnectorTimeouts;

Type: cdktf.IResolvable | VpcAccessConnectorTimeouts

Uh oh!

FilesExpand file tree

vpcAccessConnector.typescript.md

Latest commit

History

vpcAccessConnector.typescript.md

File metadata and controls

vpcAccessConnector Submodule

Constructs