CfnClientVpnEndpoint L1 construct
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
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnClientVpnEndpoint = new ec2.CfnClientVpnEndpoint(this, 'MyCfnClientVpnEndpoint', {
authenticationOptions: [{
type: 'type',
// the properties below are optional
activeDirectory: {
directoryId: 'directoryId',
},
federatedAuthentication: {
samlProviderArn: 'samlProviderArn',
// the properties below are optional
selfServiceSamlProviderArn: 'selfServiceSamlProviderArn',
},
mutualAuthentication: {
clientRootCertificateChainArn: 'clientRootCertificateChainArn',
},
}],
connectionLogOptions: {
enabled: false,
// the properties below are optional
cloudwatchLogGroup: 'cloudwatchLogGroup',
cloudwatchLogStream: 'cloudwatchLogStream',
includeAuthorizationPolicyContext: false,
},
serverCertificateArn: 'serverCertificateArn',
// the properties below are optional
authorizationPolicy: {
policyDocument: 'policyDocument',
// the properties below are optional
description: 'description',
shadowMode: 'shadowMode',
},
clientCidrBlock: 'clientCidrBlock',
clientConnectOptions: {
enabled: false,
// the properties below are optional
lambdaFunctionArn: 'lambdaFunctionArn',
},
clientLoginBannerOptions: {
enabled: false,
// the properties below are optional
bannerText: 'bannerText',
},
clientRouteEnforcementOptions: {
enforced: false,
},
description: 'description',
devicePostureOptions: {
enabled: false,
trustProviders: [{
tenantId: 'tenantId',
trustProviderType: 'trustProviderType',
// the properties below are optional
publicSigningKeyUrl: 'publicSigningKeyUrl',
}],
},
disconnectOnSessionTimeout: false,
dnsServers: ['dnsServers'],
endpointIpAddressType: 'endpointIpAddressType',
securityGroupIds: ['securityGroupIds'],
selfServicePortal: 'selfServicePortal',
sessionTimeoutHours: 123,
splitTunnel: false,
tagSpecifications: [{
resourceType: 'resourceType',
tags: [{
key: 'key',
value: 'value',
}],
}],
trafficIpAddressType: 'trafficIpAddressType',
transitGatewayConfiguration: {
transitGatewayId: 'transitGatewayId',
// the properties below are optional
availabilityZoneIds: ['availabilityZoneIds'],
availabilityZones: ['availabilityZones'],
},
transportProtocol: 'transportProtocol',
vpcId: 'vpcId',
vpnPort: 123,
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2
cfn_client_vpn_endpoint = ec2.CfnClientVpnEndpoint(self, "MyCfnClientVpnEndpoint",
authentication_options=[ec2.CfnClientVpnEndpoint.ClientAuthenticationRequestProperty(
type="type",
# the properties below are optional
active_directory=ec2.CfnClientVpnEndpoint.DirectoryServiceAuthenticationRequestProperty(
directory_id="directoryId"
),
federated_authentication=ec2.CfnClientVpnEndpoint.FederatedAuthenticationRequestProperty(
saml_provider_arn="samlProviderArn",
# the properties below are optional
self_service_saml_provider_arn="selfServiceSamlProviderArn"
),
mutual_authentication=ec2.CfnClientVpnEndpoint.CertificateAuthenticationRequestProperty(
client_root_certificate_chain_arn="clientRootCertificateChainArn"
)
)],
connection_log_options=ec2.CfnClientVpnEndpoint.ConnectionLogOptionsProperty(
enabled=False,
# the properties below are optional
cloudwatch_log_group="cloudwatchLogGroup",
cloudwatch_log_stream="cloudwatchLogStream",
include_authorization_policy_context=False
),
server_certificate_arn="serverCertificateArn",
# the properties below are optional
authorization_policy=ec2.CfnClientVpnEndpoint.AuthorizationPolicyProperty(
policy_document="policyDocument",
# the properties below are optional
description="description",
shadow_mode="shadowMode"
),
client_cidr_block="clientCidrBlock",
client_connect_options=ec2.CfnClientVpnEndpoint.ClientConnectOptionsProperty(
enabled=False,
# the properties below are optional
lambda_function_arn="lambdaFunctionArn"
),
client_login_banner_options=ec2.CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty(
enabled=False,
# the properties below are optional
banner_text="bannerText"
),
client_route_enforcement_options=ec2.CfnClientVpnEndpoint.ClientRouteEnforcementOptionsProperty(
enforced=False
),
description="description",
device_posture_options=ec2.CfnClientVpnEndpoint.DevicePostureOptionsProperty(
enabled=False,
trust_providers=[ec2.CfnClientVpnEndpoint.DevicePostureTrustProviderProperty(
tenant_id="tenantId",
trust_provider_type="trustProviderType",
# the properties below are optional
public_signing_key_url="publicSigningKeyUrl"
)]
),
disconnect_on_session_timeout=False,
dns_servers=["dnsServers"],
endpoint_ip_address_type="endpointIpAddressType",
security_group_ids=["securityGroupIds"],
self_service_portal="selfServicePortal",
session_timeout_hours=123,
split_tunnel=False,
tag_specifications=[ec2.CfnClientVpnEndpoint.TagSpecificationProperty(
resource_type="resourceType",
tags=[CfnTag(
key="key",
value="value"
)]
)],
traffic_ip_address_type="trafficIpAddressType",
transit_gateway_configuration=ec2.CfnClientVpnEndpoint.TransitGatewayConfigurationProperty(
transit_gateway_id="transitGatewayId",
# the properties below are optional
availability_zone_ids=["availabilityZoneIds"],
availability_zones=["availabilityZones"]
),
transport_protocol="transportProtocol",
vpc_id="vpcId",
vpn_port=123
)
java
// 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")
.includeAuthorizationPolicyContext(false)
.build())
.serverCertificateArn("serverCertificateArn")
// the properties below are optional
.authorizationPolicy(AuthorizationPolicyProperty.builder()
.policyDocument("policyDocument")
// the properties below are optional
.description("description")
.shadowMode("shadowMode")
.build())
.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")
.devicePostureOptions(DevicePostureOptionsProperty.builder()
.enabled(false)
.trustProviders(List.of(DevicePostureTrustProviderProperty.builder()
.tenantId("tenantId")
.trustProviderType("trustProviderType")
// the properties below are optional
.publicSigningKeyUrl("publicSigningKeyUrl")
.build()))
.build())
.disconnectOnSessionTimeout(false)
.dnsServers(List.of("dnsServers"))
.endpointIpAddressType("endpointIpAddressType")
.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()))
.trafficIpAddressType("trafficIpAddressType")
.transitGatewayConfiguration(TransitGatewayConfigurationProperty.builder()
.transitGatewayId("transitGatewayId")
// the properties below are optional
.availabilityZoneIds(List.of("availabilityZoneIds"))
.availabilityZones(List.of("availabilityZones"))
.build())
.transportProtocol("transportProtocol")
.vpcId("vpcId")
.vpnPort(123)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var cfnClientVpnEndpoint = new CfnClientVpnEndpoint(this, "MyCfnClientVpnEndpoint", new CfnClientVpnEndpointProps {
AuthenticationOptions = new [] { new ClientAuthenticationRequestProperty {
Type = "type",
// the properties below are optional
ActiveDirectory = new DirectoryServiceAuthenticationRequestProperty {
DirectoryId = "directoryId"
},
FederatedAuthentication = new FederatedAuthenticationRequestProperty {
SamlProviderArn = "samlProviderArn",
// the properties below are optional
SelfServiceSamlProviderArn = "selfServiceSamlProviderArn"
},
MutualAuthentication = new CertificateAuthenticationRequestProperty {
ClientRootCertificateChainArn = "clientRootCertificateChainArn"
}
} },
ConnectionLogOptions = new ConnectionLogOptionsProperty {
Enabled = false,
// the properties below are optional
CloudwatchLogGroup = "cloudwatchLogGroup",
CloudwatchLogStream = "cloudwatchLogStream",
IncludeAuthorizationPolicyContext = false
},
ServerCertificateArn = "serverCertificateArn",
// the properties below are optional
AuthorizationPolicy = new AuthorizationPolicyProperty {
PolicyDocument = "policyDocument",
// the properties below are optional
Description = "description",
ShadowMode = "shadowMode"
},
ClientCidrBlock = "clientCidrBlock",
ClientConnectOptions = new ClientConnectOptionsProperty {
Enabled = false,
// the properties below are optional
LambdaFunctionArn = "lambdaFunctionArn"
},
ClientLoginBannerOptions = new ClientLoginBannerOptionsProperty {
Enabled = false,
// the properties below are optional
BannerText = "bannerText"
},
ClientRouteEnforcementOptions = new ClientRouteEnforcementOptionsProperty {
Enforced = false
},
Description = "description",
DevicePostureOptions = new DevicePostureOptionsProperty {
Enabled = false,
TrustProviders = new [] { new DevicePostureTrustProviderProperty {
TenantId = "tenantId",
TrustProviderType = "trustProviderType",
// the properties below are optional
PublicSigningKeyUrl = "publicSigningKeyUrl"
} }
},
DisconnectOnSessionTimeout = false,
DnsServers = new [] { "dnsServers" },
EndpointIpAddressType = "endpointIpAddressType",
SecurityGroupIds = new [] { "securityGroupIds" },
SelfServicePortal = "selfServicePortal",
SessionTimeoutHours = 123,
SplitTunnel = false,
TagSpecifications = new [] { new TagSpecificationProperty {
ResourceType = "resourceType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
} },
TrafficIpAddressType = "trafficIpAddressType",
TransitGatewayConfiguration = new TransitGatewayConfigurationProperty {
TransitGatewayId = "transitGatewayId",
// the properties below are optional
AvailabilityZoneIds = new [] { "availabilityZoneIds" },
AvailabilityZones = new [] { "availabilityZones" }
},
TransportProtocol = "transportProtocol",
VpcId = "vpcId",
VpnPort = 123
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnClientVpnEndpoint := awscdk.Aws_ec2.NewCfnClientVpnEndpoint(this, jsii.String("MyCfnClientVpnEndpoint"), &CfnClientVpnEndpointProps{
AuthenticationOptions: []interface{}{
&ClientAuthenticationRequestProperty{
Type: jsii.String("type"),
// the properties below are optional
ActiveDirectory: &DirectoryServiceAuthenticationRequestProperty{
DirectoryId: jsii.String("directoryId"),
},
FederatedAuthentication: &FederatedAuthenticationRequestProperty{
SamlProviderArn: jsii.String("samlProviderArn"),
// the properties below are optional
SelfServiceSamlProviderArn: jsii.String("selfServiceSamlProviderArn"),
},
MutualAuthentication: &CertificateAuthenticationRequestProperty{
ClientRootCertificateChainArn: jsii.String("clientRootCertificateChainArn"),
},
},
},
ConnectionLogOptions: &ConnectionLogOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
CloudwatchLogGroup: jsii.String("cloudwatchLogGroup"),
CloudwatchLogStream: jsii.String("cloudwatchLogStream"),
IncludeAuthorizationPolicyContext: jsii.Boolean(false),
},
ServerCertificateArn: jsii.String("serverCertificateArn"),
// the properties below are optional
AuthorizationPolicy: &AuthorizationPolicyProperty{
PolicyDocument: jsii.String("policyDocument"),
// the properties below are optional
Description: jsii.String("description"),
ShadowMode: jsii.String("shadowMode"),
},
ClientCidrBlock: jsii.String("clientCidrBlock"),
ClientConnectOptions: &ClientConnectOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
LambdaFunctionArn: jsii.String("lambdaFunctionArn"),
},
ClientLoginBannerOptions: &ClientLoginBannerOptionsProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
BannerText: jsii.String("bannerText"),
},
ClientRouteEnforcementOptions: &ClientRouteEnforcementOptionsProperty{
Enforced: jsii.Boolean(false),
},
Description: jsii.String("description"),
DevicePostureOptions: &DevicePostureOptionsProperty{
Enabled: jsii.Boolean(false),
TrustProviders: []interface{}{
&DevicePostureTrustProviderProperty{
TenantId: jsii.String("tenantId"),
TrustProviderType: jsii.String("trustProviderType"),
// the properties below are optional
PublicSigningKeyUrl: jsii.String("publicSigningKeyUrl"),
},
},
},
DisconnectOnSessionTimeout: jsii.Boolean(false),
DnsServers: []*string{
jsii.String("dnsServers"),
},
EndpointIpAddressType: jsii.String("endpointIpAddressType"),
SecurityGroupIds: []*string{
jsii.String("securityGroupIds"),
},
SelfServicePortal: jsii.String("selfServicePortal"),
SessionTimeoutHours: jsii.Number(123),
SplitTunnel: jsii.Boolean(false),
TagSpecifications: []interface{}{
&TagSpecificationProperty{
ResourceType: jsii.String("resourceType"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
},
},
TrafficIpAddressType: jsii.String("trafficIpAddressType"),
TransitGatewayConfiguration: &TransitGatewayConfigurationProperty{
TransitGatewayId: jsii.String("transitGatewayId"),
// the properties below are optional
AvailabilityZoneIds: []*string{
jsii.String("availabilityZoneIds"),
},
AvailabilityZones: []*string{
jsii.String("availabilityZones"),
},
},
TransportProtocol: jsii.String("transportProtocol"),
VpcId: jsii.String("vpcId"),
VpnPort: jsii.Number(123),
})
Initializer
ts
new CfnClientVpnEndpoint(scope: Construct, id: string, props: CfnClientVpnEndpointProps)
python
CfnClientVpnEndpoint(scope: Construct, id: str, props: CfnClientVpnEndpointProps)
java
new CfnClientVpnEndpoint(Construct scope, String id, CfnClientVpnEndpointProps props)
csharp
new CfnClientVpnEndpoint(Construct scope, string id, CfnClientVpnEndpointProps props)
go
NewCfnClientVpnEndpoint(Scope Construct, Id *string, Props CfnClientVpnEndpointProps)
Construct Props
authenticationOptionsIResolvable | IResolvable | CfnClientVpnEndpoint.ClientAuthenticationRequestProperty[]authentication_optionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ClientAuthenticationRequestProperty]]]authenticationOptionsIResolvableAuthenticationOptionsIResolvableAuthenticationOptionsinterface{}required#Information about the authentication method to be used to authenticate clients.
authorizationPolicyoptionalIResolvable | CfnClientVpnEndpoint.AuthorizationPolicyPropertyauthorization_policyoptionaltyping.Union[IResolvable, AuthorizationPolicyProperty]authorizationPolicyoptionalIResolvableAuthorizationPolicyoptionalIResolvableAuthorizationPolicyoptionalinterface{}#clientCidrBlockoptionalstringclient_cidr_blockoptionalstrclientCidrBlockoptionalStringClientCidrBlockoptionalstringClientCidrBlockoptional*string#The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
notes
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.
clientConnectOptionsoptionalIResolvable | CfnClientVpnEndpoint.ClientConnectOptionsPropertyclient_connect_optionsoptionaltyping.Union[IResolvable, ClientConnectOptionsProperty]clientConnectOptionsoptionalIResolvableClientConnectOptionsoptionalIResolvableClientConnectOptionsoptionalinterface{}#The options for managing connection authorization for new client connections.
clientLoginBannerOptionsoptionalIResolvable | CfnClientVpnEndpoint.ClientLoginBannerOptionsPropertyclient_login_banner_optionsoptionaltyping.Union[IResolvable, ClientLoginBannerOptionsProperty]clientLoginBannerOptionsoptionalIResolvableClientLoginBannerOptionsoptionalIResolvableClientLoginBannerOptionsoptionalinterface{}#Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
clientRouteEnforcementOptionsoptionalIResolvable | CfnClientVpnEndpoint.ClientRouteEnforcementOptionsPropertyclient_route_enforcement_optionsoptionaltyping.Union[IResolvable, ClientRouteEnforcementOptionsProperty]clientRouteEnforcementOptionsoptionalIResolvableClientRouteEnforcementOptionsoptionalIResolvableClientRouteEnforcementOptionsoptionalinterface{}#Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.
notes
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.
connectionLogOptionsIResolvable | CfnClientVpnEndpoint.ConnectionLogOptionsPropertyconnection_log_optionstyping.Union[IResolvable, ConnectionLogOptionsProperty]connectionLogOptionsIResolvableConnectionLogOptionsIResolvableConnectionLogOptionsinterface{}required#Information about the client connection logging options.
notes
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
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A brief description of the Client VPN endpoint.
devicePostureOptionsoptionalIResolvable | CfnClientVpnEndpoint.DevicePostureOptionsPropertydevice_posture_optionsoptionaltyping.Union[IResolvable, DevicePostureOptionsProperty]devicePostureOptionsoptionalIResolvableDevicePostureOptionsoptionalIResolvableDevicePostureOptionsoptionalinterface{}#disconnectOnSessionTimeoutoptionalboolean | IResolvabledisconnect_on_session_timeoutoptionaltyping.Union[bool, IResolvable]disconnectOnSessionTimeoutoptionalBooleanDisconnectOnSessionTimeoutoptionalboolDisconnectOnSessionTimeoutoptionalinterface{}#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 .
dnsServersoptionalstring[]dns_serversoptionaltyping.List[str]dnsServersoptionalList<String>DnsServersoptionalstring[]DnsServersoptional*[]*string#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.
endpointIpAddressTypeoptionalstringendpoint_ip_address_typeoptionalstrendpointIpAddressTypeoptionalStringEndpointIpAddressTypeoptionalstringEndpointIpAddressTypeoptional*string#The IP address type of the Client VPN endpoint.
Possible values are ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.
securityGroupIdsoptionalstring[]security_group_idsoptionaltyping.List[str]securityGroupIdsoptionalList<String>SecurityGroupIdsoptionalstring[]SecurityGroupIdsoptional*[]*string#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.
selfServicePortaloptionalstringself_service_portaloptionalstrselfServicePortaloptionalStringSelfServicePortaloptionalstringSelfServicePortaloptional*string#Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
serverCertificateArnstringserver_certificate_arnstrserverCertificateArnStringServerCertificateArnstringServerCertificateArn*stringrequired#The ARN of the server certificate.
For more information, see the Certificate Manager User Guide .
sessionTimeoutHoursoptionalnumbersession_timeout_hoursoptionalint | floatsessionTimeoutHoursoptionalNumberSessionTimeoutHoursoptionaldoubleSessionTimeoutHoursoptional*float64#The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
splitTunneloptionalboolean | IResolvablesplit_tunneloptionaltyping.Union[bool, IResolvable]splitTunneloptionalBooleanSplitTunneloptionalboolSplitTunneloptionalinterface{}#Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
notes
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 .
tagSpecificationsoptionalIResolvable | IResolvable | CfnClientVpnEndpoint.TagSpecificationProperty[]tag_specificationsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TagSpecificationProperty]]]tagSpecificationsoptionalIResolvableTagSpecificationsoptionalIResolvableTagSpecificationsoptionalinterface{}#The tags to apply to the Client VPN endpoint during creation.
trafficIpAddressTypeoptionalstringtraffic_ip_address_typeoptionalstrtrafficIpAddressTypeoptionalStringTrafficIpAddressTypeoptionalstringTrafficIpAddressTypeoptional*string#The IP address type of the Client VPN endpoint.
Possible values are either ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.
transitGatewayConfigurationoptionalIResolvable | CfnClientVpnEndpoint.TransitGatewayConfigurationPropertytransit_gateway_configurationoptionaltyping.Union[IResolvable, TransitGatewayConfigurationProperty]transitGatewayConfigurationoptionalIResolvableTransitGatewayConfigurationoptionalIResolvableTransitGatewayConfigurationoptionalinterface{}#transportProtocoloptionalstringtransport_protocoloptionalstrtransportProtocoloptionalStringTransportProtocoloptionalstringTransportProtocoloptional*string#The transport protocol to be used by the VPN session.
Default value: udp
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.
vpnPortoptionalnumbervpn_portoptionalint | floatvpnPortoptionalNumberVpnPortoptionaldoubleVpnPortoptional*float64#The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
Properties
authenticationOptionsIResolvable | IResolvable | CfnClientVpnEndpoint.ClientAuthenticationRequestProperty[]authentication_optionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ClientAuthenticationRequestProperty]]]authenticationOptionsIResolvableAuthenticationOptionsIResolvableAuthenticationOptionsinterface{}#Information about the authentication method to be used to authenticate clients.
authorizationPolicymay be undefinedIResolvable | CfnClientVpnEndpoint.AuthorizationPolicyPropertyauthorization_policymay be undefinedtyping.Union[IResolvable, AuthorizationPolicyProperty]authorizationPolicymay be undefinedIResolvableAuthorizationPolicymay be undefinedIResolvableAuthorizationPolicymay be undefinedinterface{}#CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#AWS resource type.
clientCidrBlockmay be undefinedstringclient_cidr_blockmay be undefinedstrclientCidrBlockmay be undefinedStringClientCidrBlockmay be undefinedstringClientCidrBlockmay be undefined*string#The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
clientConnectOptionsmay be undefinedIResolvable | CfnClientVpnEndpoint.ClientConnectOptionsPropertyclient_connect_optionsmay be undefinedtyping.Union[IResolvable, ClientConnectOptionsProperty]clientConnectOptionsmay be undefinedIResolvableClientConnectOptionsmay be undefinedIResolvableClientConnectOptionsmay be undefinedinterface{}#The options for managing connection authorization for new client connections.
clientLoginBannerOptionsmay be undefinedIResolvable | CfnClientVpnEndpoint.ClientLoginBannerOptionsPropertyclient_login_banner_optionsmay be undefinedtyping.Union[IResolvable, ClientLoginBannerOptionsProperty]clientLoginBannerOptionsmay be undefinedIResolvableClientLoginBannerOptionsmay be undefinedIResolvableClientLoginBannerOptionsmay be undefinedinterface{}#Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
clientRouteEnforcementOptionsmay be undefinedIResolvable | CfnClientVpnEndpoint.ClientRouteEnforcementOptionsPropertyclient_route_enforcement_optionsmay be undefinedtyping.Union[IResolvable, ClientRouteEnforcementOptionsProperty]clientRouteEnforcementOptionsmay be undefinedIResolvableClientRouteEnforcementOptionsmay be undefinedIResolvableClientRouteEnforcementOptionsmay be undefinedinterface{}#Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.
clientVpnEndpointRefClientVpnEndpointReferenceclient_vpn_endpoint_refClientVpnEndpointReferenceclientVpnEndpointRefClientVpnEndpointReferenceClientVpnEndpointRefClientVpnEndpointReferenceClientVpnEndpointRefClientVpnEndpointReference#A reference to a ClientVpnEndpoint resource.
connectionLogOptionsIResolvable | CfnClientVpnEndpoint.ConnectionLogOptionsPropertyconnection_log_optionstyping.Union[IResolvable, ConnectionLogOptionsProperty]connectionLogOptionsIResolvableConnectionLogOptionsIResolvableConnectionLogOptionsinterface{}#Information about the client connection logging options.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#A brief description of the Client VPN endpoint.
devicePostureOptionsmay be undefinedIResolvable | CfnClientVpnEndpoint.DevicePostureOptionsPropertydevice_posture_optionsmay be undefinedtyping.Union[IResolvable, DevicePostureOptionsProperty]devicePostureOptionsmay be undefinedIResolvableDevicePostureOptionsmay be undefinedIResolvableDevicePostureOptionsmay be undefinedinterface{}#disconnectOnSessionTimeoutmay be undefinedboolean | IResolvabledisconnect_on_session_timeoutmay be undefinedtyping.Union[bool, IResolvable]disconnectOnSessionTimeoutmay be undefinedBooleanDisconnectOnSessionTimeoutmay be undefinedboolDisconnectOnSessionTimeoutmay be undefinedinterface{}#Indicates whether the client VPN session is disconnected after the maximum `sessionTimeoutHours` is reached.
dnsServersmay be undefinedstring[]dns_serversmay be undefinedtyping.List[str]dnsServersmay be undefinedList<String>DnsServersmay be undefinedstring[]DnsServersmay be undefined*[]*string#Information about the DNS servers to be used for DNS resolution.
endpointIpAddressTypemay be undefinedstringendpoint_ip_address_typemay be undefinedstrendpointIpAddressTypemay be undefinedStringEndpointIpAddressTypemay be undefinedstringEndpointIpAddressTypemay be undefined*string#The IP address type of the Client VPN endpoint.
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
securityGroupIdsmay be undefinedstring[]security_group_idsmay be undefinedtyping.List[str]securityGroupIdsmay be undefinedList<String>SecurityGroupIdsmay be undefinedstring[]SecurityGroupIdsmay be undefined*[]*string#The IDs of one or more security groups to apply to the target network.
selfServicePortalmay be undefinedstringself_service_portalmay be undefinedstrselfServicePortalmay be undefinedStringSelfServicePortalmay be undefinedstringSelfServicePortalmay be undefined*string#Specify whether to enable the self-service portal for the Client VPN endpoint.
serverCertificateArnstringserver_certificate_arnstrserverCertificateArnStringServerCertificateArnstringServerCertificateArn*string#The ARN of the server certificate.
sessionTimeoutHoursmay be undefinednumbersession_timeout_hoursmay be undefinedint | floatsessionTimeoutHoursmay be undefinedNumberSessionTimeoutHoursmay be undefineddoubleSessionTimeoutHoursmay be undefined*float64#The maximum VPN session duration time in hours.
splitTunnelmay be undefinedboolean | IResolvablesplit_tunnelmay be undefinedtyping.Union[bool, IResolvable]splitTunnelmay be undefinedBooleanSplitTunnelmay be undefinedboolSplitTunnelmay be undefinedinterface{}#Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tagSpecificationsmay be undefinedIResolvable | IResolvable | CfnClientVpnEndpoint.TagSpecificationProperty[]tag_specificationsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TagSpecificationProperty]]]tagSpecificationsmay be undefinedIResolvableTagSpecificationsmay be undefinedIResolvableTagSpecificationsmay be undefinedinterface{}#The tags to apply to the Client VPN endpoint during creation.
trafficIpAddressTypemay be undefinedstringtraffic_ip_address_typemay be undefinedstrtrafficIpAddressTypemay be undefinedStringTrafficIpAddressTypemay be undefinedstringTrafficIpAddressTypemay be undefined*string#The IP address type of the Client VPN endpoint.
transitGatewayConfigurationmay be undefinedIResolvable | CfnClientVpnEndpoint.TransitGatewayConfigurationPropertytransit_gateway_configurationmay be undefinedtyping.Union[IResolvable, TransitGatewayConfigurationProperty]transitGatewayConfigurationmay be undefinedIResolvableTransitGatewayConfigurationmay be undefinedIResolvableTransitGatewayConfigurationmay be undefinedinterface{}#transportProtocolmay be undefinedstringtransport_protocolmay be undefinedstrtransportProtocolmay be undefinedStringTransportProtocolmay be undefinedstringTransportProtocolmay be undefined*string#The transport protocol to be used by the VPN session.
vpcIdmay be undefinedstringvpc_idmay be undefinedstrvpcIdmay be undefinedStringVpcIdmay be undefinedstringVpcIdmay be undefined*string#The ID of the VPC to associate with the Client VPN endpoint.
vpnPortmay be undefinednumbervpn_portmay be undefinedint | floatvpnPortmay be undefinedNumberVpnPortmay be undefineddoubleVpnPortmay be undefined*float64#The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
arnForClientVpnEndpoint(resource: IClientVpnEndpointRef): string@staticmethod def arn_for_client_vpn_endpoint(resource: IClientVpnEndpointRef) -> strpublic static String arnForClientVpnEndpoint(IClientVpnEndpointRef resource)public static string ArnForClientVpnEndpoint(IClientVpnEndpointRef resource)func ArnForClientVpnEndpoint(Resource IClientVpnEndpointRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#fromClientVpnEndpointId(scope: Construct, id: string, clientVpnEndpointId: string): IClientVpnEndpointRef@staticmethod def from_client_vpn_endpoint_id(scope: Construct, id: str, client_vpn_endpoint_id: str) -> IClientVpnEndpointRefpublic static IClientVpnEndpointRef fromClientVpnEndpointId(Construct scope, String id, String clientVpnEndpointId)public static IClientVpnEndpointRef FromClientVpnEndpointId(Construct scope, string id, string clientVpnEndpointId)func FromClientVpnEndpointId(Scope Construct, Id *string, ClientVpnEndpointId *string) IClientVpnEndpointRefstatic#Creates a new IClientVpnEndpointRef from a clientVpnEndpointId.
getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnClientVpnEndpoint(x: any): boolean@staticmethod def is_cfn_client_vpn_endpoint(x: Any) -> boolpublic static Boolean isCfnClientVpnEndpoint(Object x)public static bool IsCfnClientVpnEndpoint(object x)func IsCfnClientVpnEndpoint(X interface{}) *boolstatic#Checks whether the given object is a CfnClientVpnEndpoint.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.