Class ReservedInstances
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.ReservedInstances
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReservedInstances.Builder,ReservedInstances>
@Generated("software.amazon.awssdk:codegen") public final class ReservedInstances extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReservedInstances.Builder,ReservedInstances>
Describes a Reserved Instance.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ReservedInstances.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
availabilityZone()
The Availability Zone in which the Reserved Instance can be used.static ReservedInstances.Builder
builder()
CurrencyCodeValues
currencyCode()
The currency of the Reserved Instance.String
currencyCodeAsString()
The currency of the Reserved Instance.Long
duration()
The duration of the Reserved Instance, in seconds.Instant
end()
The time when the Reserved Instance expires.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
Float
fixedPrice()
The purchase price of the Reserved Instance.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasRecurringCharges()
For responses, this returns true if the service returned a value for the RecurringCharges property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Integer
instanceCount()
The number of reservations purchased.Tenancy
instanceTenancy()
The tenancy of the instance.String
instanceTenancyAsString()
The tenancy of the instance.InstanceType
instanceType()
The instance type on which the Reserved Instance can be used.String
instanceTypeAsString()
The instance type on which the Reserved Instance can be used.OfferingClassType
offeringClass()
The offering class of the Reserved Instance.String
offeringClassAsString()
The offering class of the Reserved Instance.OfferingTypeValues
offeringType()
The Reserved Instance offering type.String
offeringTypeAsString()
The Reserved Instance offering type.RIProductDescription
productDescription()
The Reserved Instance product platform description.String
productDescriptionAsString()
The Reserved Instance product platform description.List<RecurringCharge>
recurringCharges()
The recurring charge tag assigned to the resource.String
reservedInstancesId()
The ID of the Reserved Instance.Scope
scope()
The scope of the Reserved Instance.String
scopeAsString()
The scope of the Reserved Instance.List<SdkField<?>>
sdkFields()
static Class<? extends ReservedInstances.Builder>
serializableBuilderClass()
Instant
start()
The date and time the Reserved Instance started.ReservedInstanceState
state()
The state of the Reserved Instance purchase.String
stateAsString()
The state of the Reserved Instance purchase.List<Tag>
tags()
Any tags assigned to the resource.ReservedInstances.Builder
toBuilder()
String
toString()
Returns a string representation of this object.Float
usagePrice()
The usage price of the Reserved Instance, per hour.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
availabilityZone
public final String 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
public final Long duration()
The duration of the Reserved Instance, in seconds.
- Returns:
- The duration of the Reserved Instance, in seconds.
-
end
public final Instant end()
The time when the Reserved Instance expires.
- Returns:
- The time when the Reserved Instance expires.
-
fixedPrice
public final Float fixedPrice()
The purchase price of the Reserved Instance.
- Returns:
- The purchase price of the Reserved Instance.
-
instanceCount
public final Integer instanceCount()
The number of reservations purchased.
- Returns:
- The number of reservations purchased.
-
instanceType
public final InstanceType 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:
InstanceType
-
instanceTypeAsString
public final String 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:
InstanceType
-
productDescription
public final RIProductDescription 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:
RIProductDescription
-
productDescriptionAsString
public final String 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:
RIProductDescription
-
reservedInstancesId
public final String reservedInstancesId()
The ID of the Reserved Instance.
- Returns:
- The ID of the Reserved Instance.
-
start
public final Instant start()
The date and time the Reserved Instance started.
- Returns:
- The date and time the Reserved Instance started.
-
state
public final ReservedInstanceState 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:
ReservedInstanceState
-
stateAsString
public final String 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:
ReservedInstanceState
-
usagePrice
public final Float usagePrice()
The usage price of the Reserved Instance, per hour.
- Returns:
- The usage price of the Reserved Instance, per hour.
-
currencyCode
public final CurrencyCodeValues 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:
CurrencyCodeValues
-
currencyCodeAsString
public final String 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:
CurrencyCodeValues
-
instanceTenancy
public final Tenancy 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:
Tenancy
-
instanceTenancyAsString
public final String 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:
Tenancy
-
offeringClass
public final OfferingClassType 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:
OfferingClassType
-
offeringClassAsString
public final String 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:
OfferingClassType
-
offeringType
public final OfferingTypeValues 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:
OfferingTypeValues
-
offeringTypeAsString
public final String 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:
OfferingTypeValues
-
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
public final List<RecurringCharge> 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
public final Scope 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:
Scope
-
scopeAsString
public final String 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:
Scope
-
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
public final List<Tag> 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
public ReservedInstances.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ReservedInstances.Builder,ReservedInstances>
-
builder
public static ReservedInstances.Builder builder()
-
serializableBuilderClass
public static Class<? extends ReservedInstances.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-