com.amazonaws.services.ec2.model

Class Host

java.lang.Object

com.amazonaws.services.ec2.model.Host

All Implemented Interfaces:

Serializable, Cloneable

public class Host
extends Object
implements Serializable, Cloneable

Describes the properties of the Dedicated host.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Host()

Method Summary

Methods

Modifier and Type	Method and Description
Host	clone()
boolean	equals(Object obj)
String	getAutoPlacement() Whether auto-placement is on or off.
String	getAvailabilityZone() The Availability Zone of the Dedicated host.
AvailableCapacity	getAvailableCapacity() The number of new instances that can be launched onto the Dedicated host.
String	getClientToken() Unique, case-sensitive identifier you provide to ensure idempotency of the request.
String	getHostId() The ID of the Dedicated host.
HostProperties	getHostProperties() The hardware specifications of the Dedicated host.
String	getHostReservationId() The reservation ID of the Dedicated host.
List<HostInstance>	getInstances() The IDs and instance type that are currently running on the Dedicated host.
String	getState() The Dedicated host's state.
int	hashCode()
void	setAutoPlacement(AutoPlacement autoPlacement) Whether auto-placement is on or off.
void	setAutoPlacement(String autoPlacement) Whether auto-placement is on or off.
void	setAvailabilityZone(String availabilityZone) The Availability Zone of the Dedicated host.
void	setAvailableCapacity(AvailableCapacity availableCapacity) The number of new instances that can be launched onto the Dedicated host.
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
void	setHostId(String hostId) The ID of the Dedicated host.
void	setHostProperties(HostProperties hostProperties) The hardware specifications of the Dedicated host.
void	setHostReservationId(String hostReservationId) The reservation ID of the Dedicated host.
void	setInstances(Collection<HostInstance> instances) The IDs and instance type that are currently running on the Dedicated host.
void	setState(AllocationState state) The Dedicated host's state.
void	setState(String state) The Dedicated host's state.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Host	withAutoPlacement(AutoPlacement autoPlacement) Whether auto-placement is on or off.
Host	withAutoPlacement(String autoPlacement) Whether auto-placement is on or off.
Host	withAvailabilityZone(String availabilityZone) The Availability Zone of the Dedicated host.
Host	withAvailableCapacity(AvailableCapacity availableCapacity) The number of new instances that can be launched onto the Dedicated host.
Host	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
Host	withHostId(String hostId) The ID of the Dedicated host.
Host	withHostProperties(HostProperties hostProperties) The hardware specifications of the Dedicated host.
Host	withHostReservationId(String hostReservationId) The reservation ID of the Dedicated host.
Host	withInstances(Collection<HostInstance> instances) The IDs and instance type that are currently running on the Dedicated host.
Host	withInstances(HostInstance... instances) The IDs and instance type that are currently running on the Dedicated host.
Host	withState(AllocationState state) The Dedicated host's state.
Host	withState(String state) The Dedicated host's state.

Methods inherited from class java.lang.Object

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

Constructor Detail

Host

public Host()

Method Detail

getHostId

public String getHostId()

The ID of the Dedicated host.

Returns:

The ID of the Dedicated host.

setHostId

public void setHostId(String hostId)

The ID of the Dedicated host.

Parameters:

hostId - The ID of the Dedicated host.

withHostId

public Host withHostId(String hostId)

The ID of the Dedicated host.

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

Parameters:

hostId - The ID of the Dedicated host.

Returns:

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

getAutoPlacement

public String getAutoPlacement()

Whether auto-placement is on or off.

Constraints:
Allowed Values: on, off

Returns:

Whether auto-placement is on or off.

See Also:

AutoPlacement

setAutoPlacement

public void setAutoPlacement(String autoPlacement)

Whether auto-placement is on or off.

Constraints:
Allowed Values: on, off

Parameters:

autoPlacement - Whether auto-placement is on or off.

See Also:

AutoPlacement

withAutoPlacement

public Host withAutoPlacement(String autoPlacement)

Whether auto-placement is on or off.

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

Constraints:
Allowed Values: on, off

Parameters:

autoPlacement - Whether auto-placement is on or off.

Returns:

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

See Also:

AutoPlacement

setAutoPlacement

public void setAutoPlacement(AutoPlacement autoPlacement)

Whether auto-placement is on or off.

Constraints:
Allowed Values: on, off

Parameters:

autoPlacement - Whether auto-placement is on or off.

See Also:

AutoPlacement

withAutoPlacement

public Host withAutoPlacement(AutoPlacement autoPlacement)

Whether auto-placement is on or off.

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

Constraints:
Allowed Values: on, off

Parameters:

autoPlacement - Whether auto-placement is on or off.

Returns:

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

See Also:

AutoPlacement

getHostReservationId

public String getHostReservationId()

The reservation ID of the Dedicated host. This returns a null response if the Dedicated host doesn't have an associated reservation.

Returns:

The reservation ID of the Dedicated host. This returns a null response if the Dedicated host doesn't have an associated reservation.

setHostReservationId

public void setHostReservationId(String hostReservationId)

The reservation ID of the Dedicated host. This returns a null response if the Dedicated host doesn't have an associated reservation.

Parameters:

hostReservationId - The reservation ID of the Dedicated host. This returns a null response if the Dedicated host doesn't have an associated reservation.

withHostReservationId

public Host withHostReservationId(String hostReservationId)

The reservation ID of the Dedicated host. This returns a null response if the Dedicated host doesn't have an associated reservation.

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

Parameters:

hostReservationId - The reservation ID of the Dedicated host. This returns a null response if the Dedicated host doesn't have an associated reservation.

Returns:

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

getClientToken

public String getClientToken()

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Returns:

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

setClientToken

public void setClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

withClientToken

public Host withClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

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

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Returns:

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

getHostProperties

public HostProperties getHostProperties()

The hardware specifications of the Dedicated host.

Returns:

The hardware specifications of the Dedicated host.

setHostProperties

public void setHostProperties(HostProperties hostProperties)

The hardware specifications of the Dedicated host.

Parameters:

hostProperties - The hardware specifications of the Dedicated host.

withHostProperties

public Host withHostProperties(HostProperties hostProperties)

The hardware specifications of the Dedicated host.

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

Parameters:

hostProperties - The hardware specifications of the Dedicated host.

Returns:

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

getState

public String getState()

The Dedicated host's state.

Constraints:
Allowed Values: available, under-assessment, permanent-failure, released, released-permanent-failure

Returns:

The Dedicated host's state.

See Also:

AllocationState

setState

public void setState(String state)

The Dedicated host's state.

Constraints:
Allowed Values: available, under-assessment, permanent-failure, released, released-permanent-failure

Parameters:

state - The Dedicated host's state.

See Also:

AllocationState

withState

public Host withState(String state)

The Dedicated host's state.

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

Constraints:
Allowed Values: available, under-assessment, permanent-failure, released, released-permanent-failure

Parameters:

state - The Dedicated host's state.

Returns:

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

See Also:

AllocationState

setState

public void setState(AllocationState state)

The Dedicated host's state.

Constraints:
Allowed Values: available, under-assessment, permanent-failure, released, released-permanent-failure

Parameters:

state - The Dedicated host's state.

See Also:

AllocationState

withState

public Host withState(AllocationState state)

The Dedicated host's state.

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

Constraints:
Allowed Values: available, under-assessment, permanent-failure, released, released-permanent-failure

Parameters:

state - The Dedicated host's state.

Returns:

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

See Also:

AllocationState

getAvailabilityZone

public String getAvailabilityZone()

The Availability Zone of the Dedicated host.

Returns:

The Availability Zone of the Dedicated host.

setAvailabilityZone

public void setAvailabilityZone(String availabilityZone)

The Availability Zone of the Dedicated host.

Parameters:

availabilityZone - The Availability Zone of the Dedicated host.

withAvailabilityZone

public Host withAvailabilityZone(String availabilityZone)

The Availability Zone of the Dedicated host.

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

Parameters:

availabilityZone - The Availability Zone of the Dedicated host.

Returns:

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

getInstances

public List<HostInstance> getInstances()

The IDs and instance type that are currently running on the Dedicated host.

Returns:

The IDs and instance type that are currently running on the Dedicated host.

setInstances

public void setInstances(Collection<HostInstance> instances)

The IDs and instance type that are currently running on the Dedicated host.

Parameters:

instances - The IDs and instance type that are currently running on the Dedicated host.

withInstances

public Host withInstances(HostInstance... instances)

The IDs and instance type that are currently running on the Dedicated host.

NOTE: This method appends the values to the existing list (if any). Use setInstances(java.util.Collection) or withInstances(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:

instances - The IDs and instance type that are currently running on the Dedicated host.

Returns:

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

withInstances

public Host withInstances(Collection<HostInstance> instances)

The IDs and instance type that are currently running on the Dedicated host.

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

Parameters:

instances - The IDs and instance type that are currently running on the Dedicated host.

Returns:

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

getAvailableCapacity

public AvailableCapacity getAvailableCapacity()

The number of new instances that can be launched onto the Dedicated host.

Returns:

The number of new instances that can be launched onto the Dedicated host.

setAvailableCapacity

public void setAvailableCapacity(AvailableCapacity availableCapacity)

The number of new instances that can be launched onto the Dedicated host.

Parameters:

availableCapacity - The number of new instances that can be launched onto the Dedicated host.

withAvailableCapacity

public Host withAvailableCapacity(AvailableCapacity availableCapacity)

The number of new instances that can be launched onto the Dedicated host.

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

Parameters:

availableCapacity - The number of new instances that can be launched onto the Dedicated host.

Returns:

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

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 Host clone()

Overrides:

clone in class Object