Skip to content
AWS for Query.Farm

aws.ec2.describe_transit_gateway_connect_peers

Example SQL Queries

SELECT * FROM
aws.ec2.describe_transit_gateway_connect_peers;

Description

Describes one or more Connect peers.

Table Definition

Column NameColumn Data Type
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. The possible values are:

  • state - The state of the Connect peer (pending | available | deleting | deleted).

  • transit-gateway-attachment-id - The ID of the attachment.

  • transit-gateway-connect-peer-id - The ID of the Connect peer.

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[]
transit_gateway_connect_peer_ids Input Column

The IDs of the Connect peers.

VARCHAR[]
Show child fields
transit_gateway_connect_peer_ids[]
_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
connect_peer_configuration

The Connect peer details.

STRUCT(
    "transit_gateway_address" VARCHAR,
    "peer_address" VARCHAR,
    "inside_cidr_blocks" VARCHAR[],
    "protocol" VARCHAR,
    "bgp_configurations" STRUCT(
        "transit_gateway_asn" BIGINT,
        "peer_asn" BIGINT,
        "transit_gateway_address" VARCHAR,
        "peer_address" VARCHAR,
        "bgp_status" VARCHAR
    )[]
)
Show child fields
connect_peer_configuration.bgp_configurations[]
Show child fields
connect_peer_configuration.bgp_configurations[].bgp_status

The BGP status.

connect_peer_configuration.bgp_configurations[].peer_address

The interior BGP peer IP address for the appliance.

connect_peer_configuration.bgp_configurations[].peer_asn

The peer Autonomous System Number (ASN).

connect_peer_configuration.bgp_configurations[].transit_gateway_address

The interior BGP peer IP address for the transit gateway.

connect_peer_configuration.bgp_configurations[].transit_gateway_asn

The transit gateway Autonomous System Number (ASN).

connect_peer_configuration.inside_cidr_blocks[]
connect_peer_configuration.peer_address

The Connect peer IP address on the appliance side of the tunnel.

connect_peer_configuration.protocol

The tunnel protocol.

connect_peer_configuration.transit_gateway_address

The Connect peer IP address on the transit gateway side of the tunnel.

creation_time

The creation time.

TIMESTAMP_S
state

The state of the Connect peer.

VARCHAR
tags

The tags for the Connect peer.

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.

transit_gateway_attachment_id

The ID of the Connect attachment.

VARCHAR
transit_gateway_connect_peer_id

The ID of the Connect peer.

VARCHAR