Interface DBCapacityReservation.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DBCapacityReservation.Builder,DBCapacityReservation>, SdkBuilder<DBCapacityReservation.Builder,DBCapacityReservation>, SdkPojo
Enclosing class:
DBCapacityReservation
@Mutable @NotThreadSafe public static interface DBCapacityReservation.Builder extends SdkPojo, CopyableBuilder<DBCapacityReservation.Builder,DBCapacityReservation>

  • Method Details

    • dbCapacityReservationName

      DBCapacityReservation.Builder dbCapacityReservationName(String dbCapacityReservationName)

      The name that you specified for the DB capacity reservation.

      Parameters:
      dbCapacityReservationName - The name that you specified for the DB capacity reservation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbInstanceClass

      DBCapacityReservation.Builder dbInstanceClass(String dbInstanceClass)

      The DB instance class for the reserved capacity. You specify this value when you create the reservation, and you can't change it afterward.

      Parameters:
      dbInstanceClass - The DB instance class for the reserved capacity. You specify this value when you create the reservation, and you can't change it afterward.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • engine

      DBCapacityReservation.Builder engine(String engine)

      The database engine for the reserved capacity. You specify this value when you create the reservation, and you can't change it afterward.

      Parameters:
      engine - The database engine for the reserved capacity. You specify this value when you create the reservation, and you can't change it afterward.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licenseModel

      DBCapacityReservation.Builder licenseModel(String licenseModel)

      The license model for the reserved capacity. Amazon RDS returns this value only for a reservation that reserves capacity for a specific license model. Amazon RDS doesn't return this value for a reservation whose database engine doesn't support a license model.

      A DB instance launches into the reservation only when the license model of the DB instance matches this value. For a reservation that holds no license model, Amazon RDS applies no license model check at launch.

      Valid Values:

      • RDS for Microsoft SQL Server Enterprise Edition and Standard Edition - license-included | bring-your-own-media

      • RDS for Microsoft SQL Server Developer Edition - bring-your-own-license

      • RDS for Oracle - bring-your-own-license | license-included

      • RDS for Db2 Standard Edition and Advanced Edition - bring-your-own-license | marketplace-license

      For RDS for Db2 Standard Edition and Advanced Edition, a reservation created without a license model holds bring-your-own-license.

      Parameters:
      licenseModel - The license model for the reserved capacity. Amazon RDS returns this value only for a reservation that reserves capacity for a specific license model. Amazon RDS doesn't return this value for a reservation whose database engine doesn't support a license model.

      A DB instance launches into the reservation only when the license model of the DB instance matches this value. For a reservation that holds no license model, Amazon RDS applies no license model check at launch.

      Valid Values:

      • RDS for Microsoft SQL Server Enterprise Edition and Standard Edition - license-included | bring-your-own-media

      • RDS for Microsoft SQL Server Developer Edition - bring-your-own-license

      • RDS for Oracle - bring-your-own-license | license-included

      • RDS for Db2 Standard Edition and Advanced Edition - bring-your-own-license | marketplace-license

      For RDS for Db2 Standard Edition and Advanced Edition, a reservation created without a license model holds bring-your-own-license.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reservedCapacityPerAvailabilityZone

      DBCapacityReservation.Builder reservedCapacityPerAvailabilityZone(Integer reservedCapacityPerAvailabilityZone)

      The number of DB instances that Amazon RDS reserves in each Availability Zone of the reservation. This value matches the CapacityPerAvailabilityZone parameter of the request. The total reserved capacity is this value multiplied by the number of Availability Zones of the reservation.

      Parameters:
      reservedCapacityPerAvailabilityZone - The number of DB instances that Amazon RDS reserves in each Availability Zone of the reservation. This value matches the CapacityPerAvailabilityZone parameter of the request. The total reserved capacity is this value multiplied by the number of Availability Zones of the reservation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availableCapacityPerAvailabilityZoneList

      DBCapacityReservation.Builder availableCapacityPerAvailabilityZoneList(Collection<AvailableCapacityPerAvailabilityZone> availableCapacityPerAvailabilityZoneList)

      The unused capacity of the reservation, reported for each Availability Zone of the reservation. Each entry names one Availability Zone, and it reports the number of DB instances that remain available in that Availability Zone.

      Amazon RDS reports available capacity only for a reservation that is in the active state and not past its end date. Otherwise, each entry reports an available capacity of 0. A future-dated reservation that hasn't started reports 0, and a reservation that Amazon RDS is modifying reports 0.

      A reservation reports the pending state while Amazon RDS modifies it. Therefore, a reservation in the active state that reports no available capacity has no unused capacity.

      Parameters:
      availableCapacityPerAvailabilityZoneList - The unused capacity of the reservation, reported for each Availability Zone of the reservation. Each entry names one Availability Zone, and it reports the number of DB instances that remain available in that Availability Zone.

      Amazon RDS reports available capacity only for a reservation that is in the active state and not past its end date. Otherwise, each entry reports an available capacity of 0. A future-dated reservation that hasn't started reports 0, and a reservation that Amazon RDS is modifying reports 0.

      A reservation reports the pending state while Amazon RDS modifies it. Therefore, a reservation in the active state that reports no available capacity has no unused capacity.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availableCapacityPerAvailabilityZoneList

      DBCapacityReservation.Builder availableCapacityPerAvailabilityZoneList(AvailableCapacityPerAvailabilityZone... availableCapacityPerAvailabilityZoneList)

      The unused capacity of the reservation, reported for each Availability Zone of the reservation. Each entry names one Availability Zone, and it reports the number of DB instances that remain available in that Availability Zone.

      Amazon RDS reports available capacity only for a reservation that is in the active state and not past its end date. Otherwise, each entry reports an available capacity of 0. A future-dated reservation that hasn't started reports 0, and a reservation that Amazon RDS is modifying reports 0.

      A reservation reports the pending state while Amazon RDS modifies it. Therefore, a reservation in the active state that reports no available capacity has no unused capacity.

      Parameters:
      availableCapacityPerAvailabilityZoneList - The unused capacity of the reservation, reported for each Availability Zone of the reservation. Each entry names one Availability Zone, and it reports the number of DB instances that remain available in that Availability Zone.

      Amazon RDS reports available capacity only for a reservation that is in the active state and not past its end date. Otherwise, each entry reports an available capacity of 0. A future-dated reservation that hasn't started reports 0, and a reservation that Amazon RDS is modifying reports 0.

      A reservation reports the pending state while Amazon RDS modifies it. Therefore, a reservation in the active state that reports no available capacity has no unused capacity.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • availableCapacityPerAvailabilityZoneList

      DBCapacityReservation.Builder availableCapacityPerAvailabilityZoneList(Consumer<AvailableCapacityPerAvailabilityZone.Builder>... availableCapacityPerAvailabilityZoneList)

      The unused capacity of the reservation, reported for each Availability Zone of the reservation. Each entry names one Availability Zone, and it reports the number of DB instances that remain available in that Availability Zone.

      Amazon RDS reports available capacity only for a reservation that is in the active state and not past its end date. Otherwise, each entry reports an available capacity of 0. A future-dated reservation that hasn't started reports 0, and a reservation that Amazon RDS is modifying reports 0.

      A reservation reports the pending state while Amazon RDS modifies it. Therefore, a reservation in the active state that reports no available capacity has no unused capacity.

      This is a convenience method that creates an instance of the AvailableCapacityPerAvailabilityZone.Builder avoiding the need to create one manually via AvailableCapacityPerAvailabilityZone.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to availableCapacityPerAvailabilityZoneList(List<AvailableCapacityPerAvailabilityZone>).

      Parameters:
      availableCapacityPerAvailabilityZoneList - a consumer that will call methods on AvailableCapacityPerAvailabilityZone.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endDate

      DBCapacityReservation.Builder endDate(Instant endDate)

      The date and time when the reservation expires, in Universal Coordinated Time (UTC). Amazon RDS doesn't return this value if the reservation doesn't expire.

      A DB instance that uses the reservation keeps running after the reservation expires. It continues on unreserved capacity, and Amazon RDS doesn't stop it or modify it. However, Amazon RDS no longer reserves capacity for the DB instance. Amazon RDS might later move the DB instance to different hardware, for example during hardware maintenance. That move can fail when the Amazon Web Services Region has insufficient capacity for the DB instance class.

      Parameters:
      endDate - The date and time when the reservation expires, in Universal Coordinated Time (UTC). Amazon RDS doesn't return this value if the reservation doesn't expire.

      A DB instance that uses the reservation keeps running after the reservation expires. It continues on unreserved capacity, and Amazon RDS doesn't stop it or modify it. However, Amazon RDS no longer reserves capacity for the DB instance. Amazon RDS might later move the DB instance to different hardware, for example during hardware maintenance. That move can fail when the Amazon Web Services Region has insufficient capacity for the DB instance class.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createDate

      DBCapacityReservation.Builder createDate(Instant createDate)

      The date and time when the reservation was created, in Universal Coordinated Time (UTC).

      Parameters:
      createDate - The date and time when the reservation was created, in Universal Coordinated Time (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startDate

      DBCapacityReservation.Builder startDate(Instant startDate)

      The date and time when a future-dated reservation starts, in Universal Coordinated Time (UTC). Amazon RDS doesn't return this value for a reservation that started immediately.

      Parameters:
      startDate - The date and time when a future-dated reservation starts, in Universal Coordinated Time (UTC). Amazon RDS doesn't return this value for a reservation that started immediately.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commitmentInfo

      DBCapacityReservation.Builder commitmentInfo(DBCapacityReservationCommitmentInfo commitmentInfo)

      The capacity commitment of the reservation. Amazon RDS returns this object only for a future-dated reservation.

      Parameters:
      commitmentInfo - The capacity commitment of the reservation. Amazon RDS returns this object only for a future-dated reservation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commitmentInfo

      default DBCapacityReservation.Builder commitmentInfo(Consumer<DBCapacityReservationCommitmentInfo.Builder> commitmentInfo)

      The capacity commitment of the reservation. Amazon RDS returns this object only for a future-dated reservation.

      This is a convenience method that creates an instance of the DBCapacityReservationCommitmentInfo.Builder avoiding the need to create one manually via DBCapacityReservationCommitmentInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to commitmentInfo(DBCapacityReservationCommitmentInfo).

      Parameters:
      commitmentInfo - a consumer that will call methods on DBCapacityReservationCommitmentInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      DBCapacityReservation.Builder state(String state)

      The current state of the DB capacity reservation. A DB instance can use the reservation in the active state only.

      Valid Values:

      • active - Amazon RDS holds the reserved capacity, and a DB instance can use it.

      • pending - The reservation isn't ready to use yet. Amazon RDS is creating the reserved capacity, or it is applying a requested modification.

      • assessing - Amazon RDS is evaluating the request for a future-dated reservation.

      • scheduled - Amazon RDS accepted a future-dated reservation, and the reservation is waiting for its start date.

      • delayed - Amazon RDS couldn't provide the reserved capacity of a future-dated reservation by its start date.

      • unsupported - Amazon RDS can't fulfill the future-dated reservation as requested.

      • expired - The reservation passed its end date. Amazon RDS releases the reserved capacity.

      • cancelled - You cancelled the reservation, and Amazon RDS released the reserved capacity.

      • failed - Amazon RDS couldn't reserve the capacity.

      The values assessing, scheduled, delayed, and unsupported apply to a future-dated reservation only.

      Parameters:
      state - The current state of the DB capacity reservation. A DB instance can use the reservation in the active state only.

      Valid Values:

      • active - Amazon RDS holds the reserved capacity, and a DB instance can use it.

      • pending - The reservation isn't ready to use yet. Amazon RDS is creating the reserved capacity, or it is applying a requested modification.

      • assessing - Amazon RDS is evaluating the request for a future-dated reservation.

      • scheduled - Amazon RDS accepted a future-dated reservation, and the reservation is waiting for its start date.

      • delayed - Amazon RDS couldn't provide the reserved capacity of a future-dated reservation by its start date.

      • unsupported - Amazon RDS can't fulfill the future-dated reservation as requested.

      • expired - The reservation passed its end date. Amazon RDS releases the reserved capacity.

      • cancelled - You cancelled the reservation, and Amazon RDS released the reserved capacity.

      • failed - Amazon RDS couldn't reserve the capacity.

      The values assessing, scheduled, delayed, and unsupported apply to a future-dated reservation only.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      DBCapacityReservation.Builder state(DBCapacityReservationState state)

      The current state of the DB capacity reservation. A DB instance can use the reservation in the active state only.

      Valid Values:

      • active - Amazon RDS holds the reserved capacity, and a DB instance can use it.

      • pending - The reservation isn't ready to use yet. Amazon RDS is creating the reserved capacity, or it is applying a requested modification.

      • assessing - Amazon RDS is evaluating the request for a future-dated reservation.

      • scheduled - Amazon RDS accepted a future-dated reservation, and the reservation is waiting for its start date.

      • delayed - Amazon RDS couldn't provide the reserved capacity of a future-dated reservation by its start date.

      • unsupported - Amazon RDS can't fulfill the future-dated reservation as requested.

      • expired - The reservation passed its end date. Amazon RDS releases the reserved capacity.

      • cancelled - You cancelled the reservation, and Amazon RDS released the reserved capacity.

      • failed - Amazon RDS couldn't reserve the capacity.

      The values assessing, scheduled, delayed, and unsupported apply to a future-dated reservation only.

      Parameters:
      state - The current state of the DB capacity reservation. A DB instance can use the reservation in the active state only.

      Valid Values:

      • active - Amazon RDS holds the reserved capacity, and a DB instance can use it.

      • pending - The reservation isn't ready to use yet. Amazon RDS is creating the reserved capacity, or it is applying a requested modification.

      • assessing - Amazon RDS is evaluating the request for a future-dated reservation.

      • scheduled - Amazon RDS accepted a future-dated reservation, and the reservation is waiting for its start date.

      • delayed - Amazon RDS couldn't provide the reserved capacity of a future-dated reservation by its start date.

      • unsupported - Amazon RDS can't fulfill the future-dated reservation as requested.

      • expired - The reservation passed its end date. Amazon RDS releases the reserved capacity.

      • cancelled - You cancelled the reservation, and Amazon RDS released the reserved capacity.

      • failed - Amazon RDS couldn't reserve the capacity.

      The values assessing, scheduled, delayed, and unsupported apply to a future-dated reservation only.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dbCapacityReservationArn

      DBCapacityReservation.Builder dbCapacityReservationArn(String dbCapacityReservationArn)

      The Amazon Resource Name (ARN) of the DB capacity reservation.

      Parameters:
      dbCapacityReservationArn - The Amazon Resource Name (ARN) of the DB capacity reservation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbCapacityReservationIdentifier

      DBCapacityReservation.Builder dbCapacityReservationIdentifier(String dbCapacityReservationIdentifier)

      The unique identifier of the DB capacity reservation. The identifier has the prefix dbcr-. Every other DB capacity reservation operation takes this identifier.

      Parameters:
      dbCapacityReservationIdentifier - The unique identifier of the DB capacity reservation. The identifier has the prefix dbcr- . Every other DB capacity reservation operation takes this identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagList

      DBCapacityReservation.Builder tagList(Collection<Tag> tagList)

      The tags associated with the DB capacity reservation.

      Parameters:
      tagList - The tags associated with the DB capacity reservation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagList

      DBCapacityReservation.Builder tagList(Tag... tagList)

      The tags associated with the DB capacity reservation.

      Parameters:
      tagList - The tags associated with the DB capacity reservation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagList

      DBCapacityReservation.Builder tagList(Consumer<Tag.Builder>... tagList)

      The tags associated with the DB capacity reservation.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagList(List<Tag>).

      Parameters:
      tagList - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: