Package software.amazon.awscdk.services.ec2

Class CfnClientVpnEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnClientVpnEndpoint
All Implemented Interfaces:
IInspectable, IClientVpnEndpointRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:02.840Z") @Stability(Stable) public class CfnClientVpnEndpoint extends CfnResource implements IInspectable, IClientVpnEndpointRef
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.services.ec2.*;
 CfnClientVpnEndpoint cfnClientVpnEndpoint = CfnClientVpnEndpoint.Builder.create(this, "MyCfnClientVpnEndpoint")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnClientVpnEndpoint

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

    • CfnClientVpnEndpoint

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

    • CfnClientVpnEndpoint

      @Stability(Stable) public CfnClientVpnEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnClientVpnEndpointProps props)
      Create a new AWS::EC2::ClientVpnEndpoint.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromClientVpnEndpointId

      @Stability(Stable) @NotNull public static IClientVpnEndpointRef fromClientVpnEndpointId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String clientVpnEndpointId)
      Creates a new IClientVpnEndpointRef from a clientVpnEndpointId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      clientVpnEndpointId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getClientVpnEndpointRef

      @Stability(Stable) @NotNull public ClientVpnEndpointReference getClientVpnEndpointRef()
      A reference to a ClientVpnEndpoint resource.
      Specified by:
      getClientVpnEndpointRef in interface IClientVpnEndpointRef

    • getAuthenticationOptions

      @Stability(Stable) @NotNull public 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>

    • setAuthenticationOptions

      @Stability(Stable) public void setAuthenticationOptions(@NotNull IResolvable value)
      Information about the authentication method to be used to authenticate clients.

    • setAuthenticationOptions

      @Stability(Stable) public void setAuthenticationOptions(@NotNull List<Object> value)
      Information about the authentication method to be used to authenticate clients.

    • getConnectionLogOptions

      @Stability(Stable) @NotNull public Object getConnectionLogOptions()
      Information about the client connection logging options.

      Returns union: either IResolvable or CfnClientVpnEndpoint.ConnectionLogOptionsProperty

    • setConnectionLogOptions

      @Stability(Stable) public void setConnectionLogOptions(@NotNull IResolvable value)
      Information about the client connection logging options.

    • setConnectionLogOptions

      @Stability(Stable) public void setConnectionLogOptions(@NotNull CfnClientVpnEndpoint.ConnectionLogOptionsProperty value)
      Information about the client connection logging options.

    • getServerCertificateArn

      @Stability(Stable) @NotNull public String getServerCertificateArn()
      The ARN of the server certificate.

    • setServerCertificateArn

      @Stability(Stable) public void setServerCertificateArn(@NotNull String value)
      The ARN of the server certificate.

    • getClientCidrBlock

      @Stability(Stable) @Nullable public String getClientCidrBlock()
      The IPv4 address range, in CIDR notation, from which to assign client IP addresses.

    • setClientCidrBlock

      @Stability(Stable) public void setClientCidrBlock(@Nullable String value)
      The IPv4 address range, in CIDR notation, from which to assign client IP addresses.

    • getClientConnectOptions

      @Stability(Stable) @Nullable public Object getClientConnectOptions()
      The options for managing connection authorization for new client connections.

      Returns union: either IResolvable or CfnClientVpnEndpoint.ClientConnectOptionsProperty

    • setClientConnectOptions

      @Stability(Stable) public void setClientConnectOptions(@Nullable IResolvable value)
      The options for managing connection authorization for new client connections.

    • setClientConnectOptions

      @Stability(Stable) public void setClientConnectOptions(@Nullable CfnClientVpnEndpoint.ClientConnectOptionsProperty value)
      The options for managing connection authorization for new client connections.

    • getClientLoginBannerOptions

      @Stability(Stable) @Nullable public 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

    • setClientLoginBannerOptions

      @Stability(Stable) public void setClientLoginBannerOptions(@Nullable IResolvable value)
      Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

    • setClientLoginBannerOptions

      @Stability(Stable) public void setClientLoginBannerOptions(@Nullable CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty value)
      Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

    • getClientRouteEnforcementOptions

      @Stability(Stable) @Nullable public 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.

      Returns union: either IResolvable or CfnClientVpnEndpoint.ClientRouteEnforcementOptionsProperty

    • setClientRouteEnforcementOptions

      @Stability(Stable) public void setClientRouteEnforcementOptions(@Nullable IResolvable value)
      Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.

    • setClientRouteEnforcementOptions

      @Stability(Stable) public void setClientRouteEnforcementOptions(@Nullable CfnClientVpnEndpoint.ClientRouteEnforcementOptionsProperty value)
      Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A brief description of the Client VPN endpoint.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A brief description of the Client VPN endpoint.

    • getDisconnectOnSessionTimeout

      @Stability(Stable) @Nullable public Object getDisconnectOnSessionTimeout()
      Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached.

      Returns union: either Boolean or IResolvable

    • setDisconnectOnSessionTimeout

      @Stability(Stable) public void setDisconnectOnSessionTimeout(@Nullable Boolean value)
      Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached.

    • setDisconnectOnSessionTimeout

      @Stability(Stable) public void setDisconnectOnSessionTimeout(@Nullable IResolvable value)
      Indicates whether the client VPN session is disconnected after the maximum sessionTimeoutHours is reached.

    • getDnsServers

      @Stability(Stable) @Nullable public List<String> getDnsServers()
      Information about the DNS servers to be used for DNS resolution.

    • setDnsServers

      @Stability(Stable) public void setDnsServers(@Nullable List<String> value)
      Information about the DNS servers to be used for DNS resolution.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      The IDs of one or more security groups to apply to the target network.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      The IDs of one or more security groups to apply to the target network.

    • getSelfServicePortal

      @Stability(Stable) @Nullable public String getSelfServicePortal()
      Specify whether to enable the self-service portal for the Client VPN endpoint.

    • setSelfServicePortal

      @Stability(Stable) public void setSelfServicePortal(@Nullable String value)
      Specify whether to enable the self-service portal for the Client VPN endpoint.

    • getSessionTimeoutHours

      @Stability(Stable) @Nullable public Number getSessionTimeoutHours()
      The maximum VPN session duration time in hours.

    • setSessionTimeoutHours

      @Stability(Stable) public void setSessionTimeoutHours(@Nullable Number value)
      The maximum VPN session duration time in hours.

    • getSplitTunnel

      @Stability(Stable) @Nullable public Object getSplitTunnel()
      Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

      Returns union: either Boolean or IResolvable

    • setSplitTunnel

      @Stability(Stable) public void setSplitTunnel(@Nullable Boolean value)
      Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

    • setSplitTunnel

      @Stability(Stable) public void setSplitTunnel(@Nullable IResolvable value)
      Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

    • getTagSpecifications

      @Stability(Stable) @Nullable public 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>

    • setTagSpecifications

      @Stability(Stable) public void setTagSpecifications(@Nullable IResolvable value)
      The tags to apply to the Client VPN endpoint during creation.

    • setTagSpecifications

      @Stability(Stable) public void setTagSpecifications(@Nullable List<Object> value)
      The tags to apply to the Client VPN endpoint during creation.

    • getTransportProtocol

      @Stability(Stable) @Nullable public String getTransportProtocol()
      The transport protocol to be used by the VPN session.

    • setTransportProtocol

      @Stability(Stable) public void setTransportProtocol(@Nullable String value)
      The transport protocol to be used by the VPN session.

    • getVpcId

      @Stability(Stable) @Nullable public String getVpcId()
      The ID of the VPC to associate with the Client VPN endpoint.

    • setVpcId

      @Stability(Stable) public void setVpcId(@Nullable String value)
      The ID of the VPC to associate with the Client VPN endpoint.

    • getVpnPort

      @Stability(Stable) @Nullable public Number getVpnPort()
      The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

    • setVpnPort

      @Stability(Stable) public void setVpnPort(@Nullable Number value)
      The port number to assign to the Client VPN endpoint for TCP and UDP traffic.