Skip to main content

eips_list_only

Lists eips in a region or regions, for all properties use eips

Overview

Nameeips_list_only
TypeResource
DescriptionSpecifies an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*.
For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*.
Idaws.ec2.eips_list_only

Fields

NameDatatypeDescription
public_ipstring
allocation_idstring
domainstringThe network (vpc).
If you define an Elastic IP address and associate it with a VPC that is defined in the same template, you must declare a dependency on the VPC-gateway attachment by using the [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) on this resource.
network_border_groupstringA unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups.
transfer_addressstringThe Elastic IP address you are accepting for transfer. You can only accept one transferred address. For more information on Elastic IP address transfers, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon Virtual Private Cloud User Guide*.
instance_idstringThe ID of the instance.
Updates to the InstanceId property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
public_ipv4_poolstringThe ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.
Updates to the PublicIpv4Pool property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
tagsarrayAny tags assigned to the Elastic IP address.
Updates to the Tags property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all eips in a region.

SELECT
region,
public_ip,
allocation_id
FROM aws.ec2.eips_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the eips_list_only resource, see eips