client_vpn_endpoints

Creates, updates, deletes, gets or lists a client_vpn_endpoints resource.

Overview

Name	client_vpn_endpoints
Type	Resource
Id	aws.ec2.client_vpn_endpoints

Fields

The following fields are returned by SELECT queries:

describe_client_vpn_endpoints

Name	Datatype	Description
associated_target_networks	string	Information about the associated target networks. A target network is a subnet in a VPC.
authentication_options	string	Information about the authentication method used by the Client VPN endpoint.
client_cidr_block	string	The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
client_connect_options	string	The options for managing connection authorization for new client connections.
client_login_banner_options	string	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	string	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	string	The ID of the Client VPN endpoint.
connection_log_options	string	Information about the client connection logging options for the Client VPN endpoint.
creation_time	string	The date and time the Client VPN endpoint was created.
deletion_time	string	The date and time the Client VPN endpoint was deleted, if applicable.
description	string	A brief description of the endpoint.
disconnect_on_session_timeout	boolean	Indicates whether the client VPN session is disconnected after the maximum 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_name	string	The DNS name to be used by clients when connecting to the Client VPN endpoint.
dns_servers	string	Information about the DNS servers to be used for DNS resolution.
endpoint_ip_address_type	string	The IP address type of the Client VPN endpoint. Possible values are ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.
security_group_ids	string	The IDs of the security groups for the target network.
self_service_portal_url	string	The URL of the self-service portal.
server_certificate_arn	string	The ARN of the server certificate.
session_timeout_hours	integer	The maximum VPN session duration time in hours. Valid values: 8 | 10 | 12 | 24 Default value: 24
split_tunnel	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.
status	string	The current state of the Client VPN endpoint.
tags	string	Any tags assigned to the Client VPN endpoint.
traffic_ip_address_type	string	The IP address type of the Client VPN endpoint. Possible values are either ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing.
transit_gateway_configuration	string	The Transit Gateway configuration for the Client VPN endpoint.
transport_protocol	string	The transport protocol used by the Client VPN endpoint.
vpc_id	string	The ID of the VPC.
vpn_port	integer	The port number for the Client VPN endpoint.
vpn_protocol	string	The protocol used by the VPN session.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_client_vpn_endpoints	select	region	ClientVpnEndpointId, MaxResults, NextToken, Filter, DryRun	Describes one or more Client VPN endpoints in the account.
create_client_vpn_endpoint	insert	ServerCertificateArn, Authentication, ConnectionLogOptions, region	ClientCidrBlock, DnsServers, TransportProtocol, VpnPort, Description, SplitTunnel, DryRun, ClientToken, TagSpecification, SecurityGroupId, VpcId, SelfServicePortal, ClientConnectOptions, SessionTimeoutHours, ClientLoginBannerOptions, ClientRouteEnforcementOptions, DisconnectOnSessionTimeout, EndpointIpAddressType, TrafficIpAddressType, TransitGatewayConfiguration	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.
authorize_client_vpn_ingress	update	ClientVpnEndpointId, TargetNetworkCidr, region	AccessGroupId, AuthorizeAllGroups, Description, ClientToken, DryRun	Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.
modify_client_vpn_endpoint	update	ClientVpnEndpointId, region	ServerCertificateArn, ConnectionLogOptions, DnsServers, VpnPort, Description, SplitTunnel, DryRun, SecurityGroupId, VpcId, SelfServicePortal, ClientConnectOptions, SessionTimeoutHours, ClientLoginBannerOptions, ClientRouteEnforcementOptions, DisconnectOnSessionTimeout, TransitGatewayConfiguration	Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections.
delete_client_vpn_endpoint	delete	ClientVpnEndpointId, region	DryRun	Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
apply_security_groups_to_client_vpn_target_network	exec	ClientVpnEndpointId, VpcId, SecurityGroupId, region	DryRun	Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
export_client_vpn_client_certificate_revocation_list	exec	ClientVpnEndpointId, region	DryRun	Downloads the client certificate revocation list for the specified Client VPN endpoint.
export_client_vpn_client_configuration	exec	ClientVpnEndpointId, region	DryRun	Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.
import_client_vpn_client_certificate_revocation_list	exec	ClientVpnEndpointId, CertificateRevocationList, region	DryRun	Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list. Uploading a client certificate revocation list resets existing client connections.
revoke_client_vpn_ingress	exec	ClientVpnEndpointId, TargetNetworkCidr, region	AccessGroupId, RevokeAllGroups, DryRun	Removes an ingress authorization rule from a Client VPN endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
Authentication	array	Information about the authentication method to be used to authenticate clients.
CertificateRevocationList	string	The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the Client VPN Administrator Guide.
ClientVpnEndpointId	string	The ID of the Client VPN endpoint with which the authorization rule is associated.
ConnectionLogOptions	object	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
SecurityGroupId	array	The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.
ServerCertificateArn	string	The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
TargetNetworkCidr	string	The IPv4 address range, in CIDR notation, of the network for which access is being removed.
VpcId	string	The ID of the VPC in which the associated target network is located.
region	string	AWS region (default: us-east-1)
AccessGroupId	string	The ID of the Active Directory group for which to revoke access.
AuthorizeAllGroups	boolean	Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.
ClientCidrBlock	string	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. Client CIDR range must have a size of at least /22 and must not be greater than /12.
ClientConnectOptions	object	The options for managing connection authorization for new client connections.
ClientLoginBannerOptions	object	Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
ClientRouteEnforcementOptions	object	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.
ClientToken	string	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
ClientVpnEndpointId	array	The ID of the Client VPN endpoint.
ConnectionLogOptions	object	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	string	A brief description of the Client VPN endpoint.
DisconnectOnSessionTimeout	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.
DnsServers	object	Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.
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.
EndpointIpAddressType	string	The IP address type for the Client VPN endpoint. Valid values are ipv4 (default) for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing. When set to dual-stack, clients can connect to the endpoint using either IPv4 or IPv6 addresses..
Filter	array	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).
MaxResults	integer	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.
NextToken	string	The token to retrieve the next page of results.
RevokeAllGroups	boolean	Indicates whether access should be revoked for all groups for a single TargetNetworkCidr that earlier authorized ingress for all groups using AuthorizeAllGroups. This does not impact other authorization rules that allowed ingress to the same TargetNetworkCidr with a specific AccessGroupId.
SecurityGroupId	array	The IDs of one or more security groups to apply to the target network.
SelfServicePortal	string	Specify whether to enable the self-service portal for the Client VPN endpoint.
ServerCertificateArn	string	The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).
SessionTimeoutHours	integer	The maximum VPN session duration time in hours. Valid values: 8 | 10 | 12 | 24 Default value: 24
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.
TagSpecification	array	The tags to apply to the Client VPN endpoint during creation.
TrafficIpAddressType	string	The IP address type for traffic within the Client VPN tunnel. Valid values are ipv4 (default) for IPv4 traffic only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 traffic. When set to dual-stack, clients can access both IPv4 and IPv6 resources through the VPN .
TransitGatewayConfiguration	object	The Transit Gateway configuration for the Client VPN endpoint. This option is currently not supported.
TransportProtocol	string	The transport protocol to be used by the VPN session. Default value: udp
VpcId	string	The ID of the VPC to associate with the Client VPN endpoint.
VpnPort	integer	The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: 443 | 1194 Default Value: 443

SELECT examples

describe_client_vpn_endpoints

Describes one or more Client VPN endpoints in the account.

SELECT
associated_target_networks,
authentication_options,
client_cidr_block,
client_connect_options,
client_login_banner_options,
client_route_enforcement_options,
client_vpn_endpoint_id,
connection_log_options,
creation_time,
deletion_time,
description,
disconnect_on_session_timeout,
dns_name,
dns_servers,
endpoint_ip_address_type,
security_group_ids,
self_service_portal_url,
server_certificate_arn,
session_timeout_hours,
split_tunnel,
status,
tags,
traffic_ip_address_type,
transit_gateway_configuration,
transport_protocol,
vpc_id,
vpn_port,
vpn_protocol
FROM aws.ec2.client_vpn_endpoints
WHERE region = '{{ region }}' -- required
AND ClientVpnEndpointId = '{{ ClientVpnEndpointId }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Filter = '{{ Filter }}'
AND DryRun = '{{ DryRun }}'
;

INSERT examples

create_client_vpn_endpoint

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.

INSERT INTO aws.ec2.client_vpn_endpoints (
ServerCertificateArn,
Authentication,
ConnectionLogOptions,
region,
ClientCidrBlock,
DnsServers,
TransportProtocol,
VpnPort,
Description,
SplitTunnel,
DryRun,
ClientToken,
TagSpecification,
SecurityGroupId,
VpcId,
SelfServicePortal,
ClientConnectOptions,
SessionTimeoutHours,
ClientLoginBannerOptions,
ClientRouteEnforcementOptions,
DisconnectOnSessionTimeout,
EndpointIpAddressType,
TrafficIpAddressType,
TransitGatewayConfiguration
)
SELECT 
'{{ ServerCertificateArn }}',
'{{ Authentication }}',
'{{ ConnectionLogOptions }}',
'{{ region }}',
'{{ ClientCidrBlock }}',
'{{ DnsServers }}',
'{{ TransportProtocol }}',
'{{ VpnPort }}',
'{{ Description }}',
'{{ SplitTunnel }}',
'{{ DryRun }}',
'{{ ClientToken }}',
'{{ TagSpecification }}',
'{{ SecurityGroupId }}',
'{{ VpcId }}',
'{{ SelfServicePortal }}',
'{{ ClientConnectOptions }}',
'{{ SessionTimeoutHours }}',
'{{ ClientLoginBannerOptions }}',
'{{ ClientRouteEnforcementOptions }}',
'{{ DisconnectOnSessionTimeout }}',
'{{ EndpointIpAddressType }}',
'{{ TrafficIpAddressType }}',
'{{ TransitGatewayConfiguration }}'
RETURNING
client_vpn_endpoint_id,
dns_name,
status
;

Manifest

# Description fields are for documentation purposes
- name: client_vpn_endpoints
props:
  - name: ServerCertificateArn
    value: "{{ ServerCertificateArn }}"
    description: Required parameter for the client_vpn_endpoints resource.
  - name: Authentication
    value: "{{ Authentication }}"
    description: Required parameter for the client_vpn_endpoints resource.
  - name: ConnectionLogOptions
    value: "{{ ConnectionLogOptions }}"
    description: Required parameter for the client_vpn_endpoints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the client_vpn_endpoints resource.
  - name: ClientCidrBlock
    value: "{{ ClientCidrBlock }}"
    description: 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. Client CIDR range must have a size of at least /22 and must not be greater than /12.
    description: 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. Client CIDR range must have a size of at least /22 and must not be greater than /12.
  - name: DnsServers
    value: "{{ DnsServers }}"
    description: 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.
    description: 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.
  - name: TransportProtocol
    value: "{{ TransportProtocol }}"
    description: The transport protocol to be used by the VPN session. Default value: udp
    description: The transport protocol to be used by the VPN session. Default value: udp
  - name: VpnPort
    value: {{ VpnPort }}
    description: The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: 443 | 1194 Default Value: 443
    description: The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: 443 | 1194 Default Value: 443
  - name: Description
    value: "{{ Description }}"
    description: A brief description of the Client VPN endpoint.
    description: A brief description of the Client VPN endpoint.
  - name: SplitTunnel
    value: {{ SplitTunnel }}
    description: 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.
    description: 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.
  - name: DryRun
    value: {{ DryRun }}
    description: 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.
    description: 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.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
    description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
  - name: TagSpecification
    value: "{{ TagSpecification }}"
    description: The tags to apply to the Client VPN endpoint during creation.
    description: The tags to apply to the Client VPN endpoint during creation.
  - name: SecurityGroupId
    value: "{{ SecurityGroupId }}"
    description: 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.
    description: 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.
  - name: VpcId
    value: "{{ VpcId }}"
    description: 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.
    description: 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.
  - name: SelfServicePortal
    value: "{{ SelfServicePortal }}"
    description: Specify whether to enable the self-service portal for the Client VPN endpoint. Default Value: enabled
    description: Specify whether to enable the self-service portal for the Client VPN endpoint. Default Value: enabled
  - name: ClientConnectOptions
    value: "{{ ClientConnectOptions }}"
    description: The options for managing connection authorization for new client connections.
    description: The options for managing connection authorization for new client connections.
  - name: SessionTimeoutHours
    value: {{ SessionTimeoutHours }}
    description: The maximum VPN session duration time in hours. Valid values: 8 | 10 | 12 | 24 Default value: 24
    description: The maximum VPN session duration time in hours. Valid values: 8 | 10 | 12 | 24 Default value: 24
  - name: ClientLoginBannerOptions
    value: "{{ ClientLoginBannerOptions }}"
    description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
    description: Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
  - name: ClientRouteEnforcementOptions
    value: "{{ ClientRouteEnforcementOptions }}"
    description: 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.
    description: 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.
  - name: DisconnectOnSessionTimeout
    value: {{ DisconnectOnSessionTimeout }}
    description: 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.
    description: 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.
  - name: EndpointIpAddressType
    value: "{{ EndpointIpAddressType }}"
    description: The IP address type for the Client VPN endpoint. Valid values are ipv4 (default) for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing. When set to dual-stack, clients can connect to the endpoint using either IPv4 or IPv6 addresses..
    description: The IP address type for the Client VPN endpoint. Valid values are ipv4 (default) for IPv4 addressing only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 addressing. When set to dual-stack, clients can connect to the endpoint using either IPv4 or IPv6 addresses..
  - name: TrafficIpAddressType
    value: "{{ TrafficIpAddressType }}"
    description: The IP address type for traffic within the Client VPN tunnel. Valid values are ipv4 (default) for IPv4 traffic only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 traffic. When set to dual-stack, clients can access both IPv4 and IPv6 resources through the VPN .
    description: The IP address type for traffic within the Client VPN tunnel. Valid values are ipv4 (default) for IPv4 traffic only, ipv6 for IPv6 addressing only, or dual-stack for both IPv4 and IPv6 traffic. When set to dual-stack, clients can access both IPv4 and IPv6 resources through the VPN .
  - name: TransitGatewayConfiguration
    value: "{{ TransitGatewayConfiguration }}"
    description: The Transit Gateway configuration for the Client VPN endpoint. Use this parameter to associate the endpoint with a Transit Gateway instead of a VPC. You cannot specify both TransitGatewayConfiguration and VpcId/SecurityGroupIds.
    description: The Transit Gateway configuration for the Client VPN endpoint. Use this parameter to associate the endpoint with a Transit Gateway instead of a VPC. You cannot specify both TransitGatewayConfiguration and VpcId/SecurityGroupIds.

UPDATE examples

authorize_client_vpn_ingress

Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.

UPDATE aws.ec2.client_vpn_endpoints
SET 
-- No updatable properties
WHERE 
ClientVpnEndpointId = '{{ ClientVpnEndpointId }}' --required
AND TargetNetworkCidr = '{{ TargetNetworkCidr }}' --required
AND region = '{{ region }}' --required
AND AccessGroupId = '{{ AccessGroupId}}'
AND AuthorizeAllGroups = {{ AuthorizeAllGroups}}
AND Description = '{{ Description}}'
AND ClientToken = '{{ ClientToken}}'
AND DryRun = {{ DryRun}}
RETURNING
code,
message;

modify_client_vpn_endpoint

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

UPDATE aws.ec2.client_vpn_endpoints
SET 
-- No updatable properties
WHERE 
ClientVpnEndpointId = '{{ ClientVpnEndpointId }}' --required
AND region = '{{ region }}' --required
AND ServerCertificateArn = '{{ ServerCertificateArn}}'
AND ConnectionLogOptions = '{{ ConnectionLogOptions}}'
AND DnsServers = '{{ DnsServers}}'
AND VpnPort = '{{ VpnPort}}'
AND Description = '{{ Description}}'
AND SplitTunnel = {{ SplitTunnel}}
AND DryRun = {{ DryRun}}
AND SecurityGroupId = '{{ SecurityGroupId}}'
AND VpcId = '{{ VpcId}}'
AND SelfServicePortal = '{{ SelfServicePortal}}'
AND ClientConnectOptions = '{{ ClientConnectOptions}}'
AND SessionTimeoutHours = '{{ SessionTimeoutHours}}'
AND ClientLoginBannerOptions = '{{ ClientLoginBannerOptions}}'
AND ClientRouteEnforcementOptions = '{{ ClientRouteEnforcementOptions}}'
AND DisconnectOnSessionTimeout = {{ DisconnectOnSessionTimeout}}
AND TransitGatewayConfiguration = '{{ TransitGatewayConfiguration}}'
RETURNING
return;

DELETE examples

delete_client_vpn_endpoint

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.

DELETE FROM aws.ec2.client_vpn_endpoints
WHERE ClientVpnEndpointId = '{{ ClientVpnEndpointId }}' --required
AND region = '{{ region }}' --required
AND DryRun = '{{ DryRun }}'
;

Lifecycle Methods

apply_security_groups_to_client_vpn_target_network

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.

EXEC aws.ec2.client_vpn_endpoints.apply_security_groups_to_client_vpn_target_network 
@ClientVpnEndpointId='{{ ClientVpnEndpointId }}' --required, 
@VpcId='{{ VpcId }}' --required, 
@SecurityGroupId='{{ SecurityGroupId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

export_client_vpn_client_certificate_revocation_list

Downloads the client certificate revocation list for the specified Client VPN endpoint.

EXEC aws.ec2.client_vpn_endpoints.export_client_vpn_client_certificate_revocation_list 
@ClientVpnEndpointId='{{ ClientVpnEndpointId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

export_client_vpn_client_configuration

Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.

EXEC aws.ec2.client_vpn_endpoints.export_client_vpn_client_configuration 
@ClientVpnEndpointId='{{ ClientVpnEndpointId }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

import_client_vpn_client_certificate_revocation_list

Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list. Uploading a client certificate revocation list resets existing client connections.

EXEC aws.ec2.client_vpn_endpoints.import_client_vpn_client_certificate_revocation_list 
@ClientVpnEndpointId='{{ ClientVpnEndpointId }}' --required, 
@CertificateRevocationList='{{ CertificateRevocationList }}' --required, 
@region='{{ region }}' --required, 
@DryRun={{ DryRun }}
;

revoke_client_vpn_ingress

Removes an ingress authorization rule from a Client VPN endpoint.

EXEC aws.ec2.client_vpn_endpoints.revoke_client_vpn_ingress 
@ClientVpnEndpointId='{{ ClientVpnEndpointId }}' --required, 
@TargetNetworkCidr='{{ TargetNetworkCidr }}' --required, 
@region='{{ region }}' --required, 
@AccessGroupId='{{ AccessGroupId }}', 
@RevokeAllGroups={{ RevokeAllGroups }}, 
@DryRun={{ DryRun }}
;