Address
Describes an Elastic IP address, or a carrier IP address.
Contents
- allocationId
-
The ID representing the allocation of the address.
Type: String
Required: No
- associationId
-
The ID representing the association of the address with an instance.
Type: String
Required: No
- carrierIp
-
The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).
Type: String
Required: No
- customerOwnedIp
-
The customer-owned IP address.
Type: String
Required: No
- customerOwnedIpv4Pool
-
The ID of the customer-owned address pool.
Type: String
Required: No
- domain
-
The network (
vpc).Type: String
Valid Values:
vpc | standardRequired: No
- instanceId
-
The ID of the instance that the address is associated with (if any).
Type: String
Required: No
- networkBorderGroup
-
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon advertises IP addresses.
Type: String
Required: No
- networkInterfaceId
-
The ID of the network interface.
Type: String
Required: No
- networkInterfaceOwnerId
-
The ID of the Amazon Web Services account that owns the network interface.
Type: String
Required: No
- privateIpAddress
-
The private IP address associated with the Elastic IP address.
Type: String
Required: No
- publicIp
-
The Elastic IP address.
Type: String
Required: No
- publicIpv4Pool
-
The ID of an address pool.
Type: String
Required: No
- serviceManaged
-
The service that manages the elastic IP address.
Note
The only option supported today is
alb.Type: String
Valid Values:
alb | nlb | rnatRequired: No
- subnetId
-
The ID of the subnet where the IP address is allocated.
Type: String
Required: No
- tagSet
-
Any tags assigned to the Elastic IP address.
Type: Array of Tag objects
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: