@Generated(value="software.amazon.awssdk:codegen") public final class AllocateAddressRequest extends Ec2Request implements ToCopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
AllocateAddressRequest.Builder |
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()
Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
|
String |
domainAsString()
Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
|
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() |
boolean |
hasTagSpecifications()
Returns true if the TagSpecifications 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 |
networkBorderGroup()
A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.
|
String |
publicIpv4Pool()
The ID of an address pool that you own.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AllocateAddressRequest.Builder> |
serializableBuilderClass() |
List<TagSpecification> |
tagSpecifications()
The tags to assign to the Elastic IP address.
|
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.
|
overrideConfiguration
copy
public final DomainType domain()
Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
Default: If the Region supports EC2-Classic, the default is standard
. Otherwise, the default is
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()
.
Default: If the Region supports EC2-Classic, the default is standard
. Otherwise, the default
is vpc
.
DomainType
public final String domainAsString()
Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
Default: If the Region supports EC2-Classic, the default is standard
. Otherwise, the default is
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()
.
Default: If the Region supports EC2-Classic, the default is standard
. Otherwise, the default
is vpc
.
DomainType
public final String address()
[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
public final 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.
Address
parameter
instead.public final String networkBorderGroup()
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.
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.
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.
public final 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.
public final boolean hasTagSpecifications()
public final List<TagSpecification> tagSpecifications()
The tags to assign to the Elastic IP address.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTagSpecifications()
to see if a value was sent in this field.
public AllocateAddressRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<AllocateAddressRequest.Builder,AllocateAddressRequest>
toBuilder
in class Ec2Request
public static AllocateAddressRequest.Builder builder()
public static Class<? extends AllocateAddressRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.