Class ReservedInstances
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReservedInstances.Builder,
ReservedInstances>
Describes a Reserved Instance.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Availability Zone in which the Reserved Instance can be used.static ReservedInstances.Builder
builder()
final CurrencyCodeValues
The currency of the Reserved Instance.final String
The currency of the Reserved Instance.final Long
duration()
The duration of the Reserved Instance, in seconds.final Instant
end()
The time when the Reserved Instance expires.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Float
The purchase price of the Reserved Instance.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RecurringCharges property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Integer
The number of reservations purchased.final Tenancy
The tenancy of the instance.final String
The tenancy of the instance.final InstanceType
The instance type on which the Reserved Instance can be used.final String
The instance type on which the Reserved Instance can be used.final OfferingClassType
The offering class of the Reserved Instance.final String
The offering class of the Reserved Instance.final OfferingTypeValues
The Reserved Instance offering type.final String
The Reserved Instance offering type.final RIProductDescription
The Reserved Instance product platform description.final String
The Reserved Instance product platform description.final List
<RecurringCharge> The recurring charge tag assigned to the resource.final String
The ID of the Reserved Instance.final Scope
scope()
The scope of the Reserved Instance.final String
The scope of the Reserved Instance.static Class
<? extends ReservedInstances.Builder> final Instant
start()
The date and time the Reserved Instance started.final ReservedInstanceState
state()
The state of the Reserved Instance purchase.final String
The state of the Reserved Instance purchase.tags()
Any tags assigned to the resource.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 Float
The usage price of the Reserved Instance, per hour.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
availabilityZone
The Availability Zone in which the Reserved Instance can be used.
- Returns:
- The Availability Zone in which the Reserved Instance can be used.
-
duration
The duration of the Reserved Instance, in seconds.
- Returns:
- The duration of the Reserved Instance, in seconds.
-
end
The time when the Reserved Instance expires.
- Returns:
- The time when the Reserved Instance expires.
-
fixedPrice
The purchase price of the Reserved Instance.
- Returns:
- The purchase price of the Reserved Instance.
-
instanceCount
The number of reservations purchased.
- Returns:
- The number of reservations purchased.
-
instanceType
The instance type on which the Reserved Instance can be used.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type on which the Reserved Instance can be used.
- See Also:
-
instanceTypeAsString
The instance type on which the Reserved Instance can be used.
If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- The instance type on which the Reserved Instance can be used.
- See Also:
-
productDescription
The Reserved Instance product platform description.
If the service returns an enum value that is not available in the current SDK version,
productDescription
will returnRIProductDescription.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromproductDescriptionAsString()
.- Returns:
- The Reserved Instance product platform description.
- See Also:
-
productDescriptionAsString
The Reserved Instance product platform description.
If the service returns an enum value that is not available in the current SDK version,
productDescription
will returnRIProductDescription.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromproductDescriptionAsString()
.- Returns:
- The Reserved Instance product platform description.
- See Also:
-
reservedInstancesId
The ID of the Reserved Instance.
- Returns:
- The ID of the Reserved Instance.
-
start
The date and time the Reserved Instance started.
- Returns:
- The date and time the Reserved Instance started.
-
state
The state of the Reserved Instance purchase.
If the service returns an enum value that is not available in the current SDK version,
state
will returnReservedInstanceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the Reserved Instance purchase.
- See Also:
-
stateAsString
The state of the Reserved Instance purchase.
If the service returns an enum value that is not available in the current SDK version,
state
will returnReservedInstanceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the Reserved Instance purchase.
- See Also:
-
usagePrice
The usage price of the Reserved Instance, per hour.
- Returns:
- The usage price of the Reserved Instance, per hour.
-
currencyCode
The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is
USD
.If the service returns an enum value that is not available in the current SDK version,
currencyCode
will returnCurrencyCodeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcurrencyCodeAsString()
.- Returns:
- The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this
time, the only supported currency is
USD
. - See Also:
-
currencyCodeAsString
The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is
USD
.If the service returns an enum value that is not available in the current SDK version,
currencyCode
will returnCurrencyCodeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcurrencyCodeAsString()
.- Returns:
- The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this
time, the only supported currency is
USD
. - See Also:
-
instanceTenancy
The tenancy of the instance.
If the service returns an enum value that is not available in the current SDK version,
instanceTenancy
will returnTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTenancyAsString()
.- Returns:
- The tenancy of the instance.
- See Also:
-
instanceTenancyAsString
The tenancy of the instance.
If the service returns an enum value that is not available in the current SDK version,
instanceTenancy
will returnTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTenancyAsString()
.- Returns:
- The tenancy of the instance.
- See Also:
-
offeringClass
The offering class of the Reserved Instance.
If the service returns an enum value that is not available in the current SDK version,
offeringClass
will returnOfferingClassType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingClassAsString()
.- Returns:
- The offering class of the Reserved Instance.
- See Also:
-
offeringClassAsString
The offering class of the Reserved Instance.
If the service returns an enum value that is not available in the current SDK version,
offeringClass
will returnOfferingClassType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingClassAsString()
.- Returns:
- The offering class of the Reserved Instance.
- See Also:
-
offeringType
The Reserved Instance offering type.
If the service returns an enum value that is not available in the current SDK version,
offeringType
will returnOfferingTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingTypeAsString()
.- Returns:
- The Reserved Instance offering type.
- See Also:
-
offeringTypeAsString
The Reserved Instance offering type.
If the service returns an enum value that is not available in the current SDK version,
offeringType
will returnOfferingTypeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofferingTypeAsString()
.- Returns:
- The Reserved Instance offering type.
- See Also:
-
hasRecurringCharges
public final boolean hasRecurringCharges()For responses, this returns true if the service returned a value for the RecurringCharges 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. -
recurringCharges
The recurring charge tag assigned to the resource.
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
hasRecurringCharges()
method.- Returns:
- The recurring charge tag assigned to the resource.
-
scope
The scope of the Reserved Instance.
If the service returns an enum value that is not available in the current SDK version,
scope
will returnScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscopeAsString()
.- Returns:
- The scope of the Reserved Instance.
- See Also:
-
scopeAsString
The scope of the Reserved Instance.
If the service returns an enum value that is not available in the current SDK version,
scope
will returnScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscopeAsString()
.- Returns:
- The scope of the Reserved Instance.
- See Also:
-
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 resource.
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 resource.
-
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<ReservedInstances.Builder,
ReservedInstances> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int 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
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. -
getValueForField
-
sdkFields
-