Class ClientVpnRouteOptions

Options for a ClientVpnRoute.

Inheritance

object

ClientVpnRouteOptions

Implements

IClientVpnRouteOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ClientVpnRouteOptions : IClientVpnRouteOptions

Syntax (vb)

Public Class ClientVpnRouteOptions Implements IClientVpnRouteOptions

Remarks

ExampleMetadata: fixture=client-vpn infused

Examples

var endpoint = vpc.AddClientVpnEndpoint("Endpoint", new ClientVpnEndpointOptions {
                Cidr = "10.100.0.0/16",
                ServerCertificateArn = "arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id",
                UserBasedAuthentication = ClientVpnUserBasedAuthentication.Federated(samlProvider)
            });

            // Client-to-client access
            endpoint.AddRoute("Route", new ClientVpnRouteOptions {
                Cidr = "10.100.0.0/16",
                Target = ClientVpnRouteTarget.Local()
            });

Synopsis

Constructors

ClientVpnRouteOptions()

Options for a ClientVpnRoute.

Properties

Cidr	The IPv4 address range, in CIDR notation, of the route destination.
Description	A brief description of the authorization rule.
Target	The target for the route.

Constructors

ClientVpnRouteOptions()

Options for a ClientVpnRoute.

public ClientVpnRouteOptions()

Remarks

ExampleMetadata: fixture=client-vpn infused

Examples

var endpoint = vpc.AddClientVpnEndpoint("Endpoint", new ClientVpnEndpointOptions {
                Cidr = "10.100.0.0/16",
                ServerCertificateArn = "arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id",
                UserBasedAuthentication = ClientVpnUserBasedAuthentication.Federated(samlProvider)
            });

            // Client-to-client access
            endpoint.AddRoute("Route", new ClientVpnRouteOptions {
                Cidr = "10.100.0.0/16",
                Target = ClientVpnRouteTarget.Local()
            });

Properties

Cidr

The IPv4 address range, in CIDR notation, of the route destination.

public string Cidr { get; set; }

Property Value

string

Remarks

For example:

Description

A brief description of the authorization rule.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - no description

Target

The target for the route.

public ClientVpnRouteTarget Target { get; set; }

Property Value

ClientVpnRouteTarget

Remarks

ExampleMetadata: fixture=client-vpn infused

Implements

IClientVpnRouteOptions