ec2/aws.sdk.kotlin.services.ec2.model/CreateClientVpnEndpointRequest/Builder

Builder

Properties

var authenticationOptions: List<ClientVpnAuthenticationRequest>?

Information about the authentication method to be used to authenticate clients.

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.

clientConnectOptions

var clientConnectOptions: ClientConnectOptions?

The options for managing connection authorization for new client connections.

clientLoginBannerOptions

var clientLoginBannerOptions: ClientLoginBannerOptions?

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

clientRouteEnforcementOptions

var clientRouteEnforcementOptions: ClientRouteEnforcementOptions?

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. 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.

clientToken

var clientToken: String?

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

connectionLogOptions

var connectionLogOptions: ConnectionLogOptions?

Information about the client connection logging options.

description

var description: String?

A brief description of the Client VPN endpoint.

disconnectOnSessionTimeout

var disconnectOnSessionTimeout: Boolean?

Indicates whether the client VPN session is disconnected after the maximum timeout specified in 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.

dnsServers

var dnsServers: List<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.

dryRun

var dryRun: Boolean?

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

securityGroupIds

var securityGroupIds: List<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.

selfServicePortal

var selfServicePortal: SelfServicePortal?

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

serverCertificateArn

var serverCertificateArn: String?

The ARN of the server certificate. For more information, see the Certificate Manager User Guide.

sessionTimeoutHours

var sessionTimeoutHours: Int?

The maximum VPN session duration time in hours.

splitTunnel

var splitTunnel: Boolean?

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

tagSpecifications

var tagSpecifications: List<TagSpecification>?

The tags to apply to the Client VPN endpoint during creation.

transportProtocol

var transportProtocol: TransportProtocol?

The transport protocol to be used by the VPN session.

vpcId

var vpcId: String?

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.

vpnPort

var vpnPort: Int?

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

Functions

clientConnectOptions

fun clientConnectOptions(block: ClientConnectOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ec2.model.ClientConnectOptions inside the given block

clientLoginBannerOptions

fun clientLoginBannerOptions(block: ClientLoginBannerOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ec2.model.ClientLoginBannerOptions inside the given block

clientRouteEnforcementOptions

fun clientRouteEnforcementOptions(block: ClientRouteEnforcementOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ec2.model.ClientRouteEnforcementOptions inside the given block

connectionLogOptions

fun connectionLogOptions(block: ConnectionLogOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.ec2.model.ConnectionLogOptions inside the given block