modify_client_vpn_endpoint¶
Operation¶
async
¶
modify_client_vpn_endpoint(input: ModifyClientVpnEndpointInput, plugins: list[Plugin] | None = None) -> ModifyClientVpnEndpointOutput
Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyClientVpnEndpointInput
|
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 |
|---|---|
ModifyClientVpnEndpointOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyClientVpnEndpointInput structure.
Attributes¶
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_vpn_endpoint_id: str | None = ...
The ID of the Client VPN endpoint to modify.
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. Specifying this
parameter replaces the entire device posture configuration for the
endpoint. To disable device posture and remove all device trust
providers, specify false for Enabled.
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 by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.
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
¶
The IDs of one or more security groups to apply to the target network.
class-attribute
instance-attribute
¶
self_service_portal: str | None = ...
Specify whether to enable the self-service portal for the Client VPN endpoint.
class-attribute
instance-attribute
¶
server_certificate_arn: str | None = ...
The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).
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 the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
class-attribute
instance-attribute
¶
The Transit Gateway configuration for the Client VPN endpoint. This option is currently not supported.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyClientVpnEndpointOutput structure.