create_client_vpn_endpoint¶
Operation¶
async
¶
create_client_vpn_endpoint(input: CreateClientVpnEndpointInput, plugins: list[Plugin] | None = None) -> CreateClientVpnEndpointOutput
Creates 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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateClientVpnEndpointInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateClientVpnEndpointOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateClientVpnEndpointInput structure.
Attributes¶
class-attribute
instance-attribute
¶
authentication_options: list[ClientVpnAuthenticationRequest] | None = ...
Information about the authentication method to be used to authenticate clients.
class-attribute
instance-attribute
¶
client_cidr_block: str | None = ...
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.
class-attribute
instance-attribute
¶
The options for managing connection authorization for new client connections.
class-attribute
instance-attribute
¶
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
class-attribute
instance-attribute
¶
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.
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.
class-attribute
instance-attribute
¶
client_token: str | None = ...
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
class-attribute
instance-attribute
¶
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
class-attribute
instance-attribute
¶
description: str | None = ...
A brief description of the Client VPN endpoint.
class-attribute
instance-attribute
¶
The device posture options for the Client VPN endpoint. Use this parameter to specify the device trust providers that the endpoint uses to evaluate the security posture of connecting devices.
class-attribute
instance-attribute
¶
disconnect_on_session_timeout: bool | None = ...
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.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
class-attribute
instance-attribute
¶
endpoint_ip_address_type: str | None = ...
The IP address type for the Client VPN endpoint. Valid values are ipv4
(default) for IPv4 addressing only, ipv6 for IPv6 addressing only, or
dual-stack for both IPv4 and IPv6 addressing. When set to
dual-stack, clients can connect to the endpoint using either IPv4 or
IPv6 addresses..
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
self_service_portal: str | None = ...
Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
class-attribute
instance-attribute
¶
server_certificate_arn: str | None = ...
The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
class-attribute
instance-attribute
¶
session_timeout_hours: int | None = ...
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
class-attribute
instance-attribute
¶
split_tunnel: bool | None = ...
Indicates whether split-tunnel is enabled on the Client VPN endpoint.
By default, split-tunnel on a VPN endpoint is disabled.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to apply to the Client VPN endpoint during creation.
class-attribute
instance-attribute
¶
traffic_ip_address_type: str | None = ...
The IP address type for traffic within the Client VPN tunnel. Valid
values are ipv4 (default) for IPv4 traffic only, ipv6 for IPv6
addressing only, or dual-stack for both IPv4 and IPv6 traffic. When
set to dual-stack, clients can access both IPv4 and IPv6 resources
through the VPN .
class-attribute
instance-attribute
¶
The Transit Gateway configuration for the Client VPN endpoint. Use this
parameter to associate the endpoint with a Transit Gateway instead of a
VPC. You cannot specify both TransitGatewayConfiguration and
VpcId/SecurityGroupIds.
class-attribute
instance-attribute
¶
transport_protocol: str | None = ...
The transport protocol to be used by the VPN session.
Default value: udp
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateClientVpnEndpointOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_vpn_endpoint_id: str | None = ...
The ID of the Client VPN endpoint.
class-attribute
instance-attribute
¶
dns_name: str | None = ...
The DNS name to be used by clients when establishing their VPN session.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
The current state of the Client VPN endpoint.