Package software.amazon.awscdk.services.ec2

Interface CfnRouteProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:08.922Z")
@Stability(Stable)
public interface CfnRouteProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRoute.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnRouteProps cfnRouteProps = CfnRouteProps.builder()
         .routeTableId("routeTableId")
         // the properties below are optional
         .carrierGatewayId("carrierGatewayId")
         .coreNetworkArn("coreNetworkArn")
         .destinationCidrBlock("destinationCidrBlock")
         .destinationIpv6CidrBlock("destinationIpv6CidrBlock")
         .destinationPrefixListId("destinationPrefixListId")
         .egressOnlyInternetGatewayId("egressOnlyInternetGatewayId")
         .gatewayId("gatewayId")
         .instanceId("instanceId")
         .localGatewayId("localGatewayId")
         .natGatewayId("natGatewayId")
         .networkInterfaceId("networkInterfaceId")
         .transitGatewayId("transitGatewayId")
         .vpcEndpointId("vpcEndpointId")
         .vpcPeeringConnectionId("vpcPeeringConnectionId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRouteProps.Builder	A builder for CfnRouteProps
static final class	CfnRouteProps.Jsii$Proxy	An implementation for CfnRouteProps

Method Summary

Modifier and Type	Method	Description
static CfnRouteProps.Builder	builder()
default Object	getCarrierGatewayId()	The ID of the carrier gateway.
default String	getCoreNetworkArn()	The Amazon Resource Name (ARN) of the core network.
default String	getDestinationCidrBlock()	The IPv4 CIDR address block used for the destination match.
default String	getDestinationIpv6CidrBlock()	The IPv6 CIDR block used for the destination match.
default String	getDestinationPrefixListId()	The ID of a prefix list used for the destination match.
default Object	getEgressOnlyInternetGatewayId()	[IPv6 traffic only] The ID of an egress-only internet gateway.
default Object	getGatewayId()	The ID of an internet gateway or virtual private gateway attached to your VPC.
default Object	getInstanceId()	The ID of a NAT instance in your VPC.
default String	getLocalGatewayId()	The ID of the local gateway.
default Object	getNatGatewayId()	[IPv4 traffic only] The ID of a NAT gateway.
default String	getNetworkInterfaceId()	The ID of a network interface.
Object	getRouteTableId()	The ID of the route table for the route.
default Object	getTransitGatewayId()	The ID of a transit gateway.
default String	getVpcEndpointId()	The ID of a VPC endpoint.
default Object	getVpcPeeringConnectionId()	The ID of a VPC peering connection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRouteTableId

@Stability(Stable)
@NotNull
Object getRouteTableId()

The ID of the route table for the route.

Returns union: either String or IRouteTableRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-routetableid

getCarrierGatewayId

@Stability(Stable)
@Nullable
default Object getCarrierGatewayId()

The ID of the carrier gateway.

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

Returns union: either String or ICarrierGatewayRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-carriergatewayid

getCoreNetworkArn

@Stability(Stable)
@Nullable
default String getCoreNetworkArn()

The Amazon Resource Name (ARN) of the core network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-corenetworkarn

getDestinationCidrBlock

@Stability(Stable)
@Nullable
default String getDestinationCidrBlock()

The IPv4 CIDR address block used for the destination match.

Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18 , we modify it to 100.68.0.0/18 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationcidrblock

getDestinationIpv6CidrBlock

@Stability(Stable)
@Nullable
default String getDestinationIpv6CidrBlock()

The IPv6 CIDR block used for the destination match.

Routing decisions are based on the most specific match.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationipv6cidrblock

getDestinationPrefixListId

@Stability(Stable)
@Nullable
default String getDestinationPrefixListId()

The ID of a prefix list used for the destination match.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-destinationprefixlistid

getEgressOnlyInternetGatewayId

@Stability(Stable)
@Nullable
default Object getEgressOnlyInternetGatewayId()

[IPv6 traffic only] The ID of an egress-only internet gateway.

Returns union: either String or IEgressOnlyInternetGatewayRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-egressonlyinternetgatewayid

getGatewayId

@Stability(Stable)
@Nullable
default Object getGatewayId()

The ID of an internet gateway or virtual private gateway attached to your VPC.

Returns union: either String or IInternetGatewayRef or IVPNGatewayRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-gatewayid

getInstanceId

@Stability(Stable)
@Nullable
default Object getInstanceId()

The ID of a NAT instance in your VPC.

The operation fails if you specify an instance ID unless exactly one network interface is attached.

Returns union: either String or IInstanceRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-instanceid

getLocalGatewayId

@Stability(Stable)
@Nullable
default String getLocalGatewayId()

The ID of the local gateway.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-localgatewayid

getNatGatewayId

@Stability(Stable)
@Nullable
default Object getNatGatewayId()

[IPv4 traffic only] The ID of a NAT gateway.

Returns union: either String or INatGatewayRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-natgatewayid

getNetworkInterfaceId

@Stability(Stable)
@Nullable
default String getNetworkInterfaceId()

The ID of a network interface.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-networkinterfaceid

getTransitGatewayId

@Stability(Stable)
@Nullable
default Object getTransitGatewayId()

The ID of a transit gateway.

Returns union: either String or ITransitGatewayRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-transitgatewayid

getVpcEndpointId

@Stability(Stable)
@Nullable
default String getVpcEndpointId()

The ID of a VPC endpoint.

Supported for Gateway Load Balancer endpoints only.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcendpointid

getVpcPeeringConnectionId

@Stability(Stable)
@Nullable
default Object getVpcPeeringConnectionId()

The ID of a VPC peering connection.

Returns union: either String or IVPCPeeringConnectionRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-route.html#cfn-ec2-route-vpcpeeringconnectionid

builder

@Stability(Stable)
static CfnRouteProps.Builder builder()

Returns:

a CfnRouteProps.Builder of CfnRouteProps