software.amazon.awscdk.services.ec2

Class ClientVpnEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ec2.ClientVpnEndpoint

All Implemented Interfaces:

IResource, IClientVpnEndpoint, IConnectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.402Z")
 @Stability(value=Stable)
public class ClientVpnEndpoint
extends Resource
implements IClientVpnEndpoint

A client VPN connnection.

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))
         .authorizeAllUsersToVpcCidr(false)
         .build());
 endpoint.addAuthorizationRule("Rule", ClientVpnAuthorizationRuleOptions.builder()
         .cidr("10.0.10.0/32")
         .groupId("group-id")
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientVpnEndpoint.Builder A fluent builder for ClientVpnEndpoint.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IClientVpnEndpoint

IClientVpnEndpoint.Jsii$Default, IClientVpnEndpoint.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	ClientVpnEndpoint(software.constructs.Construct scope, String id, ClientVpnEndpointProps props)
protected	ClientVpnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ClientVpnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
ClientVpnAuthorizationRule	addAuthorizationRule(String id, ClientVpnAuthorizationRuleOptions props) Adds an authorization rule to this endpoint.
ClientVpnRoute	addRoute(String id, ClientVpnRouteOptions props) Adds a route to this endpoint.
static IClientVpnEndpoint	fromEndpointAttributes(software.constructs.Construct scope, String id, ClientVpnEndpointAttributes attrs) Import an existing client VPN endpoint.
Connections	getConnections() Allows specify security group connections for the endpoint.
String	getEndpointId() The endpoint ID.
software.constructs.IDependable	getTargetNetworksAssociated() Dependable that can be depended upon to force target networks associations.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ClientVpnEndpoint

protected ClientVpnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

ClientVpnEndpoint

protected ClientVpnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ClientVpnEndpoint

@Stability(value=Stable)
public ClientVpnEndpoint(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  ClientVpnEndpointProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromEndpointAttributes

@Stability(value=Stable)
 @NotNull
public static IClientVpnEndpoint fromEndpointAttributes(@NotNull
                                                                                           software.constructs.Construct scope,
                                                                                           @NotNull
                                                                                           String id,
                                                                                           @NotNull
                                                                                           ClientVpnEndpointAttributes attrs)

Import an existing client VPN endpoint.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addAuthorizationRule

@Stability(value=Stable)
 @NotNull
public ClientVpnAuthorizationRule addAuthorizationRule(@NotNull
                                                                                          String id,
                                                                                          @NotNull
                                                                                          ClientVpnAuthorizationRuleOptions props)

Adds an authorization rule to this endpoint.

Parameters:

id - This parameter is required.

props - This parameter is required.

addRoute

@Stability(value=Stable)
 @NotNull
public ClientVpnRoute addRoute(@NotNull
                                                                  String id,
                                                                  @NotNull
                                                                  ClientVpnRouteOptions props)

Adds a route to this endpoint.

Parameters:

id - This parameter is required.

props - This parameter is required.

getConnections

@Stability(value=Stable)
 @NotNull
public Connections getConnections()

Allows specify security group connections for the endpoint.

Specified by:

getConnections in interface IConnectable

getEndpointId

@Stability(value=Stable)
 @NotNull
public String getEndpointId()

The endpoint ID.

Specified by:

getEndpointId in interface IClientVpnEndpoint

getTargetNetworksAssociated

@Stability(value=Stable)
 @NotNull
public software.constructs.IDependable getTargetNetworksAssociated()

Dependable that can be depended upon to force target networks associations.

Specified by:

getTargetNetworksAssociated in interface IClientVpnEndpoint