interface IRouteV2
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.ec2.Alpha.IRouteV2 |
Go | github.com/aws/aws-cdk-go/awsec2alpha/v2#IRouteV2 |
Java | software.amazon.awscdk.services.ec2.alpha.IRouteV2 |
Python | aws_cdk.aws_ec2_alpha.IRouteV2 |
TypeScript (source) | @aws-cdk/aws-ec2-alpha ยป IRouteV2 |
Implemented by
Route
Interface to define a route.
Properties
Name | Type | Description |
---|---|---|
destination | string | The IPv4 or IPv6 CIDR block used for the destination match. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
route | IRoute | The ID of the route table for the route. |
stack | Stack | The stack in which this resource is defined. |
target | Route | The gateway or endpoint targeted by the route. |
destination
Type:
string
The IPv4 or IPv6 CIDR block used for the destination match.
Routing decisions are based on the most specific match. TODO: Look for strong IP type implementation here.
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.
routeTable
Type:
IRoute
The ID of the route table for the route.
stack
Type:
Stack
The stack in which this resource is defined.
target
Type:
Route
The gateway or endpoint targeted by the route.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
RemovalPolicy(policy)
applypublic 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
).