Amazon Elastic Compute Cloud

{'SplitTunnel': 'boolean'}

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.

See also: AWS API Documentation

Request Syntax

client.create_client_vpn_endpoint(
    ClientCidrBlock='string',
    ServerCertificateArn='string',
    AuthenticationOptions=[
        {
            'Type': 'certificate-authentication'|'directory-service-authentication',
            'ActiveDirectory': {
                'DirectoryId': 'string'
            },
            'MutualAuthentication': {
                'ClientRootCertificateChainArn': 'string'
            }
        },
    ],
    ConnectionLogOptions={
        'Enabled': True|False,
        'CloudwatchLogGroup': 'string',
        'CloudwatchLogStream': 'string'
    },
    DnsServers=[
        'string',
    ],
    TransportProtocol='tcp'|'udp',
    Description='string',
    SplitTunnel=True|False,
    DryRun=True|False,
    ClientToken='string',
    TagSpecifications=[
        {
            'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'fleet'|'fpga-image'|'host-reservation'|'image'|'instance'|'internet-gateway'|'launch-template'|'natgateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

type ClientCidrBlock

string

param ClientCidrBlock

[REQUIRED]

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. The CIDR block should be /22 or greater.

type ServerCertificateArn

string

param ServerCertificateArn

[REQUIRED]

The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide .

type AuthenticationOptions

list

param AuthenticationOptions

[REQUIRED]

Information about the authentication method to be used to authenticate clients.

• (dict) --

  Describes the authentication method to be used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. For more information, see Authentication in the AWS Client VPN Administrator Guide .

  • Type (string) --

    The type of client authentication to be used. Specify certificate-authentication to use certificate-based authentication, or directory-service-authentication to use Active Directory authentication.

  • ActiveDirectory (dict) --

    Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication .

    • DirectoryId (string) --

      The ID of the Active Directory to be used for authentication.

  • MutualAuthentication (dict) --

    Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication .

    • ClientRootCertificateChainArn (string) --

      The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).

type ConnectionLogOptions

dict

param ConnectionLogOptions

[REQUIRED]

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.

• CloudwatchLogStream (string) --

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

type DnsServers

list

param DnsServers

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 of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.

• (string) --

type TransportProtocol

string

param TransportProtocol

The transport protocol to be used by the VPN session.

Default value: udp

type Description

string

param Description

A brief description of the Client VPN endpoint.

type SplitTunnel

boolean

param SplitTunnel

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint endpoint.

By default, split-tunnel on a VPN endpoint is disabled.

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide .

type DryRun

boolean

param DryRun

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 .

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency .

This field is autopopulated if not provided.

type TagSpecifications

list

param TagSpecifications

The tags to apply to the Client VPN endpoint during creation.

• (dict) --

  The tags to apply to a resource when the resource is being created.

  • ResourceType (string) --

    The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | dedicated-host | fleet | instance | launch-template | snapshot | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume .

    To tag a resource after it has been created, see CreateTags .

  • Tags (list) --

    The tags to apply to the resource.

    • (dict) --

      Describes a tag.

      • Key (string) --

        The key of the tag.

        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .

      • Value (string) --

        The value of the tag.

        Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

rtype

dict

returns

Response Syntax

{
    'ClientVpnEndpointId': 'string',
    'Status': {
        'Code': 'pending-associate'|'available'|'deleting'|'deleted',
        'Message': 'string'
    },
    'DnsName': 'string'
}

Response Structure

• (dict) --

  • ClientVpnEndpointId (string) --

    The ID of the Client VPN endpoint.

  • Status (dict) --

    The current state of the Client VPN endpoint.

    • Code (string) --

      The state of the Client VPN endpoint. Possible states include:

      • pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.

      • available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.

      • deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.

      • deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.

    • Message (string) --

      A message about the status of the Client VPN endpoint.

  • DnsName (string) --

    The DNS name to be used by clients when establishing their VPN session.

{'AllRegions': 'boolean'}

{'Regions': {'OptInStatus': 'string'}}

Describes the Regions that are enabled for your account, or all Regions.

For a list of the Regions supported by Amazon EC2, see Regions and Endpoints .

For information about enabling and disabling Regions for your account, see Managing AWS Regions in the AWS General Reference .

See also: AWS API Documentation

Request Syntax

client.describe_regions(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    RegionNames=[
        'string',
    ],
    DryRun=True|False,
    AllRegions=True|False
)

type Filters

list

param Filters

The filters.

• endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com ).

• region-name - The name of the Region (for example, us-east-1 ).

• (dict) --

  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:

  • DescribeAvailabilityZones

  • DescribeImages

  • DescribeInstances

  • DescribeKeyPairs

  • DescribeSecurityGroups

  • DescribeSnapshots

  • DescribeSubnets

  • DescribeTags

  • DescribeVolumes

  • DescribeVpcs

  • Name (string) --

    The name of the filter. Filter names are case-sensitive.

  • Values (list) --

    The filter values. Filter values are case-sensitive.

    • (string) --

type RegionNames

list

param RegionNames

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

• (string) --

type DryRun

boolean

param DryRun

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 .

type AllRegions

boolean

param AllRegions

Indicates whether to display all Regions, including Regions that are disabled for your account.

rtype

dict

returns

Response Syntax

{
    'Regions': [
        {
            'Endpoint': 'string',
            'RegionName': 'string',
            'OptInStatus': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • Regions (list) --

    Information about the Regions.

    • (dict) --

      Describes a Region.

      • Endpoint (string) --

        The Region service endpoint.

      • RegionName (string) --

        The name of the Region.

      • OptInStatus (string) --

        The Region opt-in status. The possible values are opt-in-not-required , opted-in , and not-opted-in .

{'SplitTunnel': 'boolean'}

Modifies the specified Client VPN endpoint. You can only modify an endpoint's server certificate information, client connection logging information, DNS server, and description. Modifying the DNS server resets existing client connections.

See also: AWS API Documentation

Request Syntax

client.modify_client_vpn_endpoint(
    ClientVpnEndpointId='string',
    ServerCertificateArn='string',
    ConnectionLogOptions={
        'Enabled': True|False,
        'CloudwatchLogGroup': 'string',
        'CloudwatchLogStream': 'string'
    },
    DnsServers={
        'CustomDnsServers': [
            'string',
        ],
        'Enabled': True|False
    },
    Description='string',
    SplitTunnel=True|False,
    DryRun=True|False
)

type ClientVpnEndpointId

string

param ClientVpnEndpointId

[REQUIRED]

The ID of the Client VPN endpoint to modify.

type ServerCertificateArn

string

param ServerCertificateArn

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

type ConnectionLogOptions

dict

param 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

• Enabled (boolean) --

  Indicates whether connection logging is enabled.

• CloudwatchLogGroup (string) --

  The name of the CloudWatch Logs log group.

• CloudwatchLogStream (string) --

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

type DnsServers

dict

param DnsServers

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.

type Description

string

param Description

A brief description of the Client VPN endpoint.

type SplitTunnel

boolean

param SplitTunnel

Indicates whether the VPN is split-tunnel.

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide .

type DryRun

boolean

param DryRun

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 .

rtype

dict

returns

Response Syntax

{
    'Return': True|False
}

Response Structure

• (dict) --

  • Return (boolean) --

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