ec2TransitGateway.md

aws_ec2_transit_gateway

Refer to the Terraform Registory for docs: aws_ec2_transit_gateway.

ec2TransitGateway Submodule

Constructs

Ec2TransitGateway

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway aws_ec2_transit_gateway}.

Initializers

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

new ec2TransitGateway.Ec2TransitGateway(scope: Construct, id: string, config?: Ec2TransitGatewayConfig)

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

---

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.
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.
resetAmazonSideAsn	No description.
resetAutoAcceptSharedAttachments	No description.
resetDefaultRouteTableAssociation	No description.
resetDefaultRouteTablePropagation	No description.
resetDescription	No description.
resetDnsSupport	No description.
resetId	No description.
resetTags	No description.
resetTagsAll	No description.
resetVpnEcmpSupport	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.

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

---

resetAmazonSideAsn

public resetAmazonSideAsn(): void

resetAutoAcceptSharedAttachments

public resetAutoAcceptSharedAttachments(): void

resetDefaultRouteTableAssociation

public resetDefaultRouteTableAssociation(): void

resetDefaultRouteTablePropagation

public resetDefaultRouteTablePropagation(): void

resetDescription

public resetDescription(): void

resetDnsSupport

public resetDnsSupport(): void

resetId

public resetId(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

resetVpnEcmpSupport

public resetVpnEcmpSupport(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.

---

isConstruct

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

ec2TransitGateway.Ec2TransitGateway.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 { ec2TransitGateway } from '@cdktf/aws-cdk'

ec2TransitGateway.Ec2TransitGateway.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

ec2TransitGateway.Ec2TransitGateway.isTerraformResource(x: any)

x^Required

• Type: any

---

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.
arn	string	No description.
associationDefaultRouteTableId	string	No description.
ownerId	string	No description.
propagationDefaultRouteTableId	string	No description.
amazonSideAsnInput	number	No description.
autoAcceptSharedAttachmentsInput	string	No description.
defaultRouteTableAssociationInput	string	No description.
defaultRouteTablePropagationInput	string	No description.
descriptionInput	string	No description.
dnsSupportInput	string	No description.
idInput	string	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
vpnEcmpSupportInput	string	No description.
amazonSideAsn	number	No description.
autoAcceptSharedAttachments	string	No description.
defaultRouteTableAssociation	string	No description.
defaultRouteTablePropagation	string	No description.
description	string	No description.
dnsSupport	string	No description.
id	string	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.
vpnEcmpSupport	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[]

---

arn^Required

public readonly arn: string;

• Type: string

---

associationDefaultRouteTableId^Required

public readonly associationDefaultRouteTableId: string;

• Type: string

---

ownerId^Required

public readonly ownerId: string;

• Type: string

---

propagationDefaultRouteTableId^Required

public readonly propagationDefaultRouteTableId: string;

• Type: string

---

amazonSideAsnInput^Optional

public readonly amazonSideAsnInput: number;

• Type: number

---

autoAcceptSharedAttachmentsInput^Optional

public readonly autoAcceptSharedAttachmentsInput: string;

• Type: string

---

defaultRouteTableAssociationInput^Optional

public readonly defaultRouteTableAssociationInput: string;

• Type: string

---

defaultRouteTablePropagationInput^Optional

public readonly defaultRouteTablePropagationInput: string;

• Type: string

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

dnsSupportInput^Optional

public readonly dnsSupportInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

tagsAllInput^Optional

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

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

---

tagsInput^Optional

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

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

---

vpnEcmpSupportInput^Optional

public readonly vpnEcmpSupportInput: string;

• Type: string

---

amazonSideAsn^Required

public readonly amazonSideAsn: number;

• Type: number

---

autoAcceptSharedAttachments^Required

public readonly autoAcceptSharedAttachments: string;

• Type: string

---

defaultRouteTableAssociation^Required

public readonly defaultRouteTableAssociation: string;

• Type: string

---

defaultRouteTablePropagation^Required

public readonly defaultRouteTablePropagation: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

dnsSupport^Required

public readonly dnsSupport: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

tags^Required

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

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

---

tagsAll^Required

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

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

---

vpnEcmpSupport^Required

public readonly vpnEcmpSupport: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

Ec2TransitGatewayConfig

Initializer

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

const ec2TransitGatewayConfig: ec2TransitGateway.Ec2TransitGatewayConfig = { ... }

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.
amazonSideAsn	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#amazon_side_asn Ec2TransitGateway#amazon_side_asn}.
autoAcceptSharedAttachments	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#auto_accept_shared_attachments Ec2TransitGateway#auto_accept_shared_attachments}.
defaultRouteTableAssociation	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#default_route_table_association Ec2TransitGateway#default_route_table_association}.
defaultRouteTablePropagation	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#default_route_table_propagation Ec2TransitGateway#default_route_table_propagation}.
description	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#description Ec2TransitGateway#description}.
dnsSupport	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#dns_support Ec2TransitGateway#dns_support}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#id Ec2TransitGateway#id}.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#tags Ec2TransitGateway#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#tags_all Ec2TransitGateway#tags_all}.
vpnEcmpSupport	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#vpn_ecmp_support Ec2TransitGateway#vpn_ecmp_support}.

---

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

---

amazonSideAsn^Optional

public readonly amazonSideAsn: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#amazon_side_asn Ec2TransitGateway#amazon_side_asn}.

---

autoAcceptSharedAttachments^Optional

public readonly autoAcceptSharedAttachments: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#auto_accept_shared_attachments Ec2TransitGateway#auto_accept_shared_attachments}.

---

defaultRouteTableAssociation^Optional

public readonly defaultRouteTableAssociation: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#default_route_table_association Ec2TransitGateway#default_route_table_association}.

---

defaultRouteTablePropagation^Optional

public readonly defaultRouteTablePropagation: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#default_route_table_propagation Ec2TransitGateway#default_route_table_propagation}.

---

description^Optional

public readonly description: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#description Ec2TransitGateway#description}.

---

dnsSupport^Optional

public readonly dnsSupport: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#dns_support Ec2TransitGateway#dns_support}.

---

id^Optional

public readonly id: string;

• Type: string

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

---

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/resources/ec2_transit_gateway#tags Ec2TransitGateway#tags}.

---

tagsAll^Optional

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

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#tags_all Ec2TransitGateway#tags_all}.

---

vpnEcmpSupport^Optional

public readonly vpnEcmpSupport: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/ec2_transit_gateway#vpn_ecmp_support Ec2TransitGateway#vpn_ecmp_support}.

---