CapacityReservation (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.ec2.model.CapacityReservation

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CapacityReservation.Builder,CapacityReservation>

@Generated(value="software.amazon.awssdk:codegen")
public final class CapacityReservation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CapacityReservation.Builder,CapacityReservation>

Describes a Capacity Reservation.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CapacityReservation.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CapacityReservation.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`availabilityZone()` The Availability Zone in which the capacity is reserved.
`String`	`availabilityZoneId()` The Availability Zone ID of the Capacity Reservation.
`Integer`	`availableInstanceCount()` The remaining capacity.
`static CapacityReservation.Builder`	`builder()`
`String`	`capacityReservationArn()` The Amazon Resource Name (ARN) of the Capacity Reservation.
`String`	`capacityReservationId()` The ID of the Capacity Reservation.
`Instant`	`createDate()` The date and time at which the Capacity Reservation was created.
`Boolean`	`ebsOptimized()` Indicates whether the Capacity Reservation supports EBS-optimized instances.
`Instant`	`endDate()` The date and time at which the Capacity Reservation expires.
`EndDateType`	`endDateType()` Indicates the way in which the Capacity Reservation ends.
`String`	`endDateTypeAsString()` Indicates the way in which the Capacity Reservation ends.
`Boolean`	`ephemeralStorage()` Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`InstanceMatchCriteria`	`instanceMatchCriteria()` Indicates the type of instance launches that the Capacity Reservation accepts.
`String`	`instanceMatchCriteriaAsString()` Indicates the type of instance launches that the Capacity Reservation accepts.
`CapacityReservationInstancePlatform`	`instancePlatform()` The type of operating system for which the Capacity Reservation reserves capacity.
`String`	`instancePlatformAsString()` The type of operating system for which the Capacity Reservation reserves capacity.
`String`	`instanceType()` The type of instance for which the Capacity Reservation reserves capacity.
`String`	`outpostArn()` The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
`String`	`ownerId()` The ID of the Amazon Web Services account that owns the Capacity Reservation.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CapacityReservation.Builder>`	`serializableBuilderClass()`
`Instant`	`startDate()` The date and time at which the Capacity Reservation was started.
`CapacityReservationState`	`state()` The current state of the Capacity Reservation.
`String`	`stateAsString()` The current state of the Capacity Reservation.
`List<Tag>`	`tags()` Any tags assigned to the Capacity Reservation.
`CapacityReservationTenancy`	`tenancy()` Indicates the tenancy of the Capacity Reservation.
`String`	`tenancyAsString()` Indicates the tenancy of the Capacity Reservation.
`CapacityReservation.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`Integer`	`totalInstanceCount()` The total number of instances for which the Capacity Reservation reserves capacity.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    CapacityReservationInstancePlatform
  - 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:
    
    CapacityReservationInstancePlatform
  - 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:
    
    CapacityReservationTenancy
  - 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:
    
    CapacityReservationTenancy
  - 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()
```
    Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
    
    Returns:
    
    Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
  - 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 Reservation is active and the capacity is available for your use.
    - expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
    - cancelled - The Capacity Reservation was cancelled. 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 might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
    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 Reservation is active and the capacity is available for your use.
    
    expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
    
    cancelled - The Capacity Reservation was cancelled. 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 might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
    See Also:
    
    CapacityReservationState
  - 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 Reservation is active and the capacity is available for your use.
    - expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
    - cancelled - The Capacity Reservation was cancelled. 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 might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
    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 Reservation is active and the capacity is available for your use.
    
    expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
    
    cancelled - The Capacity Reservation was cancelled. 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 might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
    See Also:
    
    CapacityReservationState
  - 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:
    
    EndDateType
  - 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:
    
    EndDateType
  - 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:
    
    InstanceMatchCriteria
  - 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:
    
    InstanceMatchCriteria
  - 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.
  - 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.

AWS SDK for Java API Reference - 2.17.41

Class CapacityReservation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

capacityReservationId

ownerId

capacityReservationArn

availabilityZoneId

instanceType

instancePlatform

instancePlatformAsString

availabilityZone

tenancy

tenancyAsString

totalInstanceCount

availableInstanceCount

ebsOptimized

ephemeralStorage

state

stateAsString

startDate

endDate

endDateType

endDateTypeAsString

instanceMatchCriteria

instanceMatchCriteriaAsString

createDate

hasTags

tags

outpostArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields