com.amazonaws.services.ec2.model

Class AssignPrivateIpAddressesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.AssignPrivateIpAddressesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class AssignPrivateIpAddressesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the AssignPrivateIpAddresses operation.

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide . For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide .

AssignPrivateIpAddresses is available only in EC2-VPC.

See Also:

AmazonEC2.assignPrivateIpAddresses(AssignPrivateIpAddressesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AssignPrivateIpAddressesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
AssignPrivateIpAddressesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Boolean	getAllowReassignment() Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
String	getNetworkInterfaceId() The ID of the network interface.
List<String>	getPrivateIpAddresses() One or more IP addresses to be assigned as a secondary private IP address to the network interface.
Integer	getSecondaryPrivateIpAddressCount() The number of secondary IP addresses to assign to the network interface.
int	hashCode()
Boolean	isAllowReassignment() Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
void	setAllowReassignment(Boolean allowReassignment) Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
void	setNetworkInterfaceId(String networkInterfaceId) The ID of the network interface.
void	setPrivateIpAddresses(Collection<String> privateIpAddresses) One or more IP addresses to be assigned as a secondary private IP address to the network interface.
void	setSecondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount) The number of secondary IP addresses to assign to the network interface.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AssignPrivateIpAddressesRequest	withAllowReassignment(Boolean allowReassignment) Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
AssignPrivateIpAddressesRequest	withNetworkInterfaceId(String networkInterfaceId) The ID of the network interface.
AssignPrivateIpAddressesRequest	withPrivateIpAddresses(Collection<String> privateIpAddresses) One or more IP addresses to be assigned as a secondary private IP address to the network interface.
AssignPrivateIpAddressesRequest	withPrivateIpAddresses(String... privateIpAddresses) One or more IP addresses to be assigned as a secondary private IP address to the network interface.
AssignPrivateIpAddressesRequest	withSecondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount) The number of secondary IP addresses to assign to the network interface.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

AssignPrivateIpAddressesRequest

public AssignPrivateIpAddressesRequest()

Method Detail

getNetworkInterfaceId

public String getNetworkInterfaceId()

The ID of the network interface.

Returns:

The ID of the network interface.

setNetworkInterfaceId

public void setNetworkInterfaceId(String networkInterfaceId)

The ID of the network interface.

Parameters:

networkInterfaceId - The ID of the network interface.

withNetworkInterfaceId

public AssignPrivateIpAddressesRequest withNetworkInterfaceId(String networkInterfaceId)

The ID of the network interface.

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

Parameters:

networkInterfaceId - The ID of the network interface.

Returns:

A reference to this updated object so that method calls can be chained together.

getPrivateIpAddresses

public List<String> getPrivateIpAddresses()

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

Returns:

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

setPrivateIpAddresses

public void setPrivateIpAddresses(Collection<String> privateIpAddresses)

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

Parameters:

privateIpAddresses - One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

withPrivateIpAddresses

public AssignPrivateIpAddressesRequest withPrivateIpAddresses(String... privateIpAddresses)

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

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

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

Parameters:

privateIpAddresses - One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

Returns:

A reference to this updated object so that method calls can be chained together.

withPrivateIpAddresses

public AssignPrivateIpAddressesRequest withPrivateIpAddresses(Collection<String> privateIpAddresses)

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

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

Parameters:

privateIpAddresses - One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

Returns:

A reference to this updated object so that method calls can be chained together.

getSecondaryPrivateIpAddressCount

public Integer getSecondaryPrivateIpAddressCount()

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

Returns:

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

setSecondaryPrivateIpAddressCount

public void setSecondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount)

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

Parameters:

secondaryPrivateIpAddressCount - The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

withSecondaryPrivateIpAddressCount

public AssignPrivateIpAddressesRequest withSecondaryPrivateIpAddressCount(Integer secondaryPrivateIpAddressCount)

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

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

Parameters:

secondaryPrivateIpAddressCount - The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

Returns:

A reference to this updated object so that method calls can be chained together.

isAllowReassignment

public Boolean isAllowReassignment()

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

Returns:

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

setAllowReassignment

public void setAllowReassignment(Boolean allowReassignment)

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

Parameters:

allowReassignment - Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

withAllowReassignment

public AssignPrivateIpAddressesRequest withAllowReassignment(Boolean allowReassignment)

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

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

Parameters:

allowReassignment - Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

Returns:

A reference to this updated object so that method calls can be chained together.

getAllowReassignment

public Boolean getAllowReassignment()

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

Returns:

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public AssignPrivateIpAddressesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()