software.amazon.awscdk.services.ec2

Class CfnClientVpnRoute

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.CfnClientVpnRoute

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.134Z")
 @Stability(value=Stable)
public class CfnClientVpnRoute
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::ClientVpnRoute`.

Specifies a network route to add to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

A target network association must be created before you can specify a route. If you're setting up all the components of a Client VPN endpoint at the same time, you must use the DependsOn Attribute to declare a dependency on the AWS::EC2::ClientVpnTargetNetworkAssociation 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.*;
 CfnClientVpnRoute cfnClientVpnRoute = CfnClientVpnRoute.Builder.create(this, "MyCfnClientVpnRoute")
         .clientVpnEndpointId("clientVpnEndpointId")
         .destinationCidrBlock("destinationCidrBlock")
         .targetVpcSubnetId("targetVpcSubnetId")
         // the properties below are optional
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnClientVpnRoute(software.constructs.Construct scope, String id, CfnClientVpnRouteProps props) Create a new `AWS::EC2::ClientVpnRoute`.
protected	CfnClientVpnRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnClientVpnRoute(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getClientVpnEndpointId() The ID of the Client VPN endpoint to which to add the route.
String	getDescription() A brief description of the route.
String	getDestinationCidrBlock() The IPv4 address range, in CIDR notation, of the route destination.
String	getTargetVpcSubnetId() The ID of the subnet through which you want to route traffic.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setClientVpnEndpointId(String value) The ID of the Client VPN endpoint to which to add the route.
void	setDescription(String value) A brief description of the route.
void	setDestinationCidrBlock(String value) The IPv4 address range, in CIDR notation, of the route destination.
void	setTargetVpcSubnetId(String value) The ID of the subnet through which you want to route traffic.

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

CfnClientVpnRoute

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

CfnClientVpnRoute

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

CfnClientVpnRoute

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

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

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

getClientVpnEndpointId

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

The ID of the Client VPN endpoint to which to add the route.

setClientVpnEndpointId

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

The ID of the Client VPN endpoint to which to add the route.

getDestinationCidrBlock

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

The IPv4 address range, in CIDR notation, of the route destination. For example:.

• To add a route for Internet access, enter 0.0.0.0/0
• To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
• To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range
• To add a route for the local network, enter the client CIDR range

setDestinationCidrBlock

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

The IPv4 address range, in CIDR notation, of the route destination. For example:.

• To add a route for Internet access, enter 0.0.0.0/0
• To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
• To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range
• To add a route for the local network, enter the client CIDR range

getTargetVpcSubnetId

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

The ID of the subnet through which you want to route traffic.

The specified subnet must be an existing target network of the Client VPN endpoint.

Alternatively, if you're adding a route for the local network, specify local .

setTargetVpcSubnetId

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

The ID of the subnet through which you want to route traffic.

The specified subnet must be an existing target network of the Client VPN endpoint.

Alternatively, if you're adding a route for the local network, specify local .

getDescription

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

A brief description of the route.

setDescription

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

A brief description of the route.