ClientVpnRouteProps Struct
Properties for a ClientVpnRoute.
Example
ts
// 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';
declare const clientVpnEndpoint: ec2.ClientVpnEndpoint;
declare const clientVpnRouteTarget: ec2.ClientVpnRouteTarget;
const clientVpnRouteProps: ec2.ClientVpnRouteProps = {
cidr: 'cidr',
target: clientVpnRouteTarget,
// the properties below are optional
clientVpnEndpoint: clientVpnEndpoint,
description: 'description',
};
Properties
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
clientVpnEndpointIClientVpnEndpointclient_vpn_endpointIClientVpnEndpointclientVpnEndpointIClientVpnEndpointClientVpnEndpointIClientVpnEndpointClientVpnEndpointIClientVpnEndpoint= clientVpnEndpoint is required#The client VPN endpoint to which to add the route.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#A brief description of the authorization rule.
targetClientVpnRouteTargettargetClientVpnRouteTargettargetClientVpnRouteTargetTargetClientVpnRouteTargetTargetClientVpnRouteTargetrequired#The target for the route.