interface CfnClientVpnRouteProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.EC2.CfnClientVpnRouteProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnClientVpnRouteProps |
 Java | software.amazon.awscdk.services.ec2.CfnClientVpnRouteProps |
 Python | aws_cdk.aws_ec2.CfnClientVpnRouteProps |
 TypeScript | aws-cdk-lib » aws_ec2 » CfnClientVpnRouteProps |
Properties for defining a CfnClientVpnRoute.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnClientVpnRouteProps: ec2.CfnClientVpnRouteProps = {
clientVpnEndpointId: 'clientVpnEndpointId',
destinationCidrBlock: 'destinationCidrBlock',
// the properties below are optional
description: 'description',
targetVpcSubnetId: 'targetVpcSubnetId',
};
Properties
| Name | Type | Description |
|---|---|---|
| client | string | The ID of the Client VPN endpoint to which to add the route. |
| destination | string | The IPv4 address range, in CIDR notation, of the route destination. For example:. |
| description? | string | A brief description of the route. |
| target | string | The ID of the subnet through which you want to route traffic. |
clientVpnEndpointId
Type:
string
The ID of the Client VPN endpoint to which to add the route.
destinationCidrBlock
Type:
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?
Type:
string
(optional)
A brief description of the route.
targetVpcSubnetId?
Type:
string
(optional)
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 .