Skip to content

aws.ec2.describe_client_vpn_endpoints

Example SQL Queries

SELECT * FROM
aws.ec2.describe_client_vpn_endpoints;

Description

Describes one or more Client VPN endpoints in the account.

Table Definition

Column NameColumn Data Type
client_vpn_endpoint_ids Input Column

The ID of the Client VPN endpoint.

VARCHAR[]
Show child fields
client_vpn_endpoint_ids[]
dry_run Input Column

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.

BOOLEAN
filters Input Column

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

STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

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

filters[].values[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
associated_target_networks

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

STRUCT(
"network_id" VARCHAR,
"network_type" VARCHAR
)[]
Show child fields
associated_target_networks[]
Show child fields
associated_target_networks[].network_id

The ID of the subnet.

associated_target_networks[].network_type

The target network type.

authentication_options

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

STRUCT(
"type" VARCHAR,
"active_directory" STRUCT(
"directory_id" VARCHAR
),
"mutual_authentication" STRUCT(
"client_root_certificate_chain" VARCHAR
),
"federated_authentication" STRUCT(
"saml_provider_arn" VARCHAR,
"self_service_saml_provider_arn" VARCHAR
)
)[]
Show child fields
authentication_options[]
Show child fields
authentication_options[].active_directory

Information about the Active Directory, if applicable.

Show child fields
authentication_options[].active_directory.directory_id

The ID of the Active Directory used for authentication.

authentication_options[].federated_authentication

Information about the IAM SAML identity provider, if applicable.

Show child fields
authentication_options[].federated_authentication.saml_provider_arn

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

authentication_options[].federated_authentication.self_service_saml_provider_arn

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

authentication_options[].mutual_authentication

Information about the authentication certificates, if applicable.

Show child fields
authentication_options[].mutual_authentication.client_root_certificate_chain

The ARN of the client certificate.

authentication_options[].type

The authentication type used.

client_cidr_block

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

VARCHAR
client_connect_options

The options for managing connection authorization for new client connections.

STRUCT(
"enabled" BOOLEAN,
"lambda_function_arn" VARCHAR,
"status" STRUCT(
"code" VARCHAR,
"message" VARCHAR
)
)
Show child fields
client_connect_options.enabled

Indicates whether client connect options are enabled.

client_connect_options.lambda_function_arn

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

client_connect_options.status

The status of any updates to the client connect options.

Show child fields
client_connect_options.status.code

The status code.

client_connect_options.status.message

The status message.

client_login_banner_options

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

STRUCT(
"enabled" BOOLEAN,
"banner_text" VARCHAR
)
Show child fields
client_login_banner_options.banner_text

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.

client_login_banner_options.enabled

Current state of text banner feature.

Valid values: true | false

client_vpn_endpoint_id

The ID of the Client VPN endpoint.

VARCHAR
connection_log_options

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

STRUCT(
"enabled" BOOLEAN,
"cloudwatch_log_group" VARCHAR,
"cloudwatch_log_stream" VARCHAR
)
Show child fields
connection_log_options.cloudwatch_log_group

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

connection_log_options.cloudwatch_log_stream

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

connection_log_options.enabled

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

creation_time

The date and time the Client VPN endpoint was created.

VARCHAR
deletion_time

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

VARCHAR
description

A brief description of the endpoint.

VARCHAR
dns_name

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

VARCHAR
dns_servers

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

VARCHAR[]
Show child fields
dns_servers[]
security_group_ids

The IDs of the security groups for the target network.

VARCHAR[]
Show child fields
security_group_ids[]
self_service_portal_url

The URL of the self-service portal.

VARCHAR
server_certificate_arn

The ARN of the server certificate.

VARCHAR
session_timeout_hours

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

BIGINT
split_tunnel

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.

BOOLEAN
status

The current state of the Client VPN endpoint.

STRUCT(
"code" VARCHAR,
"message" VARCHAR
)
Show child fields
status.code

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.

status.message

A message about the status of the Client VPN endpoint.

tags

Any tags assigned to the Client VPN endpoint.

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
tags[]
Show child fields
tags[].key

The key of the tag.

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

tags[].value

The value of the tag.

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

transport_protocol

The transport protocol used by the Client VPN endpoint.

VARCHAR
vpc_id

The ID of the VPC.

VARCHAR
vpn_port

The port number for the Client VPN endpoint.

BIGINT
vpn_protocol

The protocol used by the VPN session.

VARCHAR