Package 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, IClientVpnRouteRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:36.728Z") @Stability(Stable) public class CfnClientVpnRoute extends CfnResource implements IInspectable, IClientVpnRouteRef
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnClientVpnRouteProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getClientVpnRouteRef

      @Stability(Stable) @NotNull public ClientVpnRouteReference getClientVpnRouteRef()
      A reference to a ClientVpnRoute resource.
      Specified by:
      getClientVpnRouteRef in interface IClientVpnRouteRef

    • 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:.

    • setDestinationCidrBlock

      @Stability(Stable) public void setDestinationCidrBlock(@NotNull String value)
      The IPv4 address range, in CIDR notation, of the route destination.

      For example:.

    • getTargetVpcSubnetId

      @Stability(Stable) @NotNull public String getTargetVpcSubnetId()
      The ID of the subnet through which you want to route traffic.

    • setTargetVpcSubnetId

      @Stability(Stable) public void setTargetVpcSubnetId(@NotNull String value)
      The ID of the subnet through which you want to route traffic.

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