software.amazon.awscdk.services.ec2

Class CfnRoute

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnRoute

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.277Z")
 @Stability(value=Stable)
public class CfnRoute
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::Route`.

Specifies a route in a route table within a VPC.

You must specify either DestinationCidrBlock or DestinationIpv6CidrBlock , plus the ID of one of the target resources.

If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a DependsOn Attribute in the AWS::EC2::Route resource to explicitly declare a dependency on the AWS::EC2::TransitGatewayAttachment resource.

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.*;
 CfnRoute cfnRoute = CfnRoute.Builder.create(this, "MyCfnRoute")
         .routeTableId("routeTableId")
         // the properties below are optional
         .carrierGatewayId("carrierGatewayId")
         .destinationCidrBlock("destinationCidrBlock")
         .destinationIpv6CidrBlock("destinationIpv6CidrBlock")
         .egressOnlyInternetGatewayId("egressOnlyInternetGatewayId")
         .gatewayId("gatewayId")
         .instanceId("instanceId")
         .localGatewayId("localGatewayId")
         .natGatewayId("natGatewayId")
         .networkInterfaceId("networkInterfaceId")
         .transitGatewayId("transitGatewayId")
         .vpcEndpointId("vpcEndpointId")
         .vpcPeeringConnectionId("vpcPeeringConnectionId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRoute.Builder A fluent builder for CfnRoute.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRoute(software.constructs.Construct scope, String id, CfnRouteProps props) Create a new `AWS::EC2::Route`.
protected	CfnRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRoute(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getCarrierGatewayId() The ID of the carrier gateway.
protected Map<String,Object>	getCfnProperties()
String	getDestinationCidrBlock() The IPv4 CIDR block used for the destination match.
String	getDestinationIpv6CidrBlock() The IPv6 CIDR block used for the destination match.
String	getEgressOnlyInternetGatewayId() The ID of the egress-only internet gateway.
String	getGatewayId() The ID of an internet gateway or virtual private gateway attached to your VPC.
String	getInstanceId() The ID of a NAT instance in your VPC.
String	getLocalGatewayId() The ID of the local gateway.
String	getNatGatewayId() The ID of a NAT gateway.
String	getNetworkInterfaceId() The ID of the network interface.
String	getRouteTableId() The ID of the route table.
String	getTransitGatewayId() The ID of a transit gateway.
String	getVpcEndpointId() The ID of a VPC endpoint.
String	getVpcPeeringConnectionId() The ID of a VPC peering connection.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCarrierGatewayId(String value) The ID of the carrier gateway.
void	setDestinationCidrBlock(String value) The IPv4 CIDR block used for the destination match.
void	setDestinationIpv6CidrBlock(String value) The IPv6 CIDR block used for the destination match.
void	setEgressOnlyInternetGatewayId(String value) The ID of the egress-only internet gateway.
void	setGatewayId(String value) The ID of an internet gateway or virtual private gateway attached to your VPC.
void	setInstanceId(String value) The ID of a NAT instance in your VPC.
void	setLocalGatewayId(String value) The ID of the local gateway.
void	setNatGatewayId(String value) The ID of a NAT gateway.
void	setNetworkInterfaceId(String value) The ID of the network interface.
void	setRouteTableId(String value) The ID of the route table.
void	setTransitGatewayId(String value) The ID of a transit gateway.
void	setVpcEndpointId(String value) The ID of a VPC endpoint.
void	setVpcPeeringConnectionId(String value) The ID of a VPC peering connection.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRoute

protected CfnRoute(software.amazon.jsii.JsiiObjectRef objRef)

CfnRoute

protected CfnRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRoute

@Stability(value=Stable)
public CfnRoute(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnRouteProps props)

Create a new `AWS::EC2::Route`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getRouteTableId

@Stability(value=Stable)
 @NotNull
public String getRouteTableId()

The ID of the route table.

The routing table must be associated with the same VPC that the virtual private gateway is attached to.

setRouteTableId

@Stability(value=Stable)
public void setRouteTableId(@NotNull
                                                     String value)

The ID of the route table.

The routing table must be associated with the same VPC that the virtual private gateway is attached to.

getCarrierGatewayId

@Stability(value=Stable)
 @Nullable
public String getCarrierGatewayId()

The ID of the carrier gateway.

setCarrierGatewayId

@Stability(value=Stable)
public void setCarrierGatewayId(@Nullable
                                                         String value)

The ID of the carrier gateway.

getDestinationCidrBlock

@Stability(value=Stable)
 @Nullable
public String getDestinationCidrBlock()

The IPv4 CIDR block used for the destination match.

setDestinationCidrBlock

@Stability(value=Stable)
public void setDestinationCidrBlock(@Nullable
                                                             String value)

The IPv4 CIDR block used for the destination match.

getDestinationIpv6CidrBlock

@Stability(value=Stable)
 @Nullable
public String getDestinationIpv6CidrBlock()

The IPv6 CIDR block used for the destination match.

setDestinationIpv6CidrBlock

@Stability(value=Stable)
public void setDestinationIpv6CidrBlock(@Nullable
                                                                 String value)

The IPv6 CIDR block used for the destination match.

getEgressOnlyInternetGatewayId

@Stability(value=Stable)
 @Nullable
public String getEgressOnlyInternetGatewayId()

The ID of the egress-only internet gateway.

setEgressOnlyInternetGatewayId

@Stability(value=Stable)
public void setEgressOnlyInternetGatewayId(@Nullable
                                                                    String value)

The ID of the egress-only internet gateway.

getGatewayId

@Stability(value=Stable)
 @Nullable
public String getGatewayId()

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

setGatewayId

@Stability(value=Stable)
public void setGatewayId(@Nullable
                                                  String value)

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

getInstanceId

@Stability(value=Stable)
 @Nullable
public String getInstanceId()

The ID of a NAT instance in your VPC.

setInstanceId

@Stability(value=Stable)
public void setInstanceId(@Nullable
                                                   String value)

The ID of a NAT instance in your VPC.

getLocalGatewayId

@Stability(value=Stable)
 @Nullable
public String getLocalGatewayId()

The ID of the local gateway.

setLocalGatewayId

@Stability(value=Stable)
public void setLocalGatewayId(@Nullable
                                                       String value)

The ID of the local gateway.

getNatGatewayId

@Stability(value=Stable)
 @Nullable
public String getNatGatewayId()

The ID of a NAT gateway.

setNatGatewayId

@Stability(value=Stable)
public void setNatGatewayId(@Nullable
                                                     String value)

The ID of a NAT gateway.

getNetworkInterfaceId

@Stability(value=Stable)
 @Nullable
public String getNetworkInterfaceId()

The ID of the network interface.

setNetworkInterfaceId

@Stability(value=Stable)
public void setNetworkInterfaceId(@Nullable
                                                           String value)

The ID of the network interface.

getTransitGatewayId

@Stability(value=Stable)
 @Nullable
public String getTransitGatewayId()

The ID of a transit gateway.

setTransitGatewayId

@Stability(value=Stable)
public void setTransitGatewayId(@Nullable
                                                         String value)

The ID of a transit gateway.

getVpcEndpointId

@Stability(value=Stable)
 @Nullable
public String getVpcEndpointId()

The ID of a VPC endpoint.

Supported for Gateway Load Balancer endpoints only.

setVpcEndpointId

@Stability(value=Stable)
public void setVpcEndpointId(@Nullable
                                                      String value)

The ID of a VPC endpoint.

Supported for Gateway Load Balancer endpoints only.

getVpcPeeringConnectionId

@Stability(value=Stable)
 @Nullable
public String getVpcPeeringConnectionId()

The ID of a VPC peering connection.

setVpcPeeringConnectionId

@Stability(value=Stable)
public void setVpcPeeringConnectionId(@Nullable
                                                               String value)

The ID of a VPC peering connection.