Skip to content

ModifyClientVpnEndpointRequest

Source code in docs_src/capo_ec2/types/modify_client_vpn_endpoint_request.py
class ModifyClientVpnEndpointRequest(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 modify.</p>"""
    server_certificate_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).</p>"""
    connection_log_options: NotRequired[
        "capo_ec2.types.connection_log_options.ConnectionLogOptions"
    ]
    """<p>Information about the client connection logging options.</p> <p>If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:</p> <ul> <li> <p>Client connection requests</p> </li> <li> <p>Client connection results (successful and unsuccessful)</p> </li> <li> <p>Reasons for unsuccessful client connection requests</p> </li> <li> <p>Client connection termination time</p> </li> </ul>"""
    dns_servers: NotRequired[
        "capo_ec2.types.dns_servers_options_modify_structure.DnsServersOptionsModifyStructure"
    ]
    """<p>Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.</p>"""
    vpn_port: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The port number to assign to the Client VPN endpoint for TCP and UDP traffic.</p> <p>Valid Values: <code>443</code> | <code>1194</code> </p> <p>Default Value: <code>443</code> </p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>A brief description of the Client VPN endpoint.</p>"""
    split_tunnel: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the VPN is split-tunnel.</p> <p>For information about split-tunnel VPN endpoints, see <a href="https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html">Split-tunnel Client VPN endpoint</a> in the <i>Client VPN Administrator Guide</i>.</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>"""
    security_group_ids: NotRequired[
        "capo_ec2.types.client_vpn_security_group_id_set.ClientVpnSecurityGroupIdSet"
    ]
    """<p>The IDs of one or more security groups to apply to the target network.</p>"""
    vpc_id: NotRequired["capo_ec2.types.vpc_id.VpcId"]
    """<p>The ID of the VPC to associate with the Client VPN endpoint.</p>"""
    self_service_portal: NotRequired[
        "capo_ec2.types.self_service_portal.SelfServicePortal"
    ]
    """<p>Specify whether to enable the self-service portal for the Client VPN endpoint.</p>"""
    client_connect_options: NotRequired[
        "capo_ec2.types.client_connect_options.ClientConnectOptions"
    ]
    """<p>The options for managing connection authorization for new client connections.</p>"""
    session_timeout_hours: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The maximum VPN session duration time in hours.</p> <p>Valid values: <code>8 | 10 | 12 | 24</code> </p> <p>Default value: <code>24</code> </p>"""
    client_login_banner_options: NotRequired[
        "capo_ec2.types.client_login_banner_options.ClientLoginBannerOptions"
    ]
    """<p>Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.</p>"""
    client_route_enforcement_options: NotRequired[
        "capo_ec2.types.client_route_enforcement_options.ClientRouteEnforcementOptions"
    ]
    """<p>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.</p> <p>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.</p>"""
    disconnect_on_session_timeout: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the client VPN session is disconnected after the maximum timeout specified in <code>sessionTimeoutHours</code> is reached. If <code>true</code>, users are prompted to reconnect client VPN. If <code>false</code>, client VPN attempts to reconnect automatically. The default value is <code>true</code>.</p>"""
    transit_gateway_configuration: NotRequired[
        "capo_ec2.types.transit_gateway_configuration_input_structure.TransitGatewayConfigurationInputStructure"
    ]
    """<p>The Transit Gateway configuration for the Client VPN endpoint. This option is currently not supported.</p>"""
    device_posture_options: NotRequired[
        "capo_ec2.types.device_posture_options.DevicePostureOptions"
    ]
    """<p>The device posture options for the Client VPN endpoint. Specifying this parameter replaces the entire device posture configuration for the endpoint. To remove all device trust providers, specify an empty list.</p>"""

client_connect_options instance-attribute

client_connect_options: NotRequired[ClientConnectOptions]

The options for managing connection authorization for new client connections.

client_login_banner_options instance-attribute

client_login_banner_options: NotRequired[ClientLoginBannerOptions]

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

client_route_enforcement_options instance-attribute

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

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.

client_vpn_endpoint_id instance-attribute

client_vpn_endpoint_id: NotRequired[ClientVpnEndpointId]

The ID of the Client VPN endpoint to modify.

connection_log_options instance-attribute

connection_log_options: NotRequired[ConnectionLogOptions]

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

description instance-attribute

description: NotRequired[String]

A brief description of the Client VPN endpoint.

device_posture_options instance-attribute

device_posture_options: NotRequired[DevicePostureOptions]

The device posture options for the Client VPN endpoint. Specifying this parameter replaces the entire device posture configuration for the endpoint. To remove all device trust providers, specify an empty list.

disconnect_on_session_timeout instance-attribute

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

dns_servers instance-attribute

dns_servers: NotRequired[DnsServersOptionsModifyStructure]

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

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.

security_group_ids instance-attribute

security_group_ids: NotRequired[ClientVpnSecurityGroupIdSet]

The IDs of one or more security groups to apply to the target network.

self_service_portal instance-attribute

self_service_portal: NotRequired[SelfServicePortal]

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

server_certificate_arn instance-attribute

server_certificate_arn: NotRequired[String]

The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).

session_timeout_hours instance-attribute

session_timeout_hours: NotRequired[Integer]

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

split_tunnel instance-attribute

split_tunnel: NotRequired[Boolean]

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.

transit_gateway_configuration instance-attribute

transit_gateway_configuration: NotRequired[TransitGatewayConfigurationInputStructure]

The Transit Gateway configuration for the Client VPN endpoint. This option is currently not supported.

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]

The ID of the VPC to associate with the Client VPN endpoint.

vpn_port instance-attribute

vpn_port: NotRequired[Integer]

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

Valid Values: 443 | 1194

Default Value: 443