CfnClientVpnEndpoint

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.ec2.CfnClientVpnEndpoint

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:21.468Z")
public class CfnClientVpnEndpoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::EC2::ClientVpnEndpoint`.

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()))
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnClientVpnEndpoint.Builder` A fluent builder for `CfnClientVpnEndpoint`.
`static interface`	`CfnClientVpnEndpoint.CertificateAuthenticationRequestProperty` Information about the client certificate to be used for authentication.
`static interface`	`CfnClientVpnEndpoint.ClientAuthenticationRequestProperty` Describes the authentication method to be used by a Client VPN endpoint.
`static interface`	`CfnClientVpnEndpoint.ClientConnectOptionsProperty` Indicates whether client connect options are enabled.
`static interface`	`CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty` Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
`static interface`	`CfnClientVpnEndpoint.ConnectionLogOptionsProperty` Describes the client connection logging options for the Client VPN endpoint.
`static interface`	`CfnClientVpnEndpoint.DirectoryServiceAuthenticationRequestProperty` Describes the Active Directory to be used for client authentication.
`static interface`	`CfnClientVpnEndpoint.FederatedAuthenticationRequestProperty` The IAM SAML identity provider used for federated authentication.
`static interface`	`CfnClientVpnEndpoint.TagSpecificationProperty` The tags to apply to a resource when the resource is being created.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnClientVpnEndpoint(Construct scope, java.lang.String id, CfnClientVpnEndpointProps props)` Create a new `AWS::EC2::ClientVpnEndpoint`.
`protected`	`CfnClientVpnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnClientVpnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAuthenticationOptions()` Information about the authentication method to be used to authenticate clients.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getClientCidrBlock()` The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
`java.lang.Object`	`getClientConnectOptions()` The options for managing connection authorization for new client connections.
`java.lang.Object`	`getClientLoginBannerOptions()` Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
`java.lang.Object`	`getConnectionLogOptions()` Information about the client connection logging options.
`java.lang.String`	`getDescription()` A brief description of the Client VPN endpoint.
`java.util.List<java.lang.String>`	`getDnsServers()` Information about the DNS servers to be used for DNS resolution.
`java.util.List<java.lang.String>`	`getSecurityGroupIds()` The IDs of one or more security groups to apply to the target network.
`java.lang.String`	`getSelfServicePortal()` Specify whether to enable the self-service portal for the Client VPN endpoint.
`java.lang.String`	`getServerCertificateArn()` The ARN of the server certificate.
`java.lang.Number`	`getSessionTimeoutHours()` The maximum VPN session duration time in hours.
`java.lang.Object`	`getSplitTunnel()` Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
`java.lang.Object`	`getTagSpecifications()` The tags to apply to the Client VPN endpoint during creation.
`java.lang.String`	`getTransportProtocol()` The transport protocol to be used by the VPN session.
`java.lang.String`	`getVpcId()` The ID of the VPC to associate with the Client VPN endpoint.
`java.lang.Number`	`getVpnPort()` The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAuthenticationOptions(IResolvable value)` Information about the authentication method to be used to authenticate clients.
`void`	`setAuthenticationOptions(java.util.List<java.lang.Object> value)` Information about the authentication method to be used to authenticate clients.
`void`	`setClientCidrBlock(java.lang.String value)` The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
`void`	`setClientConnectOptions(CfnClientVpnEndpoint.ClientConnectOptionsProperty value)` The options for managing connection authorization for new client connections.
`void`	`setClientConnectOptions(IResolvable value)` The options for managing connection authorization for new client connections.
`void`	`setClientLoginBannerOptions(CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty value)` Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
`void`	`setClientLoginBannerOptions(IResolvable value)` Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
`void`	`setConnectionLogOptions(CfnClientVpnEndpoint.ConnectionLogOptionsProperty value)` Information about the client connection logging options.
`void`	`setConnectionLogOptions(IResolvable value)` Information about the client connection logging options.
`void`	`setDescription(java.lang.String value)` A brief description of the Client VPN endpoint.
`void`	`setDnsServers(java.util.List<java.lang.String> value)` Information about the DNS servers to be used for DNS resolution.
`void`	`setSecurityGroupIds(java.util.List<java.lang.String> value)` The IDs of one or more security groups to apply to the target network.
`void`	`setSelfServicePortal(java.lang.String value)` Specify whether to enable the self-service portal for the Client VPN endpoint.
`void`	`setServerCertificateArn(java.lang.String value)` The ARN of the server certificate.
`void`	`setSessionTimeoutHours(java.lang.Number value)` The maximum VPN session duration time in hours.
`void`	`setSplitTunnel(java.lang.Boolean value)` Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
`void`	`setSplitTunnel(IResolvable value)` Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
`void`	`setTagSpecifications(IResolvable value)` The tags to apply to the Client VPN endpoint during creation.
`void`	`setTagSpecifications(java.util.List<java.lang.Object> value)` The tags to apply to the Client VPN endpoint during creation.
`void`	`setTransportProtocol(java.lang.String value)` The transport protocol to be used by the VPN session.
`void`	`setVpcId(java.lang.String value)` The ID of the VPC to associate with the Client VPN endpoint.
`void`	`setVpnPort(java.lang.Number value)` The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnClientVpnEndpoint
```
protected CfnClientVpnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnClientVpnEndpoint
```
protected CfnClientVpnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnClientVpnEndpoint
```
public CfnClientVpnEndpoint(Construct scope,
                            java.lang.String id,
                            CfnClientVpnEndpointProps props)
```
    Create a new `AWS::EC2::ClientVpnEndpoint`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getAuthenticationOptions
```
public java.lang.Object getAuthenticationOptions()
```
    Information about the authentication method to be used to authenticate clients.
  - setAuthenticationOptions
```
public void setAuthenticationOptions(IResolvable value)
```
    Information about the authentication method to be used to authenticate clients.
  - setAuthenticationOptions
```
public void setAuthenticationOptions(java.util.List<java.lang.Object> value)
```
    Information about the authentication method to be used to authenticate clients.
  - getClientCidrBlock
```
public java.lang.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.
  - setClientCidrBlock
```
public void setClientCidrBlock(java.lang.String value)
```
    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
```
public java.lang.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
  - setConnectionLogOptions
```
public void setConnectionLogOptions(IResolvable value)
```
    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
  - setConnectionLogOptions
```
public void setConnectionLogOptions(CfnClientVpnEndpoint.ConnectionLogOptionsProperty value)
```
    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
```
public java.lang.String getServerCertificateArn()
```
    The ARN of the server certificate.
    For more information, see the AWS Certificate Manager User Guide .
  - setServerCertificateArn
```
public void setServerCertificateArn(java.lang.String value)
```
    The ARN of the server certificate.
    For more information, see the AWS Certificate Manager User Guide .
  - getClientConnectOptions
```
public java.lang.Object getClientConnectOptions()
```
    The options for managing connection authorization for new client connections.
  - setClientConnectOptions
```
public void setClientConnectOptions(IResolvable value)
```
    The options for managing connection authorization for new client connections.
  - setClientConnectOptions
```
public void setClientConnectOptions(CfnClientVpnEndpoint.ClientConnectOptionsProperty value)
```
    The options for managing connection authorization for new client connections.
  - getClientLoginBannerOptions
```
public java.lang.Object getClientLoginBannerOptions()
```
    Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
  - setClientLoginBannerOptions
```
public void setClientLoginBannerOptions(IResolvable value)
```
    Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
  - setClientLoginBannerOptions
```
public void setClientLoginBannerOptions(CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty value)
```
    Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
  - getDescription
```
public java.lang.String getDescription()
```
    A brief description of the Client VPN endpoint.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    A brief description of the Client VPN endpoint.
  - getDnsServers
```
public java.util.List<java.lang.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.
  - setDnsServers
```
public void setDnsServers(java.util.List<java.lang.String> value)
```
    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
```
public java.util.List<java.lang.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.
  - setSecurityGroupIds
```
public void setSecurityGroupIds(java.util.List<java.lang.String> value)
```
    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
```
public java.lang.String getSelfServicePortal()
```
    Specify whether to enable the self-service portal for the Client VPN endpoint.
    Default Value: enabled
  - setSelfServicePortal
```
public void setSelfServicePortal(java.lang.String value)
```
    Specify whether to enable the self-service portal for the Client VPN endpoint.
    Default Value: enabled
  - getSessionTimeoutHours
```
public java.lang.Number getSessionTimeoutHours()
```
    The maximum VPN session duration time in hours.
    Valid values: 8 | 10 | 12 | 24
    Default value: 24
  - setSessionTimeoutHours
```
public void setSessionTimeoutHours(java.lang.Number value)
```
    The maximum VPN session duration time in hours.
    Valid values: 8 | 10 | 12 | 24
    Default value: 24
  - getSplitTunnel
```
public java.lang.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 .
  - setSplitTunnel
```
public void setSplitTunnel(java.lang.Boolean value)
```
    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 .
  - setSplitTunnel
```
public void setSplitTunnel(IResolvable value)
```
    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
```
public java.lang.Object getTagSpecifications()
```
    The tags to apply to the Client VPN endpoint during creation.
  - setTagSpecifications
```
public void setTagSpecifications(IResolvable value)
```
    The tags to apply to the Client VPN endpoint during creation.
  - setTagSpecifications
```
public void setTagSpecifications(java.util.List<java.lang.Object> value)
```
    The tags to apply to the Client VPN endpoint during creation.
  - getTransportProtocol
```
public java.lang.String getTransportProtocol()
```
    The transport protocol to be used by the VPN session.
    Default value: udp
  - setTransportProtocol
```
public void setTransportProtocol(java.lang.String value)
```
    The transport protocol to be used by the VPN session.
    Default value: udp
  - getVpcId
```
public java.lang.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.
  - setVpcId
```
public void setVpcId(java.lang.String value)
```
    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
```
public java.lang.Number getVpnPort()
```
    The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
    Valid Values: 443 | 1194
    Default Value: 443
  - setVpnPort
```
public void setVpnPort(java.lang.Number value)
```
    The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
    Valid Values: 443 | 1194
    Default Value: 443

Class CfnClientVpnEndpoint

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnClientVpnEndpoint

CfnClientVpnEndpoint

CfnClientVpnEndpoint

Method Detail

inspect

renderProperties

getCfnProperties

getAuthenticationOptions

setAuthenticationOptions

setAuthenticationOptions

getClientCidrBlock

setClientCidrBlock

getConnectionLogOptions

setConnectionLogOptions

setConnectionLogOptions

getServerCertificateArn

setServerCertificateArn

getClientConnectOptions

setClientConnectOptions

setClientConnectOptions

getClientLoginBannerOptions

setClientLoginBannerOptions

setClientLoginBannerOptions

getDescription

setDescription

getDnsServers

setDnsServers

getSecurityGroupIds

setSecurityGroupIds

getSelfServicePortal

setSelfServicePortal

getSessionTimeoutHours

setSessionTimeoutHours

getSplitTunnel

setSplitTunnel

setSplitTunnel

getTagSpecifications

setTagSpecifications

setTagSpecifications

getTransportProtocol

setTransportProtocol

getVpcId

setVpcId

getVpnPort

setVpnPort