aws-sdk-rds 1.324.0 → 1.326.0

data/lib/aws-sdk-rds/db_instance.rb

@@ -886,6 +886,14 @@ module Aws::RDS
       data[:storage_operation_percent_progress]
     end
 
+    # The identifier of the DB capacity reservation associated with this DB
+    # instance. Amazon RDS doesn't return this value if the DB instance
+    # doesn't use a DB capacity reservation.
+    # @return [String]
+    def db_capacity_reservation_identifier
+      data[:db_capacity_reservation_identifier]
+    end
+
     # @!endgroup
 
     # @return [Client]
@@ -1121,6 +1129,7 @@ module Aws::RDS
     #         ],
     #       },
     #     ],
+    #     db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
     #     master_user_authentication_type: "password", # accepts password, iam-db-auth
     #   })
     # @param [Hash] options ({})
@@ -2370,6 +2379,43 @@ module Aws::RDS
     #   * `auto-backup` - The DB instance's automated backup.
     #
     #   ^
+    # @option options [String] :db_capacity_reservation_identifier
+    #   The identifier or the name of the DB capacity reservation to associate
+    #   with this DB instance. You can specify the identifier, which has the
+    #   prefix `dbcr-`, or the reservation name. When you specify this
+    #   parameter, the DB instance uses reserved capacity from the specified
+    #   reservation.
+    #
+    #   If you specify `AvailabilityZone`, Amazon RDS places the DB instance
+    #   in that Availability Zone, and the reservation must cover it.
+    #
+    #   Constraints:
+    #
+    #   * The reservation must reserve capacity for the DB instance class and
+    #     the database engine of the DB instance.
+    #
+    #   * If the reservation reserves capacity for a specific license model,
+    #     the license model of the DB instance must match it.
+    #
+    #   * The reservation must be in the `active` state, and it must not be
+    #     past its end date.
+    #
+    #   * If you specify `AvailabilityZone`, it must be one of the
+    #     Availability Zones of the reservation.
+    #
+    #   * For a Multi-AZ DB instance, the reservation must cover two or more
+    #     Availability Zones. A Multi-AZ DB instance uses one unit of reserved
+    #     capacity in each of two Availability Zones. If the reservation
+    #     covers more than two Availability Zones, Amazon RDS chooses the two
+    #     that the DB instance uses.
+    #
+    #   * The reservation must have available capacity in each Availability
+    #     Zone that the DB instance uses.
+    #
+    #   * The DB subnet group must be in a VPC with default tenancy.
+    #
+    #   * The DB subnet group must cover each Availability Zone that the DB
+    #     instance uses.
     # @option options [String] :master_user_authentication_type
     #   Specifies the authentication type for the master user. With IAM master
     #   user authentication, you can configure the master DB user with IAM
@@ -2476,6 +2522,7 @@ module Aws::RDS
     #         ],
     #       },
     #     ],
+    #     db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
     #     source_region: "String",
     #   })
     # @param [Hash] options ({})
@@ -2695,11 +2742,15 @@ module Aws::RDS
     #   The Amazon Web Services KMS key identifier is the key ARN, key ID,
     #   alias ARN, or alias name for the KMS key.
     #
-    #   If you create an encrypted read replica in the same Amazon Web
-    #   Services Region as the source DB instance or Multi-AZ DB cluster,
-    #   don't specify a value for this parameter. A read replica in the same
-    #   Amazon Web Services Region is always encrypted with the same KMS key
-    #   as the source DB instance or cluster.
+    #   For a read replica in the same Amazon Web Services Region as the
+    #   source DB instance or Multi-AZ DB cluster, specifying this parameter
+    #   is optional. If you specify a KMS key identifier, the read replica is
+    #   encrypted with that KMS key, which can be different from the KMS key
+    #   of the source.
+    #
+    #   If you don't specify a value for this parameter, the read replica is
+    #   encrypted with the same KMS key as the source DB instance or Multi-AZ
+    #   DB cluster.
     #
     #   If you create an encrypted read replica in a different Amazon Web
     #   Services Region, then you must specify a KMS key identifier for the
@@ -3126,6 +3177,45 @@ module Aws::RDS
     #   * `auto-backup` - The DB instance's automated backup.
     #
     #   ^
+    # @option options [String] :db_capacity_reservation_identifier
+    #   The identifier or the name of the DB capacity reservation to associate
+    #   with this read replica. You can specify the identifier, which has the
+    #   prefix `dbcr-`, or the reservation name. When you specify this
+    #   parameter, the read replica uses reserved capacity from the specified
+    #   reservation. A read replica uses one unit of reserved capacity, in the
+    #   same way as any other DB instance.
+    #
+    #   If you specify `AvailabilityZone`, Amazon RDS places the DB instance
+    #   in that Availability Zone, and the reservation must cover it.
+    #
+    #   Constraints:
+    #
+    #   * The reservation must reserve capacity for the DB instance class and
+    #     the database engine of the DB instance.
+    #
+    #   * If the reservation reserves capacity for a specific license model,
+    #     the license model of the source DB instance must match it. A read
+    #     replica inherits its license model from the source DB instance.
+    #
+    #   * The reservation must be in the `active` state, and it must not be
+    #     past its end date.
+    #
+    #   * If you specify `AvailabilityZone`, it must be one of the
+    #     Availability Zones of the reservation.
+    #
+    #   * For a Multi-AZ DB instance, the reservation must cover two or more
+    #     Availability Zones. A Multi-AZ DB instance uses one unit of reserved
+    #     capacity in each of two Availability Zones. If the reservation
+    #     covers more than two Availability Zones, Amazon RDS chooses the two
+    #     that the DB instance uses.
+    #
+    #   * The reservation must have available capacity in each Availability
+    #     Zone that the DB instance uses.
+    #
+    #   * The DB subnet group must be in a VPC with default tenancy.
+    #
+    #   * The DB subnet group must cover each Availability Zone that the DB
+    #     instance uses.
     # @option options [String] :source_region
     #   The source region of the snapshot. This is only needed when the
     #   shapshot is encrypted and in a different region.
@@ -3341,6 +3431,7 @@ module Aws::RDS
     #         set_for_delete: false,
     #       },
     #     ],
+    #     db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
     #     tag_specifications: [
     #       {
     #         resource_type: "String",
@@ -4447,6 +4538,135 @@ module Aws::RDS
     #   instance. You can create up to 3 additional storage volumes.
     #   Additional storage volumes are supported for RDS for Oracle and RDS
     #   for SQL Server DB instances only.
+    # @option options [String] :db_capacity_reservation_identifier
+    #   The identifier or the name of the DB capacity reservation for the DB
+    #   instance to use. You can specify the identifier, which has the prefix
+    #   `dbcr-`, or the reservation name. After the modification completes,
+    #   the DB instance uses reserved capacity from this reservation.
+    #
+    #   You can't change the DB capacity reservation of a DB instance on its
+    #   own. A request that changes the reservation must also change the DB
+    #   instance class, the Multi-AZ setting, the license model, or the
+    #   engine. Therefore, this request always changes the configuration of
+    #   the DB instance.
+    #
+    #   If the DB instance already uses the reservation that you specify, this
+    #   requirement doesn't apply. You can then change another setting, such
+    #   as the Multi-AZ setting, and keep the reservation.
+    #
+    #   For a DB instance that uses no reservation, change `DBInstanceClass`
+    #   to the DB instance class that the reservation reserves. A reservation
+    #   reserves capacity for one DB instance class, so that change moves the
+    #   DB instance onto the reserved capacity. That change also resizes the
+    #   DB instance, which interrupts it.
+    #
+    #   If the DB instance already runs the DB instance class that the
+    #   reservation reserves, change `MultiAZ` or `LicenseModel` instead. Only
+    #   RDS for Oracle and RDS for Microsoft SQL Server accept a change of
+    #   license model, so `MultiAZ` is the remaining choice for every other
+    #   engine.
+    #
+    #   If you don't specify this parameter, Amazon RDS moves the DB instance
+    #   to unreserved capacity, and it releases the reserved capacity that the
+    #   DB instance holds. A request that changes the DB instance class, the
+    #   Multi-AZ setting, the license model, or the engine moves the DB
+    #   instance to different hardware, and Amazon RDS places the DB instance
+    #   on unreserved capacity. Therefore, to keep the DB instance on reserved
+    #   capacity, specify this parameter in every request that changes any of
+    #   those settings.
+    #
+    #    The DB instance keeps its current reservation until Amazon RDS
+    #   applies
+    #   the modification. Until then, the `DBCapacityReservationIdentifier`
+    #   field of the DB instance still reports that reservation, and
+    #   `PendingModifiedValues` reports no reservation. Amazon RDS releases
+    #   the reserved capacity when it moves the DB instance.
+    #
+    #   Constraints:
+    #
+    #   * If the request changes which DB capacity reservation the DB instance
+    #     uses, it must also set a new value for `DBInstanceClass`, `MultiAZ`,
+    #     `LicenseModel`, or `Engine`. The new value must differ from the
+    #     current value. The only engine change that `ModifyDBInstance`
+    #     supports is a conversion to the CDB architecture. Repeating the
+    #     current value doesn't satisfy this requirement. This requirement
+    #     applies both when the DB instance uses no reservation, and when it
+    #     moves to a different reservation.
+    #
+    #   * The reservation must reserve capacity for the DB instance class that
+    #     the DB instance uses after the modification, and for the database
+    #     engine of the DB instance. Therefore, when the request changes
+    #     `DBInstanceClass`, the reservation reserves capacity for a DB
+    #     instance class that the DB instance doesn't use today.
+    #
+    #   * The reservation must be in the `active` state, and it must not be
+    #     past its end date.
+    #
+    #   * The reservation must have available capacity in each Availability
+    #     Zone that the DB instance uses after the modification.
+    #
+    #   * The reservation must cover the Availability Zone of the DB instance,
+    #     except when the request changes the DB instance from Multi-AZ to
+    #     Single-AZ.
+    #
+    #   * For a Multi-AZ DB instance, the reservation must cover two or more
+    #     Availability Zones. A Multi-AZ DB instance uses one unit of reserved
+    #     capacity in each of two Availability Zones.
+    #
+    #   * If the DB instance is already Multi-AZ, the reservation must cover
+    #     both of its Availability Zones. If the request converts the DB
+    #     instance to Multi-AZ, the reservation must cover the current
+    #     Availability Zone of the DB instance, and Amazon RDS chooses the
+    #     second Availability Zone from the reservation.
+    #
+    #   * If the reservation reserves capacity for a specific license model,
+    #     the license model of the DB instance must match it. Amazon RDS
+    #     checks the license model only when the request specifies
+    #     `LicenseModel`.
+    #
+    #   * You can't specify this parameter together with a change to
+    #     `DBSubnetGroupName`.
+    #
+    #   * You can't specify this parameter together with a change to both
+    #     `DBInstanceClass` and `LicenseModel`. Submit those changes as two
+    #     separate requests.
+    #
+    #   * Can't be specified together with a change to `DBInstanceClass` when
+    #     the request also changes the DB instance from Multi-AZ to Single-AZ.
+    #
+    #   * When the request changes the DB instance from Multi-AZ to Single-AZ,
+    #     the reservation must cover either the primary or the secondary
+    #     Availability Zone of the DB instance. Amazon RDS keeps the DB
+    #     instance in its primary Availability Zone, and it removes the
+    #     standby replica. Therefore, the primary Availability Zone keeps its
+    #     unit of reserved capacity, and the secondary Availability Zone
+    #     releases its unit.
+    #
+    #   * Can't be specified together with `LicenseModel` while a
+    #     modification of the DB instance class or the Multi-AZ setting is
+    #     pending.
+    #
+    #   * Can't be specified together with `DBInstanceClass` or `MultiAZ`
+    #     while a modification of the license model is pending.
+    #
+    #   * When a modification is already pending, the reservation must reserve
+    #     capacity for the DB instance as it will be after both the pending
+    #     modification and the requested modification complete.
+    #
+    #   * The DB subnet group must be in a VPC with default tenancy.
+    #
+    #   * The DB subnet group must cover each Availability Zone that the DB
+    #     instance uses.
+    #
+    #   * Isn't supported for an RDS on Outposts DB instance.
+    #
+    #   * If the reservation expires within one week, you must also enable
+    #     `ApplyImmediately`. Otherwise, choose a reservation with a later end
+    #     date.
+    #
+    #   * Amazon RDS holds a unit of reserved capacity for the DB instance
+    #     when it accepts the request, even when the modification waits for
+    #     the maintenance window.
     # @option options [Array<Types::TagSpecification>] :tag_specifications
     #   Tags to assign to resources associated with the DB instance.
     #
@@ -4658,6 +4878,7 @@ module Aws::RDS
     #     allocated_storage: 1,
     #     backup_retention_period: 1,
     #     preferred_backup_window: "String",
+    #     db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
     #     dedicated_log_volume: false,
     #     ca_certificate_identifier: "String",
     #     engine_lifecycle_support: "String",
@@ -5249,6 +5470,43 @@ module Aws::RDS
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
+    # @option options [String] :db_capacity_reservation_identifier
+    #   The identifier or the name of the DB capacity reservation to associate
+    #   with this DB instance. You can specify the identifier, which has the
+    #   prefix `dbcr-`, or the reservation name. When you specify this
+    #   parameter, the DB instance uses reserved capacity from the specified
+    #   reservation.
+    #
+    #   If you specify `AvailabilityZone`, Amazon RDS places the DB instance
+    #   in that Availability Zone, and the reservation must cover it.
+    #
+    #   Constraints:
+    #
+    #   * The reservation must reserve capacity for the DB instance class and
+    #     the database engine of the DB instance.
+    #
+    #   * If the reservation reserves capacity for a specific license model,
+    #     the license model of the DB instance must match it.
+    #
+    #   * The reservation must be in the `active` state, and it must not be
+    #     past its end date.
+    #
+    #   * If you specify `AvailabilityZone`, it must be one of the
+    #     Availability Zones of the reservation.
+    #
+    #   * For a Multi-AZ DB instance, the reservation must cover two or more
+    #     Availability Zones. A Multi-AZ DB instance uses one unit of reserved
+    #     capacity in each of two Availability Zones. If the reservation
+    #     covers more than two Availability Zones, Amazon RDS chooses the two
+    #     that the DB instance uses.
+    #
+    #   * The reservation must have available capacity in each Availability
+    #     Zone that the DB instance uses.
+    #
+    #   * The DB subnet group must be in a VPC with default tenancy.
+    #
+    #   * The DB subnet group must cover each Availability Zone that the DB
+    #     instance uses.
     # @option options [Boolean] :dedicated_log_volume
     #   Specifies whether to enable a dedicated log volume (DLV) for the DB
     #   instance.

data/lib/aws-sdk-rds/db_snapshot.rb

@@ -790,6 +790,7 @@ module Aws::RDS
     #     db_cluster_snapshot_identifier: "String",
     #     backup_retention_period: 1,
     #     preferred_backup_window: "String",
+    #     db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
     #     dedicated_log_volume: false,
     #     ca_certificate_identifier: "String",
     #     engine_lifecycle_support: "String",
@@ -1354,6 +1355,43 @@ module Aws::RDS
     #
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
+    # @option options [String] :db_capacity_reservation_identifier
+    #   The identifier or the name of the DB capacity reservation to associate
+    #   with this DB instance. You can specify the identifier, which has the
+    #   prefix `dbcr-`, or the reservation name. When you specify this
+    #   parameter, the DB instance uses reserved capacity from the specified
+    #   reservation.
+    #
+    #   If you specify `AvailabilityZone`, Amazon RDS places the DB instance
+    #   in that Availability Zone, and the reservation must cover it.
+    #
+    #   Constraints:
+    #
+    #   * The reservation must reserve capacity for the DB instance class and
+    #     the database engine of the DB instance.
+    #
+    #   * If the reservation reserves capacity for a specific license model,
+    #     the license model of the DB instance must match it.
+    #
+    #   * The reservation must be in the `active` state, and it must not be
+    #     past its end date.
+    #
+    #   * If you specify `AvailabilityZone`, it must be one of the
+    #     Availability Zones of the reservation.
+    #
+    #   * For a Multi-AZ DB instance, the reservation must cover two or more
+    #     Availability Zones. A Multi-AZ DB instance uses one unit of reserved
+    #     capacity in each of two Availability Zones. If the reservation
+    #     covers more than two Availability Zones, Amazon RDS chooses the two
+    #     that the DB instance uses.
+    #
+    #   * The reservation must have available capacity in each Availability
+    #     Zone that the DB instance uses.
+    #
+    #   * The DB subnet group must be in a VPC with default tenancy.
+    #
+    #   * The DB subnet group must cover each Availability Zone that the DB
+    #     instance uses.
     # @option options [Boolean] :dedicated_log_volume
     #   Specifies whether to enable a dedicated log volume (DLV) for the DB
     #   instance.

data/lib/aws-sdk-rds/errors.rb

@@ -44,6 +44,12 @@ module Aws::RDS
   # * {CustomDBEngineVersionAlreadyExistsFault}
   # * {CustomDBEngineVersionNotFoundFault}
   # * {CustomDBEngineVersionQuotaExceededFault}
+  # * {DBCapacityReservationAlreadyExistsFault}
+  #    * This error class is not used. `DBCapacityReservationAlreadyExists` is used during parsing instead.
+  # * {DBCapacityReservationNotFoundFault}
+  #    * This error class is not used. `DBCapacityReservationNotFound` is used during parsing instead.
+  # * {DBCapacityReservationUnsupportedFault}
+  #    * This error class is not used. `DBCapacityReservationUnsupported` is used during parsing instead.
   # * {DBClusterAlreadyExistsFault}
   # * {DBClusterAutomatedBackupNotFoundFault}
   # * {DBClusterAutomatedBackupQuotaExceededFault}
@@ -151,6 +157,8 @@ module Aws::RDS
   # * {IntegrationQuotaExceededFault}
   # * {InvalidBlueGreenDeploymentStateFault}
   # * {InvalidCustomDBEngineVersionStateFault}
+  # * {InvalidDBCapacityReservationStateFault}
+  #    * This error class is not used. `InvalidDBCapacityReservationState` is used during parsing instead.
   # * {InvalidDBClusterAutomatedBackupStateFault}
   # * {InvalidDBClusterCapacityFault}
   # * {InvalidDBClusterEndpointStateFault}
@@ -378,6 +386,42 @@ module Aws::RDS
       end
     end
 
+    # @deprecated This error class is not used during parsing.
+    #   Please use `DBCapacityReservationAlreadyExists` instead.
+    class DBCapacityReservationAlreadyExistsFault < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::RDS::Types::DBCapacityReservationAlreadyExistsFault] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+    end
+
+    # @deprecated This error class is not used during parsing.
+    #   Please use `DBCapacityReservationNotFound` instead.
+    class DBCapacityReservationNotFoundFault < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::RDS::Types::DBCapacityReservationNotFoundFault] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+    end
+
+    # @deprecated This error class is not used during parsing.
+    #   Please use `DBCapacityReservationUnsupported` instead.
+    class DBCapacityReservationUnsupportedFault < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::RDS::Types::DBCapacityReservationUnsupportedFault] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+    end
+
     class DBClusterAlreadyExistsFault < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -1176,6 +1220,18 @@ module Aws::RDS
       end
     end
 
+    # @deprecated This error class is not used during parsing.
+    #   Please use `InvalidDBCapacityReservationState` instead.
+    class InvalidDBCapacityReservationStateFault < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::RDS::Types::InvalidDBCapacityReservationStateFault] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+    end
+
     class InvalidDBClusterAutomatedBackupStateFault < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context

data/lib/aws-sdk-rds/resource.rb

@@ -1242,6 +1242,7 @@ module Aws::RDS
     #         ],
     #       },
     #     ],
+    #     db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
     #     master_user_authentication_type: "password", # accepts password, iam-db-auth
     #   })
     # @param [Hash] options ({})
@@ -2504,6 +2505,43 @@ module Aws::RDS
     #   * `auto-backup` - The DB instance's automated backup.
     #
     #   ^
+    # @option options [String] :db_capacity_reservation_identifier
+    #   The identifier or the name of the DB capacity reservation to associate
+    #   with this DB instance. You can specify the identifier, which has the
+    #   prefix `dbcr-`, or the reservation name. When you specify this
+    #   parameter, the DB instance uses reserved capacity from the specified
+    #   reservation.
+    #
+    #   If you specify `AvailabilityZone`, Amazon RDS places the DB instance
+    #   in that Availability Zone, and the reservation must cover it.
+    #
+    #   Constraints:
+    #
+    #   * The reservation must reserve capacity for the DB instance class and
+    #     the database engine of the DB instance.
+    #
+    #   * If the reservation reserves capacity for a specific license model,
+    #     the license model of the DB instance must match it.
+    #
+    #   * The reservation must be in the `active` state, and it must not be
+    #     past its end date.
+    #
+    #   * If you specify `AvailabilityZone`, it must be one of the
+    #     Availability Zones of the reservation.
+    #
+    #   * For a Multi-AZ DB instance, the reservation must cover two or more
+    #     Availability Zones. A Multi-AZ DB instance uses one unit of reserved
+    #     capacity in each of two Availability Zones. If the reservation
+    #     covers more than two Availability Zones, Amazon RDS chooses the two
+    #     that the DB instance uses.
+    #
+    #   * The reservation must have available capacity in each Availability
+    #     Zone that the DB instance uses.
+    #
+    #   * The DB subnet group must be in a VPC with default tenancy.
+    #
+    #   * The DB subnet group must cover each Availability Zone that the DB
+    #     instance uses.
     # @option options [String] :master_user_authentication_type
     #   Specifies the authentication type for the master user. With IAM master
     #   user authentication, you can configure the master DB user with IAM