Host (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.Host

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Host
extends Object
implements Serializable, Cloneable
```
Describes the properties of the Dedicated Host.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Host()

Constructors
Constructor and Description
`Host()`

Method Summary

All Methods Instance Methods Concrete 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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Host
```
public Host()
```
- Method Detail
  - setAutoPlacement
```
public void setAutoPlacement(String autoPlacement)
```
    Whether auto-placement is on or off.
    
    Parameters:
    
    autoPlacement - Whether auto-placement is on or off.
    
    See Also:
    
    AutoPlacement
  - getAutoPlacement
```
public String getAutoPlacement()
```
    Whether auto-placement is on or off.
    
    Returns:
    
    Whether auto-placement is on or off.
    
    See Also:
    
    AutoPlacement
  - withAutoPlacement
```
public Host withAutoPlacement(String autoPlacement)
```
    Whether auto-placement is on or off.
    
    Parameters:
    
    autoPlacement - Whether auto-placement is on or off.
    
    Returns:
    
    Returns a reference to this 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.
    
    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.
    
    Parameters:
    
    autoPlacement - Whether auto-placement is on or off.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AutoPlacement
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    The Availability Zone of the Dedicated Host.
    
    Parameters:
    
    availabilityZone - The Availability Zone of the Dedicated Host.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    The Availability Zone of the Dedicated Host.
    
    Returns:
    
    The Availability Zone of the Dedicated Host.
  - withAvailabilityZone
```
public Host withAvailabilityZone(String availabilityZone)
```
    The Availability Zone of the Dedicated Host.
    
    Parameters:
    
    availabilityZone - The Availability Zone of the Dedicated Host.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withAvailableCapacity
```
public Host withAvailableCapacity(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostId
```
public void setHostId(String hostId)
```
    The ID of the Dedicated Host.
    
    Parameters:
    
    hostId - The ID of the Dedicated Host.
  - getHostId
```
public String getHostId()
```
    The ID of the Dedicated Host.
    
    Returns:
    
    The ID of the Dedicated Host.
  - withHostId
```
public Host withHostId(String hostId)
```
    The ID of the Dedicated Host.
    
    Parameters:
    
    hostId - The ID of the Dedicated Host.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostProperties
```
public void setHostProperties(HostProperties hostProperties)
```
    The hardware specifications of the Dedicated Host.
    
    Parameters:
    
    hostProperties - The hardware specifications of the Dedicated Host.
  - getHostProperties
```
public HostProperties getHostProperties()
```
    The hardware specifications of the Dedicated Host.
    
    Returns:
    
    The hardware specifications of the Dedicated Host.
  - withHostProperties
```
public Host withHostProperties(HostProperties hostProperties)
```
    The hardware specifications of the Dedicated Host.
    
    Parameters:
    
    hostProperties - The hardware specifications of the Dedicated Host.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    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:
    
    Returns a reference to this 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.
    
    Parameters:
    
    instances - The IDs and instance type that are currently running on the Dedicated Host.
    
    Returns:
    
    Returns a reference to this 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.
    
    Parameters:
    
    instances - The IDs and instance type that are currently running on the Dedicated Host.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The Dedicated Host's state.
    
    Parameters:
    
    state - The Dedicated Host's state.
    
    See Also:
    
    AllocationState
  - getState
```
public String getState()
```
    The Dedicated Host's state.
    
    Returns:
    
    The Dedicated Host's state.
    
    See Also:
    
    AllocationState
  - withState
```
public Host withState(String state)
```
    The Dedicated Host's state.
    
    Parameters:
    
    state - The Dedicated Host's state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AllocationState
  - setState
```
public void setState(AllocationState state)
```
    The Dedicated Host's state.
    
    Parameters:
    
    state - The Dedicated Host's state.
    
    See Also:
    
    AllocationState
  - withState
```
public Host withState(AllocationState state)
```
    The Dedicated Host's state.
    
    Parameters:
    
    state - The Dedicated Host's state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AllocationState
  - 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Host clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class Host

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Host

Method Detail

setAutoPlacement

getAutoPlacement

withAutoPlacement

setAutoPlacement

withAutoPlacement

setAvailabilityZone

getAvailabilityZone

withAvailabilityZone

setAvailableCapacity

getAvailableCapacity

withAvailableCapacity

setClientToken

getClientToken

withClientToken

setHostId

getHostId

withHostId

setHostProperties

getHostProperties

withHostProperties

setHostReservationId

getHostReservationId

withHostReservationId

getInstances

setInstances

withInstances

withInstances

setState

getState

withState

setState

withState

toString

equals

hashCode

clone