AWS CDK Reference

Appearance

v2.274.0

ClientVpnRouteTarget Class ​

Target for a client VPN route.

Source
aws-ec2/lib/client-vpn-route.ts
Type last changed
v2.224.0 · 13 Nov 2025

Example ​

ts
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(),
});

Initializer ​

ts
new ClientVpnRouteTarget()
python
ClientVpnRouteTarget()
java
new ClientVpnRouteTarget()
csharp
new ClientVpnRouteTarget()
go
NewClientVpnRouteTarget()

Properties ​

subnetIdstringsubnet_idstrsubnetIdStringSubnetIdstringSubnetId*stringrequired#
The subnet ID.

Methods ​

local(): ClientVpnRouteTarget // chainable@staticmethod def local() -> ClientVpnRouteTargetpublic static ClientVpnRouteTarget local()public static ClientVpnRouteTarget Local()func Local() ClientVpnRouteTargetstatic#
Local network.
subnet(subnet: ISubnetRef): ClientVpnRouteTarget // chainable@staticmethod def subnet(subnet: ISubnetRef) -> ClientVpnRouteTargetpublic static ClientVpnRouteTarget subnet(ISubnetRef subnet)public static ClientVpnRouteTarget Subnet(ISubnetRef subnet)func Subnet(Subnet ISubnetRef) ClientVpnRouteTargetstatic#
Subnet.

The specified subnet must be an existing target network of the client VPN endpoint.