eip
Gets an individual eip resource
Overview
| Name | eip |
| Type | Resource |
| Description | eip |
| Id | awscc.ec2.eip |
Fields
| Name | Datatype | Description |
|---|---|---|
public_ip | string | |
allocation_id | string | |
domain | string | The network (``vpc``).<br/> 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_group | string | A 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.<br/> Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups. |
transfer_address | string | The 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_id | string | The ID of the instance.<br/> Updates to the ``InstanceId`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. |
public_ipv4_pool | string | The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool.<br/> Updates to the ``PublicIpv4Pool`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. |
tags | array | Any tags assigned to the Elastic IP address.<br/> Updates to the ``Tags`` property may require *some interruptions*. Updates on an EIP reassociates the address on its associated resource. |
region | string | AWS region. |
Methods
Currently only SELECT is supported for this resource resource.
Example
SELECT
region,
public_ip,
allocation_id,
domain,
network_border_group,
transfer_address,
instance_id,
public_ipv4_pool,
tags
FROM awscc.ec2.eip
WHERE data__Identifier = '<PublicIp>|<AllocationId>';
Permissions
To operate on the eip resource, the following permissions are required:
Read
ec2:DescribeAddresses
Delete
ec2:ReleaseAddress,
ec2:DescribeAddresses,
ec2:DisassociateAddress
Update
ec2:DescribeAddresses,
ec2:DisassociateAddress,
ec2:DeleteTags,
ec2:CreateTags,
ec2:AssociateAddress