software.amazon.awssdk.services.ec2.model

Class Address

java.lang.Object

software.amazon.awssdk.services.ec2.model.Address

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Address.Builder,Address>

@Generated(value="software.amazon.awssdk:codegen")
public final class Address
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Address.Builder,Address>

Describes an Elastic IP address, or a carrier IP address.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Address.Builder

Method Summary

Modifier and Type	Method and Description
String	allocationId() The ID representing the allocation of the address for use with EC2-VPC.
String	associationId() The ID representing the association of the address with an instance in a VPC.
static Address.Builder	builder()
String	carrierIp() The carrier IP address associated.
String	customerOwnedIp() The customer-owned IP address.
String	customerOwnedIpv4Pool() The ID of the customer-owned address pool.
DomainType	domain() Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).
String	domainAsString() Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	instanceId() The ID of the instance that the address is associated with (if any).
String	networkBorderGroup() The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
String	networkInterfaceId() The ID of the network interface.
String	networkInterfaceOwnerId() The ID of the AWS account that owns the network interface.
String	privateIpAddress() The private IP address associated with the Elastic IP address.
String	publicIp() The Elastic IP address.
String	publicIpv4Pool() The ID of an address pool.
List<SdkField<?>>	sdkFields()
static Class<? extends Address.Builder>	serializableBuilderClass()
List<Tag>	tags() Any tags assigned to the Elastic IP address.
Address.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

instanceId

public final String instanceId()

The ID of the instance that the address is associated with (if any).

Returns:

The ID of the instance that the address is associated with (if any).

publicIp

public final String publicIp()

The Elastic IP address.

Returns:

The Elastic IP address.

allocationId

public final String allocationId()

The ID representing the allocation of the address for use with EC2-VPC.

Returns:

The ID representing the allocation of the address for use with EC2-VPC.

associationId

public final String associationId()

The ID representing the association of the address with an instance in a VPC.

Returns:

The ID representing the association of the address with an instance in a VPC.

domain

public final DomainType domain()

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

If the service returns an enum value that is not available in the current SDK version, domain will return DomainType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().

Returns:

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard ) or instances in a VPC (vpc).

See Also:

DomainType

domainAsString

public final String domainAsString()

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

If the service returns an enum value that is not available in the current SDK version, domain will return DomainType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().

Returns:

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard ) or instances in a VPC (vpc).

See Also:

DomainType

networkInterfaceId

public final String networkInterfaceId()

The ID of the network interface.

Returns:

The ID of the network interface.

networkInterfaceOwnerId

public final String networkInterfaceOwnerId()

The ID of the AWS account that owns the network interface.

Returns:

The ID of the AWS account that owns the network interface.

privateIpAddress

public final String privateIpAddress()

The private IP address associated with the Elastic IP address.

Returns:

The private IP address associated with the Elastic IP address.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final List<Tag> tags()

Any tags assigned to the Elastic IP address.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

Any tags assigned to the Elastic IP address.

publicIpv4Pool

public final String publicIpv4Pool()

The ID of an address pool.

Returns:

The ID of an address pool.

networkBorderGroup

public final String networkBorderGroup()

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

Returns:

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.

customerOwnedIp

public final String customerOwnedIp()

The customer-owned IP address.

Returns:

The customer-owned IP address.

customerOwnedIpv4Pool

public final String customerOwnedIpv4Pool()

The ID of the customer-owned address pool.

Returns:

The ID of the customer-owned address pool.

carrierIp

public final String 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).

Returns:

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

toBuilder

public Address.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Address.Builder,Address>

builder

public static Address.Builder builder()

serializableBuilderClass

public static Class<? extends Address.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo