aws-cdk-lib.aws_ec2.ClientVpnRouteOptions

interface ClientVpnRouteOptions

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

Options for a ClientVpnRoute.

Example

const endpoint = vpc.addClientVpnEndpoint('Endpoint', {
  cidr: '10.100.0.0/16',
  serverCertificateArn: 'arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id',
  userBasedAuthentication: ec2.ClientVpnUserBasedAuthentication.federated(samlProvider),
});

// Client-to-client access
endpoint.addRoute('Route', {
  cidr: '10.100.0.0/16',
  target: ec2.ClientVpnRouteTarget.local(),
});

Properties

NameTypeDescription
cidrstringThe IPv4 address range, in CIDR notation, of the route destination.
targetClientVpnRouteTargetThe target for the route.
description?stringA brief description of the authorization rule.

cidr

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

target

Type: ClientVpnRouteTarget

The target for the route.


description?

Type: string (optional, default: no description)

A brief description of the authorization rule.