AWS CDK Reference

Appearance

v2.277.0

ClientVpnRouteProps Struct ​

Properties for a ClientVpnRoute.

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

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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

# client_vpn_endpoint: ec2.ClientVpnEndpoint
# client_vpn_route_target: ec2.ClientVpnRouteTarget

client_vpn_route_props = ec2.ClientVpnRouteProps(
    cidr="cidr",
    target=client_vpn_route_target,

    # the properties below are optional
    client_vpn_endpoint=client_vpn_endpoint,
    description="description"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;

ClientVpnEndpoint clientVpnEndpoint;
ClientVpnRouteTarget clientVpnRouteTarget;

ClientVpnRouteProps clientVpnRouteProps = ClientVpnRouteProps.builder()
        .cidr("cidr")
        .target(clientVpnRouteTarget)

        // the properties below are optional
        .clientVpnEndpoint(clientVpnEndpoint)
        .description("description")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;

ClientVpnEndpoint clientVpnEndpoint;
ClientVpnRouteTarget clientVpnRouteTarget;

var clientVpnRouteProps = new ClientVpnRouteProps {
    Cidr = "cidr",
    Target = clientVpnRouteTarget,

    // the properties below are optional
    ClientVpnEndpoint = clientVpnEndpoint,
    Description = "description"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var clientVpnEndpoint ClientVpnEndpoint
var clientVpnRouteTarget ClientVpnRouteTarget

clientVpnRouteProps := &ClientVpnRouteProps{
	Cidr: jsii.String("cidr"),
	Target: clientVpnRouteTarget,

	// the properties below are optional
	ClientVpnEndpoint: clientVpnEndpoint,
	Description: jsii.String("description"),
}

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
clientVpnEndpointoptionalIClientVpnEndpointclient_vpn_endpointoptionalIClientVpnEndpointclientVpnEndpointoptionalIClientVpnEndpointClientVpnEndpointoptionalIClientVpnEndpointClientVpnEndpointoptionalIClientVpnEndpoint#
The client VPN endpoint to which to add the route.

Default: clientVpnEndpoint is required

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A brief description of the authorization rule.

Default: no description