Package software.amazon.awscdk.services.ec2

Class ClientVpnEndpointOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ec2.ClientVpnEndpointOptions.Jsii$Proxy

All Implemented Interfaces:

ClientVpnEndpointOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ClientVpnEndpointOptions

@Stability(Stable)
@Internal
public static final class ClientVpnEndpointOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ClientVpnEndpointOptions

An implementation for ClientVpnEndpointOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.ClientVpnEndpointOptions

ClientVpnEndpointOptions.Builder, ClientVpnEndpointOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(ClientVpnEndpointOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the ClientVpnEndpointOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Boolean	getAuthorizeAllUsersToVpcCidr()	Whether to authorize all users to the VPC CIDR.
final String	getCidr()	The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
final String	getClientCertificateArn()	The ARN of the client certificate for mutual authentication.
final IClientVpnConnectionHandler	getClientConnectionHandler()	The AWS Lambda function used for connection authorization.
final String	getClientLoginBanner()	Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established.
final ClientRouteEnforcementOptions	getClientRouteEnforcementOptions()	Options for Client Route Enforcement.
final String	getDescription()	A brief description of the Client VPN endpoint.
final Boolean	getDisconnectOnSessionTimeout()	Indicates whether the client VPN session is disconnected after the maximum sessionTimeout is reached.
final List<String>	getDnsServers()	Information about the DNS servers to be used for DNS resolution.
final Boolean	getLogging()	Whether to enable connections logging.
final ILogGroup	getLogGroup()	A CloudWatch Logs log group for connection logging.
final ILogStream	getLogStream()	A CloudWatch Logs log stream for connection logging.
final VpnPort	getPort()	The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
final List<ISecurityGroup>	getSecurityGroups()	The security groups to apply to the target network.
final Boolean	getSelfServicePortal()	Specify whether to enable the self-service portal for the Client VPN endpoint.
final String	getServerCertificateArn()	The ARN of the server certificate.
final ClientVpnSessionTimeout	getSessionTimeout()	The maximum VPN session duration time.
final Boolean	getSplitTunnel()	Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
final TransportProtocol	getTransportProtocol()	The transport protocol to be used by the VPN session.
final ClientVpnUserBasedAuthentication	getUserBasedAuthentication()	The type of user-based authentication to use.
final SubnetSelection	getVpcSubnets()	Subnets to associate to the client VPN endpoint.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(ClientVpnEndpointOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the ClientVpnEndpointOptions.Builder.

Method Details

getCidr

public final String getCidr()

Description copied from interface: ClientVpnEndpointOptions

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.

Changing the address range will replace the Client VPN endpoint.

The CIDR block should be /22 or greater.

Specified by:

getCidr in interface ClientVpnEndpointOptions

getServerCertificateArn

public final String getServerCertificateArn()

Description copied from interface: ClientVpnEndpointOptions

The ARN of the server certificate.

Specified by:

getServerCertificateArn in interface ClientVpnEndpointOptions

getAuthorizeAllUsersToVpcCidr

public final Boolean getAuthorizeAllUsersToVpcCidr()

Description copied from interface: ClientVpnEndpointOptions

Whether to authorize all users to the VPC CIDR.

This automatically creates an authorization rule. Set this to false and use addAuthorizationRule() to create your own rules instead.

Default: true

Specified by:

getAuthorizeAllUsersToVpcCidr in interface ClientVpnEndpointOptions

getClientCertificateArn

public final String getClientCertificateArn()

Description copied from interface: ClientVpnEndpointOptions

The ARN of the client certificate for mutual authentication.

The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).

Default: - use user-based authentication

Specified by:

getClientCertificateArn in interface ClientVpnEndpointOptions

getClientConnectionHandler

public final IClientVpnConnectionHandler getClientConnectionHandler()

Description copied from interface: ClientVpnEndpointOptions

The AWS Lambda function used for connection authorization.

The name of the Lambda function must begin with the AWSClientVPN- prefix

Default: - no connection handler

Specified by:

getClientConnectionHandler in interface ClientVpnEndpointOptions

getClientLoginBanner

public final String getClientLoginBanner()

Description copied from interface: ClientVpnEndpointOptions

Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established.

UTF-8 encoded characters only. Maximum of 1400 characters.

Default: - no banner is presented to the client

Specified by:

getClientLoginBanner in interface ClientVpnEndpointOptions

getClientRouteEnforcementOptions

public final ClientRouteEnforcementOptions getClientRouteEnforcementOptions()

Description copied from interface: ClientVpnEndpointOptions

Options for Client Route Enforcement.

Client Route Enforcement is a feature of Client VPN that helps enforce administrator defined routes on devices connected through the VPN. This feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

Default: undefined - AWS Client VPN default setting is disable client route enforcement

Specified by:

getClientRouteEnforcementOptions in interface ClientVpnEndpointOptions

See Also:

• https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-cre.html

getDescription

public final String getDescription()

Description copied from interface: ClientVpnEndpointOptions

A brief description of the Client VPN endpoint.

Default: - no description

Specified by:

getDescription in interface ClientVpnEndpointOptions

getDisconnectOnSessionTimeout

public final Boolean getDisconnectOnSessionTimeout()

Description copied from interface: ClientVpnEndpointOptions

Indicates whether the client VPN session is disconnected after the maximum sessionTimeout is reached.

If true, users are prompted to reconnect client VPN. If false, client VPN attempts to reconnect automatically.

Default: undefined - AWS Client VPN default is true

Specified by:

getDisconnectOnSessionTimeout in interface ClientVpnEndpointOptions

See Also:

• https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-max-duration.html

getDnsServers

public final List<String> getDnsServers()

Description copied from interface: ClientVpnEndpointOptions

Information about the DNS servers to be used for DNS resolution.

A Client VPN endpoint can have up to two DNS servers.

Default: - use the DNS address configured on the device

Specified by:

getDnsServers in interface ClientVpnEndpointOptions

getLogging

public final Boolean getLogging()

Description copied from interface: ClientVpnEndpointOptions

Whether to enable connections logging.

Default: true

Specified by:

getLogging in interface ClientVpnEndpointOptions

getLogGroup

public final ILogGroup getLogGroup()

Description copied from interface: ClientVpnEndpointOptions

A CloudWatch Logs log group for connection logging.

Default: - a new group is created

Specified by:

getLogGroup in interface ClientVpnEndpointOptions

getLogStream

public final ILogStream getLogStream()

Description copied from interface: ClientVpnEndpointOptions

A CloudWatch Logs log stream for connection logging.

Default: - a new stream is created

Specified by:

getLogStream in interface ClientVpnEndpointOptions

getPort

public final VpnPort getPort()

Description copied from interface: ClientVpnEndpointOptions

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Default: VpnPort.HTTPS

Specified by:

getPort in interface ClientVpnEndpointOptions

getSecurityGroups

public final List<ISecurityGroup> getSecurityGroups()

Description copied from interface: ClientVpnEndpointOptions

The security groups to apply to the target network.

Default: - a new security group is created

Specified by:

getSecurityGroups in interface ClientVpnEndpointOptions

getSelfServicePortal

public final Boolean getSelfServicePortal()

Description copied from interface: ClientVpnEndpointOptions

Specify whether to enable the self-service portal for the Client VPN endpoint.

Default: true

Specified by:

getSelfServicePortal in interface ClientVpnEndpointOptions

getSessionTimeout

public final ClientVpnSessionTimeout getSessionTimeout()

Description copied from interface: ClientVpnEndpointOptions

The maximum VPN session duration time.

Default: ClientVpnSessionTimeout.TWENTY_FOUR_HOURS

Specified by:

getSessionTimeout in interface ClientVpnEndpointOptions

getSplitTunnel

public final Boolean getSplitTunnel()

Description copied from interface: ClientVpnEndpointOptions

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

Default: false

Specified by:

getSplitTunnel in interface ClientVpnEndpointOptions

See Also:

• https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html

getTransportProtocol

public final TransportProtocol getTransportProtocol()

Description copied from interface: ClientVpnEndpointOptions

The transport protocol to be used by the VPN session.

Default: TransportProtocol.UDP

Specified by:

getTransportProtocol in interface ClientVpnEndpointOptions

getUserBasedAuthentication

public final ClientVpnUserBasedAuthentication getUserBasedAuthentication()

Description copied from interface: ClientVpnEndpointOptions

The type of user-based authentication to use.

Default: - use mutual authentication

Specified by:

getUserBasedAuthentication in interface ClientVpnEndpointOptions

See Also:

• https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/client-authentication.html

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: ClientVpnEndpointOptions

Subnets to associate to the client VPN endpoint.

Default: - the VPC default strategy

Specified by:

getVpcSubnets in interface ClientVpnEndpointOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object