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:

  • Method Details

    • 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 return CurrencyCodeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyCodeAsString().

      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

      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 return CurrencyCodeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currencyCodeAsString().

      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

      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 return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTenancyAsString().

      Returns:
      The tenancy of the instance.
      See Also:

    • 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 return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTenancyAsString().

      Returns:
      The tenancy of the instance.
      See Also:

    • 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 return OfferingClassType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringClassAsString().

      Returns:
      The offering class of the Reserved Instance.
      See Also:

    • 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 return OfferingClassType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringClassAsString().

      Returns:
      The offering class of the Reserved Instance.
      See Also:

    • 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 return OfferingTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeAsString().

      Returns:
      The Reserved Instance offering type.
      See Also:

    • 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 return OfferingTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offeringTypeAsString().

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

    • 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 return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

      Returns:
      The scope of the Reserved Instance.
      See Also:

    • 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 return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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

    • availabilityZoneId

      public final String availabilityZoneId()

      The ID of the Availability Zone.

      Returns:
      The ID of the Availability Zone.

    • reservedInstancesId

      public final String reservedInstancesId()

      The ID of the Reserved Instance.

      Returns:
      The ID of the Reserved Instance.

    • 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 return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type on which the Reserved Instance can be used.
      See Also:

    • 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 return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The instance type on which the Reserved Instance can be used.
      See Also:

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

    • start

      public final Instant start()

      The date and time the Reserved Instance started.

      Returns:
      The date and time the Reserved Instance started.

    • end

      public final Instant end()

      The time when the Reserved Instance expires.

      Returns:
      The time when the Reserved Instance expires.

    • duration

      public final Long duration()

      The duration of the Reserved Instance, in seconds.

      Returns:
      The duration of the Reserved Instance, in seconds.

    • usagePrice

      public final Float usagePrice()

      The usage price of the Reserved Instance, per hour.

      Returns:
      The usage price of the Reserved Instance, per hour.

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

    • 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 return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionAsString().

      Returns:
      The Reserved Instance product platform description.
      See Also:

    • 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 return RIProductDescription.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productDescriptionAsString().

      Returns:
      The Reserved Instance product platform description.
      See Also:

    • 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 return ReservedInstanceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the Reserved Instance purchase.
      See Also:

    • 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 return ReservedInstanceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the Reserved Instance purchase.
      See Also:

    • toBuilder

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

    • builder

      public static ReservedInstances.Builder builder()

    • serializableBuilderClass

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