com.amazonaws.services.ec2.model

Class AllocateAddressRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.AllocateAddressRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<AllocateAddressRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AllocateAddressRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<AllocateAddressRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AllocateAddressRequest()

Method Summary

Modifier and Type	Method and Description
AllocateAddressRequest	clone()
boolean	equals(Object obj)
String	getAddress() [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
String	getCustomerOwnedIpv4Pool() The ID of a customer-owned address pool.
String	getDomain() Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
Request<AllocateAddressRequest>	getDryRunRequest() This method is intended for internal use only.
String	getNetworkBorderGroup() A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
String	getPublicIpv4Pool() The ID of an address pool that you own.
List<TagSpecification>	getTagSpecifications() The tags to assign to the Elastic IP address.
int	hashCode()
void	setAddress(String address) [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
void	setCustomerOwnedIpv4Pool(String customerOwnedIpv4Pool) The ID of a customer-owned address pool.
void	setDomain(DomainType domain) Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
void	setDomain(String domain) Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
void	setNetworkBorderGroup(String networkBorderGroup) A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
void	setPublicIpv4Pool(String publicIpv4Pool) The ID of an address pool that you own.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to assign to the Elastic IP address.
String	toString() Returns a string representation of this object.
AllocateAddressRequest	withAddress(String address) [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
AllocateAddressRequest	withCustomerOwnedIpv4Pool(String customerOwnedIpv4Pool) The ID of a customer-owned address pool.
AllocateAddressRequest	withDomain(DomainType domain) Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
AllocateAddressRequest	withDomain(String domain) Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
AllocateAddressRequest	withNetworkBorderGroup(String networkBorderGroup) A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
AllocateAddressRequest	withPublicIpv4Pool(String publicIpv4Pool) The ID of an address pool that you own.
AllocateAddressRequest	withTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to assign to the Elastic IP address.
AllocateAddressRequest	withTagSpecifications(TagSpecification... tagSpecifications) The tags to assign to the Elastic IP address.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

AllocateAddressRequest

public AllocateAddressRequest()

Method Detail

setDomain

public void setDomain(String 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.

Parameters:

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.

See Also:

DomainType

getDomain

public String getDomain()

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.

Returns:

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.

See Also:

DomainType

withDomain

public AllocateAddressRequest withDomain(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainType

setDomain

public void setDomain(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.

Parameters:

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.

See Also:

DomainType

withDomain

public AllocateAddressRequest withDomain(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DomainType

setAddress

public void setAddress(String address)

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

Parameters:

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

getAddress

public String getAddress()

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

withAddress

public AllocateAddressRequest withAddress(String address)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setPublicIpv4Pool

public void setPublicIpv4Pool(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.

Parameters:

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.

getPublicIpv4Pool

public String getPublicIpv4Pool()

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.

withPublicIpv4Pool

public AllocateAddressRequest withPublicIpv4Pool(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setNetworkBorderGroup

public void setNetworkBorderGroup(String networkBorderGroup)

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services 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 receive an InvalidParameterCombination error.

Parameters:

networkBorderGroup - A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services 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 receive an InvalidParameterCombination error.

getNetworkBorderGroup

public String getNetworkBorderGroup()

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services 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 receive an InvalidParameterCombination error.

Returns:

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services 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 receive an InvalidParameterCombination error.

withNetworkBorderGroup

public AllocateAddressRequest withNetworkBorderGroup(String networkBorderGroup)

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services 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 receive an InvalidParameterCombination error.

Parameters:

networkBorderGroup - A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services 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 receive an InvalidParameterCombination error.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCustomerOwnedIpv4Pool

public void setCustomerOwnedIpv4Pool(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.

Parameters:

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.

getCustomerOwnedIpv4Pool

public String getCustomerOwnedIpv4Pool()

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.

withCustomerOwnedIpv4Pool

public AllocateAddressRequest withCustomerOwnedIpv4Pool(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

The tags to assign to the Elastic IP address.

Returns:

The tags to assign to the Elastic IP address.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to assign to the Elastic IP address.

Parameters:

tagSpecifications - The tags to assign to the Elastic IP address.

withTagSpecifications

public AllocateAddressRequest withTagSpecifications(TagSpecification... tagSpecifications)

The tags to assign to the Elastic IP address.

NOTE: This method appends the values to the existing list (if any). Use setTagSpecifications(java.util.Collection) or withTagSpecifications(java.util.Collection) if you want to override the existing values.

Parameters:

tagSpecifications - The tags to assign to the Elastic IP address.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTagSpecifications

public AllocateAddressRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to assign to the Elastic IP address.

Parameters:

tagSpecifications - The tags to assign to the Elastic IP address.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<AllocateAddressRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<AllocateAddressRequest>

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AllocateAddressRequest clone()

Overrides:

clone in class AmazonWebServiceRequest