software.amazon.awssdk.services.ec2.model

Class Host

java.lang.Object

software.amazon.awssdk.services.ec2.model.Host

All Implemented Interfaces:

ToCopyableBuilder<Host.Builder,Host>

@Generated(value="software.amazon.awssdk:codegen")
public final class Host
extends Object
implements ToCopyableBuilder<Host.Builder,Host>

Describes the properties of the Dedicated Host.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Host.Builder

Method Summary

Modifier and Type	Method and Description
AutoPlacement	autoPlacement() Whether auto-placement is on or off.
String	autoPlacementAsString() Whether auto-placement is on or off.
String	availabilityZone() The Availability Zone of the Dedicated Host.
AvailableCapacity	availableCapacity() The number of new instances that can be launched onto the Dedicated Host.
static Host.Builder	builder()
String	clientToken() Unique, case-sensitive identifier you provide to ensure idempotency of the request.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hostId() The ID of the Dedicated Host.
HostProperties	hostProperties() The hardware specifications of the Dedicated Host.
String	hostReservationId() The reservation ID of the Dedicated Host.
List<HostInstance>	instances() The IDs and instance type that are currently running on the Dedicated Host.
static Class<? extends Host.Builder>	serializableBuilderClass()
AllocationState	state() The Dedicated Host's state.
String	stateAsString() The Dedicated Host's state.
Host.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

autoPlacement

public AutoPlacement autoPlacement()

Whether auto-placement is on or off.

If the service returns an enum value that is not available in the current SDK version, autoPlacement will return AutoPlacement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoPlacementAsString().

Returns:

Whether auto-placement is on or off.

See Also:

AutoPlacement

autoPlacementAsString

public String autoPlacementAsString()

Whether auto-placement is on or off.

If the service returns an enum value that is not available in the current SDK version, autoPlacement will return AutoPlacement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from autoPlacementAsString().

Returns:

Whether auto-placement is on or off.

See Also:

AutoPlacement

availabilityZone

public String availabilityZone()

The Availability Zone of the Dedicated Host.

Returns:

The Availability Zone of the Dedicated Host.

availableCapacity

public AvailableCapacity availableCapacity()

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.

clientToken

public 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:

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.

hostId

public String hostId()

The ID of the Dedicated Host.

Returns:

The ID of the Dedicated Host.

hostProperties

public HostProperties hostProperties()

The hardware specifications of the Dedicated Host.

Returns:

The hardware specifications of the Dedicated Host.

hostReservationId

public 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:

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

instances

public List<HostInstance> instances()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

state

public AllocationState state()

The Dedicated Host's state.

If the service returns an enum value that is not available in the current SDK version, state will return AllocationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The Dedicated Host's state.

See Also:

AllocationState

stateAsString

public String stateAsString()

The Dedicated Host's state.

If the service returns an enum value that is not available in the current SDK version, state will return AllocationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The Dedicated Host's state.

See Also:

AllocationState

toBuilder

public Host.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Host.Builder,Host>

Returns:

a builder for type T

builder

public static Host.Builder builder()

serializableBuilderClass

public static Class<? extends Host.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)