Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnClientVpnEndpointPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnClientVpnEndpointPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:58.346Z")
@Stability(Stable)
public class CfnClientVpnEndpointPropsMixin
extends Mixin
implements software.constructs.IMixin

Specifies a Client VPN endpoint.

A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ec2.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnClientVpnEndpointPropsMixin cfnClientVpnEndpointPropsMixin = CfnClientVpnEndpointPropsMixin.Builder.create(CfnClientVpnEndpointMixinProps.builder()
         .authenticationOptions(List.of(ClientAuthenticationRequestProperty.builder()
                 .activeDirectory(DirectoryServiceAuthenticationRequestProperty.builder()
                         .directoryId("directoryId")
                         .build())
                 .federatedAuthentication(FederatedAuthenticationRequestProperty.builder()
                         .samlProviderArn("samlProviderArn")
                         .selfServiceSamlProviderArn("selfServiceSamlProviderArn")
                         .build())
                 .mutualAuthentication(CertificateAuthenticationRequestProperty.builder()
                         .clientRootCertificateChainArn("clientRootCertificateChainArn")
                         .build())
                 .type("type")
                 .build()))
         .clientCidrBlock("clientCidrBlock")
         .clientConnectOptions(ClientConnectOptionsProperty.builder()
                 .enabled(false)
                 .lambdaFunctionArn("lambdaFunctionArn")
                 .build())
         .clientLoginBannerOptions(ClientLoginBannerOptionsProperty.builder()
                 .bannerText("bannerText")
                 .enabled(false)
                 .build())
         .clientRouteEnforcementOptions(ClientRouteEnforcementOptionsProperty.builder()
                 .enforced(false)
                 .build())
         .connectionLogOptions(ConnectionLogOptionsProperty.builder()
                 .cloudwatchLogGroup("cloudwatchLogGroup")
                 .cloudwatchLogStream("cloudwatchLogStream")
                 .enabled(false)
                 .build())
         .description("description")
         .disconnectOnSessionTimeout(false)
         .dnsServers(List.of("dnsServers"))
         .endpointIpAddressType("endpointIpAddressType")
         .securityGroupIds(List.of("securityGroupIds"))
         .selfServicePortal("selfServicePortal")
         .serverCertificateArn("serverCertificateArn")
         .sessionTimeoutHours(123)
         .splitTunnel(false)
         .tagSpecifications(List.of(TagSpecificationProperty.builder()
                 .resourceType("resourceType")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .trafficIpAddressType("trafficIpAddressType")
         .transportProtocol("transportProtocol")
         .vpcId("vpcId")
         .vpnPort(123)
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnClientVpnEndpointPropsMixin.Builder	A fluent builder for CfnClientVpnEndpointPropsMixin.
static interface	CfnClientVpnEndpointPropsMixin.CertificateAuthenticationRequestProperty	Information about the client certificate to be used for authentication.
static interface	CfnClientVpnEndpointPropsMixin.ClientAuthenticationRequestProperty	Describes the authentication method to be used by a Client VPN endpoint.
static interface	CfnClientVpnEndpointPropsMixin.ClientConnectOptionsProperty	Indicates whether client connect options are enabled.
static interface	CfnClientVpnEndpointPropsMixin.ClientLoginBannerOptionsProperty	Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
static interface	CfnClientVpnEndpointPropsMixin.ClientRouteEnforcementOptionsProperty	Client Route Enforcement is a feature of Client VPN that helps enforce administrator defined routes on devices connected through the VPN.
static interface	CfnClientVpnEndpointPropsMixin.ConnectionLogOptionsProperty	Describes the client connection logging options for the Client VPN endpoint.
static interface	CfnClientVpnEndpointPropsMixin.DirectoryServiceAuthenticationRequestProperty	Describes the Active Directory to be used for client authentication.
static interface	CfnClientVpnEndpointPropsMixin.FederatedAuthenticationRequestProperty	The IAM SAML identity provider used for federated authentication.
static interface	CfnClientVpnEndpointPropsMixin.TagSpecificationProperty	Specifies the tags to apply to the Client VPN endpoint.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnClientVpnEndpointPropsMixin(CfnClientVpnEndpointMixinProps props)	Create a mixin to apply properties to AWS::EC2::ClientVpnEndpoint.
	CfnClientVpnEndpointPropsMixin(CfnClientVpnEndpointMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::EC2::ClientVpnEndpoint.
protected	CfnClientVpnEndpointPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnClientVpnEndpointPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnClientVpnEndpointMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnClientVpnEndpointPropsMixin

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

CfnClientVpnEndpointPropsMixin

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

CfnClientVpnEndpointPropsMixin

@Stability(Stable)
public CfnClientVpnEndpointPropsMixin(@NotNull
 CfnClientVpnEndpointMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::EC2::ClientVpnEndpoint.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnClientVpnEndpointPropsMixin

@Stability(Stable)
public CfnClientVpnEndpointPropsMixin(@NotNull
 CfnClientVpnEndpointMixinProps props)

Create a mixin to apply properties to AWS::EC2::ClientVpnEndpoint.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnClientVpnEndpointMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()