Class InterruptibleCapacityAllocation

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

Represents the allocation of capacity from a source reservation to an interruptible reservation, tracking current and target instance counts for allocation management.

See Also:

  • Method Details

    • instanceCount

      public final Integer instanceCount()

      The current number of instances allocated to the interruptible reservation.

      Returns:
      The current number of instances allocated to the interruptible reservation.

    • targetInstanceCount

      public final Integer targetInstanceCount()

      After your modify request, the requested number of instances allocated to interruptible reservation.

      Returns:
      After your modify request, the requested number of instances allocated to interruptible reservation.

    • status

      public final InterruptibleCapacityReservationAllocationStatus status()

      The current status of the allocation (updating during reclamation, active when complete).

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

      Returns:
      The current status of the allocation (updating during reclamation, active when complete).
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the allocation (updating during reclamation, active when complete).

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

      Returns:
      The current status of the allocation (updating during reclamation, active when complete).
      See Also:

    • interruptibleCapacityReservationId

      public final String interruptibleCapacityReservationId()

      The ID of the interruptible Capacity Reservation created from the allocation.

      Returns:
      The ID of the interruptible Capacity Reservation created from the allocation.

    • interruptionType

      public final InterruptionType interruptionType()

      The type of interruption policy applied to the interruptible reservation.

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

      Returns:
      The type of interruption policy applied to the interruptible reservation.
      See Also:

    • interruptionTypeAsString

      public final String interruptionTypeAsString()

      The type of interruption policy applied to the interruptible reservation.

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

      Returns:
      The type of interruption policy applied to the interruptible reservation.
      See Also:

    • zeroSizePreference

      public final ZeroSizePreference zeroSizePreference()

      Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.

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

      Returns:
      Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
      See Also:

    • zeroSizePreferenceAsString

      public final String zeroSizePreferenceAsString()

      Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.

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

      Returns:
      Specifies how Amazon EC2 handles the interruptible Capacity Reservation when you reduce its allocation to zero instances. A value of retain keeps the interruptible Capacity Reservation active at zero capacity so that you can allocate instances to it again later. A value of default cancels the interruptible Capacity Reservation and returns the capacity to your source Capacity Reservation.
      See Also:

    • toBuilder

      public InterruptibleCapacityAllocation.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<InterruptibleCapacityAllocation.Builder,InterruptibleCapacityAllocation>
      Returns:
      a builder for type T

    • builder

      public static InterruptibleCapacityAllocation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InterruptibleCapacityAllocation.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.