Skip to content
AWS for Query.Farm

aws.ec2.describe_byoip_cidrs

Example SQL Queries

SELECT * FROM
aws.ec2.describe_byoip_cidrs
WHERE
"max_results" = 'VALUE';

Description

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools or DescribeIpv6Pools.

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
_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
asn_associations

The BYOIP CIDR associations with ASNs.

STRUCT(
    "asn" VARCHAR,
    "cidr" VARCHAR,
    "status_message" VARCHAR,
    "state" VARCHAR
)[]
Show child fields
asn_associations[]
Show child fields
asn_associations[].asn

The association's ASN.

asn_associations[].cidr

The association's CIDR.

asn_associations[].state

The association's state.

asn_associations[].status_message

The association's status message.

cidr

The address range, in CIDR notation.

VARCHAR
description

The description of the address range.

VARCHAR
network_border_group

If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

  • us-east-1-dfw-2

  • us-west-2-lax-1

  • us-west-2-phx-2

You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.

VARCHAR
state

The state of the address range.

  • advertised: The address range is being advertised to the internet by Amazon Web Services.

  • deprovisioned: The address range is deprovisioned.

  • failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.

  • failed-provision: The request to provision the address range was unsuccessful.

  • pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.

  • pending-provision: You’ve submitted a request to provision an address range and it's pending.

  • provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.

  • provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.

VARCHAR
status_message

Upon success, contains the ID of the address pool. Otherwise, contains an error message.

VARCHAR