interface ClientVpnRouteProps

Language	Type name
.NET	Amazon.CDK.AWS.EC2.ClientVpnRouteProps
Java	software.amazon.awscdk.services.ec2.ClientVpnRouteProps
Python	aws_cdk.aws_ec2.ClientVpnRouteProps
TypeScript (source)	@aws-cdk/aws-ec2 » ClientVpnRouteProps

Properties for a ClientVpnRoute.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2 from '@aws-cdk/aws-ec2';

declare const clientVpnEndpoint: ec2.ClientVpnEndpoint;
declare const clientVpnRouteTarget: ec2.ClientVpnRouteTarget;
const clientVpnRouteProps: ec2.ClientVpnRouteProps = {
  cidr: 'cidr',
  target: clientVpnRouteTarget,

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

Properties

Name	Type	Description
cidr	string	The IPv4 address range, in CIDR notation, of the route destination.
target	ClientVpnRouteTarget	The target for the route.
clientVpnEndoint?⚠️	IClientVpnEndpoint	The client VPN endpoint to which to add the route.
clientVpnEndpoint?	IClientVpnEndpoint	The client VPN endpoint to which to add the route.
description?	string	A 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.

---

clientVpnEndoint?⚠️

⚠️ Deprecated: Use clientVpnEndpoint instead

Type: IClientVpnEndpoint (optional, default: clientVpnEndpoint is required)

The client VPN endpoint to which to add the route.

---

clientVpnEndpoint?

Type: IClientVpnEndpoint (optional, default: clientVpnEndpoint is required)

The client VPN endpoint to which to add the route.

---

description?

Type: string (optional, default: no description)

A brief description of the authorization rule.