Package software.amazon.awscdk.services.ec2

Interface ClientVpnRouteOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ClientVpnRouteProps

All Known Implementing Classes:

ClientVpnRouteOptions.Jsii$Proxy, ClientVpnRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:00.602Z")
@Stability(Stable)
public interface ClientVpnRouteOptions
extends software.amazon.jsii.JsiiSerializable

Options for a ClientVpnRoute.

Example:

 ClientVpnEndpoint endpoint = vpc.addClientVpnEndpoint("Endpoint", ClientVpnEndpointOptions.builder()
         .cidr("10.100.0.0/16")
         .serverCertificateArn("arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id")
         .userBasedAuthentication(ClientVpnUserBasedAuthentication.federated(samlProvider))
         .build());
 // Client-to-client access
 endpoint.addRoute("Route", ClientVpnRouteOptions.builder()
         .cidr("10.100.0.0/16")
         .target(ClientVpnRouteTarget.local())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ClientVpnRouteOptions.Builder	A builder for ClientVpnRouteOptions
static final class	ClientVpnRouteOptions.Jsii$Proxy	An implementation for ClientVpnRouteOptions

Method Summary

Modifier and Type	Method	Description
static ClientVpnRouteOptions.Builder	builder()
String	getCidr()	The IPv4 address range, in CIDR notation, of the route destination.
default String	getDescription()	A brief description of the authorization rule.
ClientVpnRouteTarget	getTarget()	The target for the route.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCidr

@Stability(Stable)
@NotNull
String getCidr()

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

getTarget

@Stability(Stable)
@NotNull
ClientVpnRouteTarget getTarget()

The target for the route.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A brief description of the authorization rule.

Default: - no description

builder

@Stability(Stable)
static ClientVpnRouteOptions.Builder builder()

Returns:

a ClientVpnRouteOptions.Builder of ClientVpnRouteOptions