Class ReservedDBInstance

java.lang.Object
software.amazon.awssdk.services.rds.model.ReservedDBInstance
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReservedDBInstance.Builder,ReservedDBInstance>
@Generated("software.amazon.awssdk:codegen") public final class ReservedDBInstance extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReservedDBInstance.Builder,ReservedDBInstance>

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

See Also:

  • Method Details

    • reservedDBInstanceId

      public final String reservedDBInstanceId()

      The unique identifier for the reservation.

      Returns:
      The unique identifier for the reservation.

    • reservedDBInstancesOfferingId

      public final String reservedDBInstancesOfferingId()

      The offering identifier.

      Returns:
      The offering identifier.

    • dbInstanceClass

      public final String dbInstanceClass()

      The DB instance class for the reserved DB instance.

      Returns:
      The DB instance class for the reserved DB instance.

    • startTime

      public final Instant startTime()

      The time the reservation started.

      Returns:
      The time the reservation started.

    • duration

      public final Integer duration()

      The duration of the reservation in seconds.

      Returns:
      The duration of the reservation in seconds.

    • fixedPrice

      public final Double fixedPrice()

      The fixed price charged for this reserved DB instance.

      Returns:
      The fixed price charged for this reserved DB instance.

    • usagePrice

      public final Double usagePrice()

      The hourly price charged for this reserved DB instance.

      Returns:
      The hourly price charged for this reserved DB instance.

    • currencyCode

      public final String currencyCode()

      The currency code for the reserved DB instance.

      Returns:
      The currency code for the reserved DB instance.

    • dbInstanceCount

      public final Integer dbInstanceCount()

      The number of reserved DB instances.

      Returns:
      The number of reserved DB instances.

    • productDescription

      public final String productDescription()

      The description of the reserved DB instance.

      Returns:
      The description of the reserved DB instance.

    • offeringType

      public final String offeringType()

      The offering type of this reserved DB instance.

      Returns:
      The offering type of this reserved DB instance.

    • multiAZ

      public final Boolean multiAZ()

      Indicates whether the reservation applies to Multi-AZ deployments.

      Returns:
      Indicates whether the reservation applies to Multi-AZ deployments.

    • state

      public final String state()

      The state of the reserved DB instance.

      Returns:
      The state of the reserved DB instance.

    • 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 price charged to run this reserved DB instance.

      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 price charged to run this reserved DB instance.

    • reservedDBInstanceArn

      public final String reservedDBInstanceArn()

      The Amazon Resource Name (ARN) for the reserved DB instance.

      Returns:
      The Amazon Resource Name (ARN) for the reserved DB instance.

    • leaseId

      public final String leaseId()

      The unique identifier for the lease associated with the reserved DB instance.

      Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

      Returns:
      The unique identifier for the lease associated with the reserved DB instance.

      Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

    • toBuilder

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

    • builder

      public static ReservedDBInstance.Builder builder()

    • serializableBuilderClass

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