`dataAwsNatGateway` Submodule

Constructs

DataAwsNatGateway

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway aws_nat_gateway}.

Initializers

import { dataAwsNatGateway } from '@cdktf/aws-cdk'

new dataAwsNatGateway.DataAwsNatGateway(scope: Construct, id: string, config?: DataAwsNatGatewayConfig)

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

Type: DataAwsNatGatewayConfig

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`	Adds this resource to the terraform JSON output.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`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.
`putFilter`	No description.
`resetFilter`	No description.
`resetId`	No description.
`resetState`	No description.
`resetSubnetId`	No description.
`resetTags`	No description.
`resetVpcId`	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

Adds this resource to the terraform JSON output.

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`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(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`putFilter`

public putFilter(value: IResolvable | DataAwsNatGatewayFilter[]): void

`value`^Required

Type: cdktf.IResolvable | DataAwsNatGatewayFilter[]

`resetFilter`

public resetFilter(): void

`resetId`

public resetId(): void

`resetState`

public resetState(): void

`resetSubnetId`

public resetSubnetId(): void

`resetTags`

public resetTags(): void

`resetVpcId`

public resetVpcId(): void

Static Functions

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

`isConstruct`

import { dataAwsNatGateway } from '@cdktf/aws-cdk'

dataAwsNatGateway.DataAwsNatGateway.isConstruct(x: any)

Checks if x is a construct.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { dataAwsNatGateway } from '@cdktf/aws-cdk'

dataAwsNatGateway.DataAwsNatGateway.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformDataSource`

import { dataAwsNatGateway } from '@cdktf/aws-cdk'

dataAwsNatGateway.DataAwsNatGateway.isTerraformDataSource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { dataAwsNatGateway } from '@cdktf/aws-cdk'

dataAwsNatGateway.DataAwsNatGateway.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing DataAwsNatGateway that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_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 DataAwsNatGateway 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.
`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.
`allocationId`	`string`	No description.
`connectivityType`	`string`	No description.
`filter`	`DataAwsNatGatewayFilterList`	No description.
`networkInterfaceId`	`string`	No description.
`privateIp`	`string`	No description.
`publicIp`	`string`	No description.
`filterInput`	`cdktf.IResolvable \| DataAwsNatGatewayFilter[]`	No description.
`idInput`	`string`	No description.
`stateInput`	`string`	No description.
`subnetIdInput`	`string`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`vpcIdInput`	`string`	No description.
`id`	`string`	No description.
`state`	`string`	No description.
`subnetId`	`string`	No description.
`tags`	`{[ key: string ]: string}`	No description.
`vpcId`	`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

`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

`allocationId`^Required

public readonly allocationId: string;

Type: string

`connectivityType`^Required

public readonly connectivityType: string;

Type: string

`filter`^Required

public readonly filter: DataAwsNatGatewayFilterList;

Type: DataAwsNatGatewayFilterList

`networkInterfaceId`^Required

public readonly networkInterfaceId: string;

Type: string

`privateIp`^Required

public readonly privateIp: string;

Type: string

`publicIp`^Required

public readonly publicIp: string;

Type: string

`filterInput`^Optional

public readonly filterInput: IResolvable | DataAwsNatGatewayFilter[];

Type: cdktf.IResolvable | DataAwsNatGatewayFilter[]

`idInput`^Optional

public readonly idInput: string;

Type: string

`stateInput`^Optional

public readonly stateInput: string;

Type: string

`subnetIdInput`^Optional

public readonly subnetIdInput: string;

Type: string

`tagsInput`^Optional

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

Type: {[ key: string ]: string}

`vpcIdInput`^Optional

public readonly vpcIdInput: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`state`^Required

public readonly state: string;

Type: string

`subnetId`^Required

public readonly subnetId: string;

Type: string

`tags`^Required

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

Type: {[ key: string ]: string}

`vpcId`^Required

public readonly vpcId: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

DataAwsNatGatewayConfig

Initializer

import { dataAwsNatGateway } from '@cdktf/aws-cdk'

const dataAwsNatGatewayConfig: dataAwsNatGateway.DataAwsNatGatewayConfig = { ... }

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.
`filter`	`cdktf.IResolvable \| DataAwsNatGatewayFilter[]`	filter block.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#id DataAwsNatGateway#id}.
`state`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#state DataAwsNatGateway#state}.
`subnetId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#subnet_id DataAwsNatGateway#subnet_id}.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#tags DataAwsNatGateway#tags}.
`vpcId`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#vpc_id DataAwsNatGateway#vpc_id}.

`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[]

`filter`^Optional

public readonly filter: IResolvable | DataAwsNatGatewayFilter[];

Type: cdktf.IResolvable | DataAwsNatGatewayFilter[]

filter block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#filter DataAwsNatGateway#filter}

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#id DataAwsNatGateway#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.

`state`^Optional

public readonly state: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#state DataAwsNatGateway#state}.

`subnetId`^Optional

public readonly subnetId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#subnet_id DataAwsNatGateway#subnet_id}.

`tags`^Optional

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

Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#tags DataAwsNatGateway#tags}.

`vpcId`^Optional

public readonly vpcId: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#vpc_id DataAwsNatGateway#vpc_id}.

DataAwsNatGatewayFilter

Initializer

import { dataAwsNatGateway } from '@cdktf/aws-cdk'

const dataAwsNatGatewayFilter: dataAwsNatGateway.DataAwsNatGatewayFilter = { ... }

Properties

Name	Type	Description
`name`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#name DataAwsNatGateway#name}.
`values`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#values DataAwsNatGateway#values}.

`name`^Required

public readonly name: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#name DataAwsNatGateway#name}.

`values`^Required

public readonly values: string[];

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/nat_gateway#values DataAwsNatGateway#values}.

Classes

DataAwsNatGatewayFilterList

Initializers

import { dataAwsNatGateway } from '@cdktf/aws-cdk'

new dataAwsNatGateway.DataAwsNatGatewayFilterList(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): DataAwsNatGatewayFilterOutputReference

`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 \| DataAwsNatGatewayFilter[]`	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 | DataAwsNatGatewayFilter[];

Type: cdktf.IResolvable | DataAwsNatGatewayFilter[]

DataAwsNatGatewayFilterOutputReference

Initializers

import { dataAwsNatGateway } from '@cdktf/aws-cdk'

new dataAwsNatGateway.DataAwsNatGatewayFilterOutputReference(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.

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

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.
`valuesInput`	`string[]`	No description.
`name`	`string`	No description.
`values`	`string[]`	No description.
`internalValue`	`cdktf.IResolvable \| DataAwsNatGatewayFilter`	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

`valuesInput`^Optional

public readonly valuesInput: string[];

Type: string[]

`name`^Required

public readonly name: string;

Type: string

`values`^Required

public readonly values: string[];

Type: string[]

`internalValue`^Optional

public readonly internalValue: IResolvable | DataAwsNatGatewayFilter;

Type: cdktf.IResolvable | DataAwsNatGatewayFilter

Files

dataAwsNatGateway.md

Latest commit

History

dataAwsNatGateway.md

File metadata and controls

dataAwsNatGateway Submodule

Constructs