Class ModifyDbCapacityReservationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rds.model.RdsRequest
software.amazon.awssdk.services.rds.model.ModifyDbCapacityReservationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyDbCapacityReservationRequest.Builder,ModifyDbCapacityReservationRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyDbCapacityReservationRequest extends RdsRequest implements ToCopyableBuilder<ModifyDbCapacityReservationRequest.Builder,ModifyDbCapacityReservationRequest>

  • Method Details

    • dbCapacityReservationIdentifier

      public final String dbCapacityReservationIdentifier()

      The identifier or the name of the DB capacity reservation to modify. You can specify the identifier, which has the prefix dbcr-, or the reservation name.

      Returns:
      The identifier or the name of the DB capacity reservation to modify. You can specify the identifier, which has the prefix dbcr-, or the reservation name.

    • capacityPerAvailabilityZone

      public final Integer capacityPerAvailabilityZone()

      The new number of DB instances to reserve in each Availability Zone of the reservation. Amazon RDS applies this number to every Availability Zone of the reservation.

      An increase reserves more capacity at the time of the request, so it can fail when the Amazon Web Services Region has insufficient capacity.

      This value multiplied by the number of Availability Zones counts against the DB instances quota for your Amazon Web Services account in the Amazon Web Services Region. Amazon RDS checks the quota only when you increase the value.

      Constraints:

      • Minimum 1.

      • Can't be less than the highest number of DB instances that use the reservation in any single Availability Zone of the reservation. That number includes a DB instance that holds a unit of reserved capacity for a pending modification. To find that number for an Availability Zone, subtract AvailableCapacity from ReservedCapacityPerAvailabilityZone.

      • During a capacity commitment, can't be less than CommittedCapacityPerAvailabilityZone.

      Returns:
      The new number of DB instances to reserve in each Availability Zone of the reservation. Amazon RDS applies this number to every Availability Zone of the reservation.

      An increase reserves more capacity at the time of the request, so it can fail when the Amazon Web Services Region has insufficient capacity.

      This value multiplied by the number of Availability Zones counts against the DB instances quota for your Amazon Web Services account in the Amazon Web Services Region. Amazon RDS checks the quota only when you increase the value.

      Constraints:

      • Minimum 1.

      • Can't be less than the highest number of DB instances that use the reservation in any single Availability Zone of the reservation. That number includes a DB instance that holds a unit of reserved capacity for a pending modification. To find that number for an Availability Zone, subtract AvailableCapacity from ReservedCapacityPerAvailabilityZone.

      • During a capacity commitment, can't be less than CommittedCapacityPerAvailabilityZone.

    • endDateType

      public final EndDateType endDateType()

      The end date type for the reservation.

      Valid Values:

      • limited - The reservation has a specific end date. You must also specify EndDate.

      • unlimited - The reservation doesn't expire. Don't specify EndDate.

      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:
      The end date type for the reservation.

      Valid Values:

      • limited - The reservation has a specific end date. You must also specify EndDate.

      • unlimited - The reservation doesn't expire. Don't specify EndDate.

      See Also:

    • endDateTypeAsString

      public final String endDateTypeAsString()

      The end date type for the reservation.

      Valid Values:

      • limited - The reservation has a specific end date. You must also specify EndDate.

      • unlimited - The reservation doesn't expire. Don't specify EndDate.

      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:
      The end date type for the reservation.

      Valid Values:

      • limited - The reservation has a specific end date. You must also specify EndDate.

      • unlimited - The reservation doesn't expire. Don't specify EndDate.

      See Also:

    • endDate

      public final Instant endDate()

      The new end date for the reservation, in Universal Coordinated Time (UTC). Required when EndDateType is limited. Don't specify a value when EndDateType is unlimited.

      When you specify EndDate, you must also specify EndDateType.

      Constraints:

      • Must be a date and time in the future.

      • During a capacity commitment, must be at or after CommitmentEndDate.

      Returns:
      The new end date for the reservation, in Universal Coordinated Time (UTC). Required when EndDateType is limited. Don't specify a value when EndDateType is unlimited.

      When you specify EndDate, you must also specify EndDateType.

      Constraints:

      • Must be a date and time in the future.

      • During a capacity commitment, must be at or after CommitmentEndDate.

    • toBuilder

      public ModifyDbCapacityReservationRequest.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<ModifyDbCapacityReservationRequest.Builder,ModifyDbCapacityReservationRequest>
      Specified by:
      toBuilder in class RdsRequest
      Returns:
      a builder for type T

    • builder

      public static ModifyDbCapacityReservationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyDbCapacityReservationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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