com.amazonaws.services.ec2.model

Class ModifyInstancePlacementRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.ModifyInstancePlacementRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ModifyInstancePlacementRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the ModifyInstancePlacement operation.

Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.

Instance affinity is disabled by default. When instance affinity is host and it is not associated with a specific Dedicated host, the next time it is launched it will automatically be associated with the host it lands on. This relationship will persist if the instance is stopped/started, or rebooted.

You can modify the host ID associated with a stopped instance. If a stopped instance has a new host ID association, the instance will target that host when restarted.

You can modify the tenancy of a stopped instance with a tenancy of host or dedicated .

Affinity, hostID, and tenancy are not required parameters, but at least one of them must be specified in the request. Affinity and tenancy can be modified in the same request, but tenancy can only be modified on instances that are stopped.

See Also:

AmazonEC2.modifyInstancePlacement(ModifyInstancePlacementRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModifyInstancePlacementRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAffinity() The new affinity setting for the instance.
java.lang.String	getHostId() The ID of the Dedicated host that the instance will have affinity with.
java.lang.String	getInstanceId() The ID of the instance that you are modifying.
java.lang.String	getTenancy() The tenancy of the instance that you are modifying.
int	hashCode()
void	setAffinity(Affinity affinity) The new affinity setting for the instance.
void	setAffinity(java.lang.String affinity) The new affinity setting for the instance.
void	setHostId(java.lang.String hostId) The ID of the Dedicated host that the instance will have affinity with.
void	setInstanceId(java.lang.String instanceId) The ID of the instance that you are modifying.
void	setTenancy(HostTenancy tenancy) The tenancy of the instance that you are modifying.
void	setTenancy(java.lang.String tenancy) The tenancy of the instance that you are modifying.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ModifyInstancePlacementRequest	withAffinity(Affinity affinity) The new affinity setting for the instance.
ModifyInstancePlacementRequest	withAffinity(java.lang.String affinity) The new affinity setting for the instance.
ModifyInstancePlacementRequest	withHostId(java.lang.String hostId) The ID of the Dedicated host that the instance will have affinity with.
ModifyInstancePlacementRequest	withInstanceId(java.lang.String instanceId) The ID of the instance that you are modifying.
ModifyInstancePlacementRequest	withTenancy(HostTenancy tenancy) The tenancy of the instance that you are modifying.
ModifyInstancePlacementRequest	withTenancy(java.lang.String tenancy) The tenancy of the instance that you are modifying.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyInstancePlacementRequest

public ModifyInstancePlacementRequest()

Method Detail

getInstanceId

public java.lang.String getInstanceId()

The ID of the instance that you are modifying.

Returns:

The ID of the instance that you are modifying.

setInstanceId

public void setInstanceId(java.lang.String instanceId)

The ID of the instance that you are modifying.

Parameters:

instanceId - The ID of the instance that you are modifying.

withInstanceId

public ModifyInstancePlacementRequest withInstanceId(java.lang.String instanceId)

The ID of the instance that you are modifying.

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

Parameters:

instanceId - The ID of the instance that you are modifying.

Returns:

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

getTenancy

public java.lang.String getTenancy()

The tenancy of the instance that you are modifying.

Constraints:
Allowed Values: dedicated, host

Returns:

The tenancy of the instance that you are modifying.

See Also:

HostTenancy

setTenancy

public void setTenancy(java.lang.String tenancy)

The tenancy of the instance that you are modifying.

Constraints:
Allowed Values: dedicated, host

Parameters:

tenancy - The tenancy of the instance that you are modifying.

See Also:

HostTenancy

withTenancy

public ModifyInstancePlacementRequest withTenancy(java.lang.String tenancy)

The tenancy of the instance that you are modifying.

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

Constraints:
Allowed Values: dedicated, host

Parameters:

tenancy - The tenancy of the instance that you are modifying.

Returns:

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

See Also:

HostTenancy

setTenancy

public void setTenancy(HostTenancy tenancy)

The tenancy of the instance that you are modifying.

Constraints:
Allowed Values: dedicated, host

Parameters:

tenancy - The tenancy of the instance that you are modifying.

See Also:

HostTenancy

withTenancy

public ModifyInstancePlacementRequest withTenancy(HostTenancy tenancy)

The tenancy of the instance that you are modifying.

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

Constraints:
Allowed Values: dedicated, host

Parameters:

tenancy - The tenancy of the instance that you are modifying.

Returns:

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

See Also:

HostTenancy

getAffinity

public java.lang.String getAffinity()

The new affinity setting for the instance.

Constraints:
Allowed Values: default, host

Returns:

The new affinity setting for the instance.

See Also:

Affinity

setAffinity

public void setAffinity(java.lang.String affinity)

The new affinity setting for the instance.

Constraints:
Allowed Values: default, host

Parameters:

affinity - The new affinity setting for the instance.

See Also:

Affinity

withAffinity

public ModifyInstancePlacementRequest withAffinity(java.lang.String affinity)

The new affinity setting for the instance.

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

Constraints:
Allowed Values: default, host

Parameters:

affinity - The new affinity setting for the instance.

Returns:

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

See Also:

Affinity

setAffinity

public void setAffinity(Affinity affinity)

The new affinity setting for the instance.

Constraints:
Allowed Values: default, host

Parameters:

affinity - The new affinity setting for the instance.

See Also:

Affinity

withAffinity

public ModifyInstancePlacementRequest withAffinity(Affinity affinity)

The new affinity setting for the instance.

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

Constraints:
Allowed Values: default, host

Parameters:

affinity - The new affinity setting for the instance.

Returns:

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

See Also:

Affinity

getHostId

public java.lang.String getHostId()

The ID of the Dedicated host that the instance will have affinity with.

Returns:

The ID of the Dedicated host that the instance will have affinity with.

setHostId

public void setHostId(java.lang.String hostId)

The ID of the Dedicated host that the instance will have affinity with.

Parameters:

hostId - The ID of the Dedicated host that the instance will have affinity with.

withHostId

public ModifyInstancePlacementRequest withHostId(java.lang.String hostId)

The ID of the Dedicated host that the instance will have affinity with.

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

Parameters:

hostId - The ID of the Dedicated host that the instance will have affinity with.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object