Package software.amazon.awscdk.services.ec2

Class ClientVpnUserBasedAuthentication

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.ClientVpnUserBasedAuthentication

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:03.357Z")
@Stability(Stable)
public abstract class ClientVpnUserBasedAuthentication
extends software.amazon.jsii.JsiiObject

User-based authentication for a client VPN endpoint.

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/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClientVpnUserBasedAuthentication()
protected	ClientVpnUserBasedAuthentication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ClientVpnUserBasedAuthentication(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static ClientVpnUserBasedAuthentication	activeDirectory(String directoryId)	Active Directory authentication.
static ClientVpnUserBasedAuthentication	federated(ISAMLProviderRef samlProvider)	Federated authentication.
static ClientVpnUserBasedAuthentication	federated(ISAMLProviderRef samlProvider, ISAMLProviderRef selfServiceSamlProvider)	Federated authentication.
abstract Object	render()	Renders the user based authentication.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ClientVpnUserBasedAuthentication

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

ClientVpnUserBasedAuthentication

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

ClientVpnUserBasedAuthentication

@Stability(Stable)
protected ClientVpnUserBasedAuthentication()

Method Details

activeDirectory

@Stability(Stable)
@NotNull
public static ClientVpnUserBasedAuthentication activeDirectory(@NotNull
 String directoryId)

Active Directory authentication.

Parameters:

directoryId - This parameter is required.

federated

@Stability(Stable)
@NotNull
public static ClientVpnUserBasedAuthentication federated(@NotNull
 ISAMLProviderRef samlProvider,
 @Nullable
 ISAMLProviderRef selfServiceSamlProvider)

Federated authentication.

Parameters:

samlProvider - This parameter is required.

selfServiceSamlProvider -

federated

@Stability(Stable)
@NotNull
public static ClientVpnUserBasedAuthentication federated(@NotNull
 ISAMLProviderRef samlProvider)

Federated authentication.

Parameters:

samlProvider - This parameter is required.

render

@Stability(Stable)
@NotNull
public abstract Object render()

Renders the user based authentication.