aws-cdk-lib.aws_ec2.ClientVpnRouteOptions

ClientVpnRouteOptions Struct

Options for a ClientVpnRoute.

Source

aws-ec2/lib/client-vpn-route.ts

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

cidrstringcidrstrcidrStringCidrstringCidr*stringrequired#

The IPv4 address range, in CIDR notation, of the route destination.

notes

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?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

A brief description of the authorization rule.

Default: no description

targetClientVpnRouteTargettargetClientVpnRouteTargettargetClientVpnRouteTargetTargetClientVpnRouteTargetTargetClientVpnRouteTargetrequired#

The target for the route.