dataAwsRoute.md

dataAwsRoute Submodule

Constructs

DataAwsRoute

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

Initializers

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

new dataAwsRoute.DataAwsRoute(scope: Construct, id: string, config: DataAwsRouteConfig)

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

---

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.
resetCarrierGatewayId	No description.
resetDestinationCidrBlock	No description.
resetDestinationIpv6CidrBlock	No description.
resetDestinationPrefixListId	No description.
resetEgressOnlyGatewayId	No description.
resetGatewayId	No description.
resetId	No description.
resetInstanceId	No description.
resetLocalGatewayId	No description.
resetNatGatewayId	No description.
resetNetworkInterfaceId	No description.
resetTransitGatewayId	No description.
resetVpcPeeringConnectionId	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

---

resetCarrierGatewayId

public resetCarrierGatewayId(): void

resetDestinationCidrBlock

public resetDestinationCidrBlock(): void

resetDestinationIpv6CidrBlock

public resetDestinationIpv6CidrBlock(): void

resetDestinationPrefixListId

public resetDestinationPrefixListId(): void

resetEgressOnlyGatewayId

public resetEgressOnlyGatewayId(): void

resetGatewayId

public resetGatewayId(): void

resetId

public resetId(): void

resetInstanceId

public resetInstanceId(): void

resetLocalGatewayId

public resetLocalGatewayId(): void

resetNatGatewayId

public resetNatGatewayId(): void

resetNetworkInterfaceId

public resetNetworkInterfaceId(): void

resetTransitGatewayId

public resetTransitGatewayId(): void

resetVpcPeeringConnectionId

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

---

isConstruct

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

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

dataAwsRoute.DataAwsRoute.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

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

dataAwsRoute.DataAwsRoute.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

dataAwsRoute.DataAwsRoute.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

---

importFromId^Required

• Type: string

The id of the existing DataAwsRoute that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#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 DataAwsRoute 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.
carrierGatewayIdInput	string	No description.
destinationCidrBlockInput	string	No description.
destinationIpv6CidrBlockInput	string	No description.
destinationPrefixListIdInput	string	No description.
egressOnlyGatewayIdInput	string	No description.
gatewayIdInput	string	No description.
idInput	string	No description.
instanceIdInput	string	No description.
localGatewayIdInput	string	No description.
natGatewayIdInput	string	No description.
networkInterfaceIdInput	string	No description.
routeTableIdInput	string	No description.
transitGatewayIdInput	string	No description.
vpcPeeringConnectionIdInput	string	No description.
carrierGatewayId	string	No description.
destinationCidrBlock	string	No description.
destinationIpv6CidrBlock	string	No description.
destinationPrefixListId	string	No description.
egressOnlyGatewayId	string	No description.
gatewayId	string	No description.
id	string	No description.
instanceId	string	No description.
localGatewayId	string	No description.
natGatewayId	string	No description.
networkInterfaceId	string	No description.
routeTableId	string	No description.
transitGatewayId	string	No description.
vpcPeeringConnectionId	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

---

carrierGatewayIdInput^Optional

public readonly carrierGatewayIdInput: string;

• Type: string

---

destinationCidrBlockInput^Optional

public readonly destinationCidrBlockInput: string;

• Type: string

---

destinationIpv6CidrBlockInput^Optional

public readonly destinationIpv6CidrBlockInput: string;

• Type: string

---

destinationPrefixListIdInput^Optional

public readonly destinationPrefixListIdInput: string;

• Type: string

---

egressOnlyGatewayIdInput^Optional

public readonly egressOnlyGatewayIdInput: string;

• Type: string

---

gatewayIdInput^Optional

public readonly gatewayIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

instanceIdInput^Optional

public readonly instanceIdInput: string;

• Type: string

---

localGatewayIdInput^Optional

public readonly localGatewayIdInput: string;

• Type: string

---

natGatewayIdInput^Optional

public readonly natGatewayIdInput: string;

• Type: string

---

networkInterfaceIdInput^Optional

public readonly networkInterfaceIdInput: string;

• Type: string

---

routeTableIdInput^Optional

public readonly routeTableIdInput: string;

• Type: string

---

transitGatewayIdInput^Optional

public readonly transitGatewayIdInput: string;

• Type: string

---

vpcPeeringConnectionIdInput^Optional

public readonly vpcPeeringConnectionIdInput: string;

• Type: string

---

carrierGatewayId^Required

public readonly carrierGatewayId: string;

• Type: string

---

destinationCidrBlock^Required

public readonly destinationCidrBlock: string;

• Type: string

---

destinationIpv6CidrBlock^Required

public readonly destinationIpv6CidrBlock: string;

• Type: string

---

destinationPrefixListId^Required

public readonly destinationPrefixListId: string;

• Type: string

---

egressOnlyGatewayId^Required

public readonly egressOnlyGatewayId: string;

• Type: string

---

gatewayId^Required

public readonly gatewayId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

instanceId^Required

public readonly instanceId: string;

• Type: string

---

localGatewayId^Required

public readonly localGatewayId: string;

• Type: string

---

natGatewayId^Required

public readonly natGatewayId: string;

• Type: string

---

networkInterfaceId^Required

public readonly networkInterfaceId: string;

• Type: string

---

routeTableId^Required

public readonly routeTableId: string;

• Type: string

---

transitGatewayId^Required

public readonly transitGatewayId: string;

• Type: string

---

vpcPeeringConnectionId^Required

public readonly vpcPeeringConnectionId: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataAwsRouteConfig

Initializer

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

const dataAwsRouteConfig: dataAwsRoute.DataAwsRouteConfig = { ... }

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.
routeTableId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#route_table_id DataAwsRoute#route_table_id}.
carrierGatewayId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#carrier_gateway_id DataAwsRoute#carrier_gateway_id}.
destinationCidrBlock	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#destination_cidr_block DataAwsRoute#destination_cidr_block}.
destinationIpv6CidrBlock	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#destination_ipv6_cidr_block DataAwsRoute#destination_ipv6_cidr_block}.
destinationPrefixListId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#destination_prefix_list_id DataAwsRoute#destination_prefix_list_id}.
egressOnlyGatewayId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#egress_only_gateway_id DataAwsRoute#egress_only_gateway_id}.
gatewayId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#gateway_id DataAwsRoute#gateway_id}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#id DataAwsRoute#id}.
instanceId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#instance_id DataAwsRoute#instance_id}.
localGatewayId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#local_gateway_id DataAwsRoute#local_gateway_id}.
natGatewayId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#nat_gateway_id DataAwsRoute#nat_gateway_id}.
networkInterfaceId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#network_interface_id DataAwsRoute#network_interface_id}.
transitGatewayId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#transit_gateway_id DataAwsRoute#transit_gateway_id}.
vpcPeeringConnectionId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/route#vpc_peering_connection_id DataAwsRoute#vpc_peering_connection_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[]

---

routeTableId^Required

public readonly routeTableId: string;

• Type: string

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

---

carrierGatewayId^Optional

public readonly carrierGatewayId: string;

• Type: string

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

---

destinationCidrBlock^Optional

public readonly destinationCidrBlock: string;

• Type: string

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

---

destinationIpv6CidrBlock^Optional

public readonly destinationIpv6CidrBlock: string;

• Type: string

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

---

destinationPrefixListId^Optional

public readonly destinationPrefixListId: string;

• Type: string

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

---

egressOnlyGatewayId^Optional

public readonly egressOnlyGatewayId: string;

• Type: string

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

---

gatewayId^Optional

public readonly gatewayId: string;

• Type: string

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

---

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/route#id DataAwsRoute#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.

---

instanceId^Optional

public readonly instanceId: string;

• Type: string

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

---

localGatewayId^Optional

public readonly localGatewayId: string;

• Type: string

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

---

natGatewayId^Optional

public readonly natGatewayId: string;

• Type: string

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

---

networkInterfaceId^Optional

public readonly networkInterfaceId: string;

• Type: string

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

---

transitGatewayId^Optional

public readonly transitGatewayId: string;

• Type: string

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

---

vpcPeeringConnectionId^Optional

public readonly vpcPeeringConnectionId: string;

• Type: string

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

---