aws-sdk-rds 1.131.0 → 1.132.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1429 -297
- data/lib/aws-sdk-rds/client_api.rb +59 -0
- data/lib/aws-sdk-rds/db_cluster.rb +727 -65
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +12 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +166 -14
- data/lib/aws-sdk-rds/db_instance.rb +76 -69
- data/lib/aws-sdk-rds/db_snapshot.rb +12 -11
- data/lib/aws-sdk-rds/resource.rb +345 -57
- data/lib/aws-sdk-rds/types.rb +1652 -258
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -338,25 +338,15 @@ module Aws::RDS
|
|
338
338
|
|
339
339
|
# @!group API Operations
|
340
340
|
|
341
|
-
# Associates an Identity and Access Management (IAM) role
|
342
|
-
#
|
343
|
-
# Aurora MySQL to Access Other Amazon Web Services Services on Your
|
344
|
-
# Behalf][1] in the *Amazon Aurora User Guide*.
|
345
|
-
#
|
346
|
-
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
347
|
-
#
|
348
|
-
# </note>
|
349
|
-
#
|
350
|
-
#
|
351
|
-
#
|
352
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.html
|
341
|
+
# Associates an Identity and Access Management (IAM) role with a DB
|
342
|
+
# cluster.
|
353
343
|
#
|
354
344
|
# @option params [required, String] :db_cluster_identifier
|
355
345
|
# The name of the DB cluster to associate the IAM role with.
|
356
346
|
#
|
357
347
|
# @option params [required, String] :role_arn
|
358
348
|
# The Amazon Resource Name (ARN) of the IAM role to associate with the
|
359
|
-
# Aurora DB cluster, for example
|
349
|
+
# Aurora DB cluster, for example
|
360
350
|
# `arn:aws:iam::123456789012:role/AuroraAccessRole`.
|
361
351
|
#
|
362
352
|
# @option params [String] :feature_name
|
@@ -652,7 +642,7 @@ module Aws::RDS
|
|
652
642
|
# authorization. First, EC2 or VPC security groups can be added to the
|
653
643
|
# DBSecurityGroup if the application using the database is running on
|
654
644
|
# EC2 or VPC instances. Second, IP ranges are available if the
|
655
|
-
# application accessing your database is running on the
|
645
|
+
# application accessing your database is running on the internet.
|
656
646
|
# Required parameters for this API are one of CIDR range,
|
657
647
|
# EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either
|
658
648
|
# EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
|
@@ -911,10 +901,6 @@ module Aws::RDS
|
|
911
901
|
|
912
902
|
# Copies the specified DB cluster parameter group.
|
913
903
|
#
|
914
|
-
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
915
|
-
#
|
916
|
-
# </note>
|
917
|
-
#
|
918
904
|
# @option params [required, String] :source_db_cluster_parameter_group_identifier
|
919
905
|
# The identifier or Amazon Resource Name (ARN) for the source DB cluster
|
920
906
|
# parameter group. For information about creating an ARN, see [
|
@@ -1084,14 +1070,19 @@ module Aws::RDS
|
|
1084
1070
|
# DB cluster snapshot identified by `TargetDBClusterSnapshotIdentifier`
|
1085
1071
|
# while that DB cluster snapshot is in "copying" status.
|
1086
1072
|
#
|
1087
|
-
# For more information on copying encrypted DB cluster
|
1088
|
-
# one Amazon Web Services Region to another, see [
|
1089
|
-
# Snapshot][3] in the *Amazon Aurora User Guide.*
|
1073
|
+
# For more information on copying encrypted Amazon Aurora DB cluster
|
1074
|
+
# snapshots from one Amazon Web Services Region to another, see [
|
1075
|
+
# Copying a Snapshot][3] in the *Amazon Aurora User Guide.*
|
1090
1076
|
#
|
1091
|
-
# For more information on Amazon Aurora, see [ What
|
1092
|
-
# Aurora?][4] in the *Amazon Aurora User Guide.*
|
1077
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
1078
|
+
# Amazon Aurora?][4] in the *Amazon Aurora User Guide.*
|
1093
1079
|
#
|
1094
|
-
#
|
1080
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
1081
|
+
# deployments with two readable standby DB instances][5] in the *Amazon
|
1082
|
+
# RDS User Guide.*
|
1083
|
+
#
|
1084
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
1085
|
+
# change.
|
1095
1086
|
#
|
1096
1087
|
# </note>
|
1097
1088
|
#
|
@@ -1101,6 +1092,7 @@ module Aws::RDS
|
|
1101
1092
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1102
1093
|
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html
|
1103
1094
|
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
1095
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
1104
1096
|
#
|
1105
1097
|
# @option params [required, String] :source_db_cluster_snapshot_identifier
|
1106
1098
|
# The identifier of the DB cluster snapshot to copy. This parameter
|
@@ -2088,30 +2080,41 @@ module Aws::RDS
|
|
2088
2080
|
req.send_request(options)
|
2089
2081
|
end
|
2090
2082
|
|
2091
|
-
# Creates a new Amazon Aurora DB cluster.
|
2083
|
+
# Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
|
2092
2084
|
#
|
2093
|
-
# You can use the `ReplicationSourceIdentifier` parameter to create
|
2094
|
-
# DB cluster as a read replica of another DB cluster or
|
2095
|
-
# or PostgreSQL DB instance. For cross-
|
2096
|
-
#
|
2097
|
-
#
|
2085
|
+
# You can use the `ReplicationSourceIdentifier` parameter to create an
|
2086
|
+
# Amazon Aurora DB cluster as a read replica of another DB cluster or
|
2087
|
+
# Amazon RDS MySQL or PostgreSQL DB instance. For cross-Region
|
2088
|
+
# replication where the DB cluster identified by
|
2089
|
+
# `ReplicationSourceIdentifier` is encrypted, also specify the
|
2090
|
+
# `PreSignedUrl` parameter.
|
2098
2091
|
#
|
2099
|
-
# For more information on Amazon Aurora, see [ What
|
2092
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
2100
2093
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
2101
2094
|
#
|
2102
|
-
#
|
2095
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
2096
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
2097
|
+
# RDS User Guide.*
|
2098
|
+
#
|
2099
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
2100
|
+
# change.
|
2103
2101
|
#
|
2104
2102
|
# </note>
|
2105
2103
|
#
|
2106
2104
|
#
|
2107
2105
|
#
|
2108
2106
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
2107
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
2109
2108
|
#
|
2110
2109
|
# @option params [Array<String>] :availability_zones
|
2111
|
-
# A list of Availability Zones (AZs) where instances in the DB
|
2112
|
-
# can be created.
|
2113
|
-
#
|
2114
|
-
#
|
2110
|
+
# A list of Availability Zones (AZs) where DB instances in the DB
|
2111
|
+
# cluster can be created.
|
2112
|
+
#
|
2113
|
+
# For information on Amazon Web Services Regions and Availability Zones,
|
2114
|
+
# see [Choosing the Regions and Availability Zones][1] in the *Amazon
|
2115
|
+
# Aurora User Guide*.
|
2116
|
+
#
|
2117
|
+
# Valid for: Aurora DB clusters only
|
2115
2118
|
#
|
2116
2119
|
#
|
2117
2120
|
#
|
@@ -2128,15 +2131,21 @@ module Aws::RDS
|
|
2128
2131
|
#
|
2129
2132
|
# ^
|
2130
2133
|
#
|
2134
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2135
|
+
#
|
2131
2136
|
# @option params [String] :character_set_name
|
2132
2137
|
# A value that indicates that the DB cluster should be associated with
|
2133
2138
|
# the specified CharacterSet.
|
2134
2139
|
#
|
2140
|
+
# Valid for: Aurora DB clusters only
|
2141
|
+
#
|
2135
2142
|
# @option params [String] :database_name
|
2136
2143
|
# The name for your database of up to 64 alphanumeric characters. If you
|
2137
2144
|
# do not provide a name, Amazon RDS doesn't create a database in the DB
|
2138
2145
|
# cluster you are creating.
|
2139
2146
|
#
|
2147
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2148
|
+
#
|
2140
2149
|
# @option params [required, String] :db_cluster_identifier
|
2141
2150
|
# The DB cluster identifier. This parameter is stored as a lowercase
|
2142
2151
|
# string.
|
@@ -2151,6 +2160,8 @@ module Aws::RDS
|
|
2151
2160
|
#
|
2152
2161
|
# Example: `my-cluster1`
|
2153
2162
|
#
|
2163
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2164
|
+
#
|
2154
2165
|
# @option params [String] :db_cluster_parameter_group_name
|
2155
2166
|
# The name of the DB cluster parameter group to associate with this DB
|
2156
2167
|
# cluster. If you do not specify a value, then the default DB cluster
|
@@ -2163,60 +2174,121 @@ module Aws::RDS
|
|
2163
2174
|
#
|
2164
2175
|
# ^
|
2165
2176
|
#
|
2177
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2178
|
+
#
|
2166
2179
|
# @option params [Array<String>] :vpc_security_group_ids
|
2167
2180
|
# A list of EC2 VPC security groups to associate with this DB cluster.
|
2168
2181
|
#
|
2182
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2183
|
+
#
|
2169
2184
|
# @option params [String] :db_subnet_group_name
|
2170
2185
|
# A DB subnet group to associate with this DB cluster.
|
2171
2186
|
#
|
2187
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
2188
|
+
#
|
2172
2189
|
# Constraints: Must match the name of an existing DBSubnetGroup. Must
|
2173
2190
|
# not be default.
|
2174
2191
|
#
|
2175
2192
|
# Example: `mySubnetgroup`
|
2176
2193
|
#
|
2194
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2195
|
+
#
|
2177
2196
|
# @option params [required, String] :engine
|
2178
2197
|
# The name of the database engine to be used for this DB cluster.
|
2179
2198
|
#
|
2180
|
-
# Valid Values:
|
2181
|
-
#
|
2182
|
-
# `aurora-
|
2199
|
+
# Valid Values:
|
2200
|
+
#
|
2201
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
2202
|
+
#
|
2203
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
2204
|
+
#
|
2205
|
+
# * `aurora-postgresql`
|
2206
|
+
#
|
2207
|
+
# * `mysql`
|
2208
|
+
#
|
2209
|
+
# * `postgres`
|
2210
|
+
#
|
2211
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2183
2212
|
#
|
2184
2213
|
# @option params [String] :engine_version
|
2185
2214
|
# The version number of the database engine to use.
|
2186
2215
|
#
|
2187
|
-
# To list all of the available engine versions for
|
2188
|
-
#
|
2216
|
+
# To list all of the available engine versions for MySQL 5.6-compatible
|
2217
|
+
# Aurora, use the following command:
|
2189
2218
|
#
|
2190
2219
|
# `aws rds describe-db-engine-versions --engine aurora --query
|
2191
2220
|
# "DBEngineVersions[].EngineVersion"`
|
2192
2221
|
#
|
2193
|
-
# To list all of the available engine versions for
|
2194
|
-
#
|
2222
|
+
# To list all of the available engine versions for MySQL 5.7-compatible
|
2223
|
+
# Aurora, use the following command:
|
2195
2224
|
#
|
2196
2225
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
2197
2226
|
# "DBEngineVersions[].EngineVersion"`
|
2198
2227
|
#
|
2199
|
-
# To list all of the available engine versions for
|
2228
|
+
# To list all of the available engine versions for Aurora PostgreSQL,
|
2200
2229
|
# use the following command:
|
2201
2230
|
#
|
2202
2231
|
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
2203
2232
|
# --query "DBEngineVersions[].EngineVersion"`
|
2204
2233
|
#
|
2234
|
+
# To list all of the available engine versions for RDS for MySQL, use
|
2235
|
+
# the following command:
|
2236
|
+
#
|
2237
|
+
# `aws rds describe-db-engine-versions --engine mysql --query
|
2238
|
+
# "DBEngineVersions[].EngineVersion"`
|
2239
|
+
#
|
2240
|
+
# To list all of the available engine versions for RDS for PostgreSQL,
|
2241
|
+
# use the following command:
|
2242
|
+
#
|
2243
|
+
# `aws rds describe-db-engine-versions --engine postgres --query
|
2244
|
+
# "DBEngineVersions[].EngineVersion"`
|
2245
|
+
#
|
2205
2246
|
# **Aurora MySQL**
|
2206
2247
|
#
|
2207
|
-
#
|
2208
|
-
#
|
2248
|
+
# For information, see [MySQL on Amazon RDS Versions][1] in the *Amazon
|
2249
|
+
# Aurora User Guide.*
|
2209
2250
|
#
|
2210
2251
|
# **Aurora PostgreSQL**
|
2211
2252
|
#
|
2212
|
-
#
|
2253
|
+
# For information, see [Amazon Aurora PostgreSQL releases and engine
|
2254
|
+
# versions][2] in the *Amazon Aurora User Guide.*
|
2255
|
+
#
|
2256
|
+
# **MySQL**
|
2257
|
+
#
|
2258
|
+
# For information, see [MySQL on Amazon RDS Versions][3] in the *Amazon
|
2259
|
+
# RDS User Guide.*
|
2260
|
+
#
|
2261
|
+
# **PostgreSQL**
|
2262
|
+
#
|
2263
|
+
# For information, see [Amazon RDS for PostgreSQL versions and
|
2264
|
+
# extensions][4] in the *Amazon RDS User Guide.*
|
2265
|
+
#
|
2266
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2267
|
+
#
|
2268
|
+
#
|
2269
|
+
#
|
2270
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html
|
2271
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html
|
2272
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
2273
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
2213
2274
|
#
|
2214
2275
|
# @option params [Integer] :port
|
2215
2276
|
# The port number on which the instances in the DB cluster accept
|
2216
2277
|
# connections.
|
2217
2278
|
#
|
2218
|
-
#
|
2219
|
-
#
|
2279
|
+
# **RDS for MySQL and Aurora MySQL**
|
2280
|
+
#
|
2281
|
+
# Default: `3306`
|
2282
|
+
#
|
2283
|
+
# Valid values: `1150-65535`
|
2284
|
+
#
|
2285
|
+
# **RDS for PostgreSQL and Aurora PostgreSQL**
|
2286
|
+
#
|
2287
|
+
# Default: `5432`
|
2288
|
+
#
|
2289
|
+
# Valid values: `1150-65535`
|
2290
|
+
#
|
2291
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2220
2292
|
#
|
2221
2293
|
# @option params [String] :master_username
|
2222
2294
|
# The name of the master user for the DB cluster.
|
@@ -2229,19 +2301,22 @@ module Aws::RDS
|
|
2229
2301
|
#
|
2230
2302
|
# * Can't be a reserved word for the chosen database engine.
|
2231
2303
|
#
|
2304
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2305
|
+
#
|
2232
2306
|
# @option params [String] :master_user_password
|
2233
2307
|
# The password for the master database user. This password can contain
|
2234
2308
|
# any printable ASCII character except "/", """, or "@".
|
2235
2309
|
#
|
2236
2310
|
# Constraints: Must contain from 8 to 41 characters.
|
2237
2311
|
#
|
2312
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2313
|
+
#
|
2238
2314
|
# @option params [String] :option_group_name
|
2239
2315
|
# A value that indicates that the DB cluster should be associated with
|
2240
2316
|
# the specified option group.
|
2241
2317
|
#
|
2242
|
-
#
|
2243
|
-
#
|
2244
|
-
# DB cluster.
|
2318
|
+
# DB clusters are associated with a default option group that can't be
|
2319
|
+
# modified.
|
2245
2320
|
#
|
2246
2321
|
# @option params [String] :preferred_backup_window
|
2247
2322
|
# The daily time range during which automated backups are created if
|
@@ -2263,6 +2338,8 @@ module Aws::RDS
|
|
2263
2338
|
#
|
2264
2339
|
# * Must be at least 30 minutes.
|
2265
2340
|
#
|
2341
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2342
|
+
#
|
2266
2343
|
#
|
2267
2344
|
#
|
2268
2345
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
@@ -2283,6 +2360,8 @@ module Aws::RDS
|
|
2283
2360
|
#
|
2284
2361
|
# Constraints: Minimum 30-minute window.
|
2285
2362
|
#
|
2363
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2364
|
+
#
|
2286
2365
|
#
|
2287
2366
|
#
|
2288
2367
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
@@ -2291,12 +2370,18 @@ module Aws::RDS
|
|
2291
2370
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
2292
2371
|
# if this DB cluster is created as a read replica.
|
2293
2372
|
#
|
2373
|
+
# Valid for: Aurora DB clusters only
|
2374
|
+
#
|
2294
2375
|
# @option params [Array<Types::Tag>] :tags
|
2295
2376
|
# Tags to assign to the DB cluster.
|
2296
2377
|
#
|
2378
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2379
|
+
#
|
2297
2380
|
# @option params [Boolean] :storage_encrypted
|
2298
2381
|
# A value that indicates whether the DB cluster is encrypted.
|
2299
2382
|
#
|
2383
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2384
|
+
#
|
2300
2385
|
# @option params [String] :kms_key_id
|
2301
2386
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
2302
2387
|
# cluster.
|
@@ -2326,12 +2411,14 @@ module Aws::RDS
|
|
2326
2411
|
# Region. This KMS key is used to encrypt the read replica in that
|
2327
2412
|
# Amazon Web Services Region.
|
2328
2413
|
#
|
2414
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2415
|
+
#
|
2329
2416
|
# @option params [String] :pre_signed_url
|
2330
2417
|
# A URL that contains a Signature Version 4 signed request for the
|
2331
2418
|
# `CreateDBCluster` action to be called in the source Amazon Web
|
2332
|
-
# Services Region where the DB cluster is replicated from.
|
2333
|
-
#
|
2334
|
-
#
|
2419
|
+
# Services Region where the DB cluster is replicated from. Specify
|
2420
|
+
# `PreSignedUrl` only when you are performing cross-Region replication
|
2421
|
+
# from an encrypted DB cluster.
|
2335
2422
|
#
|
2336
2423
|
# The pre-signed URL must be a valid request for the `CreateDBCluster`
|
2337
2424
|
# API action that can be executed in the source Amazon Web Services
|
@@ -2372,6 +2459,8 @@ module Aws::RDS
|
|
2372
2459
|
#
|
2373
2460
|
# </note>
|
2374
2461
|
#
|
2462
|
+
# Valid for: Aurora DB clusters only
|
2463
|
+
#
|
2375
2464
|
#
|
2376
2465
|
#
|
2377
2466
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
@@ -2380,11 +2469,13 @@ module Aws::RDS
|
|
2380
2469
|
# @option params [Boolean] :enable_iam_database_authentication
|
2381
2470
|
# A value that indicates whether to enable mapping of Amazon Web
|
2382
2471
|
# Services Identity and Access Management (IAM) accounts to database
|
2383
|
-
# accounts. By default, mapping
|
2472
|
+
# accounts. By default, mapping isn't enabled.
|
2384
2473
|
#
|
2385
2474
|
# For more information, see [ IAM Database Authentication][1] in the
|
2386
2475
|
# *Amazon Aurora User Guide.*
|
2387
2476
|
#
|
2477
|
+
# Valid for: Aurora DB clusters only
|
2478
|
+
#
|
2388
2479
|
#
|
2389
2480
|
#
|
2390
2481
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -2393,10 +2484,6 @@ module Aws::RDS
|
|
2393
2484
|
# The target backtrack window, in seconds. To disable backtracking, set
|
2394
2485
|
# this value to 0.
|
2395
2486
|
#
|
2396
|
-
# <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
|
2397
|
-
#
|
2398
|
-
# </note>
|
2399
|
-
#
|
2400
2487
|
# Default: 0
|
2401
2488
|
#
|
2402
2489
|
# Constraints:
|
@@ -2406,6 +2493,8 @@ module Aws::RDS
|
|
2406
2493
|
#
|
2407
2494
|
# ^
|
2408
2495
|
#
|
2496
|
+
# Valid for: Aurora MySQL DB clusters only
|
2497
|
+
#
|
2409
2498
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
2410
2499
|
# The list of log types that need to be enabled for exporting to
|
2411
2500
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
@@ -2420,6 +2509,8 @@ module Aws::RDS
|
|
2420
2509
|
#
|
2421
2510
|
# Possible value is `postgresql`.
|
2422
2511
|
#
|
2512
|
+
# Valid for: Aurora DB clusters only
|
2513
|
+
#
|
2423
2514
|
#
|
2424
2515
|
#
|
2425
2516
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -2455,6 +2546,8 @@ module Aws::RDS
|
|
2455
2546
|
#
|
2456
2547
|
# * [ Limitations of Multi-Master Clusters][4]
|
2457
2548
|
#
|
2549
|
+
# Valid for: Aurora DB clusters only
|
2550
|
+
#
|
2458
2551
|
#
|
2459
2552
|
#
|
2460
2553
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
|
@@ -2466,15 +2559,21 @@ module Aws::RDS
|
|
2466
2559
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
2467
2560
|
# of the DB cluster.
|
2468
2561
|
#
|
2562
|
+
# Valid for: Aurora DB clusters only
|
2563
|
+
#
|
2469
2564
|
# @option params [Boolean] :deletion_protection
|
2470
2565
|
# A value that indicates whether the DB cluster has deletion protection
|
2471
2566
|
# enabled. The database can't be deleted when deletion protection is
|
2472
|
-
# enabled. By default, deletion protection
|
2567
|
+
# enabled. By default, deletion protection isn't enabled.
|
2568
|
+
#
|
2569
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2473
2570
|
#
|
2474
2571
|
# @option params [String] :global_cluster_identifier
|
2475
2572
|
# The global cluster ID of an Aurora cluster that becomes the primary
|
2476
2573
|
# cluster in the new global database cluster.
|
2477
2574
|
#
|
2575
|
+
# Valid for: Aurora DB clusters only
|
2576
|
+
#
|
2478
2577
|
# @option params [Boolean] :enable_http_endpoint
|
2479
2578
|
# A value that indicates whether to enable the HTTP endpoint for an
|
2480
2579
|
# Aurora Serverless DB cluster. By default, the HTTP endpoint is
|
@@ -2488,6 +2587,8 @@ module Aws::RDS
|
|
2488
2587
|
# For more information, see [Using the Data API for Aurora
|
2489
2588
|
# Serverless][1] in the *Amazon Aurora User Guide*.
|
2490
2589
|
#
|
2590
|
+
# Valid for: Aurora DB clusters only
|
2591
|
+
#
|
2491
2592
|
#
|
2492
2593
|
#
|
2493
2594
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
@@ -2496,14 +2597,19 @@ module Aws::RDS
|
|
2496
2597
|
# A value that indicates whether to copy all tags from the DB cluster to
|
2497
2598
|
# snapshots of the DB cluster. The default is not to copy them.
|
2498
2599
|
#
|
2600
|
+
# Valid for: Aurora DB clusters only
|
2601
|
+
#
|
2499
2602
|
# @option params [String] :domain
|
2500
2603
|
# The Active Directory directory ID to create the DB cluster in.
|
2501
2604
|
#
|
2502
2605
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
2503
|
-
#
|
2504
|
-
#
|
2606
|
+
# authentication to authenticate users that connect to the DB cluster.
|
2607
|
+
#
|
2608
|
+
# For more information, see [Kerberos authentication][1] in the *Amazon
|
2505
2609
|
# Aurora User Guide*.
|
2506
2610
|
#
|
2611
|
+
# Valid for: Aurora DB clusters only
|
2612
|
+
#
|
2507
2613
|
#
|
2508
2614
|
#
|
2509
2615
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
@@ -2512,6 +2618,8 @@ module Aws::RDS
|
|
2512
2618
|
# Specify the name of the IAM role to be used when making API calls to
|
2513
2619
|
# the Directory Service.
|
2514
2620
|
#
|
2621
|
+
# Valid for: Aurora DB clusters only
|
2622
|
+
#
|
2515
2623
|
# @option params [Boolean] :enable_global_write_forwarding
|
2516
2624
|
# A value that indicates whether to enable this DB cluster to forward
|
2517
2625
|
# write operations to the primary cluster of an Aurora global database
|
@@ -2527,6 +2635,171 @@ module Aws::RDS
|
|
2527
2635
|
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
2528
2636
|
# operation, but it does nothing until then.
|
2529
2637
|
#
|
2638
|
+
# Valid for: Aurora DB clusters only
|
2639
|
+
#
|
2640
|
+
# @option params [String] :db_cluster_instance_class
|
2641
|
+
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
2642
|
+
# cluster, for example db.m6g.xlarge. Not all DB instance classes are
|
2643
|
+
# available in all Amazon Web Services Regions, or for all database
|
2644
|
+
# engines.
|
2645
|
+
#
|
2646
|
+
# For the full list of DB instance classes and availability for your
|
2647
|
+
# engine, see [DB instance class][1] in the *Amazon RDS User Guide.*
|
2648
|
+
#
|
2649
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
2650
|
+
#
|
2651
|
+
# Valid for: Multi-AZ DB clusters only
|
2652
|
+
#
|
2653
|
+
#
|
2654
|
+
#
|
2655
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
2656
|
+
#
|
2657
|
+
# @option params [Integer] :allocated_storage
|
2658
|
+
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
2659
|
+
# instance in the Multi-AZ DB cluster.
|
2660
|
+
#
|
2661
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
2662
|
+
#
|
2663
|
+
# Valid for: Multi-AZ DB clusters only
|
2664
|
+
#
|
2665
|
+
# @option params [String] :storage_type
|
2666
|
+
# Specifies the storage type to be associated with the DB cluster.
|
2667
|
+
#
|
2668
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
2669
|
+
#
|
2670
|
+
# Valid values: `standard | gp2 | io1`
|
2671
|
+
#
|
2672
|
+
# If you specify `io1`, also include a value for the `Iops` parameter.
|
2673
|
+
#
|
2674
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
2675
|
+
#
|
2676
|
+
# Valid for: Multi-AZ DB clusters only
|
2677
|
+
#
|
2678
|
+
# @option params [Integer] :iops
|
2679
|
+
# The amount of Provisioned IOPS (input/output operations per second) to
|
2680
|
+
# be initially allocated for each DB instance in the Multi-AZ DB
|
2681
|
+
# cluster.
|
2682
|
+
#
|
2683
|
+
# For information about valid `Iops` values, see [Amazon RDS Provisioned
|
2684
|
+
# IOPS storage to improve performance][1] in the *Amazon RDS User
|
2685
|
+
# Guide*.
|
2686
|
+
#
|
2687
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
2688
|
+
#
|
2689
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
2690
|
+
# amount for the DB cluster.
|
2691
|
+
#
|
2692
|
+
# Valid for: Multi-AZ DB clusters only
|
2693
|
+
#
|
2694
|
+
#
|
2695
|
+
#
|
2696
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
2697
|
+
#
|
2698
|
+
# @option params [Boolean] :publicly_accessible
|
2699
|
+
# A value that indicates whether the DB cluster is publicly accessible.
|
2700
|
+
#
|
2701
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
2702
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
2703
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
2704
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
2705
|
+
# cluster is ultimately controlled by the security group it uses. That
|
2706
|
+
# public access isn't permitted if the security group assigned to the
|
2707
|
+
# DB cluster doesn't permit it.
|
2708
|
+
#
|
2709
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
2710
|
+
# cluster with a DNS name that resolves to a private IP address.
|
2711
|
+
#
|
2712
|
+
# Default: The default behavior varies depending on whether
|
2713
|
+
# `DBSubnetGroupName` is specified.
|
2714
|
+
#
|
2715
|
+
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
2716
|
+
# isn't specified, the following applies:
|
2717
|
+
#
|
2718
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
2719
|
+
# gateway attached to it, the DB cluster is private.
|
2720
|
+
#
|
2721
|
+
# * If the default VPC in the target Region has an internet gateway
|
2722
|
+
# attached to it, the DB cluster is public.
|
2723
|
+
#
|
2724
|
+
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
2725
|
+
# specified, the following applies:
|
2726
|
+
#
|
2727
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
2728
|
+
# gateway attached to it, the DB cluster is private.
|
2729
|
+
#
|
2730
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
2731
|
+
# attached to it, the DB cluster is public.
|
2732
|
+
#
|
2733
|
+
# Valid for: Multi-AZ DB clusters only
|
2734
|
+
#
|
2735
|
+
# @option params [Boolean] :auto_minor_version_upgrade
|
2736
|
+
# A value that indicates whether minor engine upgrades are applied
|
2737
|
+
# automatically to the DB cluster during the maintenance window. By
|
2738
|
+
# default, minor engine upgrades are applied automatically.
|
2739
|
+
#
|
2740
|
+
# Valid for: Multi-AZ DB clusters only
|
2741
|
+
#
|
2742
|
+
# @option params [Integer] :monitoring_interval
|
2743
|
+
# The interval, in seconds, between points when Enhanced Monitoring
|
2744
|
+
# metrics are collected for the DB cluster. To turn off collecting
|
2745
|
+
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
2746
|
+
#
|
2747
|
+
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
|
2748
|
+
# a value other than 0.
|
2749
|
+
#
|
2750
|
+
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
2751
|
+
#
|
2752
|
+
# Valid for: Multi-AZ DB clusters only
|
2753
|
+
#
|
2754
|
+
# @option params [String] :monitoring_role_arn
|
2755
|
+
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
2756
|
+
# send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example
|
2757
|
+
# is `arn:aws:iam:123456789012:role/emaccess`. For information on
|
2758
|
+
# creating a monitoring role, see [Setting up and enabling Enhanced
|
2759
|
+
# Monitoring][1] in the *Amazon RDS User Guide*.
|
2760
|
+
#
|
2761
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
2762
|
+
# `MonitoringRoleArn` value.
|
2763
|
+
#
|
2764
|
+
# Valid for: Multi-AZ DB clusters only
|
2765
|
+
#
|
2766
|
+
#
|
2767
|
+
#
|
2768
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
2769
|
+
#
|
2770
|
+
# @option params [Boolean] :enable_performance_insights
|
2771
|
+
# A value that indicates whether to turn on Performance Insights for the
|
2772
|
+
# DB cluster.
|
2773
|
+
#
|
2774
|
+
# For more information, see [ Using Amazon Performance Insights][1] in
|
2775
|
+
# the *Amazon RDS User Guide*.
|
2776
|
+
#
|
2777
|
+
# Valid for: Multi-AZ DB clusters only
|
2778
|
+
#
|
2779
|
+
#
|
2780
|
+
#
|
2781
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
2782
|
+
#
|
2783
|
+
# @option params [String] :performance_insights_kms_key_id
|
2784
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
2785
|
+
# Performance Insights data.
|
2786
|
+
#
|
2787
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
2788
|
+
# alias ARN, or alias name for the KMS key.
|
2789
|
+
#
|
2790
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
|
2791
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
2792
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
2793
|
+
# a different default KMS key for each Amazon Web Services Region.
|
2794
|
+
#
|
2795
|
+
# Valid for: Multi-AZ DB clusters only
|
2796
|
+
#
|
2797
|
+
# @option params [Integer] :performance_insights_retention_period
|
2798
|
+
# The amount of time, in days, to retain Performance Insights data.
|
2799
|
+
# Valid values are 7 or 731 (2 years).
|
2800
|
+
#
|
2801
|
+
# Valid for: Multi-AZ DB clusters only
|
2802
|
+
#
|
2530
2803
|
# @option params [String] :source_region
|
2531
2804
|
# The source region of the snapshot. This is only needed when the
|
2532
2805
|
# shapshot is encrypted and in a different region.
|
@@ -2610,6 +2883,17 @@ module Aws::RDS
|
|
2610
2883
|
# domain: "String",
|
2611
2884
|
# domain_iam_role_name: "String",
|
2612
2885
|
# enable_global_write_forwarding: false,
|
2886
|
+
# db_cluster_instance_class: "String",
|
2887
|
+
# allocated_storage: 1,
|
2888
|
+
# storage_type: "String",
|
2889
|
+
# iops: 1,
|
2890
|
+
# publicly_accessible: false,
|
2891
|
+
# auto_minor_version_upgrade: false,
|
2892
|
+
# monitoring_interval: 1,
|
2893
|
+
# monitoring_role_arn: "String",
|
2894
|
+
# enable_performance_insights: false,
|
2895
|
+
# performance_insights_kms_key_id: "String",
|
2896
|
+
# performance_insights_retention_period: 1,
|
2613
2897
|
# source_region: "String",
|
2614
2898
|
# })
|
2615
2899
|
#
|
@@ -2705,6 +2989,16 @@ module Aws::RDS
|
|
2705
2989
|
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
2706
2990
|
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
2707
2991
|
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
2992
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
2993
|
+
# resp.db_cluster.storage_type #=> String
|
2994
|
+
# resp.db_cluster.iops #=> Integer
|
2995
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
2996
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
2997
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
2998
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
2999
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
3000
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
3001
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
2708
3002
|
#
|
2709
3003
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBCluster AWS API Documentation
|
2710
3004
|
#
|
@@ -2731,7 +3025,7 @@ module Aws::RDS
|
|
2731
3025
|
# as a lowercase string.
|
2732
3026
|
#
|
2733
3027
|
# @option params [required, String] :endpoint_type
|
2734
|
-
# The type of the endpoint
|
3028
|
+
# The type of the endpoint, one of: `READER`, `WRITER`, `ANY`.
|
2735
3029
|
#
|
2736
3030
|
# @option params [Array<String>] :static_members
|
2737
3031
|
# List of DB instance identifiers that are part of the custom endpoint
|
@@ -2740,7 +3034,8 @@ module Aws::RDS
|
|
2740
3034
|
# @option params [Array<String>] :excluded_members
|
2741
3035
|
# List of DB instance identifiers that aren't part of the custom
|
2742
3036
|
# endpoint group. All other eligible instances are reachable through the
|
2743
|
-
# custom endpoint.
|
3037
|
+
# custom endpoint. This parameter is relevant only if the list of static
|
3038
|
+
# members is empty.
|
2744
3039
|
#
|
2745
3040
|
# @option params [Array<Types::Tag>] :tags
|
2746
3041
|
# The tags to be assigned to the Amazon RDS resource.
|
@@ -2809,10 +3104,16 @@ module Aws::RDS
|
|
2809
3104
|
# modify the group after creating it using
|
2810
3105
|
# `ModifyDBClusterParameterGroup`. Once you've created a DB cluster
|
2811
3106
|
# parameter group, you need to associate it with your DB cluster using
|
2812
|
-
# `ModifyDBCluster`.
|
2813
|
-
#
|
2814
|
-
#
|
2815
|
-
#
|
3107
|
+
# `ModifyDBCluster`.
|
3108
|
+
#
|
3109
|
+
# When you associate a new DB cluster parameter group with a running
|
3110
|
+
# Aurora DB cluster, reboot the DB instances in the DB cluster without
|
3111
|
+
# failover for the new DB cluster parameter group and associated
|
3112
|
+
# settings to take effect.
|
3113
|
+
#
|
3114
|
+
# When you associate a new DB cluster parameter group with a running
|
3115
|
+
# Multi-AZ DB cluster, reboot the DB cluster without failover for the
|
3116
|
+
# new DB cluster parameter group and associated settings to take effect.
|
2816
3117
|
#
|
2817
3118
|
# After you create a DB cluster parameter group, you should wait at
|
2818
3119
|
# least 5 minutes before creating your first DB cluster that uses that
|
@@ -2826,10 +3127,15 @@ module Aws::RDS
|
|
2826
3127
|
# RDS console][1] or the `DescribeDBClusterParameters` action to verify
|
2827
3128
|
# that your DB cluster parameter group has been created or modified.
|
2828
3129
|
#
|
2829
|
-
# For more information on Amazon Aurora, see [ What
|
3130
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
2830
3131
|
# Aurora?][2] in the *Amazon Aurora User Guide.*
|
2831
3132
|
#
|
2832
|
-
#
|
3133
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
3134
|
+
# deployments with two readable standby DB instances][3] in the *Amazon
|
3135
|
+
# RDS User Guide.*
|
3136
|
+
#
|
3137
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
3138
|
+
# change.
|
2833
3139
|
#
|
2834
3140
|
# </note>
|
2835
3141
|
#
|
@@ -2837,13 +3143,14 @@ module Aws::RDS
|
|
2837
3143
|
#
|
2838
3144
|
# [1]: https://console.aws.amazon.com/rds/
|
2839
3145
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
3146
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
2840
3147
|
#
|
2841
3148
|
# @option params [required, String] :db_cluster_parameter_group_name
|
2842
3149
|
# The name of the DB cluster parameter group.
|
2843
3150
|
#
|
2844
3151
|
# Constraints:
|
2845
3152
|
#
|
2846
|
-
# * Must match the name of an existing DB cluster parameter group.
|
3153
|
+
# * Must not match the name of an existing DB cluster parameter group.
|
2847
3154
|
#
|
2848
3155
|
# ^
|
2849
3156
|
#
|
@@ -2866,6 +3173,14 @@ module Aws::RDS
|
|
2866
3173
|
#
|
2867
3174
|
# Example: `aurora-postgresql9.6`
|
2868
3175
|
#
|
3176
|
+
# **RDS for MySQL**
|
3177
|
+
#
|
3178
|
+
# Example: `mysql8.0`
|
3179
|
+
#
|
3180
|
+
# **RDS for PostgreSQL**
|
3181
|
+
#
|
3182
|
+
# Example: `postgres12`
|
3183
|
+
#
|
2869
3184
|
# To list all of the available parameter group families for a DB engine,
|
2870
3185
|
# use the following command:
|
2871
3186
|
#
|
@@ -2891,6 +3206,10 @@ module Aws::RDS
|
|
2891
3206
|
#
|
2892
3207
|
# * `aurora-postgresql`
|
2893
3208
|
#
|
3209
|
+
# * `mysql`
|
3210
|
+
#
|
3211
|
+
# * `postgres`
|
3212
|
+
#
|
2894
3213
|
# @option params [required, String] :description
|
2895
3214
|
# The description for the DB cluster parameter group.
|
2896
3215
|
#
|
@@ -2948,17 +3267,24 @@ module Aws::RDS
|
|
2948
3267
|
req.send_request(options)
|
2949
3268
|
end
|
2950
3269
|
|
2951
|
-
# Creates a snapshot of a DB cluster.
|
2952
|
-
# Aurora, see [ What Is Amazon Aurora?][1] in the *Amazon Aurora User
|
2953
|
-
# Guide.*
|
3270
|
+
# Creates a snapshot of a DB cluster.
|
2954
3271
|
#
|
2955
|
-
#
|
3272
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
3273
|
+
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
3274
|
+
#
|
3275
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
3276
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
3277
|
+
# RDS User Guide.*
|
3278
|
+
#
|
3279
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
3280
|
+
# change.
|
2956
3281
|
#
|
2957
3282
|
# </note>
|
2958
3283
|
#
|
2959
3284
|
#
|
2960
3285
|
#
|
2961
3286
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
3287
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
2962
3288
|
#
|
2963
3289
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
2964
3290
|
# The identifier of the DB cluster snapshot. This parameter is stored as
|
@@ -3287,8 +3613,8 @@ module Aws::RDS
|
|
3287
3613
|
# * Web and Express editions: Must be an integer from 20 to 1024.
|
3288
3614
|
#
|
3289
3615
|
# @option params [required, String] :db_instance_class
|
3290
|
-
# The compute and memory capacity of the DB instance, for example
|
3291
|
-
#
|
3616
|
+
# The compute and memory capacity of the DB instance, for example
|
3617
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
3292
3618
|
# Web Services Regions, or for all database engines. For the full list
|
3293
3619
|
# of DB instance classes, and availability for your engine, see [DB
|
3294
3620
|
# Instance Class][1] in the *Amazon RDS User Guide.*
|
@@ -3596,27 +3922,28 @@ module Aws::RDS
|
|
3596
3922
|
#
|
3597
3923
|
# **MariaDB**
|
3598
3924
|
#
|
3599
|
-
#
|
3600
|
-
# Guide.*
|
3925
|
+
# For information, see [MariaDB on Amazon RDS Versions][2] in the
|
3926
|
+
# *Amazon RDS User Guide.*
|
3601
3927
|
#
|
3602
3928
|
# **Microsoft SQL Server**
|
3603
3929
|
#
|
3604
|
-
#
|
3605
|
-
# RDS User Guide.*
|
3930
|
+
# For information, see [Microsoft SQL Server Versions on Amazon RDS][3]
|
3931
|
+
# in the *Amazon RDS User Guide.*
|
3606
3932
|
#
|
3607
3933
|
# **MySQL**
|
3608
3934
|
#
|
3609
|
-
#
|
3935
|
+
# For information, see [MySQL on Amazon RDS Versions][4] in the *Amazon
|
3936
|
+
# RDS User Guide.*
|
3610
3937
|
#
|
3611
3938
|
# **Oracle**
|
3612
3939
|
#
|
3613
|
-
#
|
3614
|
-
# Guide.*
|
3940
|
+
# For information, see [Oracle Database Engine Release Notes][5] in the
|
3941
|
+
# *Amazon RDS User Guide.*
|
3615
3942
|
#
|
3616
3943
|
# **PostgreSQL**
|
3617
3944
|
#
|
3618
|
-
#
|
3619
|
-
# *Amazon RDS User Guide.*
|
3945
|
+
# For information, see [Amazon RDS for PostgreSQL versions and
|
3946
|
+
# extensions][6] in the *Amazon RDS User Guide.*
|
3620
3947
|
#
|
3621
3948
|
#
|
3622
3949
|
#
|
@@ -3646,8 +3973,8 @@ module Aws::RDS
|
|
3646
3973
|
# @option params [Integer] :iops
|
3647
3974
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
3648
3975
|
# be initially allocated for the DB instance. For information about
|
3649
|
-
# valid Iops values, see [Amazon RDS Provisioned IOPS
|
3650
|
-
#
|
3976
|
+
# valid `Iops` values, see [Amazon RDS Provisioned IOPS storage to
|
3977
|
+
# improve performance][1] in the *Amazon RDS User Guide*.
|
3651
3978
|
#
|
3652
3979
|
# Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances,
|
3653
3980
|
# must be a multiple between .5 and 50 of the storage amount for the DB
|
@@ -3689,12 +4016,13 @@ module Aws::RDS
|
|
3689
4016
|
# @option params [Boolean] :publicly_accessible
|
3690
4017
|
# A value that indicates whether the DB instance is publicly accessible.
|
3691
4018
|
#
|
3692
|
-
# When the DB instance is publicly accessible, its
|
3693
|
-
# to the private IP address from within the DB
|
3694
|
-
#
|
3695
|
-
#
|
3696
|
-
#
|
3697
|
-
#
|
4019
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
4020
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
4021
|
+
# instance's virtual private cloud (VPC). It resolves to the public IP
|
4022
|
+
# address from outside of the DB instance's VPC. Access to the DB
|
4023
|
+
# instance is ultimately controlled by the security group it uses. That
|
4024
|
+
# public access is not permitted if the security group assigned to the
|
4025
|
+
# DB instance doesn't permit it.
|
3698
4026
|
#
|
3699
4027
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
3700
4028
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -3705,19 +4033,19 @@ module Aws::RDS
|
|
3705
4033
|
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
3706
4034
|
# isn't specified, the following applies:
|
3707
4035
|
#
|
3708
|
-
# * If the default VPC in the target
|
4036
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
3709
4037
|
# gateway attached to it, the DB instance is private.
|
3710
4038
|
#
|
3711
|
-
# * If the default VPC in the target
|
4039
|
+
# * If the default VPC in the target Region has an internet gateway
|
3712
4040
|
# attached to it, the DB instance is public.
|
3713
4041
|
#
|
3714
4042
|
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
3715
4043
|
# specified, the following applies:
|
3716
4044
|
#
|
3717
|
-
# * If the subnets are part of a VPC that doesn’t have an
|
4045
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
3718
4046
|
# gateway attached to it, the DB instance is private.
|
3719
4047
|
#
|
3720
|
-
# * If the subnets are part of a VPC that has an
|
4048
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
3721
4049
|
# attached to it, the DB instance is public.
|
3722
4050
|
#
|
3723
4051
|
# @option params [Array<Types::Tag>] :tags
|
@@ -3876,7 +4204,7 @@ module Aws::RDS
|
|
3876
4204
|
# @option params [Boolean] :enable_iam_database_authentication
|
3877
4205
|
# A value that indicates whether to enable mapping of Amazon Web
|
3878
4206
|
# Services Identity and Access Management (IAM) accounts to database
|
3879
|
-
# accounts. By default, mapping
|
4207
|
+
# accounts. By default, mapping isn't enabled.
|
3880
4208
|
#
|
3881
4209
|
# This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora,
|
3882
4210
|
# mapping Amazon Web Services IAM accounts to database accounts is
|
@@ -3968,7 +4296,7 @@ module Aws::RDS
|
|
3968
4296
|
# @option params [Boolean] :deletion_protection
|
3969
4297
|
# A value that indicates whether the DB instance has deletion protection
|
3970
4298
|
# enabled. The database can't be deleted when deletion protection is
|
3971
|
-
# enabled. By default, deletion protection
|
4299
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
3972
4300
|
# information, see [ Deleting a DB Instance][1].
|
3973
4301
|
#
|
3974
4302
|
# **Amazon Aurora**
|
@@ -4336,7 +4664,7 @@ module Aws::RDS
|
|
4336
4664
|
# Guide*.
|
4337
4665
|
#
|
4338
4666
|
# * Can specify a PostgreSQL DB instance only if the source is running
|
4339
|
-
# PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-
|
4667
|
+
# PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-Region
|
4340
4668
|
# replication).
|
4341
4669
|
#
|
4342
4670
|
# * The specified DB instance must have automatic backups enabled, that
|
@@ -4358,8 +4686,8 @@ module Aws::RDS
|
|
4358
4686
|
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing
|
4359
4687
|
#
|
4360
4688
|
# @option params [String] :db_instance_class
|
4361
|
-
# The compute and memory capacity of the read replica, for example
|
4362
|
-
#
|
4689
|
+
# The compute and memory capacity of the read replica, for example
|
4690
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
4363
4691
|
# Web Services Regions, or for all database engines. For the full list
|
4364
4692
|
# of DB instance classes, and availability for your engine, see [DB
|
4365
4693
|
# Instance Class][1] in the *Amazon RDS User Guide.*
|
@@ -4425,8 +4753,8 @@ module Aws::RDS
|
|
4425
4753
|
#
|
4426
4754
|
# If you do not specify a value for `DBParameterGroupName`, then Amazon
|
4427
4755
|
# RDS uses the `DBParameterGroup` of source DB instance for a same
|
4428
|
-
#
|
4429
|
-
# specified DB engine for a cross
|
4756
|
+
# Region read replica, or the default `DBParameterGroup` for the
|
4757
|
+
# specified DB engine for a cross-Region read replica.
|
4430
4758
|
#
|
4431
4759
|
# Specifying a parameter group for this operation is only supported for
|
4432
4760
|
# Oracle DB instances. It isn't supported for RDS Custom.
|
@@ -4442,12 +4770,13 @@ module Aws::RDS
|
|
4442
4770
|
# @option params [Boolean] :publicly_accessible
|
4443
4771
|
# A value that indicates whether the DB instance is publicly accessible.
|
4444
4772
|
#
|
4445
|
-
# When the DB
|
4446
|
-
# to the private IP address from within the DB
|
4447
|
-
#
|
4448
|
-
#
|
4449
|
-
#
|
4450
|
-
#
|
4773
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
4774
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
4775
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
4776
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
4777
|
+
# cluster is ultimately controlled by the security group it uses. That
|
4778
|
+
# public access isn't permitted if the security group assigned to the
|
4779
|
+
# DB cluster doesn't permit it.
|
4451
4780
|
#
|
4452
4781
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
4453
4782
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -4625,7 +4954,7 @@ module Aws::RDS
|
|
4625
4954
|
# Region.
|
4626
4955
|
#
|
4627
4956
|
# `SourceRegion` isn't supported for SQL Server, because SQL Server on
|
4628
|
-
# Amazon RDS doesn't support cross-
|
4957
|
+
# Amazon RDS doesn't support cross-Region read replicas.
|
4629
4958
|
#
|
4630
4959
|
# </note>
|
4631
4960
|
#
|
@@ -4639,7 +4968,7 @@ module Aws::RDS
|
|
4639
4968
|
# @option params [Boolean] :enable_iam_database_authentication
|
4640
4969
|
# A value that indicates whether to enable mapping of Amazon Web
|
4641
4970
|
# Services Identity and Access Management (IAM) accounts to database
|
4642
|
-
# accounts. By default, mapping
|
4971
|
+
# accounts. By default, mapping isn't enabled.
|
4643
4972
|
#
|
4644
4973
|
# For more information about IAM database authentication, see [ IAM
|
4645
4974
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -4711,7 +5040,7 @@ module Aws::RDS
|
|
4711
5040
|
# @option params [Boolean] :deletion_protection
|
4712
5041
|
# A value that indicates whether the DB instance has deletion protection
|
4713
5042
|
# enabled. The database can't be deleted when deletion protection is
|
4714
|
-
# enabled. By default, deletion protection
|
5043
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
4715
5044
|
# information, see [ Deleting a DB Instance][1].
|
4716
5045
|
#
|
4717
5046
|
#
|
@@ -6238,18 +6567,22 @@ module Aws::RDS
|
|
6238
6567
|
# DB cluster are deleted and can't be recovered. Manual DB cluster
|
6239
6568
|
# snapshots of the specified DB cluster are not deleted.
|
6240
6569
|
#
|
6241
|
-
#
|
6242
|
-
#
|
6243
|
-
# For more information on Amazon Aurora, see [ What Is Amazon
|
6570
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
6244
6571
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
6245
6572
|
#
|
6246
|
-
#
|
6573
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
6574
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
6575
|
+
# RDS User Guide.*
|
6576
|
+
#
|
6577
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
6578
|
+
# change.
|
6247
6579
|
#
|
6248
6580
|
# </note>
|
6249
6581
|
#
|
6250
6582
|
#
|
6251
6583
|
#
|
6252
6584
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
6585
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
6253
6586
|
#
|
6254
6587
|
# @option params [required, String] :db_cluster_identifier
|
6255
6588
|
# The DB cluster identifier for the DB cluster to be deleted. This
|
@@ -6412,6 +6745,16 @@ module Aws::RDS
|
|
6412
6745
|
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
6413
6746
|
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
6414
6747
|
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
6748
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
6749
|
+
# resp.db_cluster.storage_type #=> String
|
6750
|
+
# resp.db_cluster.iops #=> Integer
|
6751
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
6752
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
6753
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
6754
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
6755
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
6756
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
6757
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
6415
6758
|
#
|
6416
6759
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBCluster AWS API Documentation
|
6417
6760
|
#
|
@@ -6480,16 +6823,22 @@ module Aws::RDS
|
|
6480
6823
|
# parameter group to be deleted can't be associated with any DB
|
6481
6824
|
# clusters.
|
6482
6825
|
#
|
6483
|
-
# For more information on Amazon Aurora, see [ What
|
6826
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
6484
6827
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
6485
6828
|
#
|
6486
|
-
#
|
6829
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
6830
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
6831
|
+
# RDS User Guide.*
|
6832
|
+
#
|
6833
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
6834
|
+
# change.
|
6487
6835
|
#
|
6488
6836
|
# </note>
|
6489
6837
|
#
|
6490
6838
|
#
|
6491
6839
|
#
|
6492
6840
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
6841
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
6493
6842
|
#
|
6494
6843
|
# @option params [required, String] :db_cluster_parameter_group_name
|
6495
6844
|
# The name of the DB cluster parameter group.
|
@@ -6536,16 +6885,22 @@ module Aws::RDS
|
|
6536
6885
|
#
|
6537
6886
|
# </note>
|
6538
6887
|
#
|
6539
|
-
# For more information on Amazon Aurora, see [ What
|
6888
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
6540
6889
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
6541
6890
|
#
|
6542
|
-
#
|
6891
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
6892
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
6893
|
+
# RDS User Guide.*
|
6894
|
+
#
|
6895
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
6896
|
+
# change.
|
6543
6897
|
#
|
6544
6898
|
# </note>
|
6545
6899
|
#
|
6546
6900
|
#
|
6547
6901
|
#
|
6548
6902
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
6903
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
6549
6904
|
#
|
6550
6905
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
6551
6906
|
# The identifier of the DB cluster snapshot to delete.
|
@@ -7693,7 +8048,7 @@ module Aws::RDS
|
|
7693
8048
|
|
7694
8049
|
# Returns information about backtracks for a DB cluster.
|
7695
8050
|
#
|
7696
|
-
# For more information on Amazon Aurora, see [ What
|
8051
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
7697
8052
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
7698
8053
|
#
|
7699
8054
|
# <note markdown="1"> This action only applies to Aurora MySQL DB clusters.
|
@@ -7912,16 +8267,22 @@ module Aws::RDS
|
|
7912
8267
|
# contain only the description of the specified DB cluster parameter
|
7913
8268
|
# group.
|
7914
8269
|
#
|
7915
|
-
# For more information on Amazon Aurora, see [ What
|
8270
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
7916
8271
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
7917
8272
|
#
|
7918
|
-
#
|
8273
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
8274
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
8275
|
+
# RDS User Guide.*
|
8276
|
+
#
|
8277
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
8278
|
+
# change.
|
7919
8279
|
#
|
7920
8280
|
# </note>
|
7921
8281
|
#
|
7922
8282
|
#
|
7923
8283
|
#
|
7924
8284
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
8285
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
7925
8286
|
#
|
7926
8287
|
# @option params [String] :db_cluster_parameter_group_name
|
7927
8288
|
# The name of a specific DB cluster parameter group to return details
|
@@ -8008,16 +8369,22 @@ module Aws::RDS
|
|
8008
8369
|
# Returns the detailed parameter list for a particular DB cluster
|
8009
8370
|
# parameter group.
|
8010
8371
|
#
|
8011
|
-
# For more information on Amazon Aurora, see [ What
|
8372
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
8012
8373
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
8013
8374
|
#
|
8014
|
-
#
|
8375
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
8376
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
8377
|
+
# RDS User Guide.*
|
8378
|
+
#
|
8379
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
8380
|
+
# change.
|
8015
8381
|
#
|
8016
8382
|
# </note>
|
8017
8383
|
#
|
8018
8384
|
#
|
8019
8385
|
#
|
8020
8386
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
8387
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
8021
8388
|
#
|
8022
8389
|
# @option params [required, String] :db_cluster_parameter_group_name
|
8023
8390
|
# The name of a specific DB cluster parameter group to return parameter
|
@@ -8131,10 +8498,6 @@ module Aws::RDS
|
|
8131
8498
|
# snapshot public or private, use the `ModifyDBClusterSnapshotAttribute`
|
8132
8499
|
# API action.
|
8133
8500
|
#
|
8134
|
-
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
8135
|
-
#
|
8136
|
-
# </note>
|
8137
|
-
#
|
8138
8501
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
8139
8502
|
# The identifier for the DB cluster snapshot to describe the attributes
|
8140
8503
|
# for.
|
@@ -8184,16 +8547,22 @@ module Aws::RDS
|
|
8184
8547
|
# Returns information about DB cluster snapshots. This API action
|
8185
8548
|
# supports pagination.
|
8186
8549
|
#
|
8187
|
-
# For more information on Amazon Aurora, see [ What
|
8188
|
-
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
8550
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
8551
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
8189
8552
|
#
|
8190
|
-
#
|
8553
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
8554
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
8555
|
+
# RDS User Guide.*
|
8556
|
+
#
|
8557
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
8558
|
+
# change.
|
8191
8559
|
#
|
8192
8560
|
# </note>
|
8193
8561
|
#
|
8194
8562
|
#
|
8195
8563
|
#
|
8196
8564
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
8565
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
8197
8566
|
#
|
8198
8567
|
# @option params [String] :db_cluster_identifier
|
8199
8568
|
# The ID of the DB cluster to retrieve the list of DB cluster snapshots
|
@@ -8381,20 +8750,28 @@ module Aws::RDS
|
|
8381
8750
|
req.send_request(options)
|
8382
8751
|
end
|
8383
8752
|
|
8384
|
-
# Returns information about
|
8385
|
-
# supports pagination.
|
8753
|
+
# Returns information about Amazon Aurora DB clusters and Multi-AZ DB
|
8754
|
+
# clusters. This API supports pagination.
|
8386
8755
|
#
|
8387
|
-
# For more information on Amazon Aurora, see [ What
|
8388
|
-
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
8756
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
8757
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
8389
8758
|
#
|
8390
|
-
#
|
8391
|
-
#
|
8759
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
8760
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
8761
|
+
# RDS User Guide.*
|
8762
|
+
#
|
8763
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
8764
|
+
# change.
|
8392
8765
|
#
|
8393
8766
|
# </note>
|
8394
8767
|
#
|
8768
|
+
# This operation can also return information for Amazon Neptune DB
|
8769
|
+
# instances and Amazon DocumentDB instances.
|
8770
|
+
#
|
8395
8771
|
#
|
8396
8772
|
#
|
8397
8773
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
8774
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
8398
8775
|
#
|
8399
8776
|
# @option params [String] :db_cluster_identifier
|
8400
8777
|
# The user-supplied DB cluster identifier. If this parameter is
|
@@ -8577,6 +8954,16 @@ module Aws::RDS
|
|
8577
8954
|
# resp.db_clusters[0].pending_modified_values.master_user_password #=> String
|
8578
8955
|
# resp.db_clusters[0].pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
8579
8956
|
# resp.db_clusters[0].pending_modified_values.engine_version #=> String
|
8957
|
+
# resp.db_clusters[0].db_cluster_instance_class #=> String
|
8958
|
+
# resp.db_clusters[0].storage_type #=> String
|
8959
|
+
# resp.db_clusters[0].iops #=> Integer
|
8960
|
+
# resp.db_clusters[0].publicly_accessible #=> Boolean
|
8961
|
+
# resp.db_clusters[0].auto_minor_version_upgrade #=> Boolean
|
8962
|
+
# resp.db_clusters[0].monitoring_interval #=> Integer
|
8963
|
+
# resp.db_clusters[0].monitoring_role_arn #=> String
|
8964
|
+
# resp.db_clusters[0].performance_insights_enabled #=> Boolean
|
8965
|
+
# resp.db_clusters[0].performance_insights_kms_key_id #=> String
|
8966
|
+
# resp.db_clusters[0].performance_insights_retention_period #=> Integer
|
8580
8967
|
#
|
8581
8968
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusters AWS API Documentation
|
8582
8969
|
#
|
@@ -10224,7 +10611,7 @@ module Aws::RDS
|
|
10224
10611
|
# Returns the default engine and system parameter information for the
|
10225
10612
|
# cluster database engine.
|
10226
10613
|
#
|
10227
|
-
# For more information on Amazon Aurora, see [ What
|
10614
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
10228
10615
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
10229
10616
|
#
|
10230
10617
|
#
|
@@ -10824,7 +11211,7 @@ module Aws::RDS
|
|
10824
11211
|
# Returns information about Aurora global database clusters. This API
|
10825
11212
|
# supports pagination.
|
10826
11213
|
#
|
10827
|
-
# For more information on Amazon Aurora, see [ What
|
11214
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
10828
11215
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
10829
11216
|
#
|
10830
11217
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
@@ -11265,8 +11652,8 @@ module Aws::RDS
|
|
11265
11652
|
req.send_request(options)
|
11266
11653
|
end
|
11267
11654
|
|
11268
|
-
# Returns a list of orderable DB instance options for the specified
|
11269
|
-
# engine.
|
11655
|
+
# Returns a list of orderable DB instance options for the specified DB
|
11656
|
+
# engine, DB engine version, and DB instance class.
|
11270
11657
|
#
|
11271
11658
|
# @option params [required, String] :engine
|
11272
11659
|
# The name of the engine to retrieve DB instance options for.
|
@@ -11432,6 +11819,7 @@ module Aws::RDS
|
|
11432
11819
|
# resp.orderable_db_instance_options[0].supported_activity_stream_modes #=> Array
|
11433
11820
|
# resp.orderable_db_instance_options[0].supported_activity_stream_modes[0] #=> String
|
11434
11821
|
# resp.orderable_db_instance_options[0].supports_global_databases #=> Boolean
|
11822
|
+
# resp.orderable_db_instance_options[0].supports_clusters #=> Boolean
|
11435
11823
|
# resp.marker #=> String
|
11436
11824
|
#
|
11437
11825
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeOrderableDBInstanceOptions AWS API Documentation
|
@@ -12086,27 +12474,41 @@ module Aws::RDS
|
|
12086
12474
|
|
12087
12475
|
# Forces a failover for a DB cluster.
|
12088
12476
|
#
|
12089
|
-
#
|
12090
|
-
# (read-only instances) in the DB cluster to be the
|
12091
|
-
# (the cluster writer).
|
12477
|
+
# For an Aurora DB cluster, failover for a DB cluster promotes one of
|
12478
|
+
# the Aurora Replicas (read-only instances) in the DB cluster to be the
|
12479
|
+
# primary DB instance (the cluster writer).
|
12092
12480
|
#
|
12093
|
-
#
|
12094
|
-
#
|
12095
|
-
#
|
12096
|
-
# Because each instance in a DB cluster has its own endpoint address,
|
12097
|
-
# you will need to clean up and re-establish any existing connections
|
12098
|
-
# that use those endpoint addresses when the failover is complete.
|
12481
|
+
# For a Multi-AZ DB cluster, failover for a DB cluster promotes one of
|
12482
|
+
# the readable standby DB instances (read-only instances) in the DB
|
12483
|
+
# cluster to be the primary DB instance (the cluster writer).
|
12099
12484
|
#
|
12100
|
-
#
|
12101
|
-
#
|
12485
|
+
# An Amazon Aurora DB cluster automatically fails over to an Aurora
|
12486
|
+
# Replica, if one exists, when the primary DB instance fails. A Multi-AZ
|
12487
|
+
# DB cluster automatically fails over to a readbable standby DB instance
|
12488
|
+
# when the primary DB instance fails.
|
12102
12489
|
#
|
12103
|
-
#
|
12490
|
+
# To simulate a failure of a primary instance for testing, you can force
|
12491
|
+
# a failover. Because each instance in a DB cluster has its own endpoint
|
12492
|
+
# address, make sure to clean up and re-establish any existing
|
12493
|
+
# connections that use those endpoint addresses when the failover is
|
12494
|
+
# complete.
|
12495
|
+
#
|
12496
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
12497
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
12498
|
+
#
|
12499
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
12500
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
12501
|
+
# RDS User Guide.*
|
12502
|
+
#
|
12503
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
12504
|
+
# change.
|
12104
12505
|
#
|
12105
12506
|
# </note>
|
12106
12507
|
#
|
12107
12508
|
#
|
12108
12509
|
#
|
12109
12510
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
12511
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
12110
12512
|
#
|
12111
12513
|
# @option params [required, String] :db_cluster_identifier
|
12112
12514
|
# A DB cluster identifier to force a failover for. This parameter isn't
|
@@ -12119,10 +12521,13 @@ module Aws::RDS
|
|
12119
12521
|
# ^
|
12120
12522
|
#
|
12121
12523
|
# @option params [String] :target_db_instance_identifier
|
12122
|
-
# The name of the instance to promote to the primary instance.
|
12524
|
+
# The name of the DB instance to promote to the primary DB instance.
|
12123
12525
|
#
|
12124
|
-
#
|
12125
|
-
# DB cluster
|
12526
|
+
# Specify the DB instance identifier for an Aurora Replica or a Multi-AZ
|
12527
|
+
# readable standby in the DB cluster, for example
|
12528
|
+
# `mydbcluster-replica1`.
|
12529
|
+
#
|
12530
|
+
# This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
|
12126
12531
|
#
|
12127
12532
|
# @return [Types::FailoverDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12128
12533
|
#
|
@@ -12243,6 +12648,16 @@ module Aws::RDS
|
|
12243
12648
|
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
12244
12649
|
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
12245
12650
|
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
12651
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
12652
|
+
# resp.db_cluster.storage_type #=> String
|
12653
|
+
# resp.db_cluster.iops #=> Integer
|
12654
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
12655
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
12656
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
12657
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
12658
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
12659
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
12660
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
12246
12661
|
#
|
12247
12662
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverDBCluster AWS API Documentation
|
12248
12663
|
#
|
@@ -12833,19 +13248,26 @@ module Aws::RDS
|
|
12833
13248
|
req.send_request(options)
|
12834
13249
|
end
|
12835
13250
|
|
12836
|
-
# Modify
|
12837
|
-
# or more
|
12838
|
-
# parameters and the new values in the request.
|
12839
|
-
# Amazon Aurora, see [ What Is Amazon Aurora?][1] in the *Amazon Aurora
|
12840
|
-
# User Guide.*
|
13251
|
+
# Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB
|
13252
|
+
# cluster. You can change one or more settings by specifying these
|
13253
|
+
# parameters and the new values in the request.
|
12841
13254
|
#
|
12842
|
-
#
|
13255
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
13256
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
13257
|
+
#
|
13258
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
13259
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
13260
|
+
# RDS User Guide.*
|
13261
|
+
#
|
13262
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
13263
|
+
# change.
|
12843
13264
|
#
|
12844
13265
|
# </note>
|
12845
13266
|
#
|
12846
13267
|
#
|
12847
13268
|
#
|
12848
13269
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
13270
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
12849
13271
|
#
|
12850
13272
|
# @option params [required, String] :db_cluster_identifier
|
12851
13273
|
# The DB cluster identifier for the cluster being modified. This
|
@@ -12854,6 +13276,8 @@ module Aws::RDS
|
|
12854
13276
|
# Constraints: This identifier must match the identifier of an existing
|
12855
13277
|
# DB cluster.
|
12856
13278
|
#
|
13279
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13280
|
+
#
|
12857
13281
|
# @option params [String] :new_db_cluster_identifier
|
12858
13282
|
# The new DB cluster identifier for the DB cluster when renaming a DB
|
12859
13283
|
# cluster. This value is stored as a lowercase string.
|
@@ -12868,6 +13292,8 @@ module Aws::RDS
|
|
12868
13292
|
#
|
12869
13293
|
# Example: `my-cluster2`
|
12870
13294
|
#
|
13295
|
+
# Valid for: Aurora DB clusters only
|
13296
|
+
#
|
12871
13297
|
# @option params [Boolean] :apply_immediately
|
12872
13298
|
# A value that indicates whether the modifications in this request and
|
12873
13299
|
# any pending modifications are asynchronously applied as soon as
|
@@ -12886,9 +13312,11 @@ module Aws::RDS
|
|
12886
13312
|
#
|
12887
13313
|
# By default, this parameter is disabled.
|
12888
13314
|
#
|
13315
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13316
|
+
#
|
12889
13317
|
# @option params [Integer] :backup_retention_period
|
12890
|
-
# The number of days for which automated backups are retained.
|
12891
|
-
#
|
13318
|
+
# The number of days for which automated backups are retained. Specify a
|
13319
|
+
# minimum value of 1.
|
12892
13320
|
#
|
12893
13321
|
# Default: 1
|
12894
13322
|
#
|
@@ -12898,12 +13326,18 @@ module Aws::RDS
|
|
12898
13326
|
#
|
12899
13327
|
# ^
|
12900
13328
|
#
|
13329
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13330
|
+
#
|
12901
13331
|
# @option params [String] :db_cluster_parameter_group_name
|
12902
13332
|
# The name of the DB cluster parameter group to use for the DB cluster.
|
12903
13333
|
#
|
13334
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13335
|
+
#
|
12904
13336
|
# @option params [Array<String>] :vpc_security_group_ids
|
12905
13337
|
# A list of VPC security groups that the DB cluster will belong to.
|
12906
13338
|
#
|
13339
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13340
|
+
#
|
12907
13341
|
# @option params [Integer] :port
|
12908
13342
|
# The port number on which the DB cluster accepts connections.
|
12909
13343
|
#
|
@@ -12911,25 +13345,22 @@ module Aws::RDS
|
|
12911
13345
|
#
|
12912
13346
|
# Default: The same port as the original DB cluster.
|
12913
13347
|
#
|
13348
|
+
# Valid for: Aurora DB clusters only
|
13349
|
+
#
|
12914
13350
|
# @option params [String] :master_user_password
|
12915
13351
|
# The new password for the master database user. This password can
|
12916
13352
|
# contain any printable ASCII character except "/", """, or "@".
|
12917
13353
|
#
|
12918
13354
|
# Constraints: Must contain from 8 to 41 characters.
|
12919
13355
|
#
|
13356
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13357
|
+
#
|
12920
13358
|
# @option params [String] :option_group_name
|
12921
13359
|
# A value that indicates that the DB cluster should be associated with
|
12922
|
-
# the specified option group.
|
12923
|
-
#
|
12924
|
-
#
|
12925
|
-
#
|
12926
|
-
# group that enables OEM, this change can cause a brief (sub-second)
|
12927
|
-
# period during which new connections are rejected but existing
|
12928
|
-
# connections are not interrupted.
|
12929
|
-
#
|
12930
|
-
# Permanent options can't be removed from an option group. The option
|
12931
|
-
# group can't be removed from a DB cluster once it is associated with a
|
12932
|
-
# DB cluster.
|
13360
|
+
# the specified option group.
|
13361
|
+
#
|
13362
|
+
# DB clusters are associated with a default option group that can't be
|
13363
|
+
# modified.
|
12933
13364
|
#
|
12934
13365
|
# @option params [String] :preferred_backup_window
|
12935
13366
|
# The daily time range during which automated backups are created if
|
@@ -12951,6 +13382,8 @@ module Aws::RDS
|
|
12951
13382
|
#
|
12952
13383
|
# * Must be at least 30 minutes.
|
12953
13384
|
#
|
13385
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13386
|
+
#
|
12954
13387
|
#
|
12955
13388
|
#
|
12956
13389
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
@@ -12971,6 +13404,8 @@ module Aws::RDS
|
|
12971
13404
|
#
|
12972
13405
|
# Constraints: Minimum 30-minute window.
|
12973
13406
|
#
|
13407
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13408
|
+
#
|
12974
13409
|
#
|
12975
13410
|
#
|
12976
13411
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
@@ -12978,11 +13413,13 @@ module Aws::RDS
|
|
12978
13413
|
# @option params [Boolean] :enable_iam_database_authentication
|
12979
13414
|
# A value that indicates whether to enable mapping of Amazon Web
|
12980
13415
|
# Services Identity and Access Management (IAM) accounts to database
|
12981
|
-
# accounts. By default, mapping
|
13416
|
+
# accounts. By default, mapping isn't enabled.
|
12982
13417
|
#
|
12983
13418
|
# For more information, see [ IAM Database Authentication][1] in the
|
12984
13419
|
# *Amazon Aurora User Guide.*
|
12985
13420
|
#
|
13421
|
+
# Valid for: Aurora DB clusters only
|
13422
|
+
#
|
12986
13423
|
#
|
12987
13424
|
#
|
12988
13425
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -12991,10 +13428,6 @@ module Aws::RDS
|
|
12991
13428
|
# The target backtrack window, in seconds. To disable backtracking, set
|
12992
13429
|
# this value to 0.
|
12993
13430
|
#
|
12994
|
-
# <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
|
12995
|
-
#
|
12996
|
-
# </note>
|
12997
|
-
#
|
12998
13431
|
# Default: 0
|
12999
13432
|
#
|
13000
13433
|
# Constraints:
|
@@ -13004,34 +13437,52 @@ module Aws::RDS
|
|
13004
13437
|
#
|
13005
13438
|
# ^
|
13006
13439
|
#
|
13440
|
+
# Valid for: Aurora MySQL DB clusters only
|
13441
|
+
#
|
13007
13442
|
# @option params [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
13008
13443
|
# The configuration setting for the log types to be enabled for export
|
13009
13444
|
# to CloudWatch Logs for a specific DB cluster.
|
13010
13445
|
#
|
13446
|
+
# Valid for: Aurora DB clusters only
|
13447
|
+
#
|
13011
13448
|
# @option params [String] :engine_version
|
13012
13449
|
# The version number of the database engine to which you want to
|
13013
13450
|
# upgrade. Changing this parameter results in an outage. The change is
|
13014
13451
|
# applied during the next maintenance window unless `ApplyImmediately`
|
13015
13452
|
# is enabled.
|
13016
13453
|
#
|
13017
|
-
# To list all of the available engine versions for
|
13018
|
-
#
|
13454
|
+
# To list all of the available engine versions for MySQL 5.6-compatible
|
13455
|
+
# Aurora, use the following command:
|
13019
13456
|
#
|
13020
13457
|
# `aws rds describe-db-engine-versions --engine aurora --query
|
13021
13458
|
# "DBEngineVersions[].EngineVersion"`
|
13022
13459
|
#
|
13023
|
-
# To list all of the available engine versions for
|
13024
|
-
#
|
13460
|
+
# To list all of the available engine versions for MySQL 5.7-compatible
|
13461
|
+
# Aurora, use the following command:
|
13025
13462
|
#
|
13026
13463
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
13027
13464
|
# "DBEngineVersions[].EngineVersion"`
|
13028
13465
|
#
|
13029
|
-
# To list all of the available engine versions for
|
13466
|
+
# To list all of the available engine versions for Aurora PostgreSQL,
|
13030
13467
|
# use the following command:
|
13031
13468
|
#
|
13032
13469
|
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
13033
13470
|
# --query "DBEngineVersions[].EngineVersion"`
|
13034
13471
|
#
|
13472
|
+
# To list all of the available engine versions for RDS for MySQL, use
|
13473
|
+
# the following command:
|
13474
|
+
#
|
13475
|
+
# `aws rds describe-db-engine-versions --engine mysql --query
|
13476
|
+
# "DBEngineVersions[].EngineVersion"`
|
13477
|
+
#
|
13478
|
+
# To list all of the available engine versions for RDS for PostgreSQL,
|
13479
|
+
# use the following command:
|
13480
|
+
#
|
13481
|
+
# `aws rds describe-db-engine-versions --engine postgres --query
|
13482
|
+
# "DBEngineVersions[].EngineVersion"`
|
13483
|
+
#
|
13484
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13485
|
+
#
|
13035
13486
|
# @option params [Boolean] :allow_major_version_upgrade
|
13036
13487
|
# A value that indicates whether major version upgrades are allowed.
|
13037
13488
|
#
|
@@ -13039,6 +13490,8 @@ module Aws::RDS
|
|
13039
13490
|
# value for the `EngineVersion` parameter that is a different major
|
13040
13491
|
# version than the DB cluster's current version.
|
13041
13492
|
#
|
13493
|
+
# Valid for: Aurora DB clusters only
|
13494
|
+
#
|
13042
13495
|
# @option params [String] :db_instance_parameter_group_name
|
13043
13496
|
# The name of the DB parameter group to apply to all instances of the DB
|
13044
13497
|
# cluster.
|
@@ -13060,6 +13513,8 @@ module Aws::RDS
|
|
13060
13513
|
# * The `DBInstanceParameterGroupName` parameter is only valid in
|
13061
13514
|
# combination with the `AllowMajorVersionUpgrade` parameter.
|
13062
13515
|
#
|
13516
|
+
# Valid for: Aurora DB clusters only
|
13517
|
+
#
|
13063
13518
|
# @option params [String] :domain
|
13064
13519
|
# The Active Directory directory ID to move the DB cluster to. Specify
|
13065
13520
|
# `none` to remove the cluster from its current domain. The domain must
|
@@ -13068,6 +13523,8 @@ module Aws::RDS
|
|
13068
13523
|
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
13069
13524
|
# Aurora User Guide*.
|
13070
13525
|
#
|
13526
|
+
# Valid for: Aurora DB clusters only
|
13527
|
+
#
|
13071
13528
|
#
|
13072
13529
|
#
|
13073
13530
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
@@ -13076,14 +13533,20 @@ module Aws::RDS
|
|
13076
13533
|
# Specify the name of the IAM role to be used when making API calls to
|
13077
13534
|
# the Directory Service.
|
13078
13535
|
#
|
13536
|
+
# Valid for: Aurora DB clusters only
|
13537
|
+
#
|
13079
13538
|
# @option params [Types::ScalingConfiguration] :scaling_configuration
|
13080
13539
|
# The scaling properties of the DB cluster. You can only modify scaling
|
13081
13540
|
# properties for DB clusters in `serverless` DB engine mode.
|
13082
13541
|
#
|
13542
|
+
# Valid for: Aurora DB clusters only
|
13543
|
+
#
|
13083
13544
|
# @option params [Boolean] :deletion_protection
|
13084
13545
|
# A value that indicates whether the DB cluster has deletion protection
|
13085
13546
|
# enabled. The database can't be deleted when deletion protection is
|
13086
|
-
# enabled. By default, deletion protection
|
13547
|
+
# enabled. By default, deletion protection isn't enabled.
|
13548
|
+
#
|
13549
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
13087
13550
|
#
|
13088
13551
|
# @option params [Boolean] :enable_http_endpoint
|
13089
13552
|
# A value that indicates whether to enable the HTTP endpoint for an
|
@@ -13098,6 +13561,8 @@ module Aws::RDS
|
|
13098
13561
|
# For more information, see [Using the Data API for Aurora
|
13099
13562
|
# Serverless][1] in the *Amazon Aurora User Guide*.
|
13100
13563
|
#
|
13564
|
+
# Valid for: Aurora DB clusters only
|
13565
|
+
#
|
13101
13566
|
#
|
13102
13567
|
#
|
13103
13568
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
@@ -13106,6 +13571,8 @@ module Aws::RDS
|
|
13106
13571
|
# A value that indicates whether to copy all tags from the DB cluster to
|
13107
13572
|
# snapshots of the DB cluster. The default is not to copy them.
|
13108
13573
|
#
|
13574
|
+
# Valid for: Aurora DB clusters only
|
13575
|
+
#
|
13109
13576
|
# @option params [Boolean] :enable_global_write_forwarding
|
13110
13577
|
# A value that indicates whether to enable this DB cluster to forward
|
13111
13578
|
# write operations to the primary cluster of an Aurora global database
|
@@ -13121,6 +13588,129 @@ module Aws::RDS
|
|
13121
13588
|
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
13122
13589
|
# operation, but it does nothing until then.
|
13123
13590
|
#
|
13591
|
+
# Valid for: Aurora DB clusters only
|
13592
|
+
#
|
13593
|
+
# @option params [String] :db_cluster_instance_class
|
13594
|
+
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
13595
|
+
# cluster, for example db.m6g.xlarge. Not all DB instance classes are
|
13596
|
+
# available in all Amazon Web Services Regions, or for all database
|
13597
|
+
# engines.
|
13598
|
+
#
|
13599
|
+
# For the full list of DB instance classes and availability for your
|
13600
|
+
# engine, see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
13601
|
+
#
|
13602
|
+
# Valid for: Multi-AZ DB clusters only
|
13603
|
+
#
|
13604
|
+
#
|
13605
|
+
#
|
13606
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
13607
|
+
#
|
13608
|
+
# @option params [Integer] :allocated_storage
|
13609
|
+
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
13610
|
+
# instance in the Multi-AZ DB cluster.
|
13611
|
+
#
|
13612
|
+
# Type: Integer
|
13613
|
+
#
|
13614
|
+
# Valid for: Multi-AZ DB clusters only
|
13615
|
+
#
|
13616
|
+
# @option params [String] :storage_type
|
13617
|
+
# Specifies the storage type to be associated with the DB cluster.
|
13618
|
+
#
|
13619
|
+
# Valid values: `standard | gp2 | io1`
|
13620
|
+
#
|
13621
|
+
# If you specify `io1`, you must also include a value for the `Iops`
|
13622
|
+
# parameter.
|
13623
|
+
#
|
13624
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
13625
|
+
#
|
13626
|
+
# Valid for: Multi-AZ DB clusters only
|
13627
|
+
#
|
13628
|
+
# @option params [Integer] :iops
|
13629
|
+
# The amount of Provisioned IOPS (input/output operations per second) to
|
13630
|
+
# be initially allocated for each DB instance in the Multi-AZ DB
|
13631
|
+
# cluster.
|
13632
|
+
#
|
13633
|
+
# For information about valid Iops values, see [Amazon RDS Provisioned
|
13634
|
+
# IOPS Storage to Improve Performance][1] in the *Amazon RDS User
|
13635
|
+
# Guide*.
|
13636
|
+
#
|
13637
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
13638
|
+
# amount for the DB cluster.
|
13639
|
+
#
|
13640
|
+
# Valid for: Multi-AZ DB clusters only
|
13641
|
+
#
|
13642
|
+
#
|
13643
|
+
#
|
13644
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
13645
|
+
#
|
13646
|
+
# @option params [Boolean] :auto_minor_version_upgrade
|
13647
|
+
# A value that indicates whether minor engine upgrades are applied
|
13648
|
+
# automatically to the DB cluster during the maintenance window. By
|
13649
|
+
# default, minor engine upgrades are applied automatically.
|
13650
|
+
#
|
13651
|
+
# Valid for: Multi-AZ DB clusters only
|
13652
|
+
#
|
13653
|
+
# @option params [Integer] :monitoring_interval
|
13654
|
+
# The interval, in seconds, between points when Enhanced Monitoring
|
13655
|
+
# metrics are collected for the DB cluster. To turn off collecting
|
13656
|
+
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
13657
|
+
#
|
13658
|
+
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
|
13659
|
+
# a value other than 0.
|
13660
|
+
#
|
13661
|
+
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
13662
|
+
#
|
13663
|
+
# Valid for: Multi-AZ DB clusters only
|
13664
|
+
#
|
13665
|
+
# @option params [String] :monitoring_role_arn
|
13666
|
+
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
13667
|
+
# send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example
|
13668
|
+
# is `arn:aws:iam:123456789012:role/emaccess`. For information on
|
13669
|
+
# creating a monitoring role, see [To create an IAM role for Amazon RDS
|
13670
|
+
# Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
|
13671
|
+
#
|
13672
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
13673
|
+
# `MonitoringRoleArn` value.
|
13674
|
+
#
|
13675
|
+
# Valid for: Multi-AZ DB clusters only
|
13676
|
+
#
|
13677
|
+
#
|
13678
|
+
#
|
13679
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
13680
|
+
#
|
13681
|
+
# @option params [Boolean] :enable_performance_insights
|
13682
|
+
# A value that indicates whether to turn on Performance Insights for the
|
13683
|
+
# DB cluster.
|
13684
|
+
#
|
13685
|
+
# For more information, see [ Using Amazon Performance Insights][1] in
|
13686
|
+
# the *Amazon RDS User Guide*.
|
13687
|
+
#
|
13688
|
+
# Valid for: Multi-AZ DB clusters only
|
13689
|
+
#
|
13690
|
+
#
|
13691
|
+
#
|
13692
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
13693
|
+
#
|
13694
|
+
# @option params [String] :performance_insights_kms_key_id
|
13695
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
13696
|
+
# Performance Insights data.
|
13697
|
+
#
|
13698
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
13699
|
+
# alias ARN, or alias name for the KMS key.
|
13700
|
+
#
|
13701
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
|
13702
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
13703
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
13704
|
+
# a different default KMS key for each Amazon Web Services Region.
|
13705
|
+
#
|
13706
|
+
# Valid for: Multi-AZ DB clusters only
|
13707
|
+
#
|
13708
|
+
# @option params [Integer] :performance_insights_retention_period
|
13709
|
+
# The amount of time, in days, to retain Performance Insights data.
|
13710
|
+
# Valid values are 7 or 731 (2 years).
|
13711
|
+
#
|
13712
|
+
# Valid for: Multi-AZ DB clusters only
|
13713
|
+
#
|
13124
13714
|
# @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13125
13715
|
#
|
13126
13716
|
# * {Types::ModifyDBClusterResult#db_cluster #db_cluster} => Types::DBCluster
|
@@ -13182,6 +13772,16 @@ module Aws::RDS
|
|
13182
13772
|
# enable_http_endpoint: false,
|
13183
13773
|
# copy_tags_to_snapshot: false,
|
13184
13774
|
# enable_global_write_forwarding: false,
|
13775
|
+
# db_cluster_instance_class: "String",
|
13776
|
+
# allocated_storage: 1,
|
13777
|
+
# storage_type: "String",
|
13778
|
+
# iops: 1,
|
13779
|
+
# auto_minor_version_upgrade: false,
|
13780
|
+
# monitoring_interval: 1,
|
13781
|
+
# monitoring_role_arn: "String",
|
13782
|
+
# enable_performance_insights: false,
|
13783
|
+
# performance_insights_kms_key_id: "String",
|
13784
|
+
# performance_insights_retention_period: 1,
|
13185
13785
|
# })
|
13186
13786
|
#
|
13187
13787
|
# @example Response structure
|
@@ -13276,6 +13876,16 @@ module Aws::RDS
|
|
13276
13876
|
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
13277
13877
|
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
13278
13878
|
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
13879
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
13880
|
+
# resp.db_cluster.storage_type #=> String
|
13881
|
+
# resp.db_cluster.iops #=> Integer
|
13882
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
13883
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
13884
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
13885
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
13886
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
13887
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
13888
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
13279
13889
|
#
|
13280
13890
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBCluster AWS API Documentation
|
13281
13891
|
#
|
@@ -13359,9 +13969,6 @@ module Aws::RDS
|
|
13359
13969
|
# `ParameterName`, `ParameterValue`, and `ApplyMethod`. A maximum of 20
|
13360
13970
|
# parameters can be modified in a single request.
|
13361
13971
|
#
|
13362
|
-
# For more information on Amazon Aurora, see [ What Is Amazon
|
13363
|
-
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
13364
|
-
#
|
13365
13972
|
# After you create a DB cluster parameter group, you should wait at
|
13366
13973
|
# least 5 minutes before creating your first DB cluster that uses that
|
13367
13974
|
# DB cluster parameter group as the default parameter group. This allows
|
@@ -13370,7 +13977,7 @@ module Aws::RDS
|
|
13370
13977
|
# important for parameters that are critical when creating the default
|
13371
13978
|
# database for a DB cluster, such as the character set for the default
|
13372
13979
|
# database defined by the `character_set_database` parameter. You can
|
13373
|
-
# use the *Parameter Groups* option of the [Amazon RDS console][
|
13980
|
+
# use the *Parameter Groups* option of the [Amazon RDS console][1] or
|
13374
13981
|
# the `DescribeDBClusterParameters` action to verify that your DB
|
13375
13982
|
# cluster parameter group has been created or modified.
|
13376
13983
|
#
|
@@ -13380,14 +13987,23 @@ module Aws::RDS
|
|
13380
13987
|
# must reopen any connections and retry any transactions that were
|
13381
13988
|
# active when the parameter changes took effect.
|
13382
13989
|
#
|
13383
|
-
#
|
13990
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
13991
|
+
# Amazon Aurora?][2] in the *Amazon Aurora User Guide.*
|
13992
|
+
#
|
13993
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
13994
|
+
# deployments with two readable standby DB instances][3] in the *Amazon
|
13995
|
+
# RDS User Guide.*
|
13996
|
+
#
|
13997
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
13998
|
+
# change.
|
13384
13999
|
#
|
13385
14000
|
# </note>
|
13386
14001
|
#
|
13387
14002
|
#
|
13388
14003
|
#
|
13389
|
-
# [1]: https://
|
13390
|
-
# [2]: https://
|
14004
|
+
# [1]: https://console.aws.amazon.com/rds/
|
14005
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
14006
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
13391
14007
|
#
|
13392
14008
|
# @option params [required, String] :db_cluster_parameter_group_name
|
13393
14009
|
# The name of the DB cluster parameter group to modify.
|
@@ -13497,10 +14113,6 @@ module Aws::RDS
|
|
13497
14113
|
# DescribeDBClusterSnapshotAttributes API action. The accounts are
|
13498
14114
|
# returned as values for the `restore` attribute.
|
13499
14115
|
#
|
13500
|
-
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
13501
|
-
#
|
13502
|
-
# </note>
|
13503
|
-
#
|
13504
14116
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
13505
14117
|
# The identifier for the DB cluster snapshot to modify the attributes
|
13506
14118
|
# for.
|
@@ -13623,8 +14235,8 @@ module Aws::RDS
|
|
13623
14235
|
# `CreateDBInstance`.
|
13624
14236
|
#
|
13625
14237
|
# @option params [String] :db_instance_class
|
13626
|
-
# The new compute and memory capacity of the DB instance, for example
|
13627
|
-
#
|
14238
|
+
# The new compute and memory capacity of the DB instance, for example
|
14239
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
13628
14240
|
# Web Services Regions, or for all database engines. For the full list
|
13629
14241
|
# of DB instance classes, and availability for your engine, see [DB
|
13630
14242
|
# Instance Class][1] in the *Amazon RDS User Guide*.
|
@@ -14136,12 +14748,13 @@ module Aws::RDS
|
|
14136
14748
|
# @option params [Boolean] :publicly_accessible
|
14137
14749
|
# A value that indicates whether the DB instance is publicly accessible.
|
14138
14750
|
#
|
14139
|
-
# When the DB
|
14140
|
-
# to the private IP address from within the DB
|
14141
|
-
#
|
14142
|
-
#
|
14143
|
-
#
|
14144
|
-
#
|
14751
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
14752
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
14753
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
14754
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
14755
|
+
# cluster is ultimately controlled by the security group it uses. That
|
14756
|
+
# public access isn't permitted if the security group assigned to the
|
14757
|
+
# DB cluster doesn't permit it.
|
14145
14758
|
#
|
14146
14759
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
14147
14760
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -14196,7 +14809,7 @@ module Aws::RDS
|
|
14196
14809
|
# @option params [Boolean] :enable_iam_database_authentication
|
14197
14810
|
# A value that indicates whether to enable mapping of Amazon Web
|
14198
14811
|
# Services Identity and Access Management (IAM) accounts to database
|
14199
|
-
# accounts. By default, mapping
|
14812
|
+
# accounts. By default, mapping isn't enabled.
|
14200
14813
|
#
|
14201
14814
|
# This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
|
14202
14815
|
# Services IAM accounts to database accounts is managed by the DB
|
@@ -14270,7 +14883,7 @@ module Aws::RDS
|
|
14270
14883
|
# @option params [Boolean] :deletion_protection
|
14271
14884
|
# A value that indicates whether the DB instance has deletion protection
|
14272
14885
|
# enabled. The database can't be deleted when deletion protection is
|
14273
|
-
# enabled. By default, deletion protection
|
14886
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
14274
14887
|
# information, see [ Deleting a DB Instance][1].
|
14275
14888
|
#
|
14276
14889
|
#
|
@@ -15341,7 +15954,7 @@ module Aws::RDS
|
|
15341
15954
|
# Modify a setting for an Amazon Aurora global cluster. You can change
|
15342
15955
|
# one or more database configuration parameters by specifying these
|
15343
15956
|
# parameters and the new values in the request. For more information on
|
15344
|
-
# Amazon Aurora, see [ What
|
15957
|
+
# Amazon Aurora, see [ What is Amazon Aurora?][1] in the *Amazon Aurora
|
15345
15958
|
# User Guide.*
|
15346
15959
|
#
|
15347
15960
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
@@ -15829,10 +16442,6 @@ module Aws::RDS
|
|
15829
16442
|
|
15830
16443
|
# Promotes a read replica DB cluster to a standalone DB cluster.
|
15831
16444
|
#
|
15832
|
-
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
15833
|
-
#
|
15834
|
-
# </note>
|
15835
|
-
#
|
15836
16445
|
# @option params [required, String] :db_cluster_identifier
|
15837
16446
|
# The identifier of the DB cluster read replica to promote. This
|
15838
16447
|
# parameter isn't case-sensitive.
|
@@ -15947,6 +16556,16 @@ module Aws::RDS
|
|
15947
16556
|
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
15948
16557
|
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
15949
16558
|
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
16559
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
16560
|
+
# resp.db_cluster.storage_type #=> String
|
16561
|
+
# resp.db_cluster.iops #=> Integer
|
16562
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
16563
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
16564
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
16565
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
16566
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
16567
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
16568
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
15950
16569
|
#
|
15951
16570
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplicaDBCluster AWS API Documentation
|
15952
16571
|
#
|
@@ -16046,6 +16665,158 @@ module Aws::RDS
|
|
16046
16665
|
req.send_request(options)
|
16047
16666
|
end
|
16048
16667
|
|
16668
|
+
# You might need to reboot your DB cluster, usually for maintenance
|
16669
|
+
# reasons. For example, if you make certain modifications, or if you
|
16670
|
+
# change the DB cluster parameter group associated with the DB cluster,
|
16671
|
+
# reboot the DB cluster for the changes to take effect.
|
16672
|
+
#
|
16673
|
+
# Rebooting a DB cluster restarts the database engine service. Rebooting
|
16674
|
+
# a DB cluster results in a momentary outage, during which the DB
|
16675
|
+
# cluster status is set to rebooting.
|
16676
|
+
#
|
16677
|
+
# Use this operation only for a non-Aurora Multi-AZ DB cluster. The
|
16678
|
+
# Multi-AZ DB clusters feature is in preview and is subject to change.
|
16679
|
+
#
|
16680
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
16681
|
+
# deployments with two readable standby DB instances][1] in the *Amazon
|
16682
|
+
# RDS User Guide.*
|
16683
|
+
#
|
16684
|
+
#
|
16685
|
+
#
|
16686
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
16687
|
+
#
|
16688
|
+
# @option params [required, String] :db_cluster_identifier
|
16689
|
+
# The DB cluster identifier. This parameter is stored as a lowercase
|
16690
|
+
# string.
|
16691
|
+
#
|
16692
|
+
# Constraints:
|
16693
|
+
#
|
16694
|
+
# * Must match the identifier of an existing DBCluster.
|
16695
|
+
#
|
16696
|
+
# ^
|
16697
|
+
#
|
16698
|
+
# @return [Types::RebootDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
16699
|
+
#
|
16700
|
+
# * {Types::RebootDBClusterResult#db_cluster #db_cluster} => Types::DBCluster
|
16701
|
+
#
|
16702
|
+
# @example Request syntax with placeholder values
|
16703
|
+
#
|
16704
|
+
# resp = client.reboot_db_cluster({
|
16705
|
+
# db_cluster_identifier: "String", # required
|
16706
|
+
# })
|
16707
|
+
#
|
16708
|
+
# @example Response structure
|
16709
|
+
#
|
16710
|
+
# resp.db_cluster.allocated_storage #=> Integer
|
16711
|
+
# resp.db_cluster.availability_zones #=> Array
|
16712
|
+
# resp.db_cluster.availability_zones[0] #=> String
|
16713
|
+
# resp.db_cluster.backup_retention_period #=> Integer
|
16714
|
+
# resp.db_cluster.character_set_name #=> String
|
16715
|
+
# resp.db_cluster.database_name #=> String
|
16716
|
+
# resp.db_cluster.db_cluster_identifier #=> String
|
16717
|
+
# resp.db_cluster.db_cluster_parameter_group #=> String
|
16718
|
+
# resp.db_cluster.db_subnet_group #=> String
|
16719
|
+
# resp.db_cluster.status #=> String
|
16720
|
+
# resp.db_cluster.automatic_restart_time #=> Time
|
16721
|
+
# resp.db_cluster.percent_progress #=> String
|
16722
|
+
# resp.db_cluster.earliest_restorable_time #=> Time
|
16723
|
+
# resp.db_cluster.endpoint #=> String
|
16724
|
+
# resp.db_cluster.reader_endpoint #=> String
|
16725
|
+
# resp.db_cluster.custom_endpoints #=> Array
|
16726
|
+
# resp.db_cluster.custom_endpoints[0] #=> String
|
16727
|
+
# resp.db_cluster.multi_az #=> Boolean
|
16728
|
+
# resp.db_cluster.engine #=> String
|
16729
|
+
# resp.db_cluster.engine_version #=> String
|
16730
|
+
# resp.db_cluster.latest_restorable_time #=> Time
|
16731
|
+
# resp.db_cluster.port #=> Integer
|
16732
|
+
# resp.db_cluster.master_username #=> String
|
16733
|
+
# resp.db_cluster.db_cluster_option_group_memberships #=> Array
|
16734
|
+
# resp.db_cluster.db_cluster_option_group_memberships[0].db_cluster_option_group_name #=> String
|
16735
|
+
# resp.db_cluster.db_cluster_option_group_memberships[0].status #=> String
|
16736
|
+
# resp.db_cluster.preferred_backup_window #=> String
|
16737
|
+
# resp.db_cluster.preferred_maintenance_window #=> String
|
16738
|
+
# resp.db_cluster.replication_source_identifier #=> String
|
16739
|
+
# resp.db_cluster.read_replica_identifiers #=> Array
|
16740
|
+
# resp.db_cluster.read_replica_identifiers[0] #=> String
|
16741
|
+
# resp.db_cluster.db_cluster_members #=> Array
|
16742
|
+
# resp.db_cluster.db_cluster_members[0].db_instance_identifier #=> String
|
16743
|
+
# resp.db_cluster.db_cluster_members[0].is_cluster_writer #=> Boolean
|
16744
|
+
# resp.db_cluster.db_cluster_members[0].db_cluster_parameter_group_status #=> String
|
16745
|
+
# resp.db_cluster.db_cluster_members[0].promotion_tier #=> Integer
|
16746
|
+
# resp.db_cluster.vpc_security_groups #=> Array
|
16747
|
+
# resp.db_cluster.vpc_security_groups[0].vpc_security_group_id #=> String
|
16748
|
+
# resp.db_cluster.vpc_security_groups[0].status #=> String
|
16749
|
+
# resp.db_cluster.hosted_zone_id #=> String
|
16750
|
+
# resp.db_cluster.storage_encrypted #=> Boolean
|
16751
|
+
# resp.db_cluster.kms_key_id #=> String
|
16752
|
+
# resp.db_cluster.db_cluster_resource_id #=> String
|
16753
|
+
# resp.db_cluster.db_cluster_arn #=> String
|
16754
|
+
# resp.db_cluster.associated_roles #=> Array
|
16755
|
+
# resp.db_cluster.associated_roles[0].role_arn #=> String
|
16756
|
+
# resp.db_cluster.associated_roles[0].status #=> String
|
16757
|
+
# resp.db_cluster.associated_roles[0].feature_name #=> String
|
16758
|
+
# resp.db_cluster.iam_database_authentication_enabled #=> Boolean
|
16759
|
+
# resp.db_cluster.clone_group_id #=> String
|
16760
|
+
# resp.db_cluster.cluster_create_time #=> Time
|
16761
|
+
# resp.db_cluster.earliest_backtrack_time #=> Time
|
16762
|
+
# resp.db_cluster.backtrack_window #=> Integer
|
16763
|
+
# resp.db_cluster.backtrack_consumed_change_records #=> Integer
|
16764
|
+
# resp.db_cluster.enabled_cloudwatch_logs_exports #=> Array
|
16765
|
+
# resp.db_cluster.enabled_cloudwatch_logs_exports[0] #=> String
|
16766
|
+
# resp.db_cluster.capacity #=> Integer
|
16767
|
+
# resp.db_cluster.engine_mode #=> String
|
16768
|
+
# resp.db_cluster.scaling_configuration_info.min_capacity #=> Integer
|
16769
|
+
# resp.db_cluster.scaling_configuration_info.max_capacity #=> Integer
|
16770
|
+
# resp.db_cluster.scaling_configuration_info.auto_pause #=> Boolean
|
16771
|
+
# resp.db_cluster.scaling_configuration_info.seconds_until_auto_pause #=> Integer
|
16772
|
+
# resp.db_cluster.scaling_configuration_info.timeout_action #=> String
|
16773
|
+
# resp.db_cluster.scaling_configuration_info.seconds_before_timeout #=> Integer
|
16774
|
+
# resp.db_cluster.deletion_protection #=> Boolean
|
16775
|
+
# resp.db_cluster.http_endpoint_enabled #=> Boolean
|
16776
|
+
# resp.db_cluster.activity_stream_mode #=> String, one of "sync", "async"
|
16777
|
+
# resp.db_cluster.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
16778
|
+
# resp.db_cluster.activity_stream_kms_key_id #=> String
|
16779
|
+
# resp.db_cluster.activity_stream_kinesis_stream_name #=> String
|
16780
|
+
# resp.db_cluster.copy_tags_to_snapshot #=> Boolean
|
16781
|
+
# resp.db_cluster.cross_account_clone #=> Boolean
|
16782
|
+
# resp.db_cluster.domain_memberships #=> Array
|
16783
|
+
# resp.db_cluster.domain_memberships[0].domain #=> String
|
16784
|
+
# resp.db_cluster.domain_memberships[0].status #=> String
|
16785
|
+
# resp.db_cluster.domain_memberships[0].fqdn #=> String
|
16786
|
+
# resp.db_cluster.domain_memberships[0].iam_role_name #=> String
|
16787
|
+
# resp.db_cluster.tag_list #=> Array
|
16788
|
+
# resp.db_cluster.tag_list[0].key #=> String
|
16789
|
+
# resp.db_cluster.tag_list[0].value #=> String
|
16790
|
+
# resp.db_cluster.global_write_forwarding_status #=> String, one of "enabled", "disabled", "enabling", "disabling", "unknown"
|
16791
|
+
# resp.db_cluster.global_write_forwarding_requested #=> Boolean
|
16792
|
+
# resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable #=> Array
|
16793
|
+
# resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_enable[0] #=> String
|
16794
|
+
# resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable #=> Array
|
16795
|
+
# resp.db_cluster.pending_modified_values.pending_cloudwatch_logs_exports.log_types_to_disable[0] #=> String
|
16796
|
+
# resp.db_cluster.pending_modified_values.db_cluster_identifier #=> String
|
16797
|
+
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
16798
|
+
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
16799
|
+
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
16800
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
16801
|
+
# resp.db_cluster.storage_type #=> String
|
16802
|
+
# resp.db_cluster.iops #=> Integer
|
16803
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
16804
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
16805
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
16806
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
16807
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
16808
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
16809
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
16810
|
+
#
|
16811
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBCluster AWS API Documentation
|
16812
|
+
#
|
16813
|
+
# @overload reboot_db_cluster(params = {})
|
16814
|
+
# @param [Hash] params ({})
|
16815
|
+
def reboot_db_cluster(params = {}, options = {})
|
16816
|
+
req = build_request(:reboot_db_cluster, params)
|
16817
|
+
req.send_request(options)
|
16818
|
+
end
|
16819
|
+
|
16049
16820
|
# You might need to reboot your DB instance, usually for maintenance
|
16050
16821
|
# reasons. For example, if you make certain modifications, or if you
|
16051
16822
|
# change the DB parameter group associated with the DB instance, you
|
@@ -16311,7 +17082,7 @@ module Aws::RDS
|
|
16311
17082
|
# Detaches an Aurora secondary cluster from an Aurora global database
|
16312
17083
|
# cluster. The cluster becomes a standalone cluster with read-write
|
16313
17084
|
# capability instead of being read-only and receiving data from a
|
16314
|
-
# primary cluster in a different
|
17085
|
+
# primary cluster in a different Region.
|
16315
17086
|
#
|
16316
17087
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
16317
17088
|
#
|
@@ -16366,18 +17137,25 @@ module Aws::RDS
|
|
16366
17137
|
req.send_request(options)
|
16367
17138
|
end
|
16368
17139
|
|
16369
|
-
#
|
16370
|
-
# (IAM) role from
|
16371
|
-
# [Authorizing Amazon Aurora MySQL to Access Other Amazon Web Services
|
16372
|
-
# Services on Your Behalf ][1] in the *Amazon Aurora User Guide*.
|
17140
|
+
# Removes the asssociation of an Amazon Web Services Identity and Access
|
17141
|
+
# Management (IAM) role from a DB cluster.
|
16373
17142
|
#
|
16374
|
-
#
|
17143
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
17144
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
17145
|
+
#
|
17146
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
17147
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
17148
|
+
# RDS User Guide.*
|
17149
|
+
#
|
17150
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
17151
|
+
# change.
|
16375
17152
|
#
|
16376
17153
|
# </note>
|
16377
17154
|
#
|
16378
17155
|
#
|
16379
17156
|
#
|
16380
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/
|
17157
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
17158
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
16381
17159
|
#
|
16382
17160
|
# @option params [required, String] :db_cluster_identifier
|
16383
17161
|
# The name of the DB cluster to disassociate the IAM role from.
|
@@ -16573,16 +17351,22 @@ module Aws::RDS
|
|
16573
17351
|
# You must call `RebootDBInstance` for every DB instance in your DB
|
16574
17352
|
# cluster that you want the updated static parameter to apply to.
|
16575
17353
|
#
|
16576
|
-
# For more information on Amazon Aurora, see [ What
|
16577
|
-
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
17354
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
17355
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
16578
17356
|
#
|
16579
|
-
#
|
17357
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
17358
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
17359
|
+
# RDS User Guide.*
|
17360
|
+
#
|
17361
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
17362
|
+
# change.
|
16580
17363
|
#
|
16581
17364
|
# </note>
|
16582
17365
|
#
|
16583
17366
|
#
|
16584
17367
|
#
|
16585
17368
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
17369
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
16586
17370
|
#
|
16587
17371
|
# @option params [required, String] :db_cluster_parameter_group_name
|
16588
17372
|
# The name of the DB cluster parameter group to reset.
|
@@ -16769,7 +17553,7 @@ module Aws::RDS
|
|
16769
17553
|
#
|
16770
17554
|
# </note>
|
16771
17555
|
#
|
16772
|
-
# For more information on Amazon Aurora, see [ What
|
17556
|
+
# For more information on Amazon Aurora, see [ What is Amazon
|
16773
17557
|
# Aurora?][2] in the *Amazon Aurora User Guide.*
|
16774
17558
|
#
|
16775
17559
|
# <note markdown="1"> This action only applies to Aurora DB clusters. The source DB engine
|
@@ -16984,7 +17768,7 @@ module Aws::RDS
|
|
16984
17768
|
# @option params [Boolean] :enable_iam_database_authentication
|
16985
17769
|
# A value that indicates whether to enable mapping of Amazon Web
|
16986
17770
|
# Services Identity and Access Management (IAM) accounts to database
|
16987
|
-
# accounts. By default, mapping
|
17771
|
+
# accounts. By default, mapping isn't enabled.
|
16988
17772
|
#
|
16989
17773
|
# For more information, see [ IAM Database Authentication][1] in the
|
16990
17774
|
# *Amazon Aurora User Guide.*
|
@@ -17051,7 +17835,7 @@ module Aws::RDS
|
|
17051
17835
|
# @option params [Boolean] :deletion_protection
|
17052
17836
|
# A value that indicates whether the DB cluster has deletion protection
|
17053
17837
|
# enabled. The database can't be deleted when deletion protection is
|
17054
|
-
# enabled. By default, deletion protection
|
17838
|
+
# enabled. By default, deletion protection isn't enabled.
|
17055
17839
|
#
|
17056
17840
|
# @option params [Boolean] :copy_tags_to_snapshot
|
17057
17841
|
# A value that indicates whether to copy all tags from the restored DB
|
@@ -17212,6 +17996,16 @@ module Aws::RDS
|
|
17212
17996
|
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
17213
17997
|
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
17214
17998
|
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
17999
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
18000
|
+
# resp.db_cluster.storage_type #=> String
|
18001
|
+
# resp.db_cluster.iops #=> Integer
|
18002
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
18003
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
18004
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
18005
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
18006
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
18007
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
18008
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
17215
18009
|
#
|
17216
18010
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3 AWS API Documentation
|
17217
18011
|
#
|
@@ -17223,7 +18017,6 @@ module Aws::RDS
|
|
17223
18017
|
end
|
17224
18018
|
|
17225
18019
|
# Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
|
17226
|
-
# This action only applies to Aurora DB clusters.
|
17227
18020
|
#
|
17228
18021
|
# The target DB cluster is created from the source snapshot with a
|
17229
18022
|
# default configuration. If you don't specify a security group, the new
|
@@ -17238,21 +18031,29 @@ module Aws::RDS
|
|
17238
18031
|
#
|
17239
18032
|
# </note>
|
17240
18033
|
#
|
17241
|
-
# For more information on Amazon Aurora, see [ What
|
17242
|
-
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
18034
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
18035
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
17243
18036
|
#
|
17244
|
-
#
|
18037
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
18038
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
18039
|
+
# RDS User Guide.*
|
18040
|
+
#
|
18041
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
18042
|
+
# change.
|
17245
18043
|
#
|
17246
18044
|
# </note>
|
17247
18045
|
#
|
17248
18046
|
#
|
17249
18047
|
#
|
17250
18048
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
18049
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
17251
18050
|
#
|
17252
18051
|
# @option params [Array<String>] :availability_zones
|
17253
18052
|
# Provides the list of Availability Zones (AZs) where instances in the
|
17254
18053
|
# restored DB cluster can be created.
|
17255
18054
|
#
|
18055
|
+
# Valid for: Aurora DB clusters only
|
18056
|
+
#
|
17256
18057
|
# @option params [required, String] :db_cluster_identifier
|
17257
18058
|
# The name of the DB cluster to create from the DB snapshot or DB
|
17258
18059
|
# cluster snapshot. This parameter isn't case-sensitive.
|
@@ -17267,6 +18068,8 @@ module Aws::RDS
|
|
17267
18068
|
#
|
17268
18069
|
# Example: `my-snapshot-id`
|
17269
18070
|
#
|
18071
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18072
|
+
#
|
17270
18073
|
# @option params [required, String] :snapshot_identifier
|
17271
18074
|
# The identifier for the DB snapshot or DB cluster snapshot to restore
|
17272
18075
|
# from.
|
@@ -17281,6 +18084,8 @@ module Aws::RDS
|
|
17281
18084
|
#
|
17282
18085
|
# ^
|
17283
18086
|
#
|
18087
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18088
|
+
#
|
17284
18089
|
# @option params [required, String] :engine
|
17285
18090
|
# The database engine to use for the new DB cluster.
|
17286
18091
|
#
|
@@ -17288,40 +18093,68 @@ module Aws::RDS
|
|
17288
18093
|
#
|
17289
18094
|
# Constraint: Must be compatible with the engine of the source
|
17290
18095
|
#
|
18096
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18097
|
+
#
|
17291
18098
|
# @option params [String] :engine_version
|
17292
18099
|
# The version of the database engine to use for the new DB cluster.
|
17293
18100
|
#
|
17294
|
-
# To list all of the available engine versions for
|
17295
|
-
#
|
18101
|
+
# To list all of the available engine versions for MySQL 5.6-compatible
|
18102
|
+
# Aurora, use the following command:
|
17296
18103
|
#
|
17297
18104
|
# `aws rds describe-db-engine-versions --engine aurora --query
|
17298
18105
|
# "DBEngineVersions[].EngineVersion"`
|
17299
18106
|
#
|
17300
|
-
# To list all of the available engine versions for
|
17301
|
-
#
|
18107
|
+
# To list all of the available engine versions for MySQL 5.7-compatible
|
18108
|
+
# Aurora, use the following command:
|
17302
18109
|
#
|
17303
18110
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
17304
18111
|
# "DBEngineVersions[].EngineVersion"`
|
17305
18112
|
#
|
17306
|
-
# To list all of the available engine versions for
|
18113
|
+
# To list all of the available engine versions for Aurora PostgreSQL,
|
17307
18114
|
# use the following command:
|
17308
18115
|
#
|
17309
18116
|
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
17310
18117
|
# --query "DBEngineVersions[].EngineVersion"`
|
17311
18118
|
#
|
17312
|
-
#
|
17313
|
-
# the
|
18119
|
+
# To list all of the available engine versions for RDS for MySQL, use
|
18120
|
+
# the following command:
|
17314
18121
|
#
|
17315
|
-
#
|
18122
|
+
# `aws rds describe-db-engine-versions --engine mysql --query
|
18123
|
+
# "DBEngineVersions[].EngineVersion"`
|
18124
|
+
#
|
18125
|
+
# To list all of the available engine versions for RDS for PostgreSQL,
|
18126
|
+
# use the following command:
|
18127
|
+
#
|
18128
|
+
# `aws rds describe-db-engine-versions --engine postgres --query
|
18129
|
+
# "DBEngineVersions[].EngineVersion"`
|
17316
18130
|
#
|
17317
18131
|
# **Aurora MySQL**
|
17318
18132
|
#
|
17319
|
-
#
|
17320
|
-
#
|
18133
|
+
# See [MySQL on Amazon RDS Versions][1] in the *Amazon Aurora User
|
18134
|
+
# Guide.*
|
17321
18135
|
#
|
17322
18136
|
# **Aurora PostgreSQL**
|
17323
18137
|
#
|
17324
|
-
#
|
18138
|
+
# See [Amazon Aurora PostgreSQL releases and engine versions][2] in the
|
18139
|
+
# *Amazon Aurora User Guide.*
|
18140
|
+
#
|
18141
|
+
# **MySQL**
|
18142
|
+
#
|
18143
|
+
# See [MySQL on Amazon RDS Versions][3] in the *Amazon RDS User Guide.*
|
18144
|
+
#
|
18145
|
+
# **PostgreSQL**
|
18146
|
+
#
|
18147
|
+
# See [Amazon RDS for PostgreSQL versions and extensions][4] in the
|
18148
|
+
# *Amazon RDS User Guide.*
|
18149
|
+
#
|
18150
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18151
|
+
#
|
18152
|
+
#
|
18153
|
+
#
|
18154
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html
|
18155
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html
|
18156
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
18157
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
17325
18158
|
#
|
17326
18159
|
# @option params [Integer] :port
|
17327
18160
|
# The port number on which the new DB cluster accepts connections.
|
@@ -17330,6 +18163,8 @@ module Aws::RDS
|
|
17330
18163
|
#
|
17331
18164
|
# Default: The same port as the original DB cluster.
|
17332
18165
|
#
|
18166
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18167
|
+
#
|
17333
18168
|
# @option params [String] :db_subnet_group_name
|
17334
18169
|
# The name of the DB subnet group to use for the new DB cluster.
|
17335
18170
|
#
|
@@ -17338,18 +18173,29 @@ module Aws::RDS
|
|
17338
18173
|
#
|
17339
18174
|
# Example: `mySubnetgroup`
|
17340
18175
|
#
|
18176
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18177
|
+
#
|
17341
18178
|
# @option params [String] :database_name
|
17342
18179
|
# The database name for the restored DB cluster.
|
17343
18180
|
#
|
18181
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18182
|
+
#
|
17344
18183
|
# @option params [String] :option_group_name
|
17345
18184
|
# The name of the option group to use for the restored DB cluster.
|
17346
18185
|
#
|
18186
|
+
# DB clusters are associated with a default option group that can't be
|
18187
|
+
# modified.
|
18188
|
+
#
|
17347
18189
|
# @option params [Array<String>] :vpc_security_group_ids
|
17348
18190
|
# A list of VPC security groups that the new DB cluster will belong to.
|
17349
18191
|
#
|
18192
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18193
|
+
#
|
17350
18194
|
# @option params [Array<Types::Tag>] :tags
|
17351
18195
|
# The tags to be assigned to the restored DB cluster.
|
17352
18196
|
#
|
18197
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18198
|
+
#
|
17353
18199
|
# @option params [String] :kms_key_id
|
17354
18200
|
# The Amazon Web Services KMS key identifier to use when restoring an
|
17355
18201
|
# encrypted DB cluster from a DB snapshot or DB cluster snapshot.
|
@@ -17369,14 +18215,18 @@ module Aws::RDS
|
|
17369
18215
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
17370
18216
|
# isn't encrypted, then the restored DB cluster isn't encrypted.
|
17371
18217
|
#
|
18218
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18219
|
+
#
|
17372
18220
|
# @option params [Boolean] :enable_iam_database_authentication
|
17373
18221
|
# A value that indicates whether to enable mapping of Amazon Web
|
17374
18222
|
# Services Identity and Access Management (IAM) accounts to database
|
17375
|
-
# accounts. By default, mapping
|
18223
|
+
# accounts. By default, mapping isn't enabled.
|
17376
18224
|
#
|
17377
18225
|
# For more information, see [ IAM Database Authentication][1] in the
|
17378
18226
|
# *Amazon Aurora User Guide.*
|
17379
18227
|
#
|
18228
|
+
# Valid for: Aurora DB clusters only
|
18229
|
+
#
|
17380
18230
|
#
|
17381
18231
|
#
|
17382
18232
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -17398,12 +18248,18 @@ module Aws::RDS
|
|
17398
18248
|
#
|
17399
18249
|
# ^
|
17400
18250
|
#
|
18251
|
+
# Valid for: Aurora DB clusters only
|
18252
|
+
#
|
17401
18253
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
17402
18254
|
# The list of logs that the restored DB cluster is to export to Amazon
|
17403
18255
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
17404
|
-
# used.
|
18256
|
+
# used.
|
18257
|
+
#
|
18258
|
+
# For more information, see [Publishing Database Logs to Amazon
|
17405
18259
|
# CloudWatch Logs ][1] in the *Amazon Aurora User Guide*.
|
17406
18260
|
#
|
18261
|
+
# Valid for: Aurora DB clusters only
|
18262
|
+
#
|
17407
18263
|
#
|
17408
18264
|
#
|
17409
18265
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -17414,6 +18270,8 @@ module Aws::RDS
|
|
17414
18270
|
#
|
17415
18271
|
# For more information, see [ CreateDBCluster][1].
|
17416
18272
|
#
|
18273
|
+
# Valid for: Aurora DB clusters only
|
18274
|
+
#
|
17417
18275
|
#
|
17418
18276
|
#
|
17419
18277
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
|
@@ -17422,6 +18280,8 @@ module Aws::RDS
|
|
17422
18280
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
17423
18281
|
# of the DB cluster.
|
17424
18282
|
#
|
18283
|
+
# Valid for: Aurora DB clusters only
|
18284
|
+
#
|
17425
18285
|
# @option params [String] :db_cluster_parameter_group_name
|
17426
18286
|
# The name of the DB cluster parameter group to associate with this DB
|
17427
18287
|
# cluster. If this argument is omitted, the default DB cluster parameter
|
@@ -17438,16 +18298,22 @@ module Aws::RDS
|
|
17438
18298
|
#
|
17439
18299
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
17440
18300
|
#
|
18301
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18302
|
+
#
|
17441
18303
|
# @option params [Boolean] :deletion_protection
|
17442
18304
|
# A value that indicates whether the DB cluster has deletion protection
|
17443
18305
|
# enabled. The database can't be deleted when deletion protection is
|
17444
|
-
# enabled. By default, deletion protection
|
18306
|
+
# enabled. By default, deletion protection isn't enabled.
|
18307
|
+
#
|
18308
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
17445
18309
|
#
|
17446
18310
|
# @option params [Boolean] :copy_tags_to_snapshot
|
17447
18311
|
# A value that indicates whether to copy all tags from the restored DB
|
17448
18312
|
# cluster to snapshots of the restored DB cluster. The default is not to
|
17449
18313
|
# copy them.
|
17450
18314
|
#
|
18315
|
+
# Valid for: Aurora DB clusters only
|
18316
|
+
#
|
17451
18317
|
# @option params [String] :domain
|
17452
18318
|
# Specify the Active Directory directory ID to restore the DB cluster
|
17453
18319
|
# in. The domain must be created prior to this operation. Currently,
|
@@ -17457,6 +18323,8 @@ module Aws::RDS
|
|
17457
18323
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
17458
18324
|
# RDS User Guide*.
|
17459
18325
|
#
|
18326
|
+
# Valid for: Aurora DB clusters only
|
18327
|
+
#
|
17460
18328
|
#
|
17461
18329
|
#
|
17462
18330
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -17465,6 +18333,91 @@ module Aws::RDS
|
|
17465
18333
|
# Specify the name of the IAM role to be used when making API calls to
|
17466
18334
|
# the Directory Service.
|
17467
18335
|
#
|
18336
|
+
# Valid for: Aurora DB clusters only
|
18337
|
+
#
|
18338
|
+
# @option params [String] :db_cluster_instance_class
|
18339
|
+
# The compute and memory capacity of the each DB instance in the
|
18340
|
+
# Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance
|
18341
|
+
# classes are available in all Amazon Web Services Regions, or for all
|
18342
|
+
# database engines.
|
18343
|
+
#
|
18344
|
+
# For the full list of DB instance classes, and availability for your
|
18345
|
+
# engine, see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
18346
|
+
#
|
18347
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18348
|
+
#
|
18349
|
+
#
|
18350
|
+
#
|
18351
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
18352
|
+
#
|
18353
|
+
# @option params [String] :storage_type
|
18354
|
+
# Specifies the storage type to be associated with the each DB instance
|
18355
|
+
# in the Multi-AZ DB cluster.
|
18356
|
+
#
|
18357
|
+
# Valid values: `standard | gp2 | io1`
|
18358
|
+
#
|
18359
|
+
# If you specify `io1`, you must also include a value for the `Iops`
|
18360
|
+
# parameter.
|
18361
|
+
#
|
18362
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
18363
|
+
#
|
18364
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18365
|
+
#
|
18366
|
+
# @option params [Integer] :iops
|
18367
|
+
# The amount of Provisioned IOPS (input/output operations per second) to
|
18368
|
+
# be initially allocated for each DB instance in the Multi-AZ DB
|
18369
|
+
# cluster.
|
18370
|
+
#
|
18371
|
+
# For information about valid Iops values, see [Amazon RDS Provisioned
|
18372
|
+
# IOPS Storage to Improve Performance][1] in the *Amazon RDS User
|
18373
|
+
# Guide*.
|
18374
|
+
#
|
18375
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
18376
|
+
# amount for the DB instance.
|
18377
|
+
#
|
18378
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18379
|
+
#
|
18380
|
+
#
|
18381
|
+
#
|
18382
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
18383
|
+
#
|
18384
|
+
# @option params [Boolean] :publicly_accessible
|
18385
|
+
# A value that indicates whether the DB cluster is publicly accessible.
|
18386
|
+
#
|
18387
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
18388
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
18389
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
18390
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
18391
|
+
# cluster is ultimately controlled by the security group it uses. That
|
18392
|
+
# public access is not permitted if the security group assigned to the
|
18393
|
+
# DB cluster doesn't permit it.
|
18394
|
+
#
|
18395
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
18396
|
+
# cluster with a DNS name that resolves to a private IP address.
|
18397
|
+
#
|
18398
|
+
# Default: The default behavior varies depending on whether
|
18399
|
+
# `DBSubnetGroupName` is specified.
|
18400
|
+
#
|
18401
|
+
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
18402
|
+
# isn't specified, the following applies:
|
18403
|
+
#
|
18404
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
18405
|
+
# gateway attached to it, the DB cluster is private.
|
18406
|
+
#
|
18407
|
+
# * If the default VPC in the target Region has an internet gateway
|
18408
|
+
# attached to it, the DB cluster is public.
|
18409
|
+
#
|
18410
|
+
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
18411
|
+
# specified, the following applies:
|
18412
|
+
#
|
18413
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
18414
|
+
# gateway attached to it, the DB cluster is private.
|
18415
|
+
#
|
18416
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
18417
|
+
# attached to it, the DB cluster is public.
|
18418
|
+
#
|
18419
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18420
|
+
#
|
17468
18421
|
# @return [Types::RestoreDBClusterFromSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
17469
18422
|
#
|
17470
18423
|
# * {Types::RestoreDBClusterFromSnapshotResult#db_cluster #db_cluster} => Types::DBCluster
|
@@ -17523,6 +18476,10 @@ module Aws::RDS
|
|
17523
18476
|
# copy_tags_to_snapshot: false,
|
17524
18477
|
# domain: "String",
|
17525
18478
|
# domain_iam_role_name: "String",
|
18479
|
+
# db_cluster_instance_class: "String",
|
18480
|
+
# storage_type: "String",
|
18481
|
+
# iops: 1,
|
18482
|
+
# publicly_accessible: false,
|
17526
18483
|
# })
|
17527
18484
|
#
|
17528
18485
|
# @example Response structure
|
@@ -17617,6 +18574,16 @@ module Aws::RDS
|
|
17617
18574
|
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
17618
18575
|
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
17619
18576
|
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
18577
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
18578
|
+
# resp.db_cluster.storage_type #=> String
|
18579
|
+
# resp.db_cluster.iops #=> Integer
|
18580
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
18581
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
18582
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
18583
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
18584
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
18585
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
18586
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
17620
18587
|
#
|
17621
18588
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromSnapshot AWS API Documentation
|
17622
18589
|
#
|
@@ -17634,25 +18601,32 @@ module Aws::RDS
|
|
17634
18601
|
# cluster, except that the new DB cluster is created with the default DB
|
17635
18602
|
# security group.
|
17636
18603
|
#
|
17637
|
-
# <note markdown="1">
|
17638
|
-
# that DB cluster. You must invoke the `CreateDBInstance`
|
17639
|
-
# create DB instances for the restored DB cluster, specifying
|
17640
|
-
# identifier of the restored DB cluster in `DBClusterIdentifier`.
|
17641
|
-
# can create DB instances only after the
|
17642
|
-
# action has completed and the DB
|
18604
|
+
# <note markdown="1"> For Aurora, this action only restores the DB cluster, not the DB
|
18605
|
+
# instances for that DB cluster. You must invoke the `CreateDBInstance`
|
18606
|
+
# action to create DB instances for the restored DB cluster, specifying
|
18607
|
+
# the identifier of the restored DB cluster in `DBClusterIdentifier`.
|
18608
|
+
# You can create DB instances only after the
|
18609
|
+
# `RestoreDBClusterToPointInTime` action has completed and the DB
|
18610
|
+
# cluster is available.
|
17643
18611
|
#
|
17644
18612
|
# </note>
|
17645
18613
|
#
|
17646
|
-
# For more information on Amazon Aurora, see [ What
|
17647
|
-
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
18614
|
+
# For more information on Amazon Aurora DB clusters, see [ What is
|
18615
|
+
# Amazon Aurora?][1] in the *Amazon Aurora User Guide.*
|
17648
18616
|
#
|
17649
|
-
#
|
18617
|
+
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
18618
|
+
# deployments with two readable standby DB instances][2] in the *Amazon
|
18619
|
+
# RDS User Guide.*
|
18620
|
+
#
|
18621
|
+
# <note markdown="1"> The Multi-AZ DB clusters feature is in preview and is subject to
|
18622
|
+
# change.
|
17650
18623
|
#
|
17651
18624
|
# </note>
|
17652
18625
|
#
|
17653
18626
|
#
|
17654
18627
|
#
|
17655
18628
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
18629
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
17656
18630
|
#
|
17657
18631
|
# @option params [required, String] :db_cluster_identifier
|
17658
18632
|
# The name of the new DB cluster to be created.
|
@@ -17665,6 +18639,8 @@ module Aws::RDS
|
|
17665
18639
|
#
|
17666
18640
|
# * Can't end with a hyphen or contain two consecutive hyphens
|
17667
18641
|
#
|
18642
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18643
|
+
#
|
17668
18644
|
# @option params [String] :restore_type
|
17669
18645
|
# The type of restore to be performed. You can specify one of the
|
17670
18646
|
# following values:
|
@@ -17681,6 +18657,8 @@ module Aws::RDS
|
|
17681
18657
|
# If you don't specify a `RestoreType` value, then the new DB cluster
|
17682
18658
|
# is restored as a full copy of the source DB cluster.
|
17683
18659
|
#
|
18660
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18661
|
+
#
|
17684
18662
|
# @option params [required, String] :source_db_cluster_identifier
|
17685
18663
|
# The identifier of the source DB cluster from which to restore.
|
17686
18664
|
#
|
@@ -17690,6 +18668,8 @@ module Aws::RDS
|
|
17690
18668
|
#
|
17691
18669
|
# ^
|
17692
18670
|
#
|
18671
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18672
|
+
#
|
17693
18673
|
# @option params [Time,DateTime,Date,Integer,String] :restore_to_time
|
17694
18674
|
# The date and time to restore the DB cluster to.
|
17695
18675
|
#
|
@@ -17711,6 +18691,8 @@ module Aws::RDS
|
|
17711
18691
|
#
|
17712
18692
|
# Example: `2015-03-07T23:45:00Z`
|
17713
18693
|
#
|
18694
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18695
|
+
#
|
17714
18696
|
# @option params [Boolean] :use_latest_restorable_time
|
17715
18697
|
# A value that indicates whether to restore the DB cluster to the latest
|
17716
18698
|
# restorable backup time. By default, the DB cluster isn't restored to
|
@@ -17719,6 +18701,8 @@ module Aws::RDS
|
|
17719
18701
|
# Constraints: Can't be specified if `RestoreToTime` parameter is
|
17720
18702
|
# provided.
|
17721
18703
|
#
|
18704
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18705
|
+
#
|
17722
18706
|
# @option params [Integer] :port
|
17723
18707
|
# The port number on which the new DB cluster accepts connections.
|
17724
18708
|
#
|
@@ -17726,6 +18710,8 @@ module Aws::RDS
|
|
17726
18710
|
#
|
17727
18711
|
# Default: The default port for the engine.
|
17728
18712
|
#
|
18713
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18714
|
+
#
|
17729
18715
|
# @option params [String] :db_subnet_group_name
|
17730
18716
|
# The DB subnet group name to use for the new DB cluster.
|
17731
18717
|
#
|
@@ -17734,12 +18720,19 @@ module Aws::RDS
|
|
17734
18720
|
#
|
17735
18721
|
# Example: `mySubnetgroup`
|
17736
18722
|
#
|
18723
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18724
|
+
#
|
17737
18725
|
# @option params [String] :option_group_name
|
17738
18726
|
# The name of the option group for the new DB cluster.
|
17739
18727
|
#
|
18728
|
+
# DB clusters are associated with a default option group that can't be
|
18729
|
+
# modified.
|
18730
|
+
#
|
17740
18731
|
# @option params [Array<String>] :vpc_security_group_ids
|
17741
18732
|
# A list of VPC security groups that the new DB cluster belongs to.
|
17742
18733
|
#
|
18734
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18735
|
+
#
|
17743
18736
|
# @option params [Array<Types::Tag>] :tags
|
17744
18737
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
17745
18738
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -17775,14 +18768,18 @@ module Aws::RDS
|
|
17775
18768
|
# If `DBClusterIdentifier` refers to a DB cluster that isn't encrypted,
|
17776
18769
|
# then the restore request is rejected.
|
17777
18770
|
#
|
18771
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18772
|
+
#
|
17778
18773
|
# @option params [Boolean] :enable_iam_database_authentication
|
17779
18774
|
# A value that indicates whether to enable mapping of Amazon Web
|
17780
18775
|
# Services Identity and Access Management (IAM) accounts to database
|
17781
|
-
# accounts. By default, mapping
|
18776
|
+
# accounts. By default, mapping isn't enabled.
|
17782
18777
|
#
|
17783
18778
|
# For more information, see [ IAM Database Authentication][1] in the
|
17784
18779
|
# *Amazon Aurora User Guide.*
|
17785
18780
|
#
|
18781
|
+
# Valid for: Aurora DB clusters only
|
18782
|
+
#
|
17786
18783
|
#
|
17787
18784
|
#
|
17788
18785
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -17791,10 +18788,6 @@ module Aws::RDS
|
|
17791
18788
|
# The target backtrack window, in seconds. To disable backtracking, set
|
17792
18789
|
# this value to 0.
|
17793
18790
|
#
|
17794
|
-
# <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
|
17795
|
-
#
|
17796
|
-
# </note>
|
17797
|
-
#
|
17798
18791
|
# Default: 0
|
17799
18792
|
#
|
17800
18793
|
# Constraints:
|
@@ -17804,12 +18797,18 @@ module Aws::RDS
|
|
17804
18797
|
#
|
17805
18798
|
# ^
|
17806
18799
|
#
|
18800
|
+
# Valid for: Aurora MySQL DB clusters only
|
18801
|
+
#
|
17807
18802
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
17808
18803
|
# The list of logs that the restored DB cluster is to export to
|
17809
18804
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
17810
|
-
# used.
|
18805
|
+
# used.
|
18806
|
+
#
|
18807
|
+
# For more information, see [Publishing Database Logs to Amazon
|
17811
18808
|
# CloudWatch Logs][1] in the *Amazon Aurora User Guide*.
|
17812
18809
|
#
|
18810
|
+
# Valid for: Aurora DB clusters only
|
18811
|
+
#
|
17813
18812
|
#
|
17814
18813
|
#
|
17815
18814
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -17830,16 +18829,22 @@ module Aws::RDS
|
|
17830
18829
|
#
|
17831
18830
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
17832
18831
|
#
|
18832
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
18833
|
+
#
|
17833
18834
|
# @option params [Boolean] :deletion_protection
|
17834
18835
|
# A value that indicates whether the DB cluster has deletion protection
|
17835
18836
|
# enabled. The database can't be deleted when deletion protection is
|
17836
|
-
# enabled. By default, deletion protection
|
18837
|
+
# enabled. By default, deletion protection isn't enabled.
|
18838
|
+
#
|
18839
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
17837
18840
|
#
|
17838
18841
|
# @option params [Boolean] :copy_tags_to_snapshot
|
17839
18842
|
# A value that indicates whether to copy all tags from the restored DB
|
17840
18843
|
# cluster to snapshots of the restored DB cluster. The default is not to
|
17841
18844
|
# copy them.
|
17842
18845
|
#
|
18846
|
+
# Valid for: Aurora DB clusters only
|
18847
|
+
#
|
17843
18848
|
# @option params [String] :domain
|
17844
18849
|
# Specify the Active Directory directory ID to restore the DB cluster
|
17845
18850
|
# in. The domain must be created prior to this operation.
|
@@ -17849,6 +18854,8 @@ module Aws::RDS
|
|
17849
18854
|
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
17850
18855
|
# Aurora User Guide*.
|
17851
18856
|
#
|
18857
|
+
# Valid for: Aurora DB clusters only
|
18858
|
+
#
|
17852
18859
|
#
|
17853
18860
|
#
|
17854
18861
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
@@ -17857,10 +18864,14 @@ module Aws::RDS
|
|
17857
18864
|
# Specify the name of the IAM role to be used when making API calls to
|
17858
18865
|
# the Directory Service.
|
17859
18866
|
#
|
18867
|
+
# Valid for: Aurora DB clusters only
|
18868
|
+
#
|
17860
18869
|
# @option params [Types::ScalingConfiguration] :scaling_configuration
|
17861
18870
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
17862
18871
|
# of the DB cluster.
|
17863
18872
|
#
|
18873
|
+
# Valid for: Aurora DB clusters only
|
18874
|
+
#
|
17864
18875
|
# @option params [String] :engine_mode
|
17865
18876
|
# The engine mode of the new cluster. Specify `provisioned` or
|
17866
18877
|
# `serverless`, depending on the type of the cluster you are creating.
|
@@ -17869,6 +18880,90 @@ module Aws::RDS
|
|
17869
18880
|
# clone that is an Aurora Serverless cluster, the original cluster must
|
17870
18881
|
# be an Aurora Serverless cluster or an encrypted provisioned cluster.
|
17871
18882
|
#
|
18883
|
+
# Valid for: Aurora DB clusters only
|
18884
|
+
#
|
18885
|
+
# @option params [String] :db_cluster_instance_class
|
18886
|
+
# The compute and memory capacity of the each DB instance in the
|
18887
|
+
# Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance
|
18888
|
+
# classes are available in all Amazon Web Services Regions, or for all
|
18889
|
+
# database engines.
|
18890
|
+
#
|
18891
|
+
# For the full list of DB instance classes, and availability for your
|
18892
|
+
# engine, see [DB instance class][1] in the *Amazon RDS User Guide.*
|
18893
|
+
#
|
18894
|
+
# Valid for: Multi-AZ DB clusters only
|
18895
|
+
#
|
18896
|
+
#
|
18897
|
+
#
|
18898
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
18899
|
+
#
|
18900
|
+
# @option params [String] :storage_type
|
18901
|
+
# Specifies the storage type to be associated with the each DB instance
|
18902
|
+
# in the Multi-AZ DB cluster.
|
18903
|
+
#
|
18904
|
+
# Valid values: `standard | gp2 | io1`
|
18905
|
+
#
|
18906
|
+
# If you specify `io1`, also include a value for the `Iops` parameter.
|
18907
|
+
#
|
18908
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
18909
|
+
#
|
18910
|
+
# Valid for: Multi-AZ DB clusters only
|
18911
|
+
#
|
18912
|
+
# @option params [Boolean] :publicly_accessible
|
18913
|
+
# A value that indicates whether the DB cluster is publicly accessible.
|
18914
|
+
#
|
18915
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
18916
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
18917
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
18918
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
18919
|
+
# cluster is ultimately controlled by the security group it uses. That
|
18920
|
+
# public access is not permitted if the security group assigned to the
|
18921
|
+
# DB cluster doesn't permit it.
|
18922
|
+
#
|
18923
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
18924
|
+
# cluster with a DNS name that resolves to a private IP address.
|
18925
|
+
#
|
18926
|
+
# Default: The default behavior varies depending on whether
|
18927
|
+
# `DBSubnetGroupName` is specified.
|
18928
|
+
#
|
18929
|
+
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
18930
|
+
# isn't specified, the following applies:
|
18931
|
+
#
|
18932
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
18933
|
+
# gateway attached to it, the DB cluster is private.
|
18934
|
+
#
|
18935
|
+
# * If the default VPC in the target Region has an internet gateway
|
18936
|
+
# attached to it, the DB cluster is public.
|
18937
|
+
#
|
18938
|
+
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
18939
|
+
# specified, the following applies:
|
18940
|
+
#
|
18941
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
18942
|
+
# gateway attached to it, the DB cluster is private.
|
18943
|
+
#
|
18944
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
18945
|
+
# attached to it, the DB cluster is public.
|
18946
|
+
#
|
18947
|
+
# Valid for: Multi-AZ DB clusters only
|
18948
|
+
#
|
18949
|
+
# @option params [Integer] :iops
|
18950
|
+
# The amount of Provisioned IOPS (input/output operations per second) to
|
18951
|
+
# be initially allocated for each DB instance in the Multi-AZ DB
|
18952
|
+
# cluster.
|
18953
|
+
#
|
18954
|
+
# For information about valid `Iops` values, see [Amazon RDS Provisioned
|
18955
|
+
# IOPS storage to improve performance][1] in the *Amazon RDS User
|
18956
|
+
# Guide*.
|
18957
|
+
#
|
18958
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
18959
|
+
# amount for the DB instance.
|
18960
|
+
#
|
18961
|
+
# Valid for: Multi-AZ DB clusters only
|
18962
|
+
#
|
18963
|
+
#
|
18964
|
+
#
|
18965
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
18966
|
+
#
|
17872
18967
|
# @return [Types::RestoreDBClusterToPointInTimeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
17873
18968
|
#
|
17874
18969
|
# * {Types::RestoreDBClusterToPointInTimeResult#db_cluster #db_cluster} => Types::DBCluster
|
@@ -17926,6 +19021,10 @@ module Aws::RDS
|
|
17926
19021
|
# seconds_before_timeout: 1,
|
17927
19022
|
# },
|
17928
19023
|
# engine_mode: "String",
|
19024
|
+
# db_cluster_instance_class: "String",
|
19025
|
+
# storage_type: "String",
|
19026
|
+
# publicly_accessible: false,
|
19027
|
+
# iops: 1,
|
17929
19028
|
# })
|
17930
19029
|
#
|
17931
19030
|
# @example Response structure
|
@@ -18020,6 +19119,16 @@ module Aws::RDS
|
|
18020
19119
|
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
18021
19120
|
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
18022
19121
|
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
19122
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
19123
|
+
# resp.db_cluster.storage_type #=> String
|
19124
|
+
# resp.db_cluster.iops #=> Integer
|
19125
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
19126
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
19127
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
19128
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
19129
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
19130
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
19131
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
18023
19132
|
#
|
18024
19133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterToPointInTime AWS API Documentation
|
18025
19134
|
#
|
@@ -18083,10 +19192,10 @@ module Aws::RDS
|
|
18083
19192
|
#
|
18084
19193
|
# @option params [String] :db_instance_class
|
18085
19194
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
18086
|
-
# example
|
18087
|
-
#
|
18088
|
-
#
|
18089
|
-
#
|
19195
|
+
# example db.m4.large. Not all DB instance classes are available in all
|
19196
|
+
# Amazon Web Services Regions, or for all database engines. For the full
|
19197
|
+
# list of DB instance classes, and availability for your engine, see [DB
|
19198
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
18090
19199
|
#
|
18091
19200
|
# Default: The same DBInstanceClass as the original DB instance.
|
18092
19201
|
#
|
@@ -18131,12 +19240,13 @@ module Aws::RDS
|
|
18131
19240
|
# @option params [Boolean] :publicly_accessible
|
18132
19241
|
# A value that indicates whether the DB instance is publicly accessible.
|
18133
19242
|
#
|
18134
|
-
# When the DB instance is publicly accessible, its
|
18135
|
-
# to the private IP address from within the DB
|
18136
|
-
#
|
18137
|
-
#
|
18138
|
-
#
|
18139
|
-
#
|
19243
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
19244
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
19245
|
+
# instance's virtual private cloud (VPC). It resolves to the public IP
|
19246
|
+
# address from outside of the DB instance's VPC. Access to the DB
|
19247
|
+
# instance is ultimately controlled by the security group it uses. That
|
19248
|
+
# public access is not permitted if the security group assigned to the
|
19249
|
+
# DB instance doesn't permit it.
|
18140
19250
|
#
|
18141
19251
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
18142
19252
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -18352,7 +19462,7 @@ module Aws::RDS
|
|
18352
19462
|
# @option params [Boolean] :deletion_protection
|
18353
19463
|
# A value that indicates whether the DB instance has deletion protection
|
18354
19464
|
# enabled. The database can't be deleted when deletion protection is
|
18355
|
-
# enabled. By default, deletion protection
|
19465
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
18356
19466
|
# information, see [ Deleting a DB Instance][1].
|
18357
19467
|
#
|
18358
19468
|
#
|
@@ -18754,8 +19864,8 @@ module Aws::RDS
|
|
18754
19864
|
# </note>
|
18755
19865
|
#
|
18756
19866
|
# @option params [required, String] :db_instance_class
|
18757
|
-
# The compute and memory capacity of the DB instance, for example
|
18758
|
-
#
|
19867
|
+
# The compute and memory capacity of the DB instance, for example
|
19868
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
18759
19869
|
# Web Services Regions, or for all database engines. For the full list
|
18760
19870
|
# of DB instance classes, and availability for your engine, see [DB
|
18761
19871
|
# Instance Class][1] in the *Amazon RDS User Guide.*
|
@@ -18916,12 +20026,13 @@ module Aws::RDS
|
|
18916
20026
|
# @option params [Boolean] :publicly_accessible
|
18917
20027
|
# A value that indicates whether the DB instance is publicly accessible.
|
18918
20028
|
#
|
18919
|
-
# When the DB instance is publicly accessible, its
|
18920
|
-
# to the private IP address from within the DB
|
18921
|
-
#
|
18922
|
-
#
|
18923
|
-
#
|
18924
|
-
#
|
20029
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
20030
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
20031
|
+
# instance's virtual private cloud (VPC). It resolves to the public IP
|
20032
|
+
# address from outside of the DB instance's VPC. Access to the DB
|
20033
|
+
# instance is ultimately controlled by the security group it uses. That
|
20034
|
+
# public access is not permitted if the security group assigned to the
|
20035
|
+
# DB instance doesn't permit it.
|
18925
20036
|
#
|
18926
20037
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
18927
20038
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -18999,7 +20110,7 @@ module Aws::RDS
|
|
18999
20110
|
# @option params [Boolean] :enable_iam_database_authentication
|
19000
20111
|
# A value that indicates whether to enable mapping of Amazon Web
|
19001
20112
|
# Services Identity and Access Management (IAM) accounts to database
|
19002
|
-
# accounts. By default, mapping
|
20113
|
+
# accounts. By default, mapping isn't enabled.
|
19003
20114
|
#
|
19004
20115
|
# For more information about IAM database authentication, see [ IAM
|
19005
20116
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -19080,7 +20191,7 @@ module Aws::RDS
|
|
19080
20191
|
# @option params [Boolean] :deletion_protection
|
19081
20192
|
# A value that indicates whether the DB instance has deletion protection
|
19082
20193
|
# enabled. The database can't be deleted when deletion protection is
|
19083
|
-
# enabled. By default, deletion protection
|
20194
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
19084
20195
|
# information, see [ Deleting a DB Instance][1].
|
19085
20196
|
#
|
19086
20197
|
#
|
@@ -19374,10 +20485,10 @@ module Aws::RDS
|
|
19374
20485
|
#
|
19375
20486
|
# @option params [String] :db_instance_class
|
19376
20487
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
19377
|
-
# example
|
19378
|
-
#
|
19379
|
-
#
|
19380
|
-
#
|
20488
|
+
# example db.m4.large. Not all DB instance classes are available in all
|
20489
|
+
# Amazon Web Services Regions, or for all database engines. For the full
|
20490
|
+
# list of DB instance classes, and availability for your engine, see [DB
|
20491
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
19381
20492
|
#
|
19382
20493
|
# Default: The same DBInstanceClass as the original DB instance.
|
19383
20494
|
#
|
@@ -19422,12 +20533,13 @@ module Aws::RDS
|
|
19422
20533
|
# @option params [Boolean] :publicly_accessible
|
19423
20534
|
# A value that indicates whether the DB instance is publicly accessible.
|
19424
20535
|
#
|
19425
|
-
# When the DB
|
19426
|
-
# to the private IP address from within the DB
|
19427
|
-
#
|
19428
|
-
#
|
19429
|
-
#
|
19430
|
-
#
|
20536
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
20537
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
20538
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
20539
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
20540
|
+
# cluster is ultimately controlled by the security group it uses. That
|
20541
|
+
# public access isn't permitted if the security group assigned to the
|
20542
|
+
# DB cluster doesn't permit it.
|
19431
20543
|
#
|
19432
20544
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
19433
20545
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -19577,7 +20689,7 @@ module Aws::RDS
|
|
19577
20689
|
# @option params [Boolean] :enable_iam_database_authentication
|
19578
20690
|
# A value that indicates whether to enable mapping of Amazon Web
|
19579
20691
|
# Services Identity and Access Management (IAM) accounts to database
|
19580
|
-
# accounts. By default, mapping
|
20692
|
+
# accounts. By default, mapping isn't enabled.
|
19581
20693
|
#
|
19582
20694
|
# This setting doesn't apply to RDS Custom.
|
19583
20695
|
#
|
@@ -19634,7 +20746,7 @@ module Aws::RDS
|
|
19634
20746
|
# @option params [Boolean] :deletion_protection
|
19635
20747
|
# A value that indicates whether the DB instance has deletion protection
|
19636
20748
|
# enabled. The database can't be deleted when deletion protection is
|
19637
|
-
# enabled. By default, deletion protection
|
20749
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
19638
20750
|
# information, see [ Deleting a DB Instance][1].
|
19639
20751
|
#
|
19640
20752
|
#
|
@@ -20305,6 +21417,16 @@ module Aws::RDS
|
|
20305
21417
|
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
20306
21418
|
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
20307
21419
|
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
21420
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
21421
|
+
# resp.db_cluster.storage_type #=> String
|
21422
|
+
# resp.db_cluster.iops #=> Integer
|
21423
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
21424
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
21425
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
21426
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
21427
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
21428
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
21429
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
20308
21430
|
#
|
20309
21431
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBCluster AWS API Documentation
|
20310
21432
|
#
|
@@ -20885,6 +22007,16 @@ module Aws::RDS
|
|
20885
22007
|
# resp.db_cluster.pending_modified_values.master_user_password #=> String
|
20886
22008
|
# resp.db_cluster.pending_modified_values.iam_database_authentication_enabled #=> Boolean
|
20887
22009
|
# resp.db_cluster.pending_modified_values.engine_version #=> String
|
22010
|
+
# resp.db_cluster.db_cluster_instance_class #=> String
|
22011
|
+
# resp.db_cluster.storage_type #=> String
|
22012
|
+
# resp.db_cluster.iops #=> Integer
|
22013
|
+
# resp.db_cluster.publicly_accessible #=> Boolean
|
22014
|
+
# resp.db_cluster.auto_minor_version_upgrade #=> Boolean
|
22015
|
+
# resp.db_cluster.monitoring_interval #=> Integer
|
22016
|
+
# resp.db_cluster.monitoring_role_arn #=> String
|
22017
|
+
# resp.db_cluster.performance_insights_enabled #=> Boolean
|
22018
|
+
# resp.db_cluster.performance_insights_kms_key_id #=> String
|
22019
|
+
# resp.db_cluster.performance_insights_retention_period #=> Integer
|
20888
22020
|
#
|
20889
22021
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBCluster AWS API Documentation
|
20890
22022
|
#
|
@@ -21159,7 +22291,7 @@ module Aws::RDS
|
|
21159
22291
|
params: params,
|
21160
22292
|
config: config)
|
21161
22293
|
context[:gem_name] = 'aws-sdk-rds'
|
21162
|
-
context[:gem_version] = '1.
|
22294
|
+
context[:gem_version] = '1.132.0'
|
21163
22295
|
Seahorse::Client::Request.new(handlers, context)
|
21164
22296
|
end
|
21165
22297
|
|