aws-sdk-rds 1.324.0 → 1.326.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -201,13 +201,20 @@ module Aws::RDS
201
201
  # the required types.
202
202
  #
203
203
  # @option options [Boolean] :correct_clock_skew (true)
204
- # Used only in `standard` and `adaptive` retry modes. Specifies whether to apply
205
- # a clock skew correction and retry requests with skewed client clocks.
204
+ # Used only in `standard` and `adaptive` retry modes. Specifies whether
205
+ # to apply a clock skew correction and retry requests with skewed client
206
+ # clocks. Takes effect only when `disable_clock_skew_correction` is not set.
206
207
  #
207
208
  # @option options [String] :defaults_mode ("legacy")
208
209
  # See {Aws::DefaultsModeConfiguration} for a list of the
209
210
  # accepted modes and the configuration defaults that are included.
210
211
  #
212
+ # @option options [Boolean] :disable_clock_skew_correction
213
+ # Used only in `standard` and `adaptive` retry modes. When `true`, the
214
+ # SDK does not apply a clock skew correction, does not update its stored
215
+ # skew from responses, and does not retry clock skew errors. Clock skew
216
+ # correction is enabled by default.
217
+ #
211
218
  # @option options [Boolean] :disable_host_prefix_injection (false)
212
219
  # When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
213
220
  #
@@ -1056,6 +1063,111 @@ module Aws::RDS
1056
1063
  req.send_request(options)
1057
1064
  end
1058
1065
 
1066
+ # Cancels a DB capacity reservation. Amazon RDS changes the state of the
1067
+ # reservation to `cancelled` and stops reporting available capacity for
1068
+ # it. Amazon RDS then releases the reserved capacity.
1069
+ #
1070
+ # A DB instance that uses the reservation keeps running. It continues on
1071
+ # unreserved capacity, and Amazon RDS doesn't stop it or modify it.
1072
+ # However, Amazon RDS no longer reserves capacity for the DB instance.
1073
+ # If Amazon RDS later moves the DB instance to different hardware, for
1074
+ # example during hardware maintenance, that move can fail when the
1075
+ # Amazon Web Services Region has insufficient capacity for the DB
1076
+ # instance class.
1077
+ #
1078
+ # You can't cancel a reservation in the `active` state during a
1079
+ # capacity commitment. The response of `DescribeDBCapacityReservations`
1080
+ # reports the end of the commitment in `CommitmentInfo`.
1081
+ #
1082
+ # Constraints:
1083
+ #
1084
+ # * The reservation must be in the `active`, `assessing`, or `delayed`
1085
+ # state.
1086
+ #
1087
+ # * The reservation must not be past its end date.
1088
+ #
1089
+ # @option params [required, String] :db_capacity_reservation_identifier
1090
+ # The identifier or the name of the DB capacity reservation to cancel.
1091
+ # You can specify the identifier, which has the prefix `dbcr-`, or the
1092
+ # reservation name.
1093
+ #
1094
+ # @return [Types::CancelDBCapacityReservationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1095
+ #
1096
+ # * {Types::CancelDBCapacityReservationResponse#db_capacity_reservation #db_capacity_reservation} => Types::DBCapacityReservation
1097
+ #
1098
+ #
1099
+ # @example Example: To cancel a DB capacity reservation
1100
+ #
1101
+ # # The following example cancels the specified DB capacity reservation. Amazon RDS releases the reserved capacity. A DB
1102
+ # # instance that uses the reservation keeps running on unreserved capacity.
1103
+ #
1104
+ # resp = client.cancel_db_capacity_reservation({
1105
+ # db_capacity_reservation_identifier: "dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a",
1106
+ # })
1107
+ #
1108
+ # resp.to_h outputs the following:
1109
+ # {
1110
+ # db_capacity_reservation: {
1111
+ # available_capacity_per_availability_zone_list: [
1112
+ # {
1113
+ # availability_zone: "us-east-1a",
1114
+ # available_capacity: 0,
1115
+ # },
1116
+ # {
1117
+ # availability_zone: "us-east-1b",
1118
+ # available_capacity: 0,
1119
+ # },
1120
+ # ],
1121
+ # create_date: Time.parse("2026-09-10T18:22:41.612Z"),
1122
+ # db_capacity_reservation_arn: "arn:aws:rds:us-east-1:123456789012:db-capacity-reservation:dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a",
1123
+ # db_capacity_reservation_identifier: "dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a",
1124
+ # db_capacity_reservation_name: "my-mysql-reservation",
1125
+ # db_instance_class: "db.m5.large",
1126
+ # engine: "mysql",
1127
+ # reserved_capacity_per_availability_zone: 2,
1128
+ # state: "cancelled",
1129
+ # tag_list: [
1130
+ # ],
1131
+ # },
1132
+ # }
1133
+ #
1134
+ # @example Request syntax with placeholder values
1135
+ #
1136
+ # resp = client.cancel_db_capacity_reservation({
1137
+ # db_capacity_reservation_identifier: "DBCapacityReservationIdentifier", # required
1138
+ # })
1139
+ #
1140
+ # @example Response structure
1141
+ #
1142
+ # resp.db_capacity_reservation.db_capacity_reservation_name #=> String
1143
+ # resp.db_capacity_reservation.db_instance_class #=> String
1144
+ # resp.db_capacity_reservation.engine #=> String
1145
+ # resp.db_capacity_reservation.license_model #=> String
1146
+ # resp.db_capacity_reservation.reserved_capacity_per_availability_zone #=> Integer
1147
+ # resp.db_capacity_reservation.available_capacity_per_availability_zone_list #=> Array
1148
+ # resp.db_capacity_reservation.available_capacity_per_availability_zone_list[0].availability_zone #=> String
1149
+ # resp.db_capacity_reservation.available_capacity_per_availability_zone_list[0].available_capacity #=> Integer
1150
+ # resp.db_capacity_reservation.end_date #=> Time
1151
+ # resp.db_capacity_reservation.create_date #=> Time
1152
+ # resp.db_capacity_reservation.start_date #=> Time
1153
+ # resp.db_capacity_reservation.commitment_info.committed_capacity_per_availability_zone #=> Integer
1154
+ # resp.db_capacity_reservation.commitment_info.commitment_end_date #=> Time
1155
+ # resp.db_capacity_reservation.state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "assessing", "scheduled", "delayed", "unsupported"
1156
+ # resp.db_capacity_reservation.db_capacity_reservation_arn #=> String
1157
+ # resp.db_capacity_reservation.db_capacity_reservation_identifier #=> String
1158
+ # resp.db_capacity_reservation.tag_list #=> Array
1159
+ # resp.db_capacity_reservation.tag_list[0].key #=> String
1160
+ # resp.db_capacity_reservation.tag_list[0].value #=> String
1161
+ #
1162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CancelDBCapacityReservation AWS API Documentation
1163
+ #
1164
+ # @overload cancel_db_capacity_reservation(params = {})
1165
+ # @param [Hash] params ({})
1166
+ def cancel_db_capacity_reservation(params = {}, options = {})
1167
+ req = build_request(:cancel_db_capacity_reservation, params)
1168
+ req.send_request(options)
1169
+ end
1170
+
1059
1171
  # Cancels an export task in progress that is exporting a snapshot or
1060
1172
  # cluster to Amazon S3. Any data that has already been written to the S3
1061
1173
  # bucket isn't removed.
@@ -2755,6 +2867,405 @@ module Aws::RDS
2755
2867
  req.send_request(options)
2756
2868
  end
2757
2869
 
2870
+ # Creates a DB capacity reservation. A DB capacity reservation reserves
2871
+ # compute and memory capacity for DB instances of one DB instance class
2872
+ # and one database engine. Amazon RDS reserves that capacity in each
2873
+ # Availability Zone that you specify.
2874
+ #
2875
+ # Amazon RDS reserves the same amount of capacity in every Availability
2876
+ # Zone in the request. You set that amount with
2877
+ # `CapacityPerAvailabilityZone`, and you set the Availability Zones with
2878
+ # `AvailabilityZones`. The total reserved capacity is
2879
+ # `CapacityPerAvailabilityZone` multiplied by the number of Availability
2880
+ # Zones.
2881
+ #
2882
+ # Specify `StartDate` and `CommitmentDuration` together to create a
2883
+ # future-dated reservation. A future-dated reservation reserves capacity
2884
+ # for a period that starts later. Amazon RDS holds that capacity for the
2885
+ # length of the commitment.
2886
+ #
2887
+ # A future-dated reservation has the following additional constraints:
2888
+ #
2889
+ # * `DBInstanceClass` must be a `db.c`, `db.m`, `db.r`, `db.t`, or
2890
+ # `db.x` DB instance class. The letter after `db.` gives the DB
2891
+ # instance class family. For example, `db.x2g.xlarge` qualifies, and
2892
+ # `db.z1d.xlarge` doesn't.
2893
+ #
2894
+ # * If `DBInstanceClass` is a `db.m` or `db.r` DB instance class, it
2895
+ # must be from generation 7 or later. The digit after the family
2896
+ # letter gives the generation. For example, `db.m7g.xlarge` qualifies,
2897
+ # and `db.m5.xlarge` doesn't. A `db.c`, `db.t`, or `db.x` DB instance
2898
+ # class has no generation requirement.
2899
+ #
2900
+ # * The reserved capacity must total at least 32 vCPUs in each
2901
+ # Availability Zone. Multiply `CapacityPerAvailabilityZone` by the
2902
+ # number of vCPUs of the DB instance class. The product must be 32 or
2903
+ # more.
2904
+ #
2905
+ # * `CommitmentDuration` must be at least 14 days. For a `db.x` DB
2906
+ # instance class, it must be at least 84 days.
2907
+ #
2908
+ # * `StartDate` must be from 5 to 120 days in the future.
2909
+ #
2910
+ # Therefore, a DB instance class with 2 vCPUs needs a
2911
+ # `CapacityPerAvailabilityZone` of 16 or more, a class with 4 vCPUs
2912
+ # needs 8 or more, a class with 8 vCPUs needs 4 or more, and a class
2913
+ # with 16 vCPUs needs 2 or more. For the number of vCPUs of each DB
2914
+ # instance class, see [DB instance classes][1] in the *Amazon RDS User
2915
+ # Guide*.
2916
+ #
2917
+ # <note markdown="1"> You can't modify a future-dated reservation before it starts. You
2918
+ # can't cancel a future-dated reservation in the `scheduled` state. You
2919
+ # can't cancel a reservation in the `active` state during its capacity
2920
+ # commitment. Therefore, you can't cancel a future-dated reservation
2921
+ # from the time that Amazon RDS schedules it until the commitment ends.
2922
+ #
2923
+ # </note>
2924
+ #
2925
+ #
2926
+ #
2927
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
2928
+ #
2929
+ # @option params [required, String] :db_capacity_reservation_name
2930
+ # The name of the DB capacity reservation. This name must be unique for
2931
+ # your Amazon Web Services account in the Amazon Web Services Region.
2932
+ #
2933
+ # Constraints:
2934
+ #
2935
+ # * Must contain from 1 to 63 lowercase letters, digits, or hyphens.
2936
+ #
2937
+ # * First character must be a lowercase letter.
2938
+ #
2939
+ # * Can't end with a hyphen or contain two consecutive hyphens.
2940
+ #
2941
+ # * Can't contain more than 16 groups of characters separated by
2942
+ # hyphens.
2943
+ #
2944
+ # * Can't begin with `dbcr-`.
2945
+ #
2946
+ # @option params [required, String] :db_instance_class
2947
+ # The compute and memory capacity to reserve, for example `db.m5.large`.
2948
+ # Not all DB instance classes are available in all Amazon Web Services
2949
+ # Regions, or for all database engines. For the full list of DB instance
2950
+ # classes, and availability for your engine, see [DB instance
2951
+ # classes][1] in the *Amazon RDS User Guide*.
2952
+ #
2953
+ # Constraints:
2954
+ #
2955
+ # * Must be a DB instance class that the specified `Engine` supports.
2956
+ #
2957
+ # * For RDS for Oracle with `LicenseModel` set to `license-included`,
2958
+ # some DB instance classes aren't supported. Either choose a
2959
+ # supported DB instance class, or set `LicenseModel` to
2960
+ # `bring-your-own-license`.
2961
+ #
2962
+ #
2963
+ #
2964
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
2965
+ #
2966
+ # @option params [required, String] :engine
2967
+ # The database engine to reserve capacity for.
2968
+ #
2969
+ # Valid Values: `aurora-mysql` \| `aurora-postgresql` \| `mysql` \|
2970
+ # `postgres` \| `mariadb` \| `oracle-ee` \| `oracle-ee-cdb` \|
2971
+ # `oracle-se2` \| `oracle-se2-cdb` \| `sqlserver-ee` \| `sqlserver-se`
2972
+ # \| `sqlserver-web` \| `sqlserver-ex` \| `sqlserver-dev-ee` \|
2973
+ # `sqlserver-dev-se` \| `db2-ae` \| `db2-ce` \| `db2-se`
2974
+ #
2975
+ # <note markdown="1"> The Developer Edition engines `sqlserver-dev-ee` and
2976
+ # `sqlserver-dev-se` support no Multi-AZ DB instance and no read
2977
+ # replica. Therefore, a reservation for either engine serves Single-AZ
2978
+ # DB instances only.
2979
+ #
2980
+ # </note>
2981
+ #
2982
+ # @option params [required, Integer] :capacity_per_availability_zone
2983
+ # The number of DB instances to reserve in each Availability Zone that
2984
+ # you list in `AvailabilityZones`. Amazon RDS reserves this number of DB
2985
+ # instances in every listed Availability Zone.
2986
+ #
2987
+ # A Single-AZ DB instance uses one unit of reserved capacity, in one
2988
+ # Availability Zone. A Multi-AZ DB instance is one DB instance, and it
2989
+ # uses one unit of reserved capacity in each of two Availability Zones.
2990
+ # Therefore, a Multi-AZ DB instance uses two units in total. A read
2991
+ # replica uses one unit of reserved capacity, in the same way as any
2992
+ # other DB instance.
2993
+ #
2994
+ # Amazon RDS reserves capacity in each Availability Zone separately.
2995
+ # Reserved capacity in one Availability Zone can't serve a DB instance
2996
+ # in another Availability Zone. A request for a DB instance fails when
2997
+ # the Availability Zone of the DB instance has no available capacity.
2998
+ #
2999
+ # Therefore, set this value to the number of DB instances that you want
3000
+ # to run at the same time in one Availability Zone. Don't set it to the
3001
+ # number that you want in total.
3002
+ #
3003
+ # This value multiplied by the number of Availability Zones counts
3004
+ # against the DB instances quota for your Amazon Web Services account in
3005
+ # the Amazon Web Services Region. Your existing DB instances, and the
3006
+ # unused capacity of your other reservations, count against the same
3007
+ # quota.
3008
+ #
3009
+ # To find the value of the DB instances quota, see [Quotas and
3010
+ # constraints for Amazon RDS][1] in the *Amazon RDS User Guide*.
3011
+ #
3012
+ # Constraints:
3013
+ #
3014
+ # * Minimum 1.
3015
+ #
3016
+ # ^
3017
+ #
3018
+ #
3019
+ #
3020
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html
3021
+ #
3022
+ # @option params [required, Array<String>] :availability_zones
3023
+ # A list of Availability Zones for the reservation.
3024
+ #
3025
+ # You can't change the Availability Zones of a reservation after you
3026
+ # create it. Reserved capacity in an Availability Zone that no DB
3027
+ # instance uses stays unused.
3028
+ #
3029
+ # Constraints:
3030
+ #
3031
+ # * Must specify one or more Availability Zones.
3032
+ #
3033
+ # * Each Availability Zone can appear only once.
3034
+ #
3035
+ # * Each Availability Zone must be in the Amazon Web Services Region of
3036
+ # the request.
3037
+ #
3038
+ # * Each Availability Zone must have capacity for the requested DB
3039
+ # instance class.
3040
+ #
3041
+ # * Must include two or more Availability Zones to use the reservation
3042
+ # for a Multi-AZ DB instance.
3043
+ #
3044
+ # * A DB instance can use reserved capacity only in an Availability Zone
3045
+ # that its DB subnet group covers.
3046
+ #
3047
+ # Example: `us-east-1a`
3048
+ #
3049
+ # @option params [Time,DateTime,Date,Integer,String] :end_date
3050
+ # The date and time when the reservation expires, in Universal
3051
+ # Coordinated Time (UTC). If you don't specify a value, the reservation
3052
+ # doesn't expire.
3053
+ #
3054
+ # To change the expiration of an existing reservation, use
3055
+ # `ModifyDBCapacityReservation`. That operation takes `EndDateType`
3056
+ # along with `EndDate`.
3057
+ #
3058
+ # Constraints:
3059
+ #
3060
+ # * Must be a date and time in the future.
3061
+ #
3062
+ # * For a future-dated reservation, must be at or after `StartDate` plus
3063
+ # `CommitmentDuration`. For example, a reservation that starts on
3064
+ # 2026-12-01 with a 30-day commitment can't expire before 2026-12-31.
3065
+ # To reserve capacity for one calendar month, set `CommitmentDuration`
3066
+ # to 30 days or fewer, not to the length of the month.
3067
+ #
3068
+ # Example: `2026-12-31T23:59:59Z`
3069
+ #
3070
+ # @option params [Time,DateTime,Date,Integer,String] :start_date
3071
+ # The date and time when the reservation starts, in Universal
3072
+ # Coordinated Time (UTC). Specify this parameter to create a
3073
+ # future-dated reservation. If you don't specify a value, the
3074
+ # reservation starts immediately.
3075
+ #
3076
+ # A reservation that starts later always carries a capacity commitment.
3077
+ # Therefore, a request that specifies `StartDate` must also meet every
3078
+ # constraint of a future-dated reservation, including the minimum
3079
+ # reserved capacity in each Availability Zone.
3080
+ #
3081
+ # Constraints:
3082
+ #
3083
+ # * Must be from 5 to 120 days in the future.
3084
+ #
3085
+ # * You must also specify `CommitmentDuration`.
3086
+ #
3087
+ # Example: `2026-12-01T00:00:00Z`
3088
+ #
3089
+ # @option params [Integer] :commitment_duration
3090
+ # The length of the capacity commitment that you request for a
3091
+ # future-dated reservation, in seconds. Amazon RDS measures this length
3092
+ # from `StartDate`.
3093
+ #
3094
+ # <note markdown="1"> Amazon RDS can grant a shorter capacity commitment than you request.
3095
+ # Therefore, read `CommitmentEndDate` in `CommitmentInfo` for the
3096
+ # commitment that Amazon RDS granted.
3097
+ #
3098
+ # </note>
3099
+ #
3100
+ # The commitment doesn't end the reservation. Specify `EndDate` to set
3101
+ # an expiration date. You can't cancel a reservation in the `active`
3102
+ # state during the commitment.
3103
+ #
3104
+ # Constraints:
3105
+ #
3106
+ # * Minimum 1209600, which is 14 days. For a `db.x` DB instance class,
3107
+ # such as `db.x2g.xlarge`, the minimum is 7257600, which is 84 days.
3108
+ #
3109
+ # * Must be less than 315576000, which is 10 years.
3110
+ #
3111
+ # * You must also specify `StartDate`.
3112
+ #
3113
+ # Example: `2592000`
3114
+ #
3115
+ # @option params [String] :license_model
3116
+ # The license model to reserve capacity for. Specify this parameter only
3117
+ # for RDS for Microsoft SQL Server Enterprise Edition, Standard Edition,
3118
+ # and Developer Edition, for RDS for Oracle, or for RDS for Db2 Standard
3119
+ # Edition and Advanced Edition. Amazon RDS rejects the request for any
3120
+ # other engine. This includes Amazon Aurora, the Web and Express
3121
+ # editions of RDS for Microsoft SQL Server, and RDS for Db2 Community
3122
+ # Edition.
3123
+ #
3124
+ # Valid Values:
3125
+ #
3126
+ # * RDS for Microsoft SQL Server Enterprise Edition and Standard Edition
3127
+ # - `license-included | bring-your-own-media`
3128
+ #
3129
+ # * RDS for Microsoft SQL Server Developer Edition -
3130
+ # `bring-your-own-license`
3131
+ #
3132
+ # * RDS for Oracle - `bring-your-own-license | license-included`
3133
+ #
3134
+ # * RDS for Db2 Standard Edition and Advanced Edition -
3135
+ # `bring-your-own-license | marketplace-license`
3136
+ #
3137
+ # A DB instance launches into the reservation only when the license
3138
+ # model of the DB instance matches the license model of the reservation.
3139
+ # For a reservation that holds no license model, Amazon RDS applies no
3140
+ # license model check at launch.
3141
+ #
3142
+ # For RDS for Microsoft SQL Server Enterprise Edition and Standard
3143
+ # Edition, if you don't specify a value, Amazon RDS uses
3144
+ # `license-included`.
3145
+ #
3146
+ # For RDS for Microsoft SQL Server Developer Edition, if you don't
3147
+ # specify a value, Amazon RDS uses `bring-your-own-license`. That is the
3148
+ # only license model that these engines accept, and Amazon RDS rejects
3149
+ # any other value.
3150
+ #
3151
+ # For RDS for Oracle, if you don't specify a value, Amazon RDS uses the
3152
+ # only orderable license model for the DB instance class. If more than
3153
+ # one license model is orderable, you must specify one.
3154
+ #
3155
+ # For RDS for Db2 Standard Edition and Advanced Edition, if you don't
3156
+ # specify a value, Amazon RDS uses `bring-your-own-license`. To reserve
3157
+ # capacity for Db2 DB instances that you license through Amazon Web
3158
+ # Services Marketplace, specify `marketplace-license`.
3159
+ #
3160
+ # <note markdown="1"> For RDS for Oracle, the license models that you can reserve depend on
3161
+ # the engine and the DB instance class. RDS for Oracle Enterprise
3162
+ # Edition doesn't support `license-included`.
3163
+ #
3164
+ # </note>
3165
+ #
3166
+ # @option params [Array<Types::Tag>] :tags
3167
+ # Tags to assign to the DB capacity reservation.
3168
+ #
3169
+ # @return [Types::CreateDBCapacityReservationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3170
+ #
3171
+ # * {Types::CreateDBCapacityReservationResponse#db_capacity_reservation #db_capacity_reservation} => Types::DBCapacityReservation
3172
+ #
3173
+ #
3174
+ # @example Example: To create a DB capacity reservation in two Availability Zones
3175
+ #
3176
+ # # The following example reserves capacity for two db.m5.large RDS for MySQL DB instances in each of two Availability
3177
+ # # Zones. Amazon RDS reserves the same capacity in every Availability Zone in the request. The total reserved capacity is
3178
+ # # four units. Four units serve four Single-AZ DB instances, or two Multi-AZ DB instances, because a Multi-AZ DB instance
3179
+ # # uses one unit in each of two Availability Zones.
3180
+ #
3181
+ # resp = client.create_db_capacity_reservation({
3182
+ # availability_zones: [
3183
+ # "us-east-1a",
3184
+ # "us-east-1b",
3185
+ # ],
3186
+ # capacity_per_availability_zone: 2,
3187
+ # db_capacity_reservation_name: "my-mysql-reservation",
3188
+ # db_instance_class: "db.m5.large",
3189
+ # engine: "mysql",
3190
+ # })
3191
+ #
3192
+ # resp.to_h outputs the following:
3193
+ # {
3194
+ # db_capacity_reservation: {
3195
+ # available_capacity_per_availability_zone_list: [
3196
+ # {
3197
+ # availability_zone: "us-east-1a",
3198
+ # available_capacity: 2,
3199
+ # },
3200
+ # {
3201
+ # availability_zone: "us-east-1b",
3202
+ # available_capacity: 2,
3203
+ # },
3204
+ # ],
3205
+ # create_date: Time.parse("2026-09-10T18:22:41.612Z"),
3206
+ # db_capacity_reservation_arn: "arn:aws:rds:us-east-1:123456789012:db-capacity-reservation:dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a",
3207
+ # db_capacity_reservation_identifier: "dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a",
3208
+ # db_capacity_reservation_name: "my-mysql-reservation",
3209
+ # db_instance_class: "db.m5.large",
3210
+ # engine: "mysql",
3211
+ # reserved_capacity_per_availability_zone: 2,
3212
+ # state: "active",
3213
+ # tag_list: [
3214
+ # ],
3215
+ # },
3216
+ # }
3217
+ #
3218
+ # @example Request syntax with placeholder values
3219
+ #
3220
+ # resp = client.create_db_capacity_reservation({
3221
+ # db_capacity_reservation_name: "DBCapacityReservationName", # required
3222
+ # db_instance_class: "DBInstanceClass", # required
3223
+ # engine: "String", # required
3224
+ # capacity_per_availability_zone: 1, # required
3225
+ # availability_zones: ["String"], # required
3226
+ # end_date: Time.now,
3227
+ # start_date: Time.now,
3228
+ # commitment_duration: 1,
3229
+ # license_model: "String",
3230
+ # tags: [
3231
+ # {
3232
+ # key: "String",
3233
+ # value: "String",
3234
+ # },
3235
+ # ],
3236
+ # })
3237
+ #
3238
+ # @example Response structure
3239
+ #
3240
+ # resp.db_capacity_reservation.db_capacity_reservation_name #=> String
3241
+ # resp.db_capacity_reservation.db_instance_class #=> String
3242
+ # resp.db_capacity_reservation.engine #=> String
3243
+ # resp.db_capacity_reservation.license_model #=> String
3244
+ # resp.db_capacity_reservation.reserved_capacity_per_availability_zone #=> Integer
3245
+ # resp.db_capacity_reservation.available_capacity_per_availability_zone_list #=> Array
3246
+ # resp.db_capacity_reservation.available_capacity_per_availability_zone_list[0].availability_zone #=> String
3247
+ # resp.db_capacity_reservation.available_capacity_per_availability_zone_list[0].available_capacity #=> Integer
3248
+ # resp.db_capacity_reservation.end_date #=> Time
3249
+ # resp.db_capacity_reservation.create_date #=> Time
3250
+ # resp.db_capacity_reservation.start_date #=> Time
3251
+ # resp.db_capacity_reservation.commitment_info.committed_capacity_per_availability_zone #=> Integer
3252
+ # resp.db_capacity_reservation.commitment_info.commitment_end_date #=> Time
3253
+ # resp.db_capacity_reservation.state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "assessing", "scheduled", "delayed", "unsupported"
3254
+ # resp.db_capacity_reservation.db_capacity_reservation_arn #=> String
3255
+ # resp.db_capacity_reservation.db_capacity_reservation_identifier #=> String
3256
+ # resp.db_capacity_reservation.tag_list #=> Array
3257
+ # resp.db_capacity_reservation.tag_list[0].key #=> String
3258
+ # resp.db_capacity_reservation.tag_list[0].value #=> String
3259
+ #
3260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBCapacityReservation AWS API Documentation
3261
+ #
3262
+ # @overload create_db_capacity_reservation(params = {})
3263
+ # @param [Hash] params ({})
3264
+ def create_db_capacity_reservation(params = {}, options = {})
3265
+ req = build_request(:create_db_capacity_reservation, params)
3266
+ req.send_request(options)
3267
+ end
3268
+
2758
3269
  # Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
2759
3270
  #
2760
3271
  # If you create an Aurora DB cluster, the request creates an empty
@@ -6064,6 +6575,44 @@ module Aws::RDS
6064
6575
  #
6065
6576
  # ^
6066
6577
  #
6578
+ # @option params [String] :db_capacity_reservation_identifier
6579
+ # The identifier or the name of the DB capacity reservation to associate
6580
+ # with this DB instance. You can specify the identifier, which has the
6581
+ # prefix `dbcr-`, or the reservation name. When you specify this
6582
+ # parameter, the DB instance uses reserved capacity from the specified
6583
+ # reservation.
6584
+ #
6585
+ # If you specify `AvailabilityZone`, Amazon RDS places the DB instance
6586
+ # in that Availability Zone, and the reservation must cover it.
6587
+ #
6588
+ # Constraints:
6589
+ #
6590
+ # * The reservation must reserve capacity for the DB instance class and
6591
+ # the database engine of the DB instance.
6592
+ #
6593
+ # * If the reservation reserves capacity for a specific license model,
6594
+ # the license model of the DB instance must match it.
6595
+ #
6596
+ # * The reservation must be in the `active` state, and it must not be
6597
+ # past its end date.
6598
+ #
6599
+ # * If you specify `AvailabilityZone`, it must be one of the
6600
+ # Availability Zones of the reservation.
6601
+ #
6602
+ # * For a Multi-AZ DB instance, the reservation must cover two or more
6603
+ # Availability Zones. A Multi-AZ DB instance uses one unit of reserved
6604
+ # capacity in each of two Availability Zones. If the reservation
6605
+ # covers more than two Availability Zones, Amazon RDS chooses the two
6606
+ # that the DB instance uses.
6607
+ #
6608
+ # * The reservation must have available capacity in each Availability
6609
+ # Zone that the DB instance uses.
6610
+ #
6611
+ # * The DB subnet group must be in a VPC with default tenancy.
6612
+ #
6613
+ # * The DB subnet group must cover each Availability Zone that the DB
6614
+ # instance uses.
6615
+ #
6067
6616
  # @option params [String] :master_user_authentication_type
6068
6617
  # Specifies the authentication type for the master user. With IAM master
6069
6618
  # user authentication, you can configure the master DB user with IAM
@@ -6290,6 +6839,7 @@ module Aws::RDS
6290
6839
  # ],
6291
6840
  # },
6292
6841
  # ],
6842
+ # db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
6293
6843
  # master_user_authentication_type: "password", # accepts password, iam-db-auth
6294
6844
  # })
6295
6845
  #
@@ -6366,6 +6916,7 @@ module Aws::RDS
6366
6916
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
6367
6917
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
6368
6918
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
6919
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
6369
6920
  # resp.db_instance.latest_restorable_time #=> Time
6370
6921
  # resp.db_instance.multi_az #=> Boolean
6371
6922
  # resp.db_instance.engine_version #=> String
@@ -6479,6 +7030,7 @@ module Aws::RDS
6479
7030
  # resp.db_instance.storage_volume_status #=> String
6480
7031
  # resp.db_instance.storage_operation_status #=> String
6481
7032
  # resp.db_instance.storage_operation_percent_progress #=> Integer
7033
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
6482
7034
  #
6483
7035
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstance AWS API Documentation
6484
7036
  #
@@ -6790,11 +7342,15 @@ module Aws::RDS
6790
7342
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
6791
7343
  # alias ARN, or alias name for the KMS key.
6792
7344
  #
6793
- # If you create an encrypted read replica in the same Amazon Web
6794
- # Services Region as the source DB instance or Multi-AZ DB cluster,
6795
- # don't specify a value for this parameter. A read replica in the same
6796
- # Amazon Web Services Region is always encrypted with the same KMS key
6797
- # as the source DB instance or cluster.
7345
+ # For a read replica in the same Amazon Web Services Region as the
7346
+ # source DB instance or Multi-AZ DB cluster, specifying this parameter
7347
+ # is optional. If you specify a KMS key identifier, the read replica is
7348
+ # encrypted with that KMS key, which can be different from the KMS key
7349
+ # of the source.
7350
+ #
7351
+ # If you don't specify a value for this parameter, the read replica is
7352
+ # encrypted with the same KMS key as the source DB instance or Multi-AZ
7353
+ # DB cluster.
6798
7354
  #
6799
7355
  # If you create an encrypted read replica in a different Amazon Web
6800
7356
  # Services Region, then you must specify a KMS key identifier for the
@@ -7251,6 +7807,46 @@ module Aws::RDS
7251
7807
  #
7252
7808
  # ^
7253
7809
  #
7810
+ # @option params [String] :db_capacity_reservation_identifier
7811
+ # The identifier or the name of the DB capacity reservation to associate
7812
+ # with this read replica. You can specify the identifier, which has the
7813
+ # prefix `dbcr-`, or the reservation name. When you specify this
7814
+ # parameter, the read replica uses reserved capacity from the specified
7815
+ # reservation. A read replica uses one unit of reserved capacity, in the
7816
+ # same way as any other DB instance.
7817
+ #
7818
+ # If you specify `AvailabilityZone`, Amazon RDS places the DB instance
7819
+ # in that Availability Zone, and the reservation must cover it.
7820
+ #
7821
+ # Constraints:
7822
+ #
7823
+ # * The reservation must reserve capacity for the DB instance class and
7824
+ # the database engine of the DB instance.
7825
+ #
7826
+ # * If the reservation reserves capacity for a specific license model,
7827
+ # the license model of the source DB instance must match it. A read
7828
+ # replica inherits its license model from the source DB instance.
7829
+ #
7830
+ # * The reservation must be in the `active` state, and it must not be
7831
+ # past its end date.
7832
+ #
7833
+ # * If you specify `AvailabilityZone`, it must be one of the
7834
+ # Availability Zones of the reservation.
7835
+ #
7836
+ # * For a Multi-AZ DB instance, the reservation must cover two or more
7837
+ # Availability Zones. A Multi-AZ DB instance uses one unit of reserved
7838
+ # capacity in each of two Availability Zones. If the reservation
7839
+ # covers more than two Availability Zones, Amazon RDS chooses the two
7840
+ # that the DB instance uses.
7841
+ #
7842
+ # * The reservation must have available capacity in each Availability
7843
+ # Zone that the DB instance uses.
7844
+ #
7845
+ # * The DB subnet group must be in a VPC with default tenancy.
7846
+ #
7847
+ # * The DB subnet group must cover each Availability Zone that the DB
7848
+ # instance uses.
7849
+ #
7254
7850
  # @option params [String] :source_region
7255
7851
  # The source region of the snapshot. This is only needed when the
7256
7852
  # shapshot is encrypted and in a different region.
@@ -7362,6 +7958,7 @@ module Aws::RDS
7362
7958
  # ],
7363
7959
  # },
7364
7960
  # ],
7961
+ # db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
7365
7962
  # source_region: "String",
7366
7963
  # })
7367
7964
  #
@@ -7438,6 +8035,7 @@ module Aws::RDS
7438
8035
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
7439
8036
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
7440
8037
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
8038
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
7441
8039
  # resp.db_instance.latest_restorable_time #=> Time
7442
8040
  # resp.db_instance.multi_az #=> Boolean
7443
8041
  # resp.db_instance.engine_version #=> String
@@ -7551,6 +8149,7 @@ module Aws::RDS
7551
8149
  # resp.db_instance.storage_volume_status #=> String
7552
8150
  # resp.db_instance.storage_operation_status #=> String
7553
8151
  # resp.db_instance.storage_operation_percent_progress #=> Integer
8152
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
7554
8153
  #
7555
8154
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplica AWS API Documentation
7556
8155
  #
@@ -10549,6 +11148,7 @@ module Aws::RDS
10549
11148
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
10550
11149
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
10551
11150
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
11151
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
10552
11152
  # resp.db_instance.latest_restorable_time #=> Time
10553
11153
  # resp.db_instance.multi_az #=> Boolean
10554
11154
  # resp.db_instance.engine_version #=> String
@@ -10662,6 +11262,7 @@ module Aws::RDS
10662
11262
  # resp.db_instance.storage_volume_status #=> String
10663
11263
  # resp.db_instance.storage_operation_status #=> String
10664
11264
  # resp.db_instance.storage_operation_percent_progress #=> Integer
11265
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
10665
11266
  #
10666
11267
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstance AWS API Documentation
10667
11268
  #
@@ -12175,6 +12776,218 @@ module Aws::RDS
12175
12776
  req.send_request(options)
12176
12777
  end
12177
12778
 
12779
+ # Describes one or more DB capacity reservations. A DB capacity
12780
+ # reservation reserves capacity for Amazon RDS DB instances in one or
12781
+ # more Availability Zones.
12782
+ #
12783
+ # If you don't specify a `DBCapacityReservationIdentifier`, this
12784
+ # operation returns information about all DB capacity reservations for
12785
+ # your Amazon Web Services account.
12786
+ #
12787
+ # This operation supports pagination.
12788
+ #
12789
+ # @option params [String] :db_capacity_reservation_identifier
12790
+ # The identifier or the name of the DB capacity reservation to describe.
12791
+ # You can specify the identifier, which has the prefix `dbcr-`, or the
12792
+ # reservation name.
12793
+ #
12794
+ # @option params [String] :marker
12795
+ # An optional pagination token provided by a previous
12796
+ # `DescribeDBCapacityReservations` request. If this parameter is
12797
+ # specified, the response includes only records beyond the marker, up to
12798
+ # the value specified by `MaxRecords`.
12799
+ #
12800
+ # @option params [Integer] :max_records
12801
+ # The maximum number of records to include in the response. If more
12802
+ # records exist than the specified `MaxRecords` value, a pagination
12803
+ # token called a marker is included in the response so that you can
12804
+ # retrieve the remaining results.
12805
+ #
12806
+ # Default: 100
12807
+ #
12808
+ # Constraints:
12809
+ #
12810
+ # * Must be a minimum of 20.
12811
+ #
12812
+ # * Can't exceed 100.
12813
+ #
12814
+ # @option params [Array<Types::Filter>] :filters
12815
+ # A filter that specifies which DB capacity reservations to describe.
12816
+ #
12817
+ # Supported filters:
12818
+ #
12819
+ # * `db-capacity-reservation-name` - Accepts DB capacity reservation
12820
+ # names. The response includes only the reservations that these names
12821
+ # identify. Use this filter to describe several reservations by name
12822
+ # in one request.
12823
+ #
12824
+ # * `state` - Accepts reservation states. The response includes only the
12825
+ # reservations in these states.
12826
+ #
12827
+ # * `engine` - Accepts database engine names. The response includes only
12828
+ # the reservations that reserve capacity for these engines.
12829
+ #
12830
+ # * `db-instance-class` - Accepts DB instance classes. The response
12831
+ # includes only the reservations that reserve capacity for these DB
12832
+ # instance classes.
12833
+ #
12834
+ # * `availability-zone` - Accepts Availability Zone names. The response
12835
+ # includes only the reservations that cover these Availability Zones.
12836
+ #
12837
+ # When you specify more than one value for a filter, the response
12838
+ # includes the reservations that match any of those values. When you
12839
+ # specify more than one filter, the response includes only the
12840
+ # reservations that match every filter.
12841
+ #
12842
+ # Amazon RDS rejects the request when a filter name isn't in this list,
12843
+ # or when a filter specifies no values.
12844
+ #
12845
+ # <note markdown="1"> The `state` filter doesn't accept `expired`. To find an expired
12846
+ # reservation, compare `EndDate` against the current date and time.
12847
+ #
12848
+ # </note>
12849
+ #
12850
+ # @return [Types::DescribeDBCapacityReservationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
12851
+ #
12852
+ # * {Types::DescribeDBCapacityReservationsResponse#db_capacity_reservations #db_capacity_reservations} => Array&lt;Types::DBCapacityReservation&gt;
12853
+ # * {Types::DescribeDBCapacityReservationsResponse#marker #marker} => String
12854
+ #
12855
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
12856
+ #
12857
+ #
12858
+ # @example Example: To describe a DB capacity reservation
12859
+ #
12860
+ # # The following example retrieves the details of the specified DB capacity reservation. The response reports the reserved
12861
+ # # capacity and the available capacity for each Availability Zone of the reservation.
12862
+ #
12863
+ # resp = client.describe_db_capacity_reservations({
12864
+ # db_capacity_reservation_identifier: "dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a",
12865
+ # })
12866
+ #
12867
+ # resp.to_h outputs the following:
12868
+ # {
12869
+ # db_capacity_reservations: [
12870
+ # {
12871
+ # available_capacity_per_availability_zone_list: [
12872
+ # {
12873
+ # availability_zone: "us-east-1a",
12874
+ # available_capacity: 1,
12875
+ # },
12876
+ # {
12877
+ # availability_zone: "us-east-1b",
12878
+ # available_capacity: 2,
12879
+ # },
12880
+ # ],
12881
+ # create_date: Time.parse("2026-09-10T18:22:41.612Z"),
12882
+ # db_capacity_reservation_arn: "arn:aws:rds:us-east-1:123456789012:db-capacity-reservation:dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a",
12883
+ # db_capacity_reservation_identifier: "dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a",
12884
+ # db_capacity_reservation_name: "my-mysql-reservation",
12885
+ # db_instance_class: "db.m5.large",
12886
+ # engine: "mysql",
12887
+ # reserved_capacity_per_availability_zone: 2,
12888
+ # state: "active",
12889
+ # tag_list: [
12890
+ # ],
12891
+ # },
12892
+ # ],
12893
+ # }
12894
+ #
12895
+ # @example Example: To list DB capacity reservations one page at a time
12896
+ #
12897
+ # # The following example lists the active DB capacity reservations for the AWS account, 20 records at a time. The Marker
12898
+ # # value comes from the response of the previous DescribeDBCapacityReservations request. Omit Marker for the first request.
12899
+ # # A Marker is an opaque token. Pass it back without any change, and don't parse it or build one yourself. A Marker expires
12900
+ # # 24 hours after Amazon RDS issues it. The Marker values in this example are shortened for readability.
12901
+ #
12902
+ # resp = client.describe_db_capacity_reservations({
12903
+ # filters: [
12904
+ # {
12905
+ # name: "state",
12906
+ # values: [
12907
+ # "active",
12908
+ # ],
12909
+ # },
12910
+ # ],
12911
+ # marker: "eyJ2ZXJzaW9uIjoxLCJ0b2tlbkRldGFpbCI6IkFRSUNBSGhWdjlWNG1RM3JLY0xwWjh0Mlh5RjdiTjB3UmpTNXVF...",
12912
+ # max_records: 20,
12913
+ # })
12914
+ #
12915
+ # resp.to_h outputs the following:
12916
+ # {
12917
+ # db_capacity_reservations: [
12918
+ # {
12919
+ # available_capacity_per_availability_zone_list: [
12920
+ # {
12921
+ # availability_zone: "us-east-1c",
12922
+ # available_capacity: 4,
12923
+ # },
12924
+ # {
12925
+ # availability_zone: "us-east-1d",
12926
+ # available_capacity: 4,
12927
+ # },
12928
+ # ],
12929
+ # create_date: Time.parse("2026-09-08T11:04:07.335Z"),
12930
+ # db_capacity_reservation_arn: "arn:aws:rds:us-east-1:123456789012:db-capacity-reservation:dbcr-3npv8ck1zt6wq9db4mhx2js7fr5gy0ea",
12931
+ # db_capacity_reservation_identifier: "dbcr-3npv8ck1zt6wq9db4mhx2js7fr5gy0ea",
12932
+ # db_capacity_reservation_name: "my-postgres-reservation",
12933
+ # db_instance_class: "db.r6g.xlarge",
12934
+ # engine: "postgres",
12935
+ # reserved_capacity_per_availability_zone: 4,
12936
+ # state: "active",
12937
+ # tag_list: [
12938
+ # ],
12939
+ # },
12940
+ # ],
12941
+ # marker: "eyJ2ZXJzaW9uIjoxLCJ0b2tlbkRldGFpbCI6IkFRSUNBSGkyWnBRN25SeERrVDN2WWJHY0w5c1dtRTB1SmZIYU41...",
12942
+ # }
12943
+ #
12944
+ # @example Request syntax with placeholder values
12945
+ #
12946
+ # resp = client.describe_db_capacity_reservations({
12947
+ # db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
12948
+ # marker: "String",
12949
+ # max_records: 1,
12950
+ # filters: [
12951
+ # {
12952
+ # name: "String", # required
12953
+ # values: ["String"], # required
12954
+ # },
12955
+ # ],
12956
+ # })
12957
+ #
12958
+ # @example Response structure
12959
+ #
12960
+ # resp.db_capacity_reservations #=> Array
12961
+ # resp.db_capacity_reservations[0].db_capacity_reservation_name #=> String
12962
+ # resp.db_capacity_reservations[0].db_instance_class #=> String
12963
+ # resp.db_capacity_reservations[0].engine #=> String
12964
+ # resp.db_capacity_reservations[0].license_model #=> String
12965
+ # resp.db_capacity_reservations[0].reserved_capacity_per_availability_zone #=> Integer
12966
+ # resp.db_capacity_reservations[0].available_capacity_per_availability_zone_list #=> Array
12967
+ # resp.db_capacity_reservations[0].available_capacity_per_availability_zone_list[0].availability_zone #=> String
12968
+ # resp.db_capacity_reservations[0].available_capacity_per_availability_zone_list[0].available_capacity #=> Integer
12969
+ # resp.db_capacity_reservations[0].end_date #=> Time
12970
+ # resp.db_capacity_reservations[0].create_date #=> Time
12971
+ # resp.db_capacity_reservations[0].start_date #=> Time
12972
+ # resp.db_capacity_reservations[0].commitment_info.committed_capacity_per_availability_zone #=> Integer
12973
+ # resp.db_capacity_reservations[0].commitment_info.commitment_end_date #=> Time
12974
+ # resp.db_capacity_reservations[0].state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "assessing", "scheduled", "delayed", "unsupported"
12975
+ # resp.db_capacity_reservations[0].db_capacity_reservation_arn #=> String
12976
+ # resp.db_capacity_reservations[0].db_capacity_reservation_identifier #=> String
12977
+ # resp.db_capacity_reservations[0].tag_list #=> Array
12978
+ # resp.db_capacity_reservations[0].tag_list[0].key #=> String
12979
+ # resp.db_capacity_reservations[0].tag_list[0].value #=> String
12980
+ # resp.marker #=> String
12981
+ #
12982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBCapacityReservations AWS API Documentation
12983
+ #
12984
+ # @overload describe_db_capacity_reservations(params = {})
12985
+ # @param [Hash] params ({})
12986
+ def describe_db_capacity_reservations(params = {}, options = {})
12987
+ req = build_request(:describe_db_capacity_reservations, params)
12988
+ req.send_request(options)
12989
+ end
12990
+
12178
12991
  # Displays backups for both current and deleted DB clusters. For
12179
12992
  # example, use this operation to find details about automated backups
12180
12993
  # for previously deleted clusters. Current clusters are returned for
@@ -14299,6 +15112,7 @@ module Aws::RDS
14299
15112
  # resp.db_instances[0].pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
14300
15113
  # resp.db_instances[0].pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
14301
15114
  # resp.db_instances[0].pending_modified_values.additional_storage_volumes[0].storage_type #=> String
15115
+ # resp.db_instances[0].pending_modified_values.db_capacity_reservation_identifier #=> String
14302
15116
  # resp.db_instances[0].latest_restorable_time #=> Time
14303
15117
  # resp.db_instances[0].multi_az #=> Boolean
14304
15118
  # resp.db_instances[0].engine_version #=> String
@@ -14412,6 +15226,7 @@ module Aws::RDS
14412
15226
  # resp.db_instances[0].storage_volume_status #=> String
14413
15227
  # resp.db_instances[0].storage_operation_status #=> String
14414
15228
  # resp.db_instances[0].storage_operation_percent_progress #=> Integer
15229
+ # resp.db_instances[0].db_capacity_reservation_identifier #=> String
14415
15230
  #
14416
15231
  #
14417
15232
  # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -20051,6 +20866,137 @@ module Aws::RDS
20051
20866
  req.send_request(options)
20052
20867
  end
20053
20868
 
20869
+ # Modifies a DB capacity reservation. You can change the reserved
20870
+ # capacity in each Availability Zone of the reservation, and you can
20871
+ # change the end date of the reservation. You can't change the
20872
+ # Availability Zones of an existing reservation.
20873
+ #
20874
+ # The reservation must be in the `active` state. A future-dated
20875
+ # reservation that hasn't started isn't modifiable, and neither is a
20876
+ # reservation that Amazon RDS is already modifying.
20877
+ #
20878
+ # You must specify `CapacityPerAvailabilityZone`, `EndDateType`, or
20879
+ # `EndDate`. A request that specifies none of the three changes nothing,
20880
+ # and Amazon RDS rejects it.
20881
+ #
20882
+ # @option params [required, String] :db_capacity_reservation_identifier
20883
+ # The identifier or the name of the DB capacity reservation to modify.
20884
+ # You can specify the identifier, which has the prefix `dbcr-`, or the
20885
+ # reservation name.
20886
+ #
20887
+ # @option params [Integer] :capacity_per_availability_zone
20888
+ # The new number of DB instances to reserve in each Availability Zone of
20889
+ # the reservation. Amazon RDS applies this number to every Availability
20890
+ # Zone of the reservation.
20891
+ #
20892
+ # An increase reserves more capacity at the time of the request, so it
20893
+ # can fail when the Amazon Web Services Region has insufficient
20894
+ # capacity.
20895
+ #
20896
+ # This value multiplied by the number of Availability Zones counts
20897
+ # against the DB instances quota for your Amazon Web Services account in
20898
+ # the Amazon Web Services Region. Amazon RDS checks the quota only when
20899
+ # you increase the value.
20900
+ #
20901
+ # Constraints:
20902
+ #
20903
+ # * Minimum 1.
20904
+ #
20905
+ # * Can't be less than the highest number of DB instances that use the
20906
+ # reservation in any single Availability Zone of the reservation. That
20907
+ # number includes a DB instance that holds a unit of reserved capacity
20908
+ # for a pending modification. To find that number for an Availability
20909
+ # Zone, subtract `AvailableCapacity` from
20910
+ # `ReservedCapacityPerAvailabilityZone`.
20911
+ #
20912
+ # * During a capacity commitment, can't be less than
20913
+ # `CommittedCapacityPerAvailabilityZone`.
20914
+ #
20915
+ # @option params [String] :end_date_type
20916
+ # The end date type for the reservation.
20917
+ #
20918
+ # Valid Values:
20919
+ #
20920
+ # * `limited` - The reservation has a specific end date. You must also
20921
+ # specify `EndDate`.
20922
+ #
20923
+ # * `unlimited` - The reservation doesn't expire. Don't specify
20924
+ # `EndDate`.
20925
+ #
20926
+ # @option params [Time,DateTime,Date,Integer,String] :end_date
20927
+ # The new end date for the reservation, in Universal Coordinated Time
20928
+ # (UTC). Required when `EndDateType` is `limited`. Don't specify a
20929
+ # value when `EndDateType` is `unlimited`.
20930
+ #
20931
+ # When you specify `EndDate`, you must also specify `EndDateType`.
20932
+ #
20933
+ # Constraints:
20934
+ #
20935
+ # * Must be a date and time in the future.
20936
+ #
20937
+ # * During a capacity commitment, must be at or after
20938
+ # `CommitmentEndDate`.
20939
+ #
20940
+ # @return [Types::ModifyDBCapacityReservationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
20941
+ #
20942
+ # * {Types::ModifyDBCapacityReservationResponse#db_capacity_reservation #db_capacity_reservation} => Types::DBCapacityReservation
20943
+ #
20944
+ #
20945
+ # @example Example: To change the capacity and the end date of a DB capacity reservation
20946
+ #
20947
+ # # The following example raises the reserved capacity to three DB instances in each Availability Zone of the reservation,
20948
+ # # and it sets an end date. Set EndDateType to limited to give the reservation an end date. Set EndDateType to unlimited to
20949
+ # # remove the end date, and specify no EndDate. Amazon RDS applies the modification asynchronously, and it moves the
20950
+ # # reservation to the pending state. Call DescribeDBCapacityReservations to check when the reservation returns to the
20951
+ # # active state with the new capacity.
20952
+ #
20953
+ # resp = client.modify_db_capacity_reservation({
20954
+ # capacity_per_availability_zone: 3,
20955
+ # db_capacity_reservation_identifier: "dbcr-7hqk2m9xv4t1bn6cz3ws8dj5fp0gyr2a",
20956
+ # end_date: Time.parse("2026-12-31T23:59:59Z"),
20957
+ # end_date_type: "limited",
20958
+ # })
20959
+ #
20960
+ # @example Request syntax with placeholder values
20961
+ #
20962
+ # resp = client.modify_db_capacity_reservation({
20963
+ # db_capacity_reservation_identifier: "DBCapacityReservationIdentifier", # required
20964
+ # capacity_per_availability_zone: 1,
20965
+ # end_date_type: "unlimited", # accepts unlimited, limited
20966
+ # end_date: Time.now,
20967
+ # })
20968
+ #
20969
+ # @example Response structure
20970
+ #
20971
+ # resp.db_capacity_reservation.db_capacity_reservation_name #=> String
20972
+ # resp.db_capacity_reservation.db_instance_class #=> String
20973
+ # resp.db_capacity_reservation.engine #=> String
20974
+ # resp.db_capacity_reservation.license_model #=> String
20975
+ # resp.db_capacity_reservation.reserved_capacity_per_availability_zone #=> Integer
20976
+ # resp.db_capacity_reservation.available_capacity_per_availability_zone_list #=> Array
20977
+ # resp.db_capacity_reservation.available_capacity_per_availability_zone_list[0].availability_zone #=> String
20978
+ # resp.db_capacity_reservation.available_capacity_per_availability_zone_list[0].available_capacity #=> Integer
20979
+ # resp.db_capacity_reservation.end_date #=> Time
20980
+ # resp.db_capacity_reservation.create_date #=> Time
20981
+ # resp.db_capacity_reservation.start_date #=> Time
20982
+ # resp.db_capacity_reservation.commitment_info.committed_capacity_per_availability_zone #=> Integer
20983
+ # resp.db_capacity_reservation.commitment_info.commitment_end_date #=> Time
20984
+ # resp.db_capacity_reservation.state #=> String, one of "active", "expired", "cancelled", "pending", "failed", "assessing", "scheduled", "delayed", "unsupported"
20985
+ # resp.db_capacity_reservation.db_capacity_reservation_arn #=> String
20986
+ # resp.db_capacity_reservation.db_capacity_reservation_identifier #=> String
20987
+ # resp.db_capacity_reservation.tag_list #=> Array
20988
+ # resp.db_capacity_reservation.tag_list[0].key #=> String
20989
+ # resp.db_capacity_reservation.tag_list[0].value #=> String
20990
+ #
20991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBCapacityReservation AWS API Documentation
20992
+ #
20993
+ # @overload modify_db_capacity_reservation(params = {})
20994
+ # @param [Hash] params ({})
20995
+ def modify_db_capacity_reservation(params = {}, options = {})
20996
+ req = build_request(:modify_db_capacity_reservation, params)
20997
+ req.send_request(options)
20998
+ end
20999
+
20054
21000
  # Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB
20055
21001
  # cluster. You can change one or more settings by specifying these
20056
21002
  # parameters and the new values in the request.
@@ -22641,6 +23587,136 @@ module Aws::RDS
22641
23587
  # Additional storage volumes are supported for RDS for Oracle and RDS
22642
23588
  # for SQL Server DB instances only.
22643
23589
  #
23590
+ # @option params [String] :db_capacity_reservation_identifier
23591
+ # The identifier or the name of the DB capacity reservation for the DB
23592
+ # instance to use. You can specify the identifier, which has the prefix
23593
+ # `dbcr-`, or the reservation name. After the modification completes,
23594
+ # the DB instance uses reserved capacity from this reservation.
23595
+ #
23596
+ # You can't change the DB capacity reservation of a DB instance on its
23597
+ # own. A request that changes the reservation must also change the DB
23598
+ # instance class, the Multi-AZ setting, the license model, or the
23599
+ # engine. Therefore, this request always changes the configuration of
23600
+ # the DB instance.
23601
+ #
23602
+ # If the DB instance already uses the reservation that you specify, this
23603
+ # requirement doesn't apply. You can then change another setting, such
23604
+ # as the Multi-AZ setting, and keep the reservation.
23605
+ #
23606
+ # For a DB instance that uses no reservation, change `DBInstanceClass`
23607
+ # to the DB instance class that the reservation reserves. A reservation
23608
+ # reserves capacity for one DB instance class, so that change moves the
23609
+ # DB instance onto the reserved capacity. That change also resizes the
23610
+ # DB instance, which interrupts it.
23611
+ #
23612
+ # If the DB instance already runs the DB instance class that the
23613
+ # reservation reserves, change `MultiAZ` or `LicenseModel` instead. Only
23614
+ # RDS for Oracle and RDS for Microsoft SQL Server accept a change of
23615
+ # license model, so `MultiAZ` is the remaining choice for every other
23616
+ # engine.
23617
+ #
23618
+ # If you don't specify this parameter, Amazon RDS moves the DB instance
23619
+ # to unreserved capacity, and it releases the reserved capacity that the
23620
+ # DB instance holds. A request that changes the DB instance class, the
23621
+ # Multi-AZ setting, the license model, or the engine moves the DB
23622
+ # instance to different hardware, and Amazon RDS places the DB instance
23623
+ # on unreserved capacity. Therefore, to keep the DB instance on reserved
23624
+ # capacity, specify this parameter in every request that changes any of
23625
+ # those settings.
23626
+ #
23627
+ # The DB instance keeps its current reservation until Amazon RDS
23628
+ # applies
23629
+ # the modification. Until then, the `DBCapacityReservationIdentifier`
23630
+ # field of the DB instance still reports that reservation, and
23631
+ # `PendingModifiedValues` reports no reservation. Amazon RDS releases
23632
+ # the reserved capacity when it moves the DB instance.
23633
+ #
23634
+ # Constraints:
23635
+ #
23636
+ # * If the request changes which DB capacity reservation the DB instance
23637
+ # uses, it must also set a new value for `DBInstanceClass`, `MultiAZ`,
23638
+ # `LicenseModel`, or `Engine`. The new value must differ from the
23639
+ # current value. The only engine change that `ModifyDBInstance`
23640
+ # supports is a conversion to the CDB architecture. Repeating the
23641
+ # current value doesn't satisfy this requirement. This requirement
23642
+ # applies both when the DB instance uses no reservation, and when it
23643
+ # moves to a different reservation.
23644
+ #
23645
+ # * The reservation must reserve capacity for the DB instance class that
23646
+ # the DB instance uses after the modification, and for the database
23647
+ # engine of the DB instance. Therefore, when the request changes
23648
+ # `DBInstanceClass`, the reservation reserves capacity for a DB
23649
+ # instance class that the DB instance doesn't use today.
23650
+ #
23651
+ # * The reservation must be in the `active` state, and it must not be
23652
+ # past its end date.
23653
+ #
23654
+ # * The reservation must have available capacity in each Availability
23655
+ # Zone that the DB instance uses after the modification.
23656
+ #
23657
+ # * The reservation must cover the Availability Zone of the DB instance,
23658
+ # except when the request changes the DB instance from Multi-AZ to
23659
+ # Single-AZ.
23660
+ #
23661
+ # * For a Multi-AZ DB instance, the reservation must cover two or more
23662
+ # Availability Zones. A Multi-AZ DB instance uses one unit of reserved
23663
+ # capacity in each of two Availability Zones.
23664
+ #
23665
+ # * If the DB instance is already Multi-AZ, the reservation must cover
23666
+ # both of its Availability Zones. If the request converts the DB
23667
+ # instance to Multi-AZ, the reservation must cover the current
23668
+ # Availability Zone of the DB instance, and Amazon RDS chooses the
23669
+ # second Availability Zone from the reservation.
23670
+ #
23671
+ # * If the reservation reserves capacity for a specific license model,
23672
+ # the license model of the DB instance must match it. Amazon RDS
23673
+ # checks the license model only when the request specifies
23674
+ # `LicenseModel`.
23675
+ #
23676
+ # * You can't specify this parameter together with a change to
23677
+ # `DBSubnetGroupName`.
23678
+ #
23679
+ # * You can't specify this parameter together with a change to both
23680
+ # `DBInstanceClass` and `LicenseModel`. Submit those changes as two
23681
+ # separate requests.
23682
+ #
23683
+ # * Can't be specified together with a change to `DBInstanceClass` when
23684
+ # the request also changes the DB instance from Multi-AZ to Single-AZ.
23685
+ #
23686
+ # * When the request changes the DB instance from Multi-AZ to Single-AZ,
23687
+ # the reservation must cover either the primary or the secondary
23688
+ # Availability Zone of the DB instance. Amazon RDS keeps the DB
23689
+ # instance in its primary Availability Zone, and it removes the
23690
+ # standby replica. Therefore, the primary Availability Zone keeps its
23691
+ # unit of reserved capacity, and the secondary Availability Zone
23692
+ # releases its unit.
23693
+ #
23694
+ # * Can't be specified together with `LicenseModel` while a
23695
+ # modification of the DB instance class or the Multi-AZ setting is
23696
+ # pending.
23697
+ #
23698
+ # * Can't be specified together with `DBInstanceClass` or `MultiAZ`
23699
+ # while a modification of the license model is pending.
23700
+ #
23701
+ # * When a modification is already pending, the reservation must reserve
23702
+ # capacity for the DB instance as it will be after both the pending
23703
+ # modification and the requested modification complete.
23704
+ #
23705
+ # * The DB subnet group must be in a VPC with default tenancy.
23706
+ #
23707
+ # * The DB subnet group must cover each Availability Zone that the DB
23708
+ # instance uses.
23709
+ #
23710
+ # * Isn't supported for an RDS on Outposts DB instance.
23711
+ #
23712
+ # * If the reservation expires within one week, you must also enable
23713
+ # `ApplyImmediately`. Otherwise, choose a reservation with a later end
23714
+ # date.
23715
+ #
23716
+ # * Amazon RDS holds a unit of reserved capacity for the DB instance
23717
+ # when it accepts the request, even when the modification waits for
23718
+ # the maintenance window.
23719
+ #
22644
23720
  # @option params [Array<Types::TagSpecification>] :tag_specifications
22645
23721
  # Tags to assign to resources associated with the DB instance.
22646
23722
  #
@@ -22825,6 +23901,7 @@ module Aws::RDS
22825
23901
  # set_for_delete: false,
22826
23902
  # },
22827
23903
  # ],
23904
+ # db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
22828
23905
  # tag_specifications: [
22829
23906
  # {
22830
23907
  # resource_type: "String",
@@ -22913,6 +23990,7 @@ module Aws::RDS
22913
23990
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
22914
23991
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
22915
23992
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
23993
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
22916
23994
  # resp.db_instance.latest_restorable_time #=> Time
22917
23995
  # resp.db_instance.multi_az #=> Boolean
22918
23996
  # resp.db_instance.engine_version #=> String
@@ -23026,6 +24104,7 @@ module Aws::RDS
23026
24104
  # resp.db_instance.storage_volume_status #=> String
23027
24105
  # resp.db_instance.storage_operation_status #=> String
23028
24106
  # resp.db_instance.storage_operation_percent_progress #=> Integer
24107
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
23029
24108
  #
23030
24109
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstance AWS API Documentation
23031
24110
  #
@@ -24916,6 +25995,7 @@ module Aws::RDS
24916
25995
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
24917
25996
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
24918
25997
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
25998
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
24919
25999
  # resp.db_instance.latest_restorable_time #=> Time
24920
26000
  # resp.db_instance.multi_az #=> Boolean
24921
26001
  # resp.db_instance.engine_version #=> String
@@ -25029,6 +26109,7 @@ module Aws::RDS
25029
26109
  # resp.db_instance.storage_volume_status #=> String
25030
26110
  # resp.db_instance.storage_operation_status #=> String
25031
26111
  # resp.db_instance.storage_operation_percent_progress #=> Integer
26112
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
25032
26113
  #
25033
26114
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplica AWS API Documentation
25034
26115
  #
@@ -25676,6 +26757,7 @@ module Aws::RDS
25676
26757
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
25677
26758
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
25678
26759
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
26760
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
25679
26761
  # resp.db_instance.latest_restorable_time #=> Time
25680
26762
  # resp.db_instance.multi_az #=> Boolean
25681
26763
  # resp.db_instance.engine_version #=> String
@@ -25789,6 +26871,7 @@ module Aws::RDS
25789
26871
  # resp.db_instance.storage_volume_status #=> String
25790
26872
  # resp.db_instance.storage_operation_status #=> String
25791
26873
  # resp.db_instance.storage_operation_percent_progress #=> Integer
26874
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
25792
26875
  #
25793
26876
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstance AWS API Documentation
25794
26877
  #
@@ -29891,6 +30974,44 @@ module Aws::RDS
29891
30974
  #
29892
30975
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
29893
30976
  #
30977
+ # @option params [String] :db_capacity_reservation_identifier
30978
+ # The identifier or the name of the DB capacity reservation to associate
30979
+ # with this DB instance. You can specify the identifier, which has the
30980
+ # prefix `dbcr-`, or the reservation name. When you specify this
30981
+ # parameter, the DB instance uses reserved capacity from the specified
30982
+ # reservation.
30983
+ #
30984
+ # If you specify `AvailabilityZone`, Amazon RDS places the DB instance
30985
+ # in that Availability Zone, and the reservation must cover it.
30986
+ #
30987
+ # Constraints:
30988
+ #
30989
+ # * The reservation must reserve capacity for the DB instance class and
30990
+ # the database engine of the DB instance.
30991
+ #
30992
+ # * If the reservation reserves capacity for a specific license model,
30993
+ # the license model of the DB instance must match it.
30994
+ #
30995
+ # * The reservation must be in the `active` state, and it must not be
30996
+ # past its end date.
30997
+ #
30998
+ # * If you specify `AvailabilityZone`, it must be one of the
30999
+ # Availability Zones of the reservation.
31000
+ #
31001
+ # * For a Multi-AZ DB instance, the reservation must cover two or more
31002
+ # Availability Zones. A Multi-AZ DB instance uses one unit of reserved
31003
+ # capacity in each of two Availability Zones. If the reservation
31004
+ # covers more than two Availability Zones, Amazon RDS chooses the two
31005
+ # that the DB instance uses.
31006
+ #
31007
+ # * The reservation must have available capacity in each Availability
31008
+ # Zone that the DB instance uses.
31009
+ #
31010
+ # * The DB subnet group must be in a VPC with default tenancy.
31011
+ #
31012
+ # * The DB subnet group must cover each Availability Zone that the DB
31013
+ # instance uses.
31014
+ #
29894
31015
  # @option params [Boolean] :dedicated_log_volume
29895
31016
  # Specifies whether to enable a dedicated log volume (DLV) for the DB
29896
31017
  # instance.
@@ -30096,6 +31217,7 @@ module Aws::RDS
30096
31217
  # db_cluster_snapshot_identifier: "String",
30097
31218
  # backup_retention_period: 1,
30098
31219
  # preferred_backup_window: "String",
31220
+ # db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
30099
31221
  # dedicated_log_volume: false,
30100
31222
  # ca_certificate_identifier: "String",
30101
31223
  # engine_lifecycle_support: "String",
@@ -30197,6 +31319,7 @@ module Aws::RDS
30197
31319
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
30198
31320
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
30199
31321
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
31322
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
30200
31323
  # resp.db_instance.latest_restorable_time #=> Time
30201
31324
  # resp.db_instance.multi_az #=> Boolean
30202
31325
  # resp.db_instance.engine_version #=> String
@@ -30310,6 +31433,7 @@ module Aws::RDS
30310
31433
  # resp.db_instance.storage_volume_status #=> String
30311
31434
  # resp.db_instance.storage_operation_status #=> String
30312
31435
  # resp.db_instance.storage_operation_percent_progress #=> Integer
31436
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
30313
31437
  #
30314
31438
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot AWS API Documentation
30315
31439
  #
@@ -30840,6 +31964,44 @@ module Aws::RDS
30840
31964
  # Amazon Web Services account has a different default KMS key for each
30841
31965
  # Amazon Web Services Region.
30842
31966
  #
31967
+ # @option params [String] :db_capacity_reservation_identifier
31968
+ # The identifier or the name of the DB capacity reservation to associate
31969
+ # with this DB instance. You can specify the identifier, which has the
31970
+ # prefix `dbcr-`, or the reservation name. When you specify this
31971
+ # parameter, the DB instance uses reserved capacity from the specified
31972
+ # reservation.
31973
+ #
31974
+ # If you specify `AvailabilityZone`, Amazon RDS places the DB instance
31975
+ # in that Availability Zone, and the reservation must cover it.
31976
+ #
31977
+ # Constraints:
31978
+ #
31979
+ # * The reservation must reserve capacity for the DB instance class and
31980
+ # the database engine of the DB instance.
31981
+ #
31982
+ # * If the reservation reserves capacity for a specific license model,
31983
+ # the license model of the DB instance must match it.
31984
+ #
31985
+ # * The reservation must be in the `active` state, and it must not be
31986
+ # past its end date.
31987
+ #
31988
+ # * If you specify `AvailabilityZone`, it must be one of the
31989
+ # Availability Zones of the reservation.
31990
+ #
31991
+ # * For a Multi-AZ DB instance, the reservation must cover two or more
31992
+ # Availability Zones. A Multi-AZ DB instance uses one unit of reserved
31993
+ # capacity in each of two Availability Zones. If the reservation
31994
+ # covers more than two Availability Zones, Amazon RDS chooses the two
31995
+ # that the DB instance uses.
31996
+ #
31997
+ # * The reservation must have available capacity in each Availability
31998
+ # Zone that the DB instance uses.
31999
+ #
32000
+ # * The DB subnet group must be in a VPC with default tenancy.
32001
+ #
32002
+ # * The DB subnet group must cover each Availability Zone that the DB
32003
+ # instance uses.
32004
+ #
30843
32005
  # @option params [Boolean] :dedicated_log_volume
30844
32006
  # Specifies whether to enable a dedicated log volume (DLV) for the DB
30845
32007
  # instance.
@@ -30975,6 +32137,7 @@ module Aws::RDS
30975
32137
  # network_type: "String",
30976
32138
  # manage_master_user_password: false,
30977
32139
  # master_user_secret_kms_key_id: "String",
32140
+ # db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
30978
32141
  # dedicated_log_volume: false,
30979
32142
  # ca_certificate_identifier: "String",
30980
32143
  # engine_lifecycle_support: "String",
@@ -31074,6 +32237,7 @@ module Aws::RDS
31074
32237
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
31075
32238
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
31076
32239
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
32240
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
31077
32241
  # resp.db_instance.latest_restorable_time #=> Time
31078
32242
  # resp.db_instance.multi_az #=> Boolean
31079
32243
  # resp.db_instance.engine_version #=> String
@@ -31187,6 +32351,7 @@ module Aws::RDS
31187
32351
  # resp.db_instance.storage_volume_status #=> String
31188
32352
  # resp.db_instance.storage_operation_status #=> String
31189
32353
  # resp.db_instance.storage_operation_percent_progress #=> Integer
32354
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
31190
32355
  #
31191
32356
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3 AWS API Documentation
31192
32357
  #
@@ -31832,6 +32997,44 @@ module Aws::RDS
31832
32997
  #
31833
32998
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
31834
32999
  #
33000
+ # @option params [String] :db_capacity_reservation_identifier
33001
+ # The identifier or the name of the DB capacity reservation to associate
33002
+ # with this DB instance. You can specify the identifier, which has the
33003
+ # prefix `dbcr-`, or the reservation name. When you specify this
33004
+ # parameter, the DB instance uses reserved capacity from the specified
33005
+ # reservation.
33006
+ #
33007
+ # If you specify `AvailabilityZone`, Amazon RDS places the DB instance
33008
+ # in that Availability Zone, and the reservation must cover it.
33009
+ #
33010
+ # Constraints:
33011
+ #
33012
+ # * The reservation must reserve capacity for the DB instance class and
33013
+ # the database engine of the DB instance.
33014
+ #
33015
+ # * If the reservation reserves capacity for a specific license model,
33016
+ # the license model of the DB instance must match it.
33017
+ #
33018
+ # * The reservation must be in the `active` state, and it must not be
33019
+ # past its end date.
33020
+ #
33021
+ # * If you specify `AvailabilityZone`, it must be one of the
33022
+ # Availability Zones of the reservation.
33023
+ #
33024
+ # * For a Multi-AZ DB instance, the reservation must cover two or more
33025
+ # Availability Zones. A Multi-AZ DB instance uses one unit of reserved
33026
+ # capacity in each of two Availability Zones. If the reservation
33027
+ # covers more than two Availability Zones, Amazon RDS chooses the two
33028
+ # that the DB instance uses.
33029
+ #
33030
+ # * The reservation must have available capacity in each Availability
33031
+ # Zone that the DB instance uses.
33032
+ #
33033
+ # * The DB subnet group must be in a VPC with default tenancy.
33034
+ #
33035
+ # * The DB subnet group must cover each Availability Zone that the DB
33036
+ # instance uses.
33037
+ #
31835
33038
  # @option params [Boolean] :dedicated_log_volume
31836
33039
  # Specifies whether to enable a dedicated log volume (DLV) for the DB
31837
33040
  # instance.
@@ -32100,6 +33303,7 @@ module Aws::RDS
32100
33303
  # allocated_storage: 1,
32101
33304
  # backup_retention_period: 1,
32102
33305
  # preferred_backup_window: "String",
33306
+ # db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
32103
33307
  # dedicated_log_volume: false,
32104
33308
  # ca_certificate_identifier: "String",
32105
33309
  # engine_lifecycle_support: "String",
@@ -32201,6 +33405,7 @@ module Aws::RDS
32201
33405
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
32202
33406
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
32203
33407
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
33408
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
32204
33409
  # resp.db_instance.latest_restorable_time #=> Time
32205
33410
  # resp.db_instance.multi_az #=> Boolean
32206
33411
  # resp.db_instance.engine_version #=> String
@@ -32314,6 +33519,7 @@ module Aws::RDS
32314
33519
  # resp.db_instance.storage_volume_status #=> String
32315
33520
  # resp.db_instance.storage_operation_status #=> String
32316
33521
  # resp.db_instance.storage_operation_percent_progress #=> Integer
33522
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
32317
33523
  #
32318
33524
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTime AWS API Documentation
32319
33525
  #
@@ -32753,6 +33959,41 @@ module Aws::RDS
32753
33959
  # @option params [required, String] :db_instance_identifier
32754
33960
  # The user-supplied instance identifier.
32755
33961
  #
33962
+ # @option params [String] :db_capacity_reservation_identifier
33963
+ # The identifier or the name of the DB capacity reservation for the DB
33964
+ # instance to use after it starts. You can specify the identifier, which
33965
+ # has the prefix `dbcr-`, or the reservation name.
33966
+ #
33967
+ # Specify this parameter when the DB instance stopped using a
33968
+ # reservation, or when you want the DB instance to use a different
33969
+ # reservation.
33970
+ #
33971
+ # If you omit this parameter, and the DB instance kept a DB capacity
33972
+ # reservation when it stopped, Amazon RDS starts the DB instance in that
33973
+ # reservation.
33974
+ #
33975
+ # If that reservation is deleted, ended, or cancelled, the DB instance
33976
+ # still starts. Amazon RDS starts the DB instance outside the
33977
+ # reservation, on unreserved capacity, and it charges on-demand prices
33978
+ # for the DB instance.
33979
+ #
33980
+ # If that reservation has no available capacity in the Availability Zone
33981
+ # of the DB instance, the request fails. Amazon RDS doesn't start the
33982
+ # DB instance, and it doesn't wait for capacity in that Availability
33983
+ # Zone. Specify a reservation that has available capacity in that
33984
+ # Availability Zone, or retry the request after the reservation has
33985
+ # available capacity.
33986
+ #
33987
+ # Constraints:
33988
+ #
33989
+ # * The reservation must be in the `active` state.
33990
+ #
33991
+ # * The reservation must reserve capacity for the DB instance class and
33992
+ # the engine of the DB instance.
33993
+ #
33994
+ # * The reservation must cover the Availability Zone of the DB instance,
33995
+ # and it must have available capacity in that Availability Zone.
33996
+ #
32756
33997
  # @return [Types::StartDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
32757
33998
  #
32758
33999
  # * {Types::StartDBInstanceResult#db_instance #db_instance} => Types::DBInstance
@@ -32777,6 +34018,7 @@ module Aws::RDS
32777
34018
  #
32778
34019
  # resp = client.start_db_instance({
32779
34020
  # db_instance_identifier: "String", # required
34021
+ # db_capacity_reservation_identifier: "DBCapacityReservationIdentifier",
32780
34022
  # })
32781
34023
  #
32782
34024
  # @example Response structure
@@ -32852,6 +34094,7 @@ module Aws::RDS
32852
34094
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
32853
34095
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
32854
34096
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
34097
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
32855
34098
  # resp.db_instance.latest_restorable_time #=> Time
32856
34099
  # resp.db_instance.multi_az #=> Boolean
32857
34100
  # resp.db_instance.engine_version #=> String
@@ -32965,6 +34208,7 @@ module Aws::RDS
32965
34208
  # resp.db_instance.storage_volume_status #=> String
32966
34209
  # resp.db_instance.storage_operation_status #=> String
32967
34210
  # resp.db_instance.storage_operation_percent_progress #=> Integer
34211
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
32968
34212
  #
32969
34213
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstance AWS API Documentation
32970
34214
  #
@@ -33643,6 +34887,31 @@ module Aws::RDS
33643
34887
  # The user-supplied instance identifier of the DB Snapshot created
33644
34888
  # immediately before the DB instance is stopped.
33645
34889
  #
34890
+ # @option params [Boolean] :detach_from_db_capacity_reservation
34891
+ # Specifies whether the DB instance stops using its DB capacity
34892
+ # reservation when the DB instance stops. When you specify `true`, the
34893
+ # DB instance belongs to no reservation after it stops, and a later
34894
+ # start launches it outside the reservation.
34895
+ #
34896
+ # By default, a stopped DB instance keeps its DB capacity reservation,
34897
+ # and a later start returns the DB instance to the same reservation.
34898
+ #
34899
+ # Every stop releases the unit of reserved capacity that the DB instance
34900
+ # holds, for either value of this parameter. Another DB instance can
34901
+ # then use that capacity. This parameter controls the reservation that
34902
+ # the DB instance belongs to, and it does not control the release of the
34903
+ # capacity.
34904
+ #
34905
+ # If the DB instance uses no DB capacity reservation, this parameter has
34906
+ # no effect.
34907
+ #
34908
+ # Amazon RDS holds no capacity for a stopped DB instance. When the
34909
+ # reservation has no available capacity in the Availability Zone of the
34910
+ # DB instance, a later start waits for capacity in that Availability
34911
+ # Zone. When the DB instance belongs to no reservation, a later start
34912
+ # can fail because the Amazon Web Services Region has insufficient
34913
+ # capacity for the DB instance class.
34914
+ #
33646
34915
  # @return [Types::StopDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
33647
34916
  #
33648
34917
  # * {Types::StopDBInstanceResult#db_instance #db_instance} => Types::DBInstance
@@ -33668,6 +34937,7 @@ module Aws::RDS
33668
34937
  # resp = client.stop_db_instance({
33669
34938
  # db_instance_identifier: "String", # required
33670
34939
  # db_snapshot_identifier: "String",
34940
+ # detach_from_db_capacity_reservation: false,
33671
34941
  # })
33672
34942
  #
33673
34943
  # @example Response structure
@@ -33743,6 +35013,7 @@ module Aws::RDS
33743
35013
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
33744
35014
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
33745
35015
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
35016
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
33746
35017
  # resp.db_instance.latest_restorable_time #=> Time
33747
35018
  # resp.db_instance.multi_az #=> Boolean
33748
35019
  # resp.db_instance.engine_version #=> String
@@ -33856,6 +35127,7 @@ module Aws::RDS
33856
35127
  # resp.db_instance.storage_volume_status #=> String
33857
35128
  # resp.db_instance.storage_operation_status #=> String
33858
35129
  # resp.db_instance.storage_operation_percent_progress #=> Integer
35130
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
33859
35131
  #
33860
35132
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstance AWS API Documentation
33861
35133
  #
@@ -34385,6 +35657,7 @@ module Aws::RDS
34385
35657
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].max_allocated_storage #=> Integer
34386
35658
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_throughput #=> Integer
34387
35659
  # resp.db_instance.pending_modified_values.additional_storage_volumes[0].storage_type #=> String
35660
+ # resp.db_instance.pending_modified_values.db_capacity_reservation_identifier #=> String
34388
35661
  # resp.db_instance.latest_restorable_time #=> Time
34389
35662
  # resp.db_instance.multi_az #=> Boolean
34390
35663
  # resp.db_instance.engine_version #=> String
@@ -34498,6 +35771,7 @@ module Aws::RDS
34498
35771
  # resp.db_instance.storage_volume_status #=> String
34499
35772
  # resp.db_instance.storage_operation_status #=> String
34500
35773
  # resp.db_instance.storage_operation_percent_progress #=> Integer
35774
+ # resp.db_instance.db_capacity_reservation_identifier #=> String
34501
35775
  #
34502
35776
  # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/SwitchoverReadReplica AWS API Documentation
34503
35777
  #
@@ -34526,7 +35800,7 @@ module Aws::RDS
34526
35800
  tracer: tracer
34527
35801
  )
34528
35802
  context[:gem_name] = 'aws-sdk-rds'
34529
- context[:gem_version] = '1.324.0'
35803
+ context[:gem_version] = '1.326.0'
34530
35804
  Seahorse::Client::Request.new(handlers, context)
34531
35805
  end
34532
35806