Skip to content

Latest commit

 

History

History
1855 lines (1154 loc) · 69.2 KB

route.md

File metadata and controls

1855 lines (1154 loc) · 69.2 KB

route Submodule

Constructs

Route

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

Initializers

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

new route.Route(scope: Construct, id: string, config: RouteConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config RouteConfig 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".
putTimeouts 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.
resetTimeouts No description.
resetTransitGatewayId No description.
resetVpcEndpointId No description.
resetVpcPeeringConnectionId 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".


putTimeouts
public putTimeouts(value: RouteTimeouts): void
valueRequired

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
resetTimeouts
public resetTimeouts(): void
resetTransitGatewayId
public resetTransitGatewayId(): void
resetVpcEndpointId
public resetVpcEndpointId(): void
resetVpcPeeringConnectionId
public resetVpcPeeringConnectionId(): 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 Route resource upon running "cdktf plan ".

isConstruct
import { route } from '@cdktf/aws-cdk'

route.Route.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.


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

route.Route.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { route } from '@cdktf/aws-cdk'

route.Route.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { route } from '@cdktf/aws-cdk'

route.Route.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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


importFromIdRequired
  • Type: string

The id of the existing Route that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route#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 Route 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.
instanceOwnerId string No description.
origin string No description.
state string No description.
timeouts RouteTimeoutsOutputReference 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.
timeoutsInput cdktf.IResolvable | RouteTimeouts No description.
transitGatewayIdInput string No description.
vpcEndpointIdInput 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.
vpcEndpointId string No description.
vpcPeeringConnectionId 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[]

instanceOwnerIdRequired
public readonly instanceOwnerId: string;
  • Type: string

originRequired
public readonly origin: string;
  • Type: string

stateRequired
public readonly state: string;
  • Type: string

timeoutsRequired
public readonly timeouts: RouteTimeoutsOutputReference;

carrierGatewayIdInputOptional
public readonly carrierGatewayIdInput: string;
  • Type: string

destinationCidrBlockInputOptional
public readonly destinationCidrBlockInput: string;
  • Type: string

destinationIpv6CidrBlockInputOptional
public readonly destinationIpv6CidrBlockInput: string;
  • Type: string

destinationPrefixListIdInputOptional
public readonly destinationPrefixListIdInput: string;
  • Type: string

egressOnlyGatewayIdInputOptional
public readonly egressOnlyGatewayIdInput: string;
  • Type: string

gatewayIdInputOptional
public readonly gatewayIdInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

instanceIdInputOptional
public readonly instanceIdInput: string;
  • Type: string

localGatewayIdInputOptional
public readonly localGatewayIdInput: string;
  • Type: string

natGatewayIdInputOptional
public readonly natGatewayIdInput: string;
  • Type: string

networkInterfaceIdInputOptional
public readonly networkInterfaceIdInput: string;
  • Type: string

routeTableIdInputOptional
public readonly routeTableIdInput: string;
  • Type: string

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | RouteTimeouts;

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

destinationCidrBlockRequired
public readonly destinationCidrBlock: string;
  • Type: string

destinationIpv6CidrBlockRequired
public readonly destinationIpv6CidrBlock: string;
  • Type: string

destinationPrefixListIdRequired
public readonly destinationPrefixListId: string;
  • Type: string

egressOnlyGatewayIdRequired
public readonly egressOnlyGatewayId: string;
  • Type: string

gatewayIdRequired
public readonly gatewayId: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

instanceIdRequired
public readonly instanceId: string;
  • Type: string

localGatewayIdRequired
public readonly localGatewayId: string;
  • Type: string

natGatewayIdRequired
public readonly natGatewayId: string;
  • Type: string

networkInterfaceIdRequired
public readonly networkInterfaceId: string;
  • Type: string

routeTableIdRequired
public readonly routeTableId: string;
  • Type: string

transitGatewayIdRequired
public readonly transitGatewayId: string;
  • Type: string

vpcEndpointIdRequired
public readonly vpcEndpointId: string;
  • Type: string

vpcPeeringConnectionIdRequired
public readonly vpcPeeringConnectionId: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

RouteConfig

Initializer

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

const routeConfig: route.RouteConfig = { ... }

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

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

routeTableIdRequired
public readonly routeTableId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route#route_table_id Route#route_table_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#carrier_gateway_id Route#carrier_gateway_id}.


destinationCidrBlockOptional
public readonly destinationCidrBlock: string;
  • Type: string

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


destinationIpv6CidrBlockOptional
public readonly destinationIpv6CidrBlock: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route#destination_ipv6_cidr_block Route#destination_ipv6_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#destination_prefix_list_id Route#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#egress_only_gateway_id Route#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#gateway_id Route#gateway_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#id Route#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.


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#instance_id Route#instance_id}.


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#local_gateway_id Route#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#nat_gateway_id Route#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#network_interface_id Route#network_interface_id}.


timeoutsOptional
public readonly timeouts: RouteTimeouts;

timeouts block.

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


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#transit_gateway_id Route#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#vpc_endpoint_id Route#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#vpc_peering_connection_id Route#vpc_peering_connection_id}.


RouteTimeouts

Initializer

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

const routeTimeouts: route.RouteTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route#create Route#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route#delete Route#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route#update Route#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#create Route#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#delete Route#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#update Route#update}.


Classes

RouteTimeoutsOutputReference

Initializers

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

new route.RouteTimeoutsOutputReference(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 | RouteTimeouts 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 | RouteTimeouts;