All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnClientVpnEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:08.660Z") @Stability(Stable) public interface CfnClientVpnEndpointProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnClientVpnEndpoint.

Example:

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

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnClientVpnEndpointProps.Builder

A builder for CfnClientVpnEndpointProps

static final class

CfnClientVpnEndpointProps.Jsii$Proxy

An implementation for CfnClientVpnEndpointProps
Method Summary

Modifier and Type

Method

Description

static CfnClientVpnEndpointProps.Builder

builder()

Object

getAuthenticationOptions()

Information about the authentication method to be used to authenticate clients.

default String

getClientCidrBlock()

The IPv4 address range, in CIDR notation, from which to assign client IP addresses.

default Object

getClientConnectOptions()

The options for managing connection authorization for new client connections.

default Object

getClientLoginBannerOptions()

Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

default Object

getClientRouteEnforcementOptions()

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.

Object

getConnectionLogOptions()

Information about the client connection logging options.

default String

getDescription()

A brief description of the Client VPN endpoint.

default Object

getDisconnectOnSessionTimeout()

Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached.

default List<String>

getDnsServers()

Information about the DNS servers to be used for DNS resolution.

default List<String>

getSecurityGroupIds()

The IDs of one or more security groups to apply to the target network.

default String

getSelfServicePortal()

Specify whether to enable the self-service portal for the Client VPN endpoint.

String

getServerCertificateArn()

The ARN of the server certificate.

default Number

getSessionTimeoutHours()

The maximum VPN session duration time in hours.

default Object

getSplitTunnel()

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

default Object

getTagSpecifications()

The tags to apply to the Client VPN endpoint during creation.

default String

getTransportProtocol()

The transport protocol to be used by the VPN session.

default String

getVpcId()

The ID of the VPC to associate with the Client VPN endpoint.

default Number

getVpnPort()

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAuthenticationOptions
  
  @Stability(Stable) @NotNull Object getAuthenticationOptions()
  
  Information about the authentication method to be used to authenticate clients.
  Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnClientVpnEndpoint.ClientAuthenticationRequestProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-authenticationoptions
- getConnectionLogOptions
  
  @Stability(Stable) @NotNull Object getConnectionLogOptions()
  Information about the client connection logging options.
  If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
  
  Client connection requests
  
  Client connection results (successful and unsuccessful)
  
  Reasons for unsuccessful client connection requests
  
  Client connection termination time
  
  Returns union: either IResolvable or CfnClientVpnEndpoint.ConnectionLogOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-connectionlogoptions
- getServerCertificateArn
  
  @Stability(Stable) @NotNull String getServerCertificateArn()
  
  The ARN of the server certificate.
  For more information, see the Certificate Manager User Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-servercertificatearn
- getClientCidrBlock
  
  @Stability(Stable) @Nullable default String getClientCidrBlock()
  
  The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
  The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientcidrblock
- getClientConnectOptions
  
  @Stability(Stable) @Nullable default Object getClientConnectOptions()
  
  The options for managing connection authorization for new client connections.
  Returns union: either IResolvable or CfnClientVpnEndpoint.ClientConnectOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientconnectoptions
- getClientLoginBannerOptions
  
  @Stability(Stable) @Nullable default Object getClientLoginBannerOptions()
  
  Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
  Returns union: either IResolvable or CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions
- getClientRouteEnforcementOptions
  
  @Stability(Stable) @Nullable default Object getClientRouteEnforcementOptions()
  
  Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.
  T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
  Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
  Returns union: either IResolvable or CfnClientVpnEndpoint.ClientRouteEnforcementOptionsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientrouteenforcementoptions
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  A brief description of the Client VPN endpoint.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-description
- getDisconnectOnSessionTimeout
  
  @Stability(Stable) @Nullable default Object getDisconnectOnSessionTimeout()
  
  Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached.
  If true , users are prompted to reconnect client VPN. If false , client VPN attempts to reconnect automatically. The default value is true .
  Returns union: either Boolean or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-disconnectonsessiontimeout
- getDnsServers
  
  @Stability(Stable) @Nullable default List<String> getDnsServers()
  
  Information about the DNS servers to be used for DNS resolution.
  A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-dnsservers
- getSecurityGroupIds
  
  @Stability(Stable) @Nullable default List<String> getSecurityGroupIds()
  
  The IDs of one or more security groups to apply to the target network.
  You must also specify the ID of the VPC that contains the security groups.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-securitygroupids
- getSelfServicePortal
  
  @Stability(Stable) @Nullable default String getSelfServicePortal()
  
  Specify whether to enable the self-service portal for the Client VPN endpoint.
  Default Value: enabled
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-selfserviceportal
- getSessionTimeoutHours
  
  @Stability(Stable) @Nullable default Number getSessionTimeoutHours()
  
  The maximum VPN session duration time in hours.
  Valid values: 8 | 10 | 12 | 24
  Default value: 24
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-sessiontimeouthours
- getSplitTunnel
  
  @Stability(Stable) @Nullable default Object getSplitTunnel()
  
  Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
  By default, split-tunnel on a VPN endpoint is disabled.
  For information about split-tunnel VPN endpoints, see Split-tunnel AWS Client VPN endpoint in the AWS Client VPN Administrator Guide .
  Returns union: either Boolean or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel
- getTagSpecifications
  
  @Stability(Stable) @Nullable default Object getTagSpecifications()
  
  The tags to apply to the Client VPN endpoint during creation.
  Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnClientVpnEndpoint.TagSpecificationProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-tagspecifications
- getTransportProtocol
  
  @Stability(Stable) @Nullable default String getTransportProtocol()
  
  The transport protocol to be used by the VPN session.
  Default value: udp
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-transportprotocol
- getVpcId
  
  @Stability(Stable) @Nullable default String getVpcId()
  
  The ID of the VPC to associate with the Client VPN endpoint.
  If no security group IDs are specified in the request, the default security group for the VPC is applied.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpcid
- getVpnPort
  
  @Stability(Stable) @Nullable default Number getVpnPort()
  
  The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
  Valid Values: 443 | 1194
  Default Value: 443
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpnport
- builder
  
  @Stability(Stable) static CfnClientVpnEndpointProps.Builder builder()
  
  Returns:
  
  a CfnClientVpnEndpointProps.Builder of CfnClientVpnEndpointProps

Interface CfnClientVpnEndpointProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAuthenticationOptions

getConnectionLogOptions

getServerCertificateArn

getClientCidrBlock

getClientConnectOptions

getClientLoginBannerOptions

getClientRouteEnforcementOptions

getDescription

getDisconnectOnSessionTimeout

getDnsServers

getSecurityGroupIds

getSelfServicePortal

getSessionTimeoutHours

getSplitTunnel

getTagSpecifications

getTransportProtocol

getVpcId

getVpnPort

builder