Amazon Elastic Compute Cloud

2022/01/18 - Amazon Elastic Compute Cloud - 3 updated api methods

Changes  Add support for AWS Client VPN client login banner and session timeout.

CreateClientVpnEndpoint (updated) Link ¶
Changes (request) 
{'ClientLoginBannerOptions': {'BannerText': 'string', 'Enabled': 'boolean'},
 'SessionTimeoutHours': 'integer'}

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'|'federated-authentication',
            'ActiveDirectory': {
                'DirectoryId': 'string'
            },
            'MutualAuthentication': {
                'ClientRootCertificateChainArn': 'string'
            },
            'FederatedAuthentication': {
                'SAMLProviderArn': 'string',
                'SelfServiceSAMLProviderArn': 'string'
            }
        },
    ],
    ConnectionLogOptions={
        'Enabled': True|False,
        'CloudwatchLogGroup': 'string',
        'CloudwatchLogStream': 'string'
    },
    DnsServers=[
        'string',
    ],
    TransportProtocol='tcp'|'udp',
    VpnPort=123,
    Description='string',
    SplitTunnel=True|False,
    DryRun=True|False,
    ClientToken='string',
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    SecurityGroupIds=[
        'string',
    ],
    VpcId='string',
    SelfServicePortal='enabled'|'disabled',
    ClientConnectOptions={
        'Enabled': True|False,
        'LambdaFunctionArn': 'string'
    },
    SessionTimeoutHours=123,
    ClientLoginBannerOptions={
        'Enabled': True|False,
        'BannerText': '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 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. For more information, see Authentication in the Client VPN Administrator Guide.

    • Type (string) --

      The type of client authentication to be used.

    • 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 Certificate Manager (ACM).

    • FederatedAuthentication (dict) --

      Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.

      • SAMLProviderArn (string) --

        The Amazon Resource Name (ARN) of the IAM SAML identity provider.

      • SelfServiceSAMLProviderArn (string) --

        The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

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. Required if connection logging is enabled.

  • 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 configured on the device is used for the DNS server.

  • (string) --

type TransportProtocol:

string

param TransportProtocol:

The transport protocol to be used by the VPN session.

Default value: udp

type VpnPort:

integer

param VpnPort:

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

Valid Values: 443 | 1194

Default Value: 443

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 Client VPN endpoint.

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

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the 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 on creation.

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

type SecurityGroupIds:

list

param SecurityGroupIds:

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

  • (string) --

type VpcId:

string

param VpcId:

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

type SelfServicePortal:

string

param SelfServicePortal:

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

Default Value: enabled

type ClientConnectOptions:

dict

param ClientConnectOptions:

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.

type SessionTimeoutHours:

integer

param SessionTimeoutHours:

type ClientLoginBannerOptions:

dict

param ClientLoginBannerOptions:

  • Enabled (boolean) --

  • BannerText (string) --

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.

DescribeClientVpnEndpoints (updated) Link ¶
Changes (response) 
{'ClientVpnEndpoints': {'ClientLoginBannerOptions': {'BannerText': 'string',
                                                     'Enabled': 'boolean'},
                        'SessionTimeoutHours': 'integer'}}

Describes one or more Client VPN endpoints in the account.

See also: AWS API Documentation

Request Syntax

client.describe_client_vpn_endpoints(
    ClientVpnEndpointIds=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)
type ClientVpnEndpointIds:

list

param ClientVpnEndpointIds:

The ID of the Client VPN endpoint.

  • (string) --

type MaxResults:

integer

param MaxResults:

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

type NextToken:

string

param NextToken:

The token to retrieve the next page of results.

type Filters:

list

param Filters:

One or more filters. Filter names and values are case-sensitive.

  • endpoint-id - The ID of the Client VPN endpoint.

  • transport-protocol - The transport protocol ( tcp | udp).

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

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) --

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

    • Values (list) --

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

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

rtype:

dict

returns:

Response Syntax

{
    'ClientVpnEndpoints': [
        {
            'ClientVpnEndpointId': 'string',
            'Description': 'string',
            'Status': {
                'Code': 'pending-associate'|'available'|'deleting'|'deleted',
                'Message': 'string'
            },
            'CreationTime': 'string',
            'DeletionTime': 'string',
            'DnsName': 'string',
            'ClientCidrBlock': 'string',
            'DnsServers': [
                'string',
            ],
            'SplitTunnel': True|False,
            'VpnProtocol': 'openvpn',
            'TransportProtocol': 'tcp'|'udp',
            'VpnPort': 123,
            'AssociatedTargetNetworks': [
                {
                    'NetworkId': 'string',
                    'NetworkType': 'vpc'
                },
            ],
            'ServerCertificateArn': 'string',
            'AuthenticationOptions': [
                {
                    'Type': 'certificate-authentication'|'directory-service-authentication'|'federated-authentication',
                    'ActiveDirectory': {
                        'DirectoryId': 'string'
                    },
                    'MutualAuthentication': {
                        'ClientRootCertificateChain': 'string'
                    },
                    'FederatedAuthentication': {
                        'SamlProviderArn': 'string',
                        'SelfServiceSamlProviderArn': 'string'
                    }
                },
            ],
            'ConnectionLogOptions': {
                'Enabled': True|False,
                'CloudwatchLogGroup': 'string',
                'CloudwatchLogStream': 'string'
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'SecurityGroupIds': [
                'string',
            ],
            'VpcId': 'string',
            'SelfServicePortalUrl': 'string',
            'ClientConnectOptions': {
                'Enabled': True|False,
                'LambdaFunctionArn': 'string',
                'Status': {
                    'Code': 'applying'|'applied',
                    'Message': 'string'
                }
            },
            'SessionTimeoutHours': 123,
            'ClientLoginBannerOptions': {
                'Enabled': True|False,
                'BannerText': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ClientVpnEndpoints (list) --

      Information about the Client VPN endpoints.

      • (dict) --

        Describes a Client VPN endpoint.

        • ClientVpnEndpointId (string) --

          The ID of the Client VPN endpoint.

        • Description (string) --

          A brief description of the 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.

        • CreationTime (string) --

          The date and time the Client VPN endpoint was created.

        • DeletionTime (string) --

          The date and time the Client VPN endpoint was deleted, if applicable.

        • DnsName (string) --

          The DNS name to be used by clients when connecting to the Client VPN endpoint.

        • ClientCidrBlock (string) --

          The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

        • DnsServers (list) --

          Information about the DNS servers to be used for DNS resolution.

          • (string) --

        • SplitTunnel (boolean) --

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

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

        • VpnProtocol (string) --

          The protocol used by the VPN session.

        • TransportProtocol (string) --

          The transport protocol used by the Client VPN endpoint.

        • VpnPort (integer) --

          The port number for the Client VPN endpoint.

        • AssociatedTargetNetworks (list) --

          Information about the associated target networks. A target network is a subnet in a VPC.

          • (dict) --

            Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.

            • NetworkId (string) --

              The ID of the subnet.

            • NetworkType (string) --

              The target network type.

        • ServerCertificateArn (string) --

          The ARN of the server certificate.

        • AuthenticationOptions (list) --

          Information about the authentication method used by the Client VPN endpoint.

          • (dict) --

            Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.

            • Type (string) --

              The authentication type used.

            • ActiveDirectory (dict) --

              Information about the Active Directory, if applicable.

              • DirectoryId (string) --

                The ID of the Active Directory used for authentication.

            • MutualAuthentication (dict) --

              Information about the authentication certificates, if applicable.

              • ClientRootCertificateChain (string) --

                The ARN of the client certificate.

            • FederatedAuthentication (dict) --

              Information about the IAM SAML identity provider, if applicable.

              • SamlProviderArn (string) --

                The Amazon Resource Name (ARN) of the IAM SAML identity provider.

              • SelfServiceSamlProviderArn (string) --

                The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.

        • ConnectionLogOptions (dict) --

          Information about the client connection logging options for the Client VPN endpoint.

          • Enabled (boolean) --

            Indicates whether client connection logging is enabled for the Client VPN endpoint.

          • CloudwatchLogGroup (string) --

            The name of the Amazon CloudWatch Logs log group to which connection logging data is published.

          • CloudwatchLogStream (string) --

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

        • Tags (list) --

          Any tags assigned to the Client VPN endpoint.

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

        • SecurityGroupIds (list) --

          The IDs of the security groups for the target network.

          • (string) --

        • VpcId (string) --

          The ID of the VPC.

        • SelfServicePortalUrl (string) --

          The URL of the self-service portal.

        • ClientConnectOptions (dict) --

          The options for managing connection authorization for new client connections.

          • Enabled (boolean) --

            Indicates whether client connect options are enabled.

          • LambdaFunctionArn (string) --

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

          • Status (dict) --

            The status of any updates to the client connect options.

            • Code (string) --

              The status code.

            • Message (string) --

              The status message.

        • SessionTimeoutHours (integer) --

        • ClientLoginBannerOptions (dict) --

          • Enabled (boolean) --

          • BannerText (string) --

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

ModifyClientVpnEndpoint (updated) Link ¶
Changes (request) 
{'ClientLoginBannerOptions': {'BannerText': 'string', 'Enabled': 'boolean'},
 'SessionTimeoutHours': 'integer'}

Modifies the specified Client VPN endpoint. 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
    },
    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'
    }
)
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 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. Required if connection logging is enabled.

  • 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 VpnPort:

integer

param VpnPort:

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

Valid Values: 443 | 1194

Default Value: 443

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 Client VPN endpoint in the 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 SecurityGroupIds:

list

param SecurityGroupIds:

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

  • (string) --

type VpcId:

string

param VpcId:

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

type SelfServicePortal:

string

param SelfServicePortal:

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

type ClientConnectOptions:

dict

param ClientConnectOptions:

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.

type SessionTimeoutHours:

integer

param SessionTimeoutHours:

type ClientLoginBannerOptions:

dict

param ClientLoginBannerOptions:

  • Enabled (boolean) --

  • BannerText (string) --

rtype:

dict

returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

  • (dict) --

    • Return (boolean) --

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