EC2 / Client / modify_client_vpn_endpoint

modify_client_vpn_endpoint

EC2.Client.modify_client_vpn_endpoint(**kwargs)

Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.

See also: AWS API Documentation

Request Syntax

response = client.modify_client_vpn_endpoint(
    ClientVpnEndpointId='string',
    ServerCertificateArn='string',
    ConnectionLogOptions={
        'Enabled': True|False,
        'CloudwatchLogGroup': 'string',
        'CloudwatchLogStream': 'string'
    },
    DnsServers={
        'CustomDnsServers': [
            'string',
        ],
        'Enabled': True|False
    },
    VpnPort=123,
    Description='string',
    SplitTunnel=True|False,
    DryRun=True|False,
    SecurityGroupIds=[
        'string',
    ],
    VpcId='string',
    SelfServicePortal='enabled'|'disabled',
    ClientConnectOptions={
        'Enabled': True|False,
        'LambdaFunctionArn': 'string'
    },
    SessionTimeoutHours=123,
    ClientLoginBannerOptions={
        'Enabled': True|False,
        'BannerText': 'string'
    }
)

Parameters:

• ClientVpnEndpointId (string) –

  [REQUIRED]

  The ID of the Client VPN endpoint to modify.

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

• ConnectionLogOptions (dict) –

  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

  • Enabled (boolean) –

    Indicates whether connection logging is enabled.

  • CloudwatchLogGroup (string) –

    The name of the CloudWatch Logs log group. Required if connection logging is enabled.

  • CloudwatchLogStream (string) –

    The name of the CloudWatch Logs log stream to which the connection data is published.

• DnsServers (dict) –

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

  • CustomDnsServers (list) –

    The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.

    • (string) –

  • Enabled (boolean) –

    Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.

• VpnPort (integer) –

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

  Valid Values: 443 | 1194

  Default Value: 443

• Description (string) – A brief description of the Client VPN endpoint.

• SplitTunnel (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.

• 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 (list) –

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

  • (string) –

• VpcId (string) – The ID of the VPC to associate with the Client VPN endpoint.

• SelfServicePortal (string) – Specify whether to enable the self-service portal for the Client VPN endpoint.

• ClientConnectOptions (dict) –

  The options for managing connection authorization for new client connections.

  • Enabled (boolean) –

    Indicates whether client connect options are enabled. The default is false (not enabled).

  • LambdaFunctionArn (string) –

    The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.

• SessionTimeoutHours (integer) –

  The maximum VPN session duration time in hours.

  Valid values: 8 | 10 | 12 | 24

  Default value: 24

• ClientLoginBannerOptions (dict) –

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

  • Enabled (boolean) –

    Enable or disable a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

    Valid values: true | false

    Default value: false

  • BannerText (string) –

    Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

• (dict) –

  • Return (boolean) –

    Returns true if the request succeeds; otherwise, it returns an error.