Class CapacityReservation
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CapacityReservation.Builder,
CapacityReservation>
Describes a Capacity Reservation.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Availability Zone in which the capacity is reserved.final String
The Availability Zone ID of the Capacity Reservation.final Integer
The remaining capacity.static CapacityReservation.Builder
builder()
final List
<CapacityAllocation> Information about instance capacity usage.final String
The ID of the Capacity Block.final String
The Amazon Resource Name (ARN) of the Capacity Reservation.final String
The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs.final String
The ID of the Capacity Reservation.Information about your commitment for a future-dated Capacity Reservation.final Instant
The date and time at which the Capacity Reservation was created.The delivery method for a future-dated Capacity Reservation.final String
The delivery method for a future-dated Capacity Reservation.final Boolean
Indicates whether the Capacity Reservation supports EBS-optimized instances.final Instant
endDate()
The date and time at which the Capacity Reservation expires.final EndDateType
Indicates the way in which the Capacity Reservation ends.final String
Indicates the way in which the Capacity Reservation ends.final Boolean
Deprecated.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CapacityAllocations property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final InstanceMatchCriteria
Indicates the type of instance launches that the Capacity Reservation accepts.final String
Indicates the type of instance launches that the Capacity Reservation accepts.The type of operating system for which the Capacity Reservation reserves capacity.final String
The type of operating system for which the Capacity Reservation reserves capacity.final String
The type of instance for which the Capacity Reservation reserves capacity.final String
The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.final String
ownerId()
The ID of the Amazon Web Services account that owns the Capacity Reservation.final String
The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created.final CapacityReservationType
The type of Capacity Reservation.final String
The type of Capacity Reservation.static Class
<? extends CapacityReservation.Builder> final Instant
The date and time at which the Capacity Reservation was started.final CapacityReservationState
state()
The current state of the Capacity Reservation.final String
The current state of the Capacity Reservation.tags()
Any tags assigned to the Capacity Reservation.tenancy()
Indicates the tenancy of the Capacity Reservation.final String
Indicates the tenancy of the Capacity Reservation.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The total number of instances for which the Capacity Reservation reserves capacity.final String
The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
capacityReservationId
The ID of the Capacity Reservation.
- Returns:
- The ID of the Capacity Reservation.
-
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
The Amazon Resource Name (ARN) of the Capacity Reservation.
- Returns:
- The Amazon Resource Name (ARN) of the Capacity Reservation.
-
availabilityZoneId
The Availability Zone ID of the Capacity Reservation.
- Returns:
- The Availability Zone ID of the Capacity Reservation.
-
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
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 returnCapacityReservationInstancePlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstancePlatformAsString()
.- Returns:
- The type of operating system for which the Capacity Reservation reserves capacity.
- See Also:
-
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 returnCapacityReservationInstancePlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstancePlatformAsString()
.- Returns:
- The type of operating system for which the Capacity Reservation reserves capacity.
- See Also:
-
availabilityZone
The Availability Zone in which the capacity is reserved.
- Returns:
- The Availability Zone in which the capacity is reserved.
-
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 returnCapacityReservationTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtenancyAsString()
.- 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
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 returnCapacityReservationTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtenancyAsString()
.- 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
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
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
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
-
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 returnCapacityReservationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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
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 returnCapacityReservationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- 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
The date and time at which the Capacity Reservation was started.
- Returns:
- The date and time at which the Capacity Reservation was started.
-
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
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 returnEndDateType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendDateTypeAsString()
.- 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
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 returnEndDateType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendDateTypeAsString()
.- 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
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 returnInstanceMatchCriteria.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceMatchCriteriaAsString()
.- 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
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 returnInstanceMatchCriteria.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceMatchCriteriaAsString()
.- 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
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 theisEmpty()
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
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
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
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
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 theisEmpty()
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
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
The type of Capacity Reservation.
If the service returns an enum value that is not available in the current SDK version,
reservationType
will returnCapacityReservationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreservationTypeAsString()
.- Returns:
- The type of Capacity Reservation.
- See Also:
-
reservationTypeAsString
The type of Capacity Reservation.
If the service returns an enum value that is not available in the current SDK version,
reservationType
will returnCapacityReservationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromreservationTypeAsString()
.- Returns:
- The type of Capacity Reservation.
- See Also:
-
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
Information about your commitment for a future-dated Capacity Reservation.
- Returns:
- Information about your commitment for a future-dated Capacity Reservation.
-
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 returnCapacityReservationDeliveryPreference.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeliveryPreferenceAsString()
.- 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
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 returnCapacityReservationDeliveryPreference.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeliveryPreferenceAsString()
.- 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
The ID of the Capacity Block.
- Returns:
- The ID of the Capacity Block.
-
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 interfaceToCopyableBuilder<CapacityReservation.Builder,
CapacityReservation> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-