Interface CreateDbCapacityReservationRequest.Builder

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

  • Method Details

    • dbCapacityReservationName

      CreateDbCapacityReservationRequest.Builder dbCapacityReservationName(String dbCapacityReservationName)

      The name of the DB capacity reservation. This name must be unique for your Amazon Web Services account in the Amazon Web Services Region.

      Constraints:

      • Must contain from 1 to 63 lowercase letters, digits, or hyphens.

      • First character must be a lowercase letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      • Can't contain more than 16 groups of characters separated by hyphens.

      • Can't begin with dbcr-.

      Parameters:
      dbCapacityReservationName - The name of the DB capacity reservation. This name must be unique for your Amazon Web Services account in the Amazon Web Services Region.

      Constraints:

      • Must contain from 1 to 63 lowercase letters, digits, or hyphens.

      • First character must be a lowercase letter.

      • Can't end with a hyphen or contain two consecutive hyphens.

      • Can't contain more than 16 groups of characters separated by hyphens.

      • Can't begin with dbcr-.

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

    • dbInstanceClass

      CreateDbCapacityReservationRequest.Builder dbInstanceClass(String dbInstanceClass)

      The compute and memory capacity to reserve, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide.

      Constraints:

      • Must be a DB instance class that the specified Engine supports.

      • For RDS for Oracle with LicenseModel set to license-included, some DB instance classes aren't supported. Either choose a supported DB instance class, or set LicenseModel to bring-your-own-license.

      Parameters:
      dbInstanceClass - The compute and memory capacity to reserve, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide.

      Constraints:

      • Must be a DB instance class that the specified Engine supports.

      • For RDS for Oracle with LicenseModel set to license-included, some DB instance classes aren't supported. Either choose a supported DB instance class, or set LicenseModel to bring-your-own-license.

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

    • engine

      CreateDbCapacityReservationRequest.Builder engine(String engine)

      The database engine to reserve capacity for.

      Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres | mariadb | oracle-ee | oracle-ee-cdb | oracle-se2 | oracle-se2-cdb | sqlserver-ee | sqlserver-se | sqlserver-web | sqlserver-ex | sqlserver-dev-ee | sqlserver-dev-se | db2-ae | db2-ce | db2-se

      The Developer Edition engines sqlserver-dev-ee and sqlserver-dev-se support no Multi-AZ DB instance and no read replica. Therefore, a reservation for either engine serves Single-AZ DB instances only.

      Parameters:
      engine - The database engine to reserve capacity for.

      Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres | mariadb | oracle-ee | oracle-ee-cdb | oracle-se2 | oracle-se2-cdb | sqlserver-ee | sqlserver-se | sqlserver-web | sqlserver-ex | sqlserver-dev-ee | sqlserver-dev-se | db2-ae | db2-ce | db2-se

      The Developer Edition engines sqlserver-dev-ee and sqlserver-dev-se support no Multi-AZ DB instance and no read replica. Therefore, a reservation for either engine serves Single-AZ DB instances only.

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

    • capacityPerAvailabilityZone

      CreateDbCapacityReservationRequest.Builder capacityPerAvailabilityZone(Integer capacityPerAvailabilityZone)

      The number of DB instances to reserve in each Availability Zone that you list in AvailabilityZones. Amazon RDS reserves this number of DB instances in every listed Availability Zone.

      A Single-AZ DB instance uses one unit of reserved capacity, in one Availability Zone. A Multi-AZ DB instance is one DB instance, and it uses one unit of reserved capacity in each of two Availability Zones. Therefore, a Multi-AZ DB instance uses two units in total. A read replica uses one unit of reserved capacity, in the same way as any other DB instance.

      Amazon RDS reserves capacity in each Availability Zone separately. Reserved capacity in one Availability Zone can't serve a DB instance in another Availability Zone. A request for a DB instance fails when the Availability Zone of the DB instance has no available capacity.

      Therefore, set this value to the number of DB instances that you want to run at the same time in one Availability Zone. Don't set it to the number that you want in total.

      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. Your existing DB instances, and the unused capacity of your other reservations, count against the same quota.

      To find the value of the DB instances quota, see Quotas and constraints for Amazon RDS in the Amazon RDS User Guide.

      Constraints:

      • Minimum 1.

      Parameters:
      capacityPerAvailabilityZone - The number of DB instances to reserve in each Availability Zone that you list in AvailabilityZones. Amazon RDS reserves this number of DB instances in every listed Availability Zone.

      A Single-AZ DB instance uses one unit of reserved capacity, in one Availability Zone. A Multi-AZ DB instance is one DB instance, and it uses one unit of reserved capacity in each of two Availability Zones. Therefore, a Multi-AZ DB instance uses two units in total. A read replica uses one unit of reserved capacity, in the same way as any other DB instance.

      Amazon RDS reserves capacity in each Availability Zone separately. Reserved capacity in one Availability Zone can't serve a DB instance in another Availability Zone. A request for a DB instance fails when the Availability Zone of the DB instance has no available capacity.

      Therefore, set this value to the number of DB instances that you want to run at the same time in one Availability Zone. Don't set it to the number that you want in total.

      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. Your existing DB instances, and the unused capacity of your other reservations, count against the same quota.

      To find the value of the DB instances quota, see Quotas and constraints for Amazon RDS in the Amazon RDS User Guide.

      Constraints:

      • Minimum 1.

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

    • availabilityZones

      CreateDbCapacityReservationRequest.Builder availabilityZones(Collection<String> availabilityZones)

      A list of Availability Zones for the reservation.

      You can't change the Availability Zones of a reservation after you create it. Reserved capacity in an Availability Zone that no DB instance uses stays unused.

      Constraints:

      • Must specify one or more Availability Zones.

      • Each Availability Zone can appear only once.

      • Each Availability Zone must be in the Amazon Web Services Region of the request.

      • Each Availability Zone must have capacity for the requested DB instance class.

      • Must include two or more Availability Zones to use the reservation for a Multi-AZ DB instance.

      • A DB instance can use reserved capacity only in an Availability Zone that its DB subnet group covers.

      Example: us-east-1a

      Parameters:
      availabilityZones - A list of Availability Zones for the reservation.

      You can't change the Availability Zones of a reservation after you create it. Reserved capacity in an Availability Zone that no DB instance uses stays unused.

      Constraints:

      • Must specify one or more Availability Zones.

      • Each Availability Zone can appear only once.

      • Each Availability Zone must be in the Amazon Web Services Region of the request.

      • Each Availability Zone must have capacity for the requested DB instance class.

      • Must include two or more Availability Zones to use the reservation for a Multi-AZ DB instance.

      • A DB instance can use reserved capacity only in an Availability Zone that its DB subnet group covers.

      Example: us-east-1a

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

    • availabilityZones

      CreateDbCapacityReservationRequest.Builder availabilityZones(String... availabilityZones)

      A list of Availability Zones for the reservation.

      You can't change the Availability Zones of a reservation after you create it. Reserved capacity in an Availability Zone that no DB instance uses stays unused.

      Constraints:

      • Must specify one or more Availability Zones.

      • Each Availability Zone can appear only once.

      • Each Availability Zone must be in the Amazon Web Services Region of the request.

      • Each Availability Zone must have capacity for the requested DB instance class.

      • Must include two or more Availability Zones to use the reservation for a Multi-AZ DB instance.

      • A DB instance can use reserved capacity only in an Availability Zone that its DB subnet group covers.

      Example: us-east-1a

      Parameters:
      availabilityZones - A list of Availability Zones for the reservation.

      You can't change the Availability Zones of a reservation after you create it. Reserved capacity in an Availability Zone that no DB instance uses stays unused.

      Constraints:

      • Must specify one or more Availability Zones.

      • Each Availability Zone can appear only once.

      • Each Availability Zone must be in the Amazon Web Services Region of the request.

      • Each Availability Zone must have capacity for the requested DB instance class.

      • Must include two or more Availability Zones to use the reservation for a Multi-AZ DB instance.

      • A DB instance can use reserved capacity only in an Availability Zone that its DB subnet group covers.

      Example: us-east-1a

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

    • endDate

      CreateDbCapacityReservationRequest.Builder endDate(Instant endDate)

      The date and time when the reservation expires, in Universal Coordinated Time (UTC). If you don't specify a value, the reservation doesn't expire.

      To change the expiration of an existing reservation, use ModifyDBCapacityReservation. That operation takes EndDateType along with EndDate.

      Constraints:

      • Must be a date and time in the future.

      • For a future-dated reservation, must be at or after StartDate plus CommitmentDuration. For example, a reservation that starts on 2026-12-01 with a 30-day commitment can't expire before 2026-12-31. To reserve capacity for one calendar month, set CommitmentDuration to 30 days or fewer, not to the length of the month.

      Example: 2026-12-31T23:59:59Z

      Parameters:
      endDate - The date and time when the reservation expires, in Universal Coordinated Time (UTC). If you don't specify a value, the reservation doesn't expire.

      To change the expiration of an existing reservation, use ModifyDBCapacityReservation. That operation takes EndDateType along with EndDate.

      Constraints:

      • Must be a date and time in the future.

      • For a future-dated reservation, must be at or after StartDate plus CommitmentDuration. For example, a reservation that starts on 2026-12-01 with a 30-day commitment can't expire before 2026-12-31. To reserve capacity for one calendar month, set CommitmentDuration to 30 days or fewer, not to the length of the month.

      Example: 2026-12-31T23:59:59Z

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

    • startDate

      CreateDbCapacityReservationRequest.Builder startDate(Instant startDate)

      The date and time when the reservation starts, in Universal Coordinated Time (UTC). Specify this parameter to create a future-dated reservation. If you don't specify a value, the reservation starts immediately.

      A reservation that starts later always carries a capacity commitment. Therefore, a request that specifies StartDate must also meet every constraint of a future-dated reservation, including the minimum reserved capacity in each Availability Zone.

      Constraints:

      • Must be from 5 to 120 days in the future.

      • You must also specify CommitmentDuration.

      Example: 2026-12-01T00:00:00Z

      Parameters:
      startDate - The date and time when the reservation starts, in Universal Coordinated Time (UTC). Specify this parameter to create a future-dated reservation. If you don't specify a value, the reservation starts immediately.

      A reservation that starts later always carries a capacity commitment. Therefore, a request that specifies StartDate must also meet every constraint of a future-dated reservation, including the minimum reserved capacity in each Availability Zone.

      Constraints:

      • Must be from 5 to 120 days in the future.

      • You must also specify CommitmentDuration.

      Example: 2026-12-01T00:00:00Z

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

    • commitmentDuration

      CreateDbCapacityReservationRequest.Builder commitmentDuration(Long commitmentDuration)

      The length of the capacity commitment that you request for a future-dated reservation, in seconds. Amazon RDS measures this length from StartDate.

      Amazon RDS can grant a shorter capacity commitment than you request. Therefore, read CommitmentEndDate in CommitmentInfo for the commitment that Amazon RDS granted.

      The commitment doesn't end the reservation. Specify EndDate to set an expiration date. You can't cancel a reservation in the active state during the commitment.

      Constraints:

      • Minimum 1209600, which is 14 days. For a db.x DB instance class, such as db.x2g.xlarge, the minimum is 7257600, which is 84 days.

      • Must be less than 315576000, which is 10 years.

      • You must also specify StartDate.

      Example: 2592000

      Parameters:
      commitmentDuration - The length of the capacity commitment that you request for a future-dated reservation, in seconds. Amazon RDS measures this length from StartDate.

      Amazon RDS can grant a shorter capacity commitment than you request. Therefore, read CommitmentEndDate in CommitmentInfo for the commitment that Amazon RDS granted.

      The commitment doesn't end the reservation. Specify EndDate to set an expiration date. You can't cancel a reservation in the active state during the commitment.

      Constraints:

      • Minimum 1209600, which is 14 days. For a db.x DB instance class, such as db.x2g.xlarge, the minimum is 7257600, which is 84 days.

      • Must be less than 315576000, which is 10 years.

      • You must also specify StartDate.

      Example: 2592000

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

    • licenseModel

      CreateDbCapacityReservationRequest.Builder licenseModel(String licenseModel)

      The license model to reserve capacity for. Specify this parameter only for RDS for Microsoft SQL Server Enterprise Edition, Standard Edition, and Developer Edition, for RDS for Oracle, or for RDS for Db2 Standard Edition and Advanced Edition. Amazon RDS rejects the request for any other engine. This includes Amazon Aurora, the Web and Express editions of RDS for Microsoft SQL Server, and RDS for Db2 Community Edition.

      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

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

      For RDS for Microsoft SQL Server Enterprise Edition and Standard Edition, if you don't specify a value, Amazon RDS uses license-included.

      For RDS for Microsoft SQL Server Developer Edition, if you don't specify a value, Amazon RDS uses bring-your-own-license. That is the only license model that these engines accept, and Amazon RDS rejects any other value.

      For RDS for Oracle, if you don't specify a value, Amazon RDS uses the only orderable license model for the DB instance class. If more than one license model is orderable, you must specify one.

      For RDS for Db2 Standard Edition and Advanced Edition, if you don't specify a value, Amazon RDS uses bring-your-own-license. To reserve capacity for Db2 DB instances that you license through Amazon Web Services Marketplace, specify marketplace-license.

      For RDS for Oracle, the license models that you can reserve depend on the engine and the DB instance class. RDS for Oracle Enterprise Edition doesn't support license-included.

      Parameters:
      licenseModel - The license model to reserve capacity for. Specify this parameter only for RDS for Microsoft SQL Server Enterprise Edition, Standard Edition, and Developer Edition, for RDS for Oracle, or for RDS for Db2 Standard Edition and Advanced Edition. Amazon RDS rejects the request for any other engine. This includes Amazon Aurora, the Web and Express editions of RDS for Microsoft SQL Server, and RDS for Db2 Community Edition.

      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

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

      For RDS for Microsoft SQL Server Enterprise Edition and Standard Edition, if you don't specify a value, Amazon RDS uses license-included.

      For RDS for Microsoft SQL Server Developer Edition, if you don't specify a value, Amazon RDS uses bring-your-own-license. That is the only license model that these engines accept, and Amazon RDS rejects any other value.

      For RDS for Oracle, if you don't specify a value, Amazon RDS uses the only orderable license model for the DB instance class. If more than one license model is orderable, you must specify one.

      For RDS for Db2 Standard Edition and Advanced Edition, if you don't specify a value, Amazon RDS uses bring-your-own-license. To reserve capacity for Db2 DB instances that you license through Amazon Web Services Marketplace, specify marketplace-license.

      For RDS for Oracle, the license models that you can reserve depend on the engine and the DB instance class. RDS for Oracle Enterprise Edition doesn't support license-included.

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

    • tags

      CreateDbCapacityReservationRequest.Builder tags(Collection<Tag> tags)

      Tags to assign to the DB capacity reservation.

      Parameters:
      tags - Tags to assign to the DB capacity reservation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDbCapacityReservationRequest.Builder tags(Tag... tags)

      Tags to assign to the DB capacity reservation.

      Parameters:
      tags - Tags to assign to the DB capacity reservation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDbCapacityReservationRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Tags to assign to 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 tags(List<Tag>).

      Parameters:
      tags - 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:

    • overrideConfiguration

      CreateDbCapacityReservationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDbCapacityReservationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.