Package software.amazon.awssdk.services.ec2.model

Class CapacityReservationSpecification

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

Describes an instance's Capacity Reservation targeting option.

Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance, to run in any open Capacity Reservation that has matching attributes, or to run only in a Capacity Reservation or Capacity Reservation group. Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.

You can only specify CapacityReservationPreference and CapacityReservationTarget if the CapacityReservationPreference is capacity-reservations-only.

See Also:

  • Method Details

    • capacityReservationPreference

      public final CapacityReservationPreference capacityReservationPreference()

      Indicates the instance's Capacity Reservation preferences. Possible preferences include:

      • capacity-reservations-only - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.

      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, and tenancy). If capacity isn't available, the instance runs as an On-Demand Instance.

      • none - The instance doesn't run in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

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

      Returns:
      Indicates the instance's Capacity Reservation preferences. Possible preferences include:

      • capacity-reservations-only - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.

      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, and tenancy). If capacity isn't available, the instance runs as an On-Demand Instance.

      • none - The instance doesn't run in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

      See Also:

    • capacityReservationPreferenceAsString

      public final String capacityReservationPreferenceAsString()

      Indicates the instance's Capacity Reservation preferences. Possible preferences include:

      • capacity-reservations-only - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.

      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, and tenancy). If capacity isn't available, the instance runs as an On-Demand Instance.

      • none - The instance doesn't run in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

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

      Returns:
      Indicates the instance's Capacity Reservation preferences. Possible preferences include:

      • capacity-reservations-only - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.

      • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, and tenancy). If capacity isn't available, the instance runs as an On-Demand Instance.

      • none - The instance doesn't run in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

      See Also:

    • capacityReservationTarget

      public final CapacityReservationTarget capacityReservationTarget()

      Information about the target Capacity Reservation or Capacity Reservation group.

      Returns:
      Information about the target Capacity Reservation or Capacity Reservation group.

    • toBuilder

      public CapacityReservationSpecification.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CapacityReservationSpecification.Builder,CapacityReservationSpecification>

    • builder

      public static CapacityReservationSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CapacityReservationSpecification.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo