Skip to content

TerminateClientVpnConnectionsRequest

Source code in docs_src/capo_ec2/types/terminate_client_vpn_connections_request.py 
15
16
17
18
19
20
21
22
23
24
25
class TerminateClientVpnConnectionsRequest(TypedDict, closed=True):
    client_vpn_endpoint_id: NotRequired[
        "capo_ec2.types.client_vpn_endpoint_id.ClientVpnEndpointId"
    ]
    """<p>The ID of the Client VPN endpoint to which the client is connected.</p>"""
    connection_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the client connection to be terminated.</p>"""
    username: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""

client_vpn_endpoint_id instance-attribute 

client_vpn_endpoint_id: NotRequired[ClientVpnEndpointId]

The ID of the Client VPN endpoint to which the client is connected.

connection_id instance-attribute 

connection_id: NotRequired[String]

The ID of the client connection to be terminated.

dry_run instance-attribute 

dry_run: NotRequired[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.

username instance-attribute 

username: NotRequired[String]

The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.