Skip to content
AWS for Query.Farm

aws.ec2.describe_client_vpn_connections

Example SQL Queries

SELECT * FROM
aws.ec2.describe_client_vpn_connections
WHERE
"client_vpn_endpoint_id" = 'VALUE';

Description

Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.

Table Definition

Column NameColumn Data Type
client_vpn_endpoint_id Required Input Column

The ID of the Client VPN endpoint to which the client is connected.

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

  • connection-id - The ID of the connection.

  • username - For Active Directory client authentication, the user name of the client who established the client connection.

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
client_ip

The IP address of the client.

VARCHAR
common_name

The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.

VARCHAR
connection_end_time

The date and time the client connection was terminated.

VARCHAR
connection_established_time

The date and time the client connection was established.

VARCHAR
connection_id

The ID of the client connection.

VARCHAR
egress_bytes

The number of bytes received by the client.

VARCHAR
egress_packets

The number of packets received by the client.

VARCHAR
ingress_bytes

The number of bytes sent by the client.

VARCHAR
ingress_packets

The number of packets sent by the client.

VARCHAR
posture_compliance_statuses

The statuses returned by the client connect handler for posture compliance, if applicable.

VARCHAR[]
Show child fields
posture_compliance_statuses[]
status

The current state of the client connection.

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

The state of the client connection.

status.message

A message about the status of the client connection, if applicable.

timestamp

The current date and time.

VARCHAR
username

The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.

VARCHAR