software.amazon.awssdk.services.ec2.model

Class AllocateAddressRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.AllocateAddressRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class AllocateAddressRequest
extends Ec2Request
implements ToCopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AllocateAddressRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	address() [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
static AllocateAddressRequest.Builder	builder()
String	customerOwnedIpv4Pool() The ID of a customer-owned address pool.
DomainType	domain() Set to vpc to allocate the address for use with instances in a VPC.
String	domainAsString() Set to vpc to allocate the address for use with instances in a VPC.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	networkBorderGroup() The location from which the IP address is advertised.
String	publicIpv4Pool() The ID of an address pool that you own.
List<SdkField<?>>	sdkFields()
static Class<? extends AllocateAddressRequest.Builder>	serializableBuilderClass()
AllocateAddressRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

domain

public DomainType domain()

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

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:

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

See Also:

DomainType

domainAsString

public String domainAsString()

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

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:

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

See Also:

DomainType

address

public String address()

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

Returns:

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

publicIpv4Pool

public String publicIpv4Pool()

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

Returns:

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

networkBorderGroup

public String networkBorderGroup()

The location from which the IP address is advertised. Use this parameter to limit the address to this location.

A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises IP addresses and limits the addresses to the group. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

Returns:

The location from which the IP address is advertised. Use this parameter to limit the address to this location.

A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises IP addresses and limits the addresses to the group. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

customerOwnedIpv4Pool

public String customerOwnedIpv4Pool()

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

Returns:

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

toBuilder

public AllocateAddressRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>

Specified by:

toBuilder in class Ec2Request

Returns:

a builder for type T

builder

public static AllocateAddressRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.