Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route aws_route}.
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. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: RouteConfig
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. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public putTimeouts(value: RouteTimeouts): void
- Type: RouteTimeouts
public resetCarrierGatewayId(): void
public resetDestinationCidrBlock(): void
public resetDestinationIpv6CidrBlock(): void
public resetDestinationPrefixListId(): void
public resetEgressOnlyGatewayId(): void
public resetGatewayId(): void
public resetId(): void
public resetInstanceId(): void
public resetLocalGatewayId(): void
public resetNatGatewayId(): void
public resetNetworkInterfaceId(): void
public resetTimeouts(): void
public resetTransitGatewayId(): void
public resetVpcEndpointId(): void
public resetVpcPeeringConnectionId(): void
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 ". |
import { route } from '@cdktf/aws-cdk'
route.Route.isConstruct(x: any)
Checks if x
is a construct.
- Type: any
Any object.
import { route } from '@cdktf/aws-cdk'
route.Route.isTerraformElement(x: any)
- Type: any
import { route } from '@cdktf/aws-cdk'
route.Route.isTerraformResource(x: any)
- Type: any
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 ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the Route to import.
- 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
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the Route to import is found.
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. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly instanceOwnerId: string;
- Type: string
public readonly origin: string;
- Type: string
public readonly state: string;
- Type: string
public readonly timeouts: RouteTimeoutsOutputReference;
public readonly carrierGatewayIdInput: string;
- Type: string
public readonly destinationCidrBlockInput: string;
- Type: string
public readonly destinationIpv6CidrBlockInput: string;
- Type: string
public readonly destinationPrefixListIdInput: string;
- Type: string
public readonly egressOnlyGatewayIdInput: string;
- Type: string
public readonly gatewayIdInput: string;
- Type: string
public readonly idInput: string;
- Type: string
public readonly instanceIdInput: string;
- Type: string
public readonly localGatewayIdInput: string;
- Type: string
public readonly natGatewayIdInput: string;
- Type: string
public readonly networkInterfaceIdInput: string;
- Type: string
public readonly routeTableIdInput: string;
- Type: string
public readonly timeoutsInput: IResolvable | RouteTimeouts;
- Type: cdktf.IResolvable | RouteTimeouts
public readonly transitGatewayIdInput: string;
- Type: string
public readonly vpcEndpointIdInput: string;
- Type: string
public readonly vpcPeeringConnectionIdInput: string;
- Type: string
public readonly carrierGatewayId: string;
- Type: string
public readonly destinationCidrBlock: string;
- Type: string
public readonly destinationIpv6CidrBlock: string;
- Type: string
public readonly destinationPrefixListId: string;
- Type: string
public readonly egressOnlyGatewayId: string;
- Type: string
public readonly gatewayId: string;
- Type: string
public readonly id: string;
- Type: string
public readonly instanceId: string;
- Type: string
public readonly localGatewayId: string;
- Type: string
public readonly natGatewayId: string;
- Type: string
public readonly networkInterfaceId: string;
- Type: string
public readonly routeTableId: string;
- Type: string
public readonly transitGatewayId: string;
- Type: string
public readonly vpcEndpointId: string;
- Type: string
public readonly vpcPeeringConnectionId: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { route } from '@cdktf/aws-cdk'
const routeConfig: route.RouteConfig = { ... }
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
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}.
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}.
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}.
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}.
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}.
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}.
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}.
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.
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}.
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}.
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}.
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}.
public readonly timeouts: RouteTimeouts;
- Type: RouteTimeouts
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/route#timeouts Route#timeouts}
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}.
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}.
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}.
import { route } from '@cdktf/aws-cdk'
const routeTimeouts: route.RouteTimeouts = { ... }
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}. |
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}.
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}.
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}.
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. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
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. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public resetCreate(): void
public resetDelete(): void
public resetUpdate(): void
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. |
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.
public readonly fqn: string;
- Type: string
public readonly createInput: string;
- Type: string
public readonly deleteInput: string;
- Type: string
public readonly updateInput: string;
- Type: string
public readonly create: string;
- Type: string
public readonly delete: string;
- Type: string
public readonly update: string;
- Type: string
public readonly internalValue: IResolvable | RouteTimeouts;
- Type: cdktf.IResolvable | RouteTimeouts