class RouteTable (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ec2.Alpha.RouteTable |
![]() | github.com/aws/aws-cdk-go/awsec2alpha/v2#RouteTable |
![]() | software.amazon.awscdk.services.ec2.alpha.RouteTable |
![]() | aws_cdk.aws_ec2_alpha.RouteTable |
![]() | @aws-cdk/aws-ec2-alpha ยป RouteTable |
Implements
IConstruct
, IDependable
, IResource
, IRoute
Creates a route table for the specified VPC.
Example
const stack = new Stack();
const myVpc = new VpcV2(this, 'Vpc');
const vpnGateway = myVpc.enableVpnGatewayV2({
vpnRoutePropagation: [{ subnetType: SubnetType.PUBLIC }],
type: VpnConnectionType.IPSEC_1,
});
const routeTable = new RouteTable(stack, 'routeTable', {
vpc: myVpc
} );
new Route(stack, 'route', {
destination: '172.31.0.0/24',
target: { gateway: vpnGateway },
routeTable: routeTable,
});
Initializer
new RouteTable(scope: Construct, id: string, props: RouteTableProps)
Parameters
- scope
Construct
- id
string
- props
Route
Table Props
Construct Props
Name | Type | Description |
---|---|---|
vpc | IVpc | The ID of the VPC. |
route | string | The resource name of the route table. |
vpc
Type:
IVpc
The ID of the VPC.
routeTableName?
Type:
string
(optional, default: provisioned without a route table name)
The resource name of the route table.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
resource | Cfn | The route table CFN resource. |
route | string | The ID of the route table. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
resource
Type:
Cfn
The route table CFN resource.
routeTableId
Type:
string
The ID of the route table.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
add | Adds a new custom route to the route table. |
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
addRoute(id, destination, target, routeName?)
public addRoute(id: string, destination: string, target: RouteTargetType, routeName?: string): void
Parameters
- id
string
- destination
string
โ The IPv4 or IPv6 CIDR block used for the destination match. - target
Route
โ The gateway or endpoint targeted by the route.Target Type - routeName
string
โ The resource name of the route.
Adds a new custom route to the route table.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.