aws-cdk-lib.aws_ec2.CfnClientVpnRouteProps

interface CfnClientVpnRouteProps

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnClientVpnRouteProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnClientVpnRouteProps
Javasoftware.amazon.awscdk.services.ec2.CfnClientVpnRouteProps
Pythonaws_cdk.aws_ec2.CfnClientVpnRouteProps
TypeScript aws-cdk-lib » aws_ec2 » CfnClientVpnRouteProps

Properties for defining a CfnClientVpnRoute.

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',
  targetVpcSubnetId: 'targetVpcSubnetId',

  // the properties below are optional
  description: 'description',
};

Properties

NameTypeDescription
clientVpnEndpointIdstringThe ID of the Client VPN endpoint to which to add the route.
destinationCidrBlockstringThe IPv4 address range, in CIDR notation, of the route destination. For example:.
targetVpcSubnetIdstringThe ID of the subnet through which you want to route traffic.
description?stringA brief description of the route.

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

targetVpcSubnetId

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


description?

Type: string (optional)

A brief description of the route.