Skip to content

aws.ec2.describe_transit_gateways

Example SQL Queries

SELECT * FROM
aws.ec2.describe_transit_gateways;

Description

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.

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:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the Amazon Web Services account that owns the transit gateway.

  • state - The state of the transit gateway (available | deleted | deleting | modifying | pending).

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

  • tag-key - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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_ids Input Column

The IDs of the transit gateways.

VARCHAR[]
Show child fields
transit_gateway_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
creation_time

The creation time.

TIMESTAMP_S
description

The description of the transit gateway.

VARCHAR
options

The transit gateway options.

STRUCT(
"amazon_side_asn" BIGINT,
"transit_gateway_cidr_blocks" VARCHAR[],
"auto_accept_shared_attachments" VARCHAR,
"default_route_table_association" VARCHAR,
"association_default_route_table_id" VARCHAR,
"default_route_table_propagation" VARCHAR,
"propagation_default_route_table_id" VARCHAR,
"vpn_ecmp_support" VARCHAR,
"dns_support" VARCHAR,
"security_group_referencing_support" VARCHAR,
"multicast_support" VARCHAR
)
Show child fields
options.amazon_side_asn

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

options.association_default_route_table_id

The ID of the default association route table.

options.auto_accept_shared_attachments

Indicates whether attachment requests are automatically accepted.

options.default_route_table_association

Indicates whether resource attachments are automatically associated with the default association route table.

options.default_route_table_propagation

Indicates whether resource attachments automatically propagate routes to the default propagation route table.

options.dns_support

Indicates whether DNS support is enabled.

options.multicast_support

Indicates whether multicast is enabled on the transit gateway

options.propagation_default_route_table_id

The ID of the default propagation route table.

options.security_group_referencing_support

This parameter is in preview and may not be available for your account.

Enables you to reference a security group across VPCs attached to a transit gateway. Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

options.transit_gateway_cidr_blocks[]
options.vpn_ecmp_support

Indicates whether Equal Cost Multipath Protocol support is enabled.

owner_id

The ID of the Amazon Web Services account that owns the transit gateway.

VARCHAR
state

The state of the transit gateway.

VARCHAR
tags

The tags for the transit gateway.

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_arn

The Amazon Resource Name (ARN) of the transit gateway.

VARCHAR
transit_gateway_id

The ID of the transit gateway.

VARCHAR