Class CapacityReservation

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

Describes a Capacity Reservation.

See Also:

  • Method Details

    • capacityReservationId

      public final String capacityReservationId()

      The ID of the Capacity Reservation.

      Returns:
      The ID of the Capacity Reservation.

    • ownerId

      public final String ownerId()

      The ID of the Amazon Web Services account that owns the Capacity Reservation.

      Returns:
      The ID of the Amazon Web Services account that owns the Capacity Reservation.

    • capacityReservationArn

      public final String capacityReservationArn()

      The Amazon Resource Name (ARN) of the Capacity Reservation.

      Returns:
      The Amazon Resource Name (ARN) of the Capacity Reservation.

    • availabilityZoneId

      public final String availabilityZoneId()

      The Availability Zone ID of the Capacity Reservation.

      Returns:
      The Availability Zone ID of the Capacity Reservation.

    • instanceType

      public final String instanceType()

      The type of instance for which the Capacity Reservation reserves capacity.

      Returns:
      The type of instance for which the Capacity Reservation reserves capacity.

    • instancePlatform

      public final CapacityReservationInstancePlatform instancePlatform()

      The type of operating system for which the Capacity Reservation reserves capacity.

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

      Returns:
      The type of operating system for which the Capacity Reservation reserves capacity.
      See Also:

    • instancePlatformAsString

      public final String instancePlatformAsString()

      The type of operating system for which the Capacity Reservation reserves capacity.

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

      Returns:
      The type of operating system for which the Capacity Reservation reserves capacity.
      See Also:

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone in which the capacity is reserved.

      Returns:
      The Availability Zone in which the capacity is reserved.

    • tenancy

      public final CapacityReservationTenancy tenancy()

      Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

      • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

      • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

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

      Returns:
      Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

      • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

      • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

      See Also:

    • tenancyAsString

      public final String tenancyAsString()

      Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

      • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

      • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

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

      Returns:
      Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

      • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

      • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

      See Also:

    • totalInstanceCount

      public final Integer totalInstanceCount()

      The total number of instances for which the Capacity Reservation reserves capacity.

      Returns:
      The total number of instances for which the Capacity Reservation reserves capacity.

    • availableInstanceCount

      public final Integer availableInstanceCount()

      The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

      Returns:
      The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

    • ebsOptimized

      public final Boolean ebsOptimized()

      Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

      Returns:
      Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

    • ephemeralStorage

      public final Boolean ephemeralStorage()

      Deprecated.

      Returns:
      Deprecated.

    • state

      public final CapacityReservationState state()

      The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

      • active - The capacity is available for use.

      • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.

      • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.

      • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

      • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.

      • scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.

      • payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.

      • payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.

      • assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.

      • delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.

      • unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

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

      Returns:
      The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

      • active - The capacity is available for use.

      • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.

      • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.

      • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

      • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.

      • scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.

      • payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.

      • payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.

      • assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.

      • delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.

      • unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

      • active - The capacity is available for use.

      • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.

      • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.

      • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

      • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.

      • scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.

      • payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.

      • payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.

      • assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.

      • delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.

      • unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

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

      Returns:
      The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

      • active - The capacity is available for use.

      • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.

      • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.

      • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

      • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.

      • scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.

      • payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.

      • payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.

      • assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.

      • delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.

      • unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

      See Also:

    • startDate

      public final Instant startDate()

      The date and time at which the Capacity Reservation was started.

      Returns:
      The date and time at which the Capacity Reservation was started.

    • endDate

      public final Instant endDate()

      The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

      Returns:
      The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

    • endDateType

      public final EndDateType endDateType()

      Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

      • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

      • limited - The Capacity Reservation expires automatically at a specified date and time.

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

      Returns:
      Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

      • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

      • limited - The Capacity Reservation expires automatically at a specified date and time.

      See Also:

    • endDateTypeAsString

      public final String endDateTypeAsString()

      Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

      • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

      • limited - The Capacity Reservation expires automatically at a specified date and time.

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

      Returns:
      Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

      • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

      • limited - The Capacity Reservation expires automatically at a specified date and time.

      See Also:

    • instanceMatchCriteria

      public final InstanceMatchCriteria instanceMatchCriteria()

      Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

      • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

      • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

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

      Returns:
      Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

      • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

      • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

      See Also:

    • instanceMatchCriteriaAsString

      public final String instanceMatchCriteriaAsString()

      Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

      • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

      • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

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

      Returns:
      Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

      • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

      • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

      See Also:

    • createDate

      public final Instant createDate()

      The date and time at which the Capacity Reservation was created.

      Returns:
      The date and time at which the Capacity Reservation was created.

    • 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 Capacity Reservation.

      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 Capacity Reservation.

    • outpostArn

      public final String outpostArn()

      The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.

      Returns:
      The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.

    • capacityReservationFleetId

      public final String capacityReservationFleetId()

      The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.

      Returns:
      The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.

    • placementGroupArn

      public final String placementGroupArn()

      The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.

    • hasCapacityAllocations

      public final boolean hasCapacityAllocations()
      For responses, this returns true if the service returned a value for the CapacityAllocations 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.

    • capacityAllocations

      public final List<CapacityAllocation> capacityAllocations()

      Information about instance capacity usage.

      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 hasCapacityAllocations() method.

      Returns:
      Information about instance capacity usage.

    • reservationType

      public final CapacityReservationType reservationType()

      The type of Capacity Reservation.

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

      Returns:
      The type of Capacity Reservation.
      See Also:

    • reservationTypeAsString

      public final String reservationTypeAsString()

      The type of Capacity Reservation.

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

      Returns:
      The type of Capacity Reservation.
      See Also:

    • unusedReservationBillingOwnerId

      public final String unusedReservationBillingOwnerId()

      The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.

      Returns:
      The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.

    • commitmentInfo

      public final CapacityReservationCommitmentInfo commitmentInfo()

      Information about your commitment for a future-dated Capacity Reservation.

      Returns:
      Information about your commitment for a future-dated Capacity Reservation.

    • deliveryPreference

      public final CapacityReservationDeliveryPreference deliveryPreference()

      The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.

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

      Returns:
      The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
      See Also:

    • deliveryPreferenceAsString

      public final String deliveryPreferenceAsString()

      The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.

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

      Returns:
      The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
      See Also:

    • capacityBlockId

      public final String capacityBlockId()

      The ID of the Capacity Block.

      Returns:
      The ID of the Capacity Block.

    • toBuilder

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

    • builder

      public static CapacityReservation.Builder builder()

    • serializableBuilderClass

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