We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 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:
- Client
Vpn stringEndpoint Id - The ID of the Client VPN endpoint to which to add the route.
- Destination
Cidr stringBlock - 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 stringSubnet Id - 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 stringEndpoint Id - The ID of the Client VPN endpoint to which to add the route.
- Destination
Cidr stringBlock - 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 stringSubnet Id - 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_ stringendpoint_ id - The ID of the Client VPN endpoint to which to add the route.
- destination_
cidr_ stringblock - 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_ stringsubnet_ id - 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 StringEndpoint Id - The ID of the Client VPN endpoint to which to add the route.
- destination
Cidr StringBlock - 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 StringSubnet Id - 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 stringEndpoint Id - The ID of the Client VPN endpoint to which to add the route.
- destination
Cidr stringBlock - 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 stringSubnet Id - 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_ strendpoint_ id - The ID of the Client VPN endpoint to which to add the route.
- destination_
cidr_ strblock - 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_ strsubnet_ id - 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 StringEndpoint Id - The ID of the Client VPN endpoint to which to add the route.
- destination
Cidr StringBlock - 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 StringSubnet Id - 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:
Look up Existing ClientVpnRoute Resource
Get an existing ClientVpnRoute resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): ClientVpnRoute@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None) -> ClientVpnRoutefunc GetClientVpnRoute(ctx *Context, name string, id IDInput, state *ClientVpnRouteState, opts ...ResourceOption) (*ClientVpnRoute, error)public static ClientVpnRoute Get(string name, Input<string> id, CustomResourceOptions? opts = null)public static ClientVpnRoute get(String name, Output<String> id, CustomResourceOptions options)resources: existingClientVpnRoute: type: aws-native:ec2:ClientVpnRoute get: id: ${id}import {
to = aws-native_ec2_client_vpn_route.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state ClientVpnRouteState
- Pass nil. This resource has no state arguments.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi