Class Host

java.lang.Object
software.amazon.awssdk.services.ec2.model.Host
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Host.Builder,Host>
@Generated("software.amazon.awssdk:codegen") public final class Host extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Host.Builder,Host>

Describes the properties of the Dedicated Host.

See Also:

  • Method Details

    • autoPlacement

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

    • autoPlacementAsString

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

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone of the Dedicated Host.

      Returns:
      The Availability Zone of the Dedicated Host.

    • availableCapacity

      public final AvailableCapacity availableCapacity()

      Information about the instances running on the Dedicated Host.

      Returns:
      Information about the instances running on the Dedicated Host.

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

    • hostId

      public final String hostId()

      The ID of the Dedicated Host.

      Returns:
      The ID of the Dedicated Host.

    • hostProperties

      public final HostProperties hostProperties()

      The hardware specifications of the Dedicated Host.

      Returns:
      The hardware specifications of the Dedicated Host.

    • hostReservationId

      public final 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.

    • hasInstances

      public final boolean hasInstances()
      For responses, this returns true if the service returned a value for the Instances property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • instances

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstances() method.

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

    • state

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

    • stateAsString

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

    • allocationTime

      public final Instant allocationTime()

      The time that the Dedicated Host was allocated.

      Returns:
      The time that the Dedicated Host was allocated.

    • releaseTime

      public final Instant releaseTime()

      The time that the Dedicated Host was released.

      Returns:
      The time that the Dedicated Host was released.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Any tags assigned to the Dedicated Host.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Any tags assigned to the Dedicated Host.

    • hostRecovery

      public final HostRecovery hostRecovery()

      Indicates whether host recovery is enabled or disabled for the Dedicated Host.

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

      Returns:
      Indicates whether host recovery is enabled or disabled for the Dedicated Host.
      See Also:

    • hostRecoveryAsString

      public final String hostRecoveryAsString()

      Indicates whether host recovery is enabled or disabled for the Dedicated Host.

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

      Returns:
      Indicates whether host recovery is enabled or disabled for the Dedicated Host.
      See Also:

    • allowsMultipleInstanceTypes

      public final AllowsMultipleInstanceTypes allowsMultipleInstanceTypes()

      Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.

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

      Returns:
      Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.
      See Also:

    • allowsMultipleInstanceTypesAsString

      public final String allowsMultipleInstanceTypesAsString()

      Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.

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

      Returns:
      Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.
      See Also:

    • ownerId

      public final String ownerId()

      The ID of the Amazon Web Services account that owns the Dedicated Host.

      Returns:
      The ID of the Amazon Web Services account that owns the Dedicated Host.

    • availabilityZoneId

      public final String availabilityZoneId()

      The ID of the Availability Zone in which the Dedicated Host is allocated.

      Returns:
      The ID of the Availability Zone in which the Dedicated Host is allocated.

    • memberOfServiceLinkedResourceGroup

      public final Boolean memberOfServiceLinkedResourceGroup()

      Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the host is in a host resource group; otherwise, it is not.

      Returns:
      Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the host is in a host resource group; otherwise, it is not.

    • outpostArn

      public final String outpostArn()

      The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.

    • hostMaintenance

      public final HostMaintenance hostMaintenance()

      Indicates whether host maintenance is enabled or disabled for the Dedicated Host.

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

      Returns:
      Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
      See Also:

    • hostMaintenanceAsString

      public final String hostMaintenanceAsString()

      Indicates whether host maintenance is enabled or disabled for the Dedicated Host.

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

      Returns:
      Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
      See Also:

    • assetId

      public final String assetId()

      The ID of the Outpost hardware asset on which the Dedicated Host is allocated.

      Returns:
      The ID of the Outpost hardware asset on which the Dedicated Host is allocated.

    • 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 final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.