Package software.amazon.awscdk.services.ec2

Interface CfnClientVpnEndpointProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnClientVpnEndpointProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.451Z") @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()))
         .clientCidrBlock("clientCidrBlock")
         .connectionLogOptions(ConnectionLogOptionsProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .cloudwatchLogGroup("cloudwatchLogGroup")
                 .cloudwatchLogStream("cloudwatchLogStream")
                 .build())
         .serverCertificateArn("serverCertificateArn")
         // the properties below are optional
         .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())
         .description("description")
         .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();

  • Method Details

    • getAuthenticationOptions

      @Stability(Stable) @NotNull Object getAuthenticationOptions()
      Information about the authentication method to be used to authenticate clients.

    • getClientCidrBlock

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

    • 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

    • getServerCertificateArn

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

      For more information, see the AWS Certificate Manager User Guide .

    • getClientConnectOptions

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

    • 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.

    • getDescription

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

    • 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.

    • 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.

    • getSelfServicePortal

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

      Default Value: enabled

    • getSessionTimeoutHours

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

      Valid values: 8 | 10 | 12 | 24

      Default value: 24

    • 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 .

    • getTagSpecifications

      @Stability(Stable) @Nullable default Object getTagSpecifications()
      The tags to apply to the Client VPN endpoint during creation.

    • getTransportProtocol

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

      Default value: udp

    • 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.

    • 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

    • builder

      @Stability(Stable) static CfnClientVpnEndpointProps.Builder builder()
      Returns:
      a CfnClientVpnEndpointProps.Builder of CfnClientVpnEndpointProps