Skip to content

Latest commit

 

History

History
2469 lines (1529 loc) · 99.3 KB

routeTable.md

File metadata and controls

2469 lines (1529 loc) · 99.3 KB

routeTable Submodule

Constructs

RouteTable

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

Initializers 

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

new routeTable.RouteTable(scope: Construct, id: string, config: RouteTableConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config RouteTableConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

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".
putRoute No description.
putTimeouts No description.
resetId No description.
resetPropagatingVgws No description.
resetRoute No description.
resetTags No description.
resetTagsAll No description.
resetTimeouts No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • 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".

idRequired
  • Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

putRoute 
public putRoute(value: IResolvable | RouteTableRoute[]): void
valueRequired
putTimeouts 
public putTimeouts(value: RouteTableTimeouts): void
valueRequired
resetId 
public resetId(): void
resetPropagatingVgws 
public resetPropagatingVgws(): void
resetRoute 
public resetRoute(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): 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 RouteTable resource upon running "cdktf plan ".
isConstruct 
import { routeTable } from '@cdktf/aws-cdk'

routeTable.RouteTable.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { routeTable } from '@cdktf/aws-cdk'

routeTable.RouteTable.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { routeTable } from '@cdktf/aws-cdk'

routeTable.RouteTable.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { routeTable } from '@cdktf/aws-cdk'

routeTable.RouteTable.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a RouteTable resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

The construct id used in the generated config for the RouteTable to import.

importFromIdRequired
  • Type: string

The id of the existing RouteTable that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the RouteTable 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.
arn string No description.
ownerId string No description.
route RouteTableRouteList No description.
timeouts RouteTableTimeoutsOutputReference No description.
idInput string No description.
propagatingVgwsInput string[] No description.
routeInput cdktf.IResolvable | RouteTableRoute[] No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
timeoutsInput cdktf.IResolvable | RouteTableTimeouts No description.
vpcIdInput string No description.
id string No description.
propagatingVgws string[] No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
vpcId string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
arnRequired 
public readonly arn: string;
  • Type: string
ownerIdRequired 
public readonly ownerId: string;
  • Type: string
routeRequired 
public readonly route: RouteTableRouteList;
timeoutsRequired 
public readonly timeouts: RouteTableTimeoutsOutputReference;
idInputOptional 
public readonly idInput: string;
  • Type: string
propagatingVgwsInputOptional 
public readonly propagatingVgwsInput: string[];
  • Type: string[]
routeInputOptional 
public readonly routeInput: IResolvable | RouteTableRoute[];
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | RouteTableTimeouts;
vpcIdInputOptional 
public readonly vpcIdInput: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
propagatingVgwsRequired 
public readonly propagatingVgws: string[];
  • Type: string[]
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
vpcIdRequired 
public readonly vpcId: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

RouteTableConfig

Initializer 

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

const routeTableConfig: routeTable.RouteTableConfig = { ... }

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.
vpcId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#vpc_id RouteTable#vpc_id}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#id RouteTable#id}.
propagatingVgws string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#propagating_vgws RouteTable#propagating_vgws}.
route cdktf.IResolvable | RouteTableRoute[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#route RouteTable#route}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#tags RouteTable#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#tags_all RouteTable#tags_all}.
timeouts RouteTableTimeouts timeouts block.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
vpcIdRequired 
public readonly vpcId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#vpc_id RouteTable#vpc_id}.

idOptional 
public readonly id: string;
  • Type: string

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

propagatingVgwsOptional 
public readonly propagatingVgws: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#propagating_vgws RouteTable#propagating_vgws}.

routeOptional 
public readonly route: IResolvable | RouteTableRoute[];

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#route RouteTable#route}.

tagsOptional 
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/route_table#tags RouteTable#tags}.

tagsAllOptional 
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/route_table#tags_all RouteTable#tags_all}.

timeoutsOptional 
public readonly timeouts: RouteTableTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#timeouts RouteTable#timeouts}

RouteTableRoute

Initializer 

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

const routeTableRoute: routeTable.RouteTableRoute = { ... }

Properties

Name Type Description
carrierGatewayId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#carrier_gateway_id RouteTable#carrier_gateway_id}.
cidrBlock string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#cidr_block RouteTable#cidr_block}.
destinationPrefixListId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#destination_prefix_list_id RouteTable#destination_prefix_list_id}.
egressOnlyGatewayId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#egress_only_gateway_id RouteTable#egress_only_gateway_id}.
gatewayId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#gateway_id RouteTable#gateway_id}.
instanceId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#instance_id RouteTable#instance_id}.
ipv6CidrBlock string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#ipv6_cidr_block RouteTable#ipv6_cidr_block}.
localGatewayId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#local_gateway_id RouteTable#local_gateway_id}.
natGatewayId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#nat_gateway_id RouteTable#nat_gateway_id}.
networkInterfaceId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#network_interface_id RouteTable#network_interface_id}.
transitGatewayId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#transit_gateway_id RouteTable#transit_gateway_id}.
vpcEndpointId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#vpc_endpoint_id RouteTable#vpc_endpoint_id}.
vpcPeeringConnectionId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#vpc_peering_connection_id RouteTable#vpc_peering_connection_id}.
carrierGatewayIdOptional 
public readonly carrierGatewayId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#carrier_gateway_id RouteTable#carrier_gateway_id}.

cidrBlockOptional 
public readonly cidrBlock: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#cidr_block RouteTable#cidr_block}.

destinationPrefixListIdOptional 
public readonly destinationPrefixListId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#destination_prefix_list_id RouteTable#destination_prefix_list_id}.

egressOnlyGatewayIdOptional 
public readonly egressOnlyGatewayId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#egress_only_gateway_id RouteTable#egress_only_gateway_id}.

gatewayIdOptional 
public readonly gatewayId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#gateway_id RouteTable#gateway_id}.

instanceIdOptional 
public readonly instanceId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#instance_id RouteTable#instance_id}.

ipv6CidrBlockOptional 
public readonly ipv6CidrBlock: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#ipv6_cidr_block RouteTable#ipv6_cidr_block}.

localGatewayIdOptional 
public readonly localGatewayId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#local_gateway_id RouteTable#local_gateway_id}.

natGatewayIdOptional 
public readonly natGatewayId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#nat_gateway_id RouteTable#nat_gateway_id}.

networkInterfaceIdOptional 
public readonly networkInterfaceId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#network_interface_id RouteTable#network_interface_id}.

transitGatewayIdOptional 
public readonly transitGatewayId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#transit_gateway_id RouteTable#transit_gateway_id}.

vpcEndpointIdOptional 
public readonly vpcEndpointId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#vpc_endpoint_id RouteTable#vpc_endpoint_id}.

vpcPeeringConnectionIdOptional 
public readonly vpcPeeringConnectionId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#vpc_peering_connection_id RouteTable#vpc_peering_connection_id}.

RouteTableTimeouts

Initializer 

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

const routeTableTimeouts: routeTable.RouteTableTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#create RouteTable#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#delete RouteTable#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#update RouteTable#update}.
createOptional 
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#create RouteTable#create}.

deleteOptional 
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#delete RouteTable#delete}.

updateOptional 
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route_table#update RouteTable#update}.

Classes

RouteTableRouteList

Initializers 

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

new routeTable.RouteTableRouteList(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).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • 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.

mapKeyAttributeNameRequired
  • Type: string
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): RouteTableRouteOutputReference
indexRequired
  • 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 | RouteTableRoute[] No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | RouteTableRoute[];

RouteTableRouteOutputReference

Initializers 

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

new routeTable.RouteTableRouteOutputReference(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).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • 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.
resetCarrierGatewayId No description.
resetCidrBlock No description.
resetDestinationPrefixListId No description.
resetEgressOnlyGatewayId No description.
resetGatewayId No description.
resetInstanceId No description.
resetIpv6CidrBlock No description.
resetLocalGatewayId No description.
resetNatGatewayId No description.
resetNetworkInterfaceId No description.
resetTransitGatewayId No description.
resetVpcEndpointId No description.
resetVpcPeeringConnectionId No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCarrierGatewayId 
public resetCarrierGatewayId(): void
resetCidrBlock 
public resetCidrBlock(): void
resetDestinationPrefixListId 
public resetDestinationPrefixListId(): void
resetEgressOnlyGatewayId 
public resetEgressOnlyGatewayId(): void
resetGatewayId 
public resetGatewayId(): void
resetInstanceId 
public resetInstanceId(): void
resetIpv6CidrBlock 
public resetIpv6CidrBlock(): void
resetLocalGatewayId 
public resetLocalGatewayId(): void
resetNatGatewayId 
public resetNatGatewayId(): void
resetNetworkInterfaceId 
public resetNetworkInterfaceId(): void
resetTransitGatewayId 
public resetTransitGatewayId(): void
resetVpcEndpointId 
public resetVpcEndpointId(): void
resetVpcPeeringConnectionId 
public resetVpcPeeringConnectionId(): 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.
carrierGatewayIdInput string No description.
cidrBlockInput string No description.
destinationPrefixListIdInput string No description.
egressOnlyGatewayIdInput string No description.
gatewayIdInput string No description.
instanceIdInput string No description.
ipv6CidrBlockInput string No description.
localGatewayIdInput string No description.
natGatewayIdInput string No description.
networkInterfaceIdInput string No description.
transitGatewayIdInput string No description.
vpcEndpointIdInput string No description.
vpcPeeringConnectionIdInput string No description.
carrierGatewayId string No description.
cidrBlock string No description.
destinationPrefixListId string No description.
egressOnlyGatewayId string No description.
gatewayId string No description.
instanceId string No description.
ipv6CidrBlock string No description.
localGatewayId string No description.
natGatewayId string No description.
networkInterfaceId string No description.
transitGatewayId string No description.
vpcEndpointId string No description.
vpcPeeringConnectionId string No description.
internalValue cdktf.IResolvable | RouteTableRoute No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
carrierGatewayIdInputOptional 
public readonly carrierGatewayIdInput: string;
  • Type: string
cidrBlockInputOptional 
public readonly cidrBlockInput: string;
  • Type: string
destinationPrefixListIdInputOptional 
public readonly destinationPrefixListIdInput: string;
  • Type: string
egressOnlyGatewayIdInputOptional 
public readonly egressOnlyGatewayIdInput: string;
  • Type: string
gatewayIdInputOptional 
public readonly gatewayIdInput: string;
  • Type: string
instanceIdInputOptional 
public readonly instanceIdInput: string;
  • Type: string
ipv6CidrBlockInputOptional 
public readonly ipv6CidrBlockInput: string;
  • Type: string
localGatewayIdInputOptional 
public readonly localGatewayIdInput: string;
  • Type: string
natGatewayIdInputOptional 
public readonly natGatewayIdInput: string;
  • Type: string
networkInterfaceIdInputOptional 
public readonly networkInterfaceIdInput: string;
  • Type: string
transitGatewayIdInputOptional 
public readonly transitGatewayIdInput: string;
  • Type: string
vpcEndpointIdInputOptional 
public readonly vpcEndpointIdInput: string;
  • Type: string
vpcPeeringConnectionIdInputOptional 
public readonly vpcPeeringConnectionIdInput: string;
  • Type: string
carrierGatewayIdRequired 
public readonly carrierGatewayId: string;
  • Type: string
cidrBlockRequired 
public readonly cidrBlock: string;
  • Type: string
destinationPrefixListIdRequired 
public readonly destinationPrefixListId: string;
  • Type: string
egressOnlyGatewayIdRequired 
public readonly egressOnlyGatewayId: string;
  • Type: string
gatewayIdRequired 
public readonly gatewayId: string;
  • Type: string
instanceIdRequired 
public readonly instanceId: string;
  • Type: string
ipv6CidrBlockRequired 
public readonly ipv6CidrBlock: string;
  • Type: string
localGatewayIdRequired 
public readonly localGatewayId: string;
  • Type: string
natGatewayIdRequired 
public readonly natGatewayId: string;
  • Type: string
networkInterfaceIdRequired 
public readonly networkInterfaceId: string;
  • Type: string
transitGatewayIdRequired 
public readonly transitGatewayId: string;
  • Type: string
vpcEndpointIdRequired 
public readonly vpcEndpointId: string;
  • Type: string
vpcPeeringConnectionIdRequired 
public readonly vpcPeeringConnectionId: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | RouteTableRoute;

RouteTableTimeoutsOutputReference

Initializers 

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

new routeTable.RouteTableTimeoutsOutputReference(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.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • 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}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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 | RouteTableTimeouts No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
createInputOptional 
public readonly createInput: string;
  • Type: string
deleteInputOptional 
public readonly deleteInput: string;
  • Type: string
updateInputOptional 
public readonly updateInput: string;
  • Type: string
createRequired 
public readonly create: string;
  • Type: string
deleteRequired 
public readonly delete: string;
  • Type: string
updateRequired 
public readonly update: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | RouteTableTimeouts;