Skip to content

aws.ec2.describe_vpcs

Example SQL Queries

SELECT * FROM
aws.ec2.describe_vpcs;

Description

Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria.

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

The filters.

  • cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.

  • cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.

  • cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.

  • dhcp-options-id - The ID of a set of DHCP options.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

  • ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

  • is-default - Indicates whether the VPC is the default VPC.

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

  • state - The state of the VPC (pending | available).

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

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC.

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

The IDs of the VPCs.

VARCHAR[]
Show child fields
vpc_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
cidr_block

The primary IPv4 CIDR block for the VPC.

VARCHAR
cidr_block_association_set

Information about the IPv4 CIDR blocks associated with the VPC.

STRUCT(
"association_id" VARCHAR,
"cidr_block" VARCHAR,
"cidr_block_state" STRUCT(
"state" VARCHAR,
"status_message" VARCHAR
)
)[]
Show child fields
cidr_block_association_set[]
Show child fields
cidr_block_association_set[].association_id

The association ID for the IPv4 CIDR block.

cidr_block_association_set[].cidr_block

The IPv4 CIDR block.

cidr_block_association_set[].cidr_block_state

Information about the state of the CIDR block.

Show child fields
cidr_block_association_set[].cidr_block_state.state

The state of the CIDR block.

cidr_block_association_set[].cidr_block_state.status_message

A message about the status of the CIDR block, if applicable.

dhcp_options_id

The ID of the set of DHCP options you've associated with the VPC.

VARCHAR
instance_tenancy

The allowed tenancy of instances launched into the VPC.

VARCHAR
ipv6_cidr_block_association_set

Information about the IPv6 CIDR blocks associated with the VPC.

STRUCT(
"association_id" VARCHAR,
"ipv6_cidr_block" VARCHAR,
"ipv6_cidr_block_state" STRUCT(
"state" VARCHAR,
"status_message" VARCHAR
),
"network_border_group" VARCHAR,
"ipv6_pool" VARCHAR,
"ipv6_address_attribute" VARCHAR,
"ip_source" VARCHAR
)[]
Show child fields
ipv6_cidr_block_association_set[]
Show child fields
ipv6_cidr_block_association_set[].association_id

The association ID for the IPv6 CIDR block.

ipv6_cidr_block_association_set[].ip_source

The source that allocated the IP address space. byoip or amazon indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). none indicates private space.

ipv6_cidr_block_association_set[].ipv6_address_attribute

Public IPv6 addresses are those advertised on the internet from Amazon Web Services. Private IP addresses are not and cannot be advertised on the internet from Amazon Web Services.

ipv6_cidr_block_association_set[].ipv6_cidr_block

The IPv6 CIDR block.

ipv6_cidr_block_association_set[].ipv6_cidr_block_state

Information about the state of the CIDR block.

Show child fields
ipv6_cidr_block_association_set[].ipv6_cidr_block_state.state

The state of the CIDR block.

ipv6_cidr_block_association_set[].ipv6_cidr_block_state.status_message

A message about the status of the CIDR block, if applicable.

ipv6_cidr_block_association_set[].ipv6_pool

The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

ipv6_cidr_block_association_set[].network_border_group

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example, us-east-1-wl1-bos-wlz-1.

is_default

Indicates whether the VPC is the default VPC.

BOOLEAN
owner_id

The ID of the Amazon Web Services account that owns the VPC.

VARCHAR
state

The current state of the VPC.

VARCHAR
tags

Any tags assigned to the VPC.

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.

vpc_id

The ID of the VPC.

VARCHAR