@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:38.128Z") @Stability(value=Stable) public class CfnClientVpnEndpoint extends CfnResource implements IInspectable
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();
| 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.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnClientVpnEndpoint(software.constructs.Construct scope,
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) |
| Modifier and Type | Method and Description |
|---|---|
Object |
getAuthenticationOptions()
Information about the authentication method to be used to authenticate clients.
|
protected Map<String,Object> |
getCfnProperties() |
String |
getClientCidrBlock()
The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
|
Object |
getClientConnectOptions()
The options for managing connection authorization for new client connections.
|
Object |
getClientLoginBannerOptions()
Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
|
Object |
getConnectionLogOptions()
Information about the client connection logging options.
|
String |
getDescription()
A brief description of the Client VPN endpoint.
|
List<String> |
getDnsServers()
Information about the DNS servers to be used for DNS resolution.
|
List<String> |
getSecurityGroupIds()
The IDs of one or more security groups to apply to the target network.
|
String |
getSelfServicePortal()
Specify whether to enable the self-service portal for the Client VPN endpoint.
|
String |
getServerCertificateArn()
The ARN of the server certificate.
|
Number |
getSessionTimeoutHours()
The maximum VPN session duration time in hours.
|
Object |
getSplitTunnel()
Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
|
Object |
getTagSpecifications()
The tags to apply to the Client VPN endpoint during creation.
|
String |
getTransportProtocol()
The transport protocol to be used by the VPN session.
|
String |
getVpcId()
The ID of the VPC to associate with the Client VPN endpoint.
|
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 Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAuthenticationOptions(IResolvable value)
Information about the authentication method to be used to authenticate clients.
|
void |
setAuthenticationOptions(List<Object> value)
Information about the authentication method to be used to authenticate clients.
|
void |
setClientCidrBlock(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(String value)
A brief description of the Client VPN endpoint.
|
void |
setDnsServers(List<String> value)
Information about the DNS servers to be used for DNS resolution.
|
void |
setSecurityGroupIds(List<String> value)
The IDs of one or more security groups to apply to the target network.
|
void |
setSelfServicePortal(String value)
Specify whether to enable the self-service portal for the Client VPN endpoint.
|
void |
setServerCertificateArn(String value)
The ARN of the server certificate.
|
void |
setSessionTimeoutHours(Number value)
The maximum VPN session duration time in hours.
|
void |
setSplitTunnel(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(List<Object> value)
The tags to apply to the Client VPN endpoint during creation.
|
void |
setTransportProtocol(String value)
The transport protocol to be used by the VPN session.
|
void |
setVpcId(String value)
The ID of the VPC to associate with the Client VPN endpoint.
|
void |
setVpnPort(Number value)
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnClientVpnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnClientVpnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnClientVpnEndpoint(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnClientVpnEndpointProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public Object getAuthenticationOptions()
@Stability(value=Stable)
public void setAuthenticationOptions(@NotNull
IResolvable value)
@Stability(value=Stable)
public void setAuthenticationOptions(@NotNull
List<Object> value)
@Stability(value=Stable) @NotNull public String getClientCidrBlock()
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. The CIDR block should be /22 or greater.
@Stability(value=Stable)
public void setClientCidrBlock(@NotNull
String value)
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. The CIDR block should be /22 or greater.
@Stability(value=Stable) @NotNull public Object getConnectionLogOptions()
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
@Stability(value=Stable)
public void setConnectionLogOptions(@NotNull
CfnClientVpnEndpoint.ConnectionLogOptionsProperty value)
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
@Stability(value=Stable)
public void setConnectionLogOptions(@NotNull
IResolvable value)
If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:
@Stability(value=Stable) @NotNull public String getServerCertificateArn()
For more information, see the AWS Certificate Manager User Guide .
@Stability(value=Stable)
public void setServerCertificateArn(@NotNull
String value)
For more information, see the AWS Certificate Manager User Guide .
@Stability(value=Stable) @Nullable public Object getClientConnectOptions()
@Stability(value=Stable)
public void setClientConnectOptions(@Nullable
CfnClientVpnEndpoint.ClientConnectOptionsProperty value)
@Stability(value=Stable)
public void setClientConnectOptions(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getClientLoginBannerOptions()
@Stability(value=Stable)
public void setClientLoginBannerOptions(@Nullable
CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty value)
@Stability(value=Stable)
public void setClientLoginBannerOptions(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getDescription()
@Stability(value=Stable)
public void setDescription(@Nullable
String value)
@Stability(value=Stable) @Nullable public List<String> getDnsServers()
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.
@Stability(value=Stable)
public void setDnsServers(@Nullable
List<String> value)
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.
@Stability(value=Stable) @Nullable public List<String> getSecurityGroupIds()
You must also specify the ID of the VPC that contains the security groups.
@Stability(value=Stable)
public void setSecurityGroupIds(@Nullable
List<String> value)
You must also specify the ID of the VPC that contains the security groups.
@Stability(value=Stable) @Nullable public String getSelfServicePortal()
Default Value: enabled
@Stability(value=Stable)
public void setSelfServicePortal(@Nullable
String value)
Default Value: enabled
@Stability(value=Stable) @Nullable public Number getSessionTimeoutHours()
Valid values: 8 | 10 | 12 | 24
Default value: 24
@Stability(value=Stable)
public void setSessionTimeoutHours(@Nullable
Number value)
Valid values: 8 | 10 | 12 | 24
Default value: 24
@Stability(value=Stable) @Nullable public Object getSplitTunnel()
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 .
@Stability(value=Stable)
public void setSplitTunnel(@Nullable
Boolean value)
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 .
@Stability(value=Stable)
public void setSplitTunnel(@Nullable
IResolvable value)
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 .
@Stability(value=Stable) @Nullable public Object getTagSpecifications()
@Stability(value=Stable)
public void setTagSpecifications(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setTagSpecifications(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public String getTransportProtocol()
Default value: udp
@Stability(value=Stable)
public void setTransportProtocol(@Nullable
String value)
Default value: udp
@Stability(value=Stable) @Nullable public String getVpcId()
If no security group IDs are specified in the request, the default security group for the VPC is applied.
@Stability(value=Stable)
public void setVpcId(@Nullable
String value)
If no security group IDs are specified in the request, the default security group for the VPC is applied.
@Stability(value=Stable) @Nullable public Number getVpnPort()
Valid Values: 443 | 1194
Default Value: 443
@Stability(value=Stable)
public void setVpnPort(@Nullable
Number value)
Valid Values: 443 | 1194
Default Value: 443
Copyright © 2022. All rights reserved.