Package software.amazon.awscdk.services.ec2

Class CfnClientVpnRoute

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ec2.CfnClientVpnRoute
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.454Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnClientVpnRoute

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

    • CfnClientVpnRoute

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

    • CfnClientVpnRoute

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

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getClientVpnEndpointId

      @Stability(Stable) @NotNull public String getClientVpnEndpointId()
      The ID of the Client VPN endpoint to which to add the route.

    • setClientVpnEndpointId

      @Stability(Stable) public void setClientVpnEndpointId(@NotNull String value)
      The ID of the Client VPN endpoint to which to add the route.

    • getDestinationCidrBlock

      @Stability(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(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(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(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(Stable) @Nullable public String getDescription()
      A brief description of the route.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A brief description of the route.