Package software.amazon.awscdk.services.ec2

Interface CfnClientVpnRouteProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClientVpnRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:15.542Z")
@Stability(Stable)
public interface CfnClientVpnRouteProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnClientVpnRoute.

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.*;
 CfnClientVpnRouteProps cfnClientVpnRouteProps = CfnClientVpnRouteProps.builder()
         .clientVpnEndpointId("clientVpnEndpointId")
         .destinationCidrBlock("destinationCidrBlock")
         .targetVpcSubnetId("targetVpcSubnetId")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnClientVpnRouteProps.Builder	builder()
String	getClientVpnEndpointId()	The ID of the Client VPN endpoint to which to add the route.
default 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClientVpnEndpointId

@Stability(Stable)
@NotNull
String getClientVpnEndpointId()

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

See Also:

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

getDestinationCidrBlock

@Stability(Stable)
@NotNull
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

See Also:

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

getTargetVpcSubnetId

@Stability(Stable)
@NotNull
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 .

See Also:

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

getDescription

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

A brief description of the route.

See Also:

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

builder

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

Returns:

a CfnClientVpnRouteProps.Builder of CfnClientVpnRouteProps