Class CapacityReservationRequest

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

The Capacity Reservation configurations to be used when using the RESERVED capacity option type.

See Also:

  • Method Details

    • reservationGroupArn

      public final String reservationGroupArn()

      The ARN of the Capacity Reservation resource group in which to run the instance.

      Returns:
      The ARN of the Capacity Reservation resource group in which to run the instance.

    • reservationPreference

      public final CapacityReservationPreference reservationPreference()

      The preference on when capacity reservations should be used.

      Valid values are:

      • RESERVATIONS_ONLY - Exclusively launch instances into capacity reservations that match the instance requirements configured for the capacity provider. If none exist, instances will fail to provision.

      • RESERVATIONS_FIRST - Prefer to launch instances into a capacity reservation if any exist that match the instance requirements configured for the capacity provider. If none exist, fall back to launching instances On-Demand.

      • RESERVATIONS_EXCLUDED - Avoid using capacity reservations and launch exclusively On-Demand.

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

      Returns:
      The preference on when capacity reservations should be used.

      Valid values are:

      • RESERVATIONS_ONLY - Exclusively launch instances into capacity reservations that match the instance requirements configured for the capacity provider. If none exist, instances will fail to provision.

      • RESERVATIONS_FIRST - Prefer to launch instances into a capacity reservation if any exist that match the instance requirements configured for the capacity provider. If none exist, fall back to launching instances On-Demand.

      • RESERVATIONS_EXCLUDED - Avoid using capacity reservations and launch exclusively On-Demand.

      See Also:

    • reservationPreferenceAsString

      public final String reservationPreferenceAsString()

      The preference on when capacity reservations should be used.

      Valid values are:

      • RESERVATIONS_ONLY - Exclusively launch instances into capacity reservations that match the instance requirements configured for the capacity provider. If none exist, instances will fail to provision.

      • RESERVATIONS_FIRST - Prefer to launch instances into a capacity reservation if any exist that match the instance requirements configured for the capacity provider. If none exist, fall back to launching instances On-Demand.

      • RESERVATIONS_EXCLUDED - Avoid using capacity reservations and launch exclusively On-Demand.

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

      Returns:
      The preference on when capacity reservations should be used.

      Valid values are:

      • RESERVATIONS_ONLY - Exclusively launch instances into capacity reservations that match the instance requirements configured for the capacity provider. If none exist, instances will fail to provision.

      • RESERVATIONS_FIRST - Prefer to launch instances into a capacity reservation if any exist that match the instance requirements configured for the capacity provider. If none exist, fall back to launching instances On-Demand.

      • RESERVATIONS_EXCLUDED - Avoid using capacity reservations and launch exclusively On-Demand.

      See Also:

    • toBuilder

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

    • builder

      public static CapacityReservationRequest.Builder builder()

    • serializableBuilderClass

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