1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. ec2
  6. ClientVpnRoute

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi

    Resource Type definition for 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.

    Create ClientVpnRoute Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClientVpnRoute(name: string, args: ClientVpnRouteArgs, opts?: CustomResourceOptions);
    @overload
    def ClientVpnRoute(resource_name: str,
                       args: ClientVpnRouteArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def ClientVpnRoute(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       client_vpn_endpoint_id: Optional[str] = None,
                       destination_cidr_block: Optional[str] = None,
                       description: Optional[str] = None,
                       target_vpc_subnet_id: Optional[str] = None)
    func NewClientVpnRoute(ctx *Context, name string, args ClientVpnRouteArgs, opts ...ResourceOption) (*ClientVpnRoute, error)
    public ClientVpnRoute(string name, ClientVpnRouteArgs args, CustomResourceOptions? opts = null)
    public ClientVpnRoute(String name, ClientVpnRouteArgs args)
    public ClientVpnRoute(String name, ClientVpnRouteArgs args, CustomResourceOptions options)
    
    type: aws-native:ec2:ClientVpnRoute
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_ec2_client_vpn_route" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ClientVpnRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClientVpnRouteArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClientVpnRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientVpnRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientVpnRouteArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ClientVpnRoute Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ClientVpnRoute resource accepts the following input properties:

    ClientVpnEndpointId string
    The ID of the Client VPN endpoint to which to add the route.
    DestinationCidrBlock string
    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.
    Description string
    A brief description of the route.
    TargetVpcSubnetId string
    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.
    ClientVpnEndpointId string
    The ID of the Client VPN endpoint to which to add the route.
    DestinationCidrBlock string
    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.
    Description string
    A brief description of the route.
    TargetVpcSubnetId string
    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.
    client_vpn_endpoint_id string
    The ID of the Client VPN endpoint to which to add the route.
    destination_cidr_block string
    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.
    description string
    A brief description of the route.
    target_vpc_subnet_id string
    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.
    clientVpnEndpointId String
    The ID of the Client VPN endpoint to which to add the route.
    destinationCidrBlock String
    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.
    description String
    A brief description of the route.
    targetVpcSubnetId String
    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.
    clientVpnEndpointId string
    The ID of the Client VPN endpoint to which to add the route.
    destinationCidrBlock string
    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.
    description string
    A brief description of the route.
    targetVpcSubnetId string
    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.
    client_vpn_endpoint_id str
    The ID of the Client VPN endpoint to which to add the route.
    destination_cidr_block str
    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.
    description str
    A brief description of the route.
    target_vpc_subnet_id str
    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.
    clientVpnEndpointId String
    The ID of the Client VPN endpoint to which to add the route.
    destinationCidrBlock String
    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.
    description String
    A brief description of the route.
    targetVpcSubnetId String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClientVpnRoute resource produces the following output properties:

    AwsId string
    The CloudFormation-generated identifier for this Client VPN route, derived from the logical resource id and client request token.
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    The CloudFormation-generated identifier for this Client VPN route, derived from the logical resource id and client request token.
    Id string
    The provider-assigned unique ID for this managed resource.
    aws_id string
    The CloudFormation-generated identifier for this Client VPN route, derived from the logical resource id and client request token.
    id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    The CloudFormation-generated identifier for this Client VPN route, derived from the logical resource id and client request token.
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    The CloudFormation-generated identifier for this Client VPN route, derived from the logical resource id and client request token.
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    The CloudFormation-generated identifier for this Client VPN route, derived from the logical resource id and client request token.
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    The CloudFormation-generated identifier for this Client VPN route, derived from the logical resource id and client request token.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.85.0
    published on Monday, Nov 2, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial