aws-cdk-lib.aws_ec2.AddRouteOptions

interface AddRouteOptions

LanguageType name
.NETAmazon.CDK.AWS.EC2.AddRouteOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#AddRouteOptions
Javasoftware.amazon.awscdk.services.ec2.AddRouteOptions
Pythonaws_cdk.aws_ec2.AddRouteOptions
TypeScript (source)aws-cdk-lib » aws_ec2 » AddRouteOptions

Options for adding a new route to a subnet.

Example

const vpc = new ec2.Vpc(this, "VPC", {
  subnetConfiguration: [{
      subnetType: ec2.SubnetType.PUBLIC,
      name: 'Public',
    },{
      subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
      name: 'Isolated',
    }]
});

(vpc.isolatedSubnets[0] as ec2.Subnet).addRoute("StaticRoute", {
    routerId: vpc.internetGatewayId!,
    routerType: ec2.RouterType.GATEWAY,
    destinationCidrBlock: "8.8.8.8/32",
})

Properties

NameTypeDescription
routerIdstringThe ID of the router.
routerTypeRouterTypeWhat type of router to route this traffic to.
destinationCidrBlock?stringIPv4 range this route applies to.
destinationIpv6CidrBlock?stringIPv6 range this route applies to.
enablesInternetConnectivity?booleanWhether this route will enable internet connectivity.

routerId

Type: string

The ID of the router.

Can be an instance ID, gateway ID, etc, depending on the router type.


routerType

Type: RouterType

What type of router to route this traffic to.


destinationCidrBlock?

Type: string (optional, default: '0.0.0.0/0')

IPv4 range this route applies to.


destinationIpv6CidrBlock?

Type: string (optional, default: Uses IPv6)

IPv6 range this route applies to.


enablesInternetConnectivity?

Type: boolean (optional, default: false)

Whether this route will enable internet connectivity.

If true, this route will be added before any AWS resources that depend on internet connectivity in the VPC will be created.