aws-sdk-rds 1.147.0 → 1.148.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +242 -405
- data/lib/aws-sdk-rds/db_cluster.rb +37 -96
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +22 -25
- data/lib/aws-sdk-rds/db_instance.rb +45 -173
- data/lib/aws-sdk-rds/db_snapshot.rb +23 -29
- data/lib/aws-sdk-rds/resource.rb +43 -134
- data/lib/aws-sdk-rds/types.rb +157 -395
- data/lib/aws-sdk-rds/waiters.rb +137 -0
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -765,7 +765,7 @@ module Aws::RDS
|
|
765
765
|
# For more information on backtracking, see [ Backtracking an Aurora DB
|
766
766
|
# Cluster][1] in the *Amazon Aurora User Guide*.
|
767
767
|
#
|
768
|
-
# <note markdown="1"> This action applies
|
768
|
+
# <note markdown="1"> This action only applies to Aurora MySQL DB clusters.
|
769
769
|
#
|
770
770
|
# </note>
|
771
771
|
#
|
@@ -1020,16 +1020,60 @@ module Aws::RDS
|
|
1020
1020
|
#
|
1021
1021
|
# You can copy an encrypted DB cluster snapshot from another Amazon Web
|
1022
1022
|
# Services Region. In that case, the Amazon Web Services Region where
|
1023
|
-
# you call the `CopyDBClusterSnapshot`
|
1024
|
-
#
|
1025
|
-
#
|
1026
|
-
#
|
1023
|
+
# you call the `CopyDBClusterSnapshot` action is the destination Amazon
|
1024
|
+
# Web Services Region for the encrypted DB cluster snapshot to be copied
|
1025
|
+
# to. To copy an encrypted DB cluster snapshot from another Amazon Web
|
1026
|
+
# Services Region, you must provide the following values:
|
1027
1027
|
#
|
1028
1028
|
# * `KmsKeyId` - The Amazon Web Services Key Management System (Amazon
|
1029
1029
|
# Web Services KMS) key identifier for the key to use to encrypt the
|
1030
1030
|
# copy of the DB cluster snapshot in the destination Amazon Web
|
1031
1031
|
# Services Region.
|
1032
1032
|
#
|
1033
|
+
# * `PreSignedUrl` - A URL that contains a Signature Version 4 signed
|
1034
|
+
# request for the `CopyDBClusterSnapshot` action to be called in the
|
1035
|
+
# source Amazon Web Services Region where the DB cluster snapshot is
|
1036
|
+
# copied from. The pre-signed URL must be a valid request for the
|
1037
|
+
# `CopyDBClusterSnapshot` API action that can be executed in the
|
1038
|
+
# source Amazon Web Services Region that contains the encrypted DB
|
1039
|
+
# cluster snapshot to be copied.
|
1040
|
+
#
|
1041
|
+
# The pre-signed URL request must contain the following parameter
|
1042
|
+
# values:
|
1043
|
+
#
|
1044
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
1045
|
+
# KMS key to use to encrypt the copy of the DB cluster snapshot in
|
1046
|
+
# the destination Amazon Web Services Region. This is the same
|
1047
|
+
# identifier for both the `CopyDBClusterSnapshot` action that is
|
1048
|
+
# called in the destination Amazon Web Services Region, and the
|
1049
|
+
# action contained in the pre-signed URL.
|
1050
|
+
#
|
1051
|
+
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
1052
|
+
# that the DB cluster snapshot is to be created in.
|
1053
|
+
#
|
1054
|
+
# * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot
|
1055
|
+
# identifier for the encrypted DB cluster snapshot to be copied.
|
1056
|
+
# This identifier must be in the Amazon Resource Name (ARN) format
|
1057
|
+
# for the source Amazon Web Services Region. For example, if you are
|
1058
|
+
# copying an encrypted DB cluster snapshot from the us-west-2 Amazon
|
1059
|
+
# Web Services Region, then your `SourceDBClusterSnapshotIdentifier`
|
1060
|
+
# looks like the following example:
|
1061
|
+
# `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115`.
|
1062
|
+
#
|
1063
|
+
# To learn how to generate a Signature Version 4 signed request, see [
|
1064
|
+
# Authenticating Requests: Using Query Parameters (Amazon Web Services
|
1065
|
+
# Signature Version 4)][1] and [ Signature Version 4 Signing
|
1066
|
+
# Process][2].
|
1067
|
+
#
|
1068
|
+
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
1069
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
1070
|
+
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
1071
|
+
# autogenerates a pre-signed URL that is a valid request for the
|
1072
|
+
# operation that can be executed in the source Amazon Web Services
|
1073
|
+
# Region.
|
1074
|
+
#
|
1075
|
+
# </note>
|
1076
|
+
#
|
1033
1077
|
# * `TargetDBClusterSnapshotIdentifier` - The identifier for the new
|
1034
1078
|
# copy of the DB cluster snapshot in the destination Amazon Web
|
1035
1079
|
# Services Region.
|
@@ -1038,7 +1082,7 @@ module Aws::RDS
|
|
1038
1082
|
# identifier for the encrypted DB cluster snapshot to be copied. This
|
1039
1083
|
# identifier must be in the ARN format for the source Amazon Web
|
1040
1084
|
# Services Region and is the same value as the
|
1041
|
-
# `SourceDBClusterSnapshotIdentifier` in the
|
1085
|
+
# `SourceDBClusterSnapshotIdentifier` in the pre-signed URL.
|
1042
1086
|
#
|
1043
1087
|
# To cancel the copy operation once it is in progress, delete the target
|
1044
1088
|
# DB cluster snapshot identified by `TargetDBClusterSnapshotIdentifier`
|
@@ -1046,20 +1090,22 @@ module Aws::RDS
|
|
1046
1090
|
#
|
1047
1091
|
# For more information on copying encrypted Amazon Aurora DB cluster
|
1048
1092
|
# snapshots from one Amazon Web Services Region to another, see [
|
1049
|
-
# Copying a Snapshot][
|
1093
|
+
# Copying a Snapshot][3] in the *Amazon Aurora User Guide*.
|
1050
1094
|
#
|
1051
1095
|
# For more information on Amazon Aurora DB clusters, see [ What is
|
1052
|
-
# Amazon Aurora?][
|
1096
|
+
# Amazon Aurora?][4] in the *Amazon Aurora User Guide*.
|
1053
1097
|
#
|
1054
1098
|
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
1055
|
-
# deployments with two readable standby DB instances][
|
1099
|
+
# deployments with two readable standby DB instances][5] in the *Amazon
|
1056
1100
|
# RDS User Guide*.
|
1057
1101
|
#
|
1058
1102
|
#
|
1059
1103
|
#
|
1060
|
-
# [1]: https://docs.aws.amazon.com/
|
1061
|
-
# [2]: https://docs.aws.amazon.com/
|
1062
|
-
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/
|
1104
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
1105
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1106
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html
|
1107
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
1108
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
1063
1109
|
#
|
1064
1110
|
# @option params [required, String] :source_db_cluster_snapshot_identifier
|
1065
1111
|
# The identifier of the DB cluster snapshot to copy. This parameter
|
@@ -1127,30 +1173,26 @@ module Aws::RDS
|
|
1127
1173
|
# the `KmsKeyId` parameter, an error is returned.
|
1128
1174
|
#
|
1129
1175
|
# @option params [String] :pre_signed_url
|
1130
|
-
#
|
1131
|
-
#
|
1132
|
-
#
|
1133
|
-
#
|
1134
|
-
#
|
1135
|
-
# copying an encrypted DB cluster
|
1136
|
-
#
|
1137
|
-
# encrypted DB cluster snapshot in the same Amazon Web Services Region.
|
1138
|
-
#
|
1139
|
-
# This setting applies only to Amazon Web Services GovCloud (US)
|
1140
|
-
# Regions. It's ignored in other Amazon Web Services Regions.
|
1176
|
+
# The URL that contains a Signature Version 4 signed request for the
|
1177
|
+
# `CopyDBClusterSnapshot` API action in the Amazon Web Services Region
|
1178
|
+
# that contains the source DB cluster snapshot to copy. The
|
1179
|
+
# `PreSignedUrl` parameter must be used when copying an encrypted DB
|
1180
|
+
# cluster snapshot from another Amazon Web Services Region. Don't
|
1181
|
+
# specify `PreSignedUrl` when you are copying an encrypted DB cluster
|
1182
|
+
# snapshot in the same Amazon Web Services Region.
|
1141
1183
|
#
|
1142
|
-
# The
|
1143
|
-
# `CopyDBClusterSnapshot` API
|
1184
|
+
# The pre-signed URL must be a valid request for the
|
1185
|
+
# `CopyDBClusterSnapshot` API action that can be executed in the source
|
1144
1186
|
# Amazon Web Services Region that contains the encrypted DB cluster
|
1145
|
-
# snapshot to
|
1146
|
-
# parameter values:
|
1187
|
+
# snapshot to be copied. The pre-signed URL request must contain the
|
1188
|
+
# following parameter values:
|
1147
1189
|
#
|
1148
|
-
# * `KmsKeyId` - The KMS key identifier for the KMS
|
1149
|
-
# encrypt the copy of the DB cluster snapshot in the
|
1150
|
-
# Amazon Web Services Region. This is the same identifier
|
1151
|
-
# `CopyDBClusterSnapshot`
|
1152
|
-
# Amazon Web Services Region, and the
|
1153
|
-
#
|
1190
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS
|
1191
|
+
# key to use to encrypt the copy of the DB cluster snapshot in the
|
1192
|
+
# destination Amazon Web Services Region. This is the same identifier
|
1193
|
+
# for both the `CopyDBClusterSnapshot` action that is called in the
|
1194
|
+
# destination Amazon Web Services Region, and the action contained in
|
1195
|
+
# the pre-signed URL.
|
1154
1196
|
#
|
1155
1197
|
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
1156
1198
|
# that the DB cluster snapshot is to be created in.
|
@@ -1172,8 +1214,9 @@ module Aws::RDS
|
|
1172
1214
|
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
1173
1215
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
1174
1216
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
1175
|
-
# autogenerates a
|
1176
|
-
# operation that can
|
1217
|
+
# autogenerates a pre-signed URL that is a valid request for the
|
1218
|
+
# operation that can be executed in the source Amazon Web Services
|
1219
|
+
# Region.
|
1177
1220
|
#
|
1178
1221
|
# </note>
|
1179
1222
|
#
|
@@ -1372,7 +1415,7 @@ module Aws::RDS
|
|
1372
1415
|
#
|
1373
1416
|
# You can copy a snapshot from one Amazon Web Services Region to
|
1374
1417
|
# another. In that case, the Amazon Web Services Region where you call
|
1375
|
-
# the `CopyDBSnapshot`
|
1418
|
+
# the `CopyDBSnapshot` action is the destination Amazon Web Services
|
1376
1419
|
# Region for the DB snapshot copy.
|
1377
1420
|
#
|
1378
1421
|
# This command doesn't apply to RDS Custom.
|
@@ -1400,7 +1443,8 @@ module Aws::RDS
|
|
1400
1443
|
# must be the Amazon Resource Name (ARN) of the shared DB snapshot.
|
1401
1444
|
#
|
1402
1445
|
# If you are copying an encrypted snapshot this parameter must be in the
|
1403
|
-
# ARN format for the source Amazon Web Services Region
|
1446
|
+
# ARN format for the source Amazon Web Services Region, and must match
|
1447
|
+
# the `SourceDBSnapshotIdentifier` in the `PreSignedUrl` parameter.
|
1404
1448
|
#
|
1405
1449
|
# Constraints:
|
1406
1450
|
#
|
@@ -1466,46 +1510,39 @@ module Aws::RDS
|
|
1466
1510
|
# snapshot to the target DB snapshot. By default, tags are not copied.
|
1467
1511
|
#
|
1468
1512
|
# @option params [String] :pre_signed_url
|
1469
|
-
#
|
1470
|
-
#
|
1471
|
-
#
|
1472
|
-
# Amazon Web Services Region that contains the source DB snapshot to
|
1473
|
-
# copy.
|
1474
|
-
#
|
1475
|
-
# This setting applies only to Amazon Web Services GovCloud (US)
|
1476
|
-
# Regions. It's ignored in other Amazon Web Services Regions.
|
1513
|
+
# The URL that contains a Signature Version 4 signed request for the
|
1514
|
+
# `CopyDBSnapshot` API action in the source Amazon Web Services Region
|
1515
|
+
# that contains the source DB snapshot to copy.
|
1477
1516
|
#
|
1478
1517
|
# You must specify this parameter when you copy an encrypted DB snapshot
|
1479
1518
|
# from another Amazon Web Services Region by using the Amazon RDS API.
|
1480
1519
|
# Don't specify `PreSignedUrl` when you are copying an encrypted DB
|
1481
1520
|
# snapshot in the same Amazon Web Services Region.
|
1482
1521
|
#
|
1483
|
-
# The presigned URL must be a valid request for the
|
1484
|
-
#
|
1485
|
-
#
|
1486
|
-
#
|
1487
|
-
# parameter values:
|
1522
|
+
# The presigned URL must be a valid request for the `CopyDBSnapshot` API
|
1523
|
+
# action that can be executed in the source Amazon Web Services Region
|
1524
|
+
# that contains the encrypted DB snapshot to be copied. The presigned
|
1525
|
+
# URL request must contain the following parameter values:
|
1488
1526
|
#
|
1489
1527
|
# * `DestinationRegion` - The Amazon Web Services Region that the
|
1490
1528
|
# encrypted DB snapshot is copied to. This Amazon Web Services Region
|
1491
|
-
# is the same one where the `CopyDBSnapshot`
|
1529
|
+
# is the same one where the `CopyDBSnapshot` action is called that
|
1492
1530
|
# contains this presigned URL.
|
1493
1531
|
#
|
1494
1532
|
# For example, if you copy an encrypted DB snapshot from the us-west-2
|
1495
1533
|
# Amazon Web Services Region to the us-east-1 Amazon Web Services
|
1496
|
-
# Region, then you call the `CopyDBSnapshot`
|
1497
|
-
#
|
1498
|
-
#
|
1499
|
-
#
|
1500
|
-
#
|
1501
|
-
#
|
1502
|
-
#
|
1503
|
-
# * `KmsKeyId` - The KMS key identifier for the KMS
|
1504
|
-
# encrypt the copy of the DB snapshot in the destination
|
1505
|
-
# Services Region. This is the same identifier for both the
|
1506
|
-
# `CopyDBSnapshot`
|
1507
|
-
#
|
1508
|
-
# URL.
|
1534
|
+
# Region, then you call the `CopyDBSnapshot` action in the us-east-1
|
1535
|
+
# Amazon Web Services Region and provide a presigned URL that contains
|
1536
|
+
# a call to the `CopyDBSnapshot` action in the us-west-2 Amazon Web
|
1537
|
+
# Services Region. For this example, the `DestinationRegion` in the
|
1538
|
+
# presigned URL must be set to the us-east-1 Amazon Web Services
|
1539
|
+
# Region.
|
1540
|
+
#
|
1541
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS
|
1542
|
+
# key to use to encrypt the copy of the DB snapshot in the destination
|
1543
|
+
# Amazon Web Services Region. This is the same identifier for both the
|
1544
|
+
# `CopyDBSnapshot` action that is called in the destination Amazon Web
|
1545
|
+
# Services Region, and the action contained in the presigned URL.
|
1509
1546
|
#
|
1510
1547
|
# * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
|
1511
1548
|
# encrypted snapshot to be copied. This identifier must be in the
|
@@ -1522,8 +1559,9 @@ module Aws::RDS
|
|
1522
1559
|
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
1523
1560
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
1524
1561
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
1525
|
-
# autogenerates a
|
1526
|
-
# operation that can
|
1562
|
+
# autogenerates a pre-signed URL that is a valid request for the
|
1563
|
+
# operation that can be executed in the source Amazon Web Services
|
1564
|
+
# Region.
|
1527
1565
|
#
|
1528
1566
|
# </note>
|
1529
1567
|
#
|
@@ -2002,7 +2040,10 @@ module Aws::RDS
|
|
2002
2040
|
#
|
2003
2041
|
# You can use the `ReplicationSourceIdentifier` parameter to create an
|
2004
2042
|
# Amazon Aurora DB cluster as a read replica of another DB cluster or
|
2005
|
-
# Amazon RDS MySQL or PostgreSQL DB instance.
|
2043
|
+
# Amazon RDS MySQL or PostgreSQL DB instance. For cross-Region
|
2044
|
+
# replication where the DB cluster identified by
|
2045
|
+
# `ReplicationSourceIdentifier` is encrypted, also specify the
|
2046
|
+
# `PreSignedUrl` parameter.
|
2006
2047
|
#
|
2007
2048
|
# For more information on Amazon Aurora, see [ What is Amazon
|
2008
2049
|
# Aurora?][1] in the *Amazon Aurora User Guide*.
|
@@ -2325,25 +2366,25 @@ module Aws::RDS
|
|
2325
2366
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2326
2367
|
#
|
2327
2368
|
# @option params [String] :pre_signed_url
|
2328
|
-
#
|
2329
|
-
#
|
2330
|
-
#
|
2331
|
-
#
|
2332
|
-
#
|
2333
|
-
#
|
2334
|
-
#
|
2335
|
-
#
|
2336
|
-
#
|
2337
|
-
#
|
2338
|
-
#
|
2339
|
-
#
|
2340
|
-
#
|
2341
|
-
# * `KmsKeyId` - The KMS key identifier for the KMS
|
2342
|
-
# encrypt the copy of the DB cluster in the destination
|
2343
|
-
# Services Region. This should refer to the same KMS key
|
2344
|
-
# `CreateDBCluster`
|
2345
|
-
# Web Services Region, and the
|
2346
|
-
# URL.
|
2369
|
+
# A URL that contains a Signature Version 4 signed request for the
|
2370
|
+
# `CreateDBCluster` action to be called in the source Amazon Web
|
2371
|
+
# Services Region where the DB cluster is replicated from. Specify
|
2372
|
+
# `PreSignedUrl` only when you are performing cross-Region replication
|
2373
|
+
# from an encrypted DB cluster.
|
2374
|
+
#
|
2375
|
+
# The pre-signed URL must be a valid request for the `CreateDBCluster`
|
2376
|
+
# API action that can be executed in the source Amazon Web Services
|
2377
|
+
# Region that contains the encrypted DB cluster to be copied.
|
2378
|
+
#
|
2379
|
+
# The pre-signed URL request must contain the following parameter
|
2380
|
+
# values:
|
2381
|
+
#
|
2382
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS
|
2383
|
+
# key to use to encrypt the copy of the DB cluster in the destination
|
2384
|
+
# Amazon Web Services Region. This should refer to the same KMS key
|
2385
|
+
# for both the `CreateDBCluster` action that is called in the
|
2386
|
+
# destination Amazon Web Services Region, and the action contained in
|
2387
|
+
# the pre-signed URL.
|
2347
2388
|
#
|
2348
2389
|
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
2349
2390
|
# that Aurora read replica will be created in.
|
@@ -2364,8 +2405,9 @@ module Aws::RDS
|
|
2364
2405
|
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
2365
2406
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
2366
2407
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
2367
|
-
# autogenerates a
|
2368
|
-
# operation that can
|
2408
|
+
# autogenerates a pre-signed URL that is a valid request for the
|
2409
|
+
# operation that can be executed in the source Amazon Web Services
|
2410
|
+
# Region.
|
2369
2411
|
#
|
2370
2412
|
# </note>
|
2371
2413
|
#
|
@@ -2382,7 +2424,7 @@ module Aws::RDS
|
|
2382
2424
|
# accounts. By default, mapping isn't enabled.
|
2383
2425
|
#
|
2384
2426
|
# For more information, see [ IAM Database Authentication][1] in the
|
2385
|
-
# *Amazon Aurora User Guide
|
2427
|
+
# *Amazon Aurora User Guide.*.
|
2386
2428
|
#
|
2387
2429
|
# Valid for: Aurora DB clusters only
|
2388
2430
|
#
|
@@ -2456,9 +2498,6 @@ module Aws::RDS
|
|
2456
2498
|
# The `multimaster` engine mode only applies for DB clusters created
|
2457
2499
|
# with Aurora MySQL version 5.6.10a.
|
2458
2500
|
#
|
2459
|
-
# The `serverless` engine mode only applies for Aurora Serverless v1 DB
|
2460
|
-
# clusters.
|
2461
|
-
#
|
2462
2501
|
# For Aurora PostgreSQL, the `global` engine mode isn't required, and
|
2463
2502
|
# both the `parallelquery` and the `multimaster` engine modes currently
|
2464
2503
|
# aren't supported.
|
@@ -2467,25 +2506,22 @@ module Aws::RDS
|
|
2467
2506
|
# information, see the following sections in the *Amazon Aurora User
|
2468
2507
|
# Guide*\:
|
2469
2508
|
#
|
2470
|
-
# * [Limitations of Aurora Serverless v1][1]
|
2471
|
-
#
|
2472
|
-
# * [Requirements for Aurora Serverless v2][2]
|
2509
|
+
# * [ Limitations of Aurora Serverless v1][1]
|
2473
2510
|
#
|
2474
|
-
# * [Limitations of Parallel Query][
|
2511
|
+
# * [ Limitations of Parallel Query][2]
|
2475
2512
|
#
|
2476
|
-
# * [Limitations of Aurora Global Databases][
|
2513
|
+
# * [ Limitations of Aurora Global Databases][3]
|
2477
2514
|
#
|
2478
|
-
# * [Limitations of Multi-Master Clusters][
|
2515
|
+
# * [ Limitations of Multi-Master Clusters][4]
|
2479
2516
|
#
|
2480
2517
|
# Valid for: Aurora DB clusters only
|
2481
2518
|
#
|
2482
2519
|
#
|
2483
2520
|
#
|
2484
2521
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
|
2485
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
2486
|
-
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
2487
|
-
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
2488
|
-
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations
|
2522
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations
|
2523
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations
|
2524
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations
|
2489
2525
|
#
|
2490
2526
|
# @option params [Types::ScalingConfiguration] :scaling_configuration
|
2491
2527
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
@@ -2727,27 +2763,8 @@ module Aws::RDS
|
|
2727
2763
|
# Valid for: Multi-AZ DB clusters only
|
2728
2764
|
#
|
2729
2765
|
# @option params [Integer] :performance_insights_retention_period
|
2730
|
-
# The
|
2731
|
-
#
|
2732
|
-
#
|
2733
|
-
# * 7
|
2734
|
-
#
|
2735
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
2736
|
-
#
|
2737
|
-
# * 731
|
2738
|
-
#
|
2739
|
-
# For example, the following values are valid:
|
2740
|
-
#
|
2741
|
-
# * 93 (3 months * 31)
|
2742
|
-
#
|
2743
|
-
# * 341 (11 months * 31)
|
2744
|
-
#
|
2745
|
-
# * 589 (19 months * 31)
|
2746
|
-
#
|
2747
|
-
# * 731
|
2748
|
-
#
|
2749
|
-
# If you specify a retention period such as 94, which isn't a valid
|
2750
|
-
# value, RDS issues an error.
|
2766
|
+
# The amount of time, in days, to retain Performance Insights data.
|
2767
|
+
# Valid values are 7 or 731 (2 years).
|
2751
2768
|
#
|
2752
2769
|
# Valid for: Multi-AZ DB clusters only
|
2753
2770
|
#
|
@@ -2980,7 +2997,7 @@ module Aws::RDS
|
|
2980
2997
|
# Creates a new custom endpoint and associates it with an Amazon Aurora
|
2981
2998
|
# DB cluster.
|
2982
2999
|
#
|
2983
|
-
# <note markdown="1"> This action applies
|
3000
|
+
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
2984
3001
|
#
|
2985
3002
|
# </note>
|
2986
3003
|
#
|
@@ -3092,9 +3109,8 @@ module Aws::RDS
|
|
3092
3109
|
# the default database for a DB cluster, such as the character set for
|
3093
3110
|
# the default database defined by the `character_set_database`
|
3094
3111
|
# parameter. You can use the *Parameter Groups* option of the [Amazon
|
3095
|
-
# RDS console][1] or the `DescribeDBClusterParameters`
|
3096
|
-
#
|
3097
|
-
# modified.
|
3112
|
+
# RDS console][1] or the `DescribeDBClusterParameters` action to verify
|
3113
|
+
# that your DB cluster parameter group has been created or modified.
|
3098
3114
|
#
|
3099
3115
|
# For more information on Amazon Aurora, see [ What is Amazon
|
3100
3116
|
# Aurora?][2] in the *Amazon Aurora User Guide*.
|
@@ -3347,23 +3363,6 @@ module Aws::RDS
|
|
3347
3363
|
|
3348
3364
|
# Creates a new DB instance.
|
3349
3365
|
#
|
3350
|
-
# The new DB instance can be an RDS DB instance, or it can be a DB
|
3351
|
-
# instance in an Aurora DB cluster. For an Aurora DB cluster, you can
|
3352
|
-
# call this operation multiple times to add more than one DB instance to
|
3353
|
-
# the cluster.
|
3354
|
-
#
|
3355
|
-
# For more information about creating an RDS DB instance, see [ Creating
|
3356
|
-
# an Amazon RDS DB instance][1] in the *Amazon RDS User Guide*.
|
3357
|
-
#
|
3358
|
-
# For more information about creating a DB instance in an Aurora DB
|
3359
|
-
# cluster, see [ Creating an Amazon Aurora DB cluster][2] in the *Amazon
|
3360
|
-
# Aurora User Guide*.
|
3361
|
-
#
|
3362
|
-
#
|
3363
|
-
#
|
3364
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html
|
3365
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html
|
3366
|
-
#
|
3367
3366
|
# @option params [String] :db_name
|
3368
3367
|
# The meaning of this parameter differs according to the database engine
|
3369
3368
|
# you use.
|
@@ -3597,16 +3596,14 @@ module Aws::RDS
|
|
3597
3596
|
#
|
3598
3597
|
# @option params [required, String] :db_instance_class
|
3599
3598
|
# The compute and memory capacity of the DB instance, for example
|
3600
|
-
# db.
|
3599
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
3601
3600
|
# Web Services Regions, or for all database engines. For the full list
|
3602
3601
|
# of DB instance classes, and availability for your engine, see [DB
|
3603
|
-
#
|
3604
|
-
# instance classes][2] in the *Amazon Aurora User Guide*.
|
3602
|
+
# Instance Class][1] in the *Amazon RDS User Guide*.
|
3605
3603
|
#
|
3606
3604
|
#
|
3607
3605
|
#
|
3608
3606
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
3609
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html
|
3610
3607
|
#
|
3611
3608
|
# @option params [required, String] :engine
|
3612
3609
|
# The name of the database engine to be used for this instance.
|
@@ -3705,9 +3702,7 @@ module Aws::RDS
|
|
3705
3702
|
# @option params [Array<String>] :db_security_groups
|
3706
3703
|
# A list of DB security groups to associate with this DB instance.
|
3707
3704
|
#
|
3708
|
-
#
|
3709
|
-
# longer used to create new DB instances. Use the `VpcSecurityGroupIds`
|
3710
|
-
# setting instead.
|
3705
|
+
# Default: The default DB security group for the database engine.
|
3711
3706
|
#
|
3712
3707
|
# @option params [Array<String>] :vpc_security_group_ids
|
3713
3708
|
# A list of Amazon EC2 VPC security groups to associate with this DB
|
@@ -3807,7 +3802,7 @@ module Aws::RDS
|
|
3807
3802
|
#
|
3808
3803
|
# * Can't be set to 0 if the DB instance is a source to read replicas
|
3809
3804
|
#
|
3810
|
-
# * Can't be set to 0 for an RDS Custom for Oracle DB instance
|
3805
|
+
# * Can't be set to 0 or 35 for an RDS Custom for Oracle DB instance
|
3811
3806
|
#
|
3812
3807
|
# @option params [String] :preferred_backup_window
|
3813
3808
|
# The daily time range during which automated backups are created if
|
@@ -3890,16 +3885,11 @@ module Aws::RDS
|
|
3890
3885
|
#
|
3891
3886
|
# This setting doesn't apply to RDS Custom.
|
3892
3887
|
#
|
3893
|
-
# **Amazon Aurora**
|
3894
|
-
#
|
3895
|
-
# Not applicable. DB instance Availability Zones (AZs) are managed by
|
3896
|
-
# the DB cluster.
|
3897
|
-
#
|
3898
3888
|
# @option params [String] :engine_version
|
3899
3889
|
# The version number of the database engine to use.
|
3900
3890
|
#
|
3901
3891
|
# For a list of valid engine versions, use the
|
3902
|
-
# `DescribeDBEngineVersions`
|
3892
|
+
# `DescribeDBEngineVersions` action.
|
3903
3893
|
#
|
3904
3894
|
# The following are the database engines and links to information about
|
3905
3895
|
# the major and minor versions that are available with Amazon RDS. Not
|
@@ -3975,10 +3965,6 @@ module Aws::RDS
|
|
3975
3965
|
#
|
3976
3966
|
# This setting doesn't apply to RDS Custom.
|
3977
3967
|
#
|
3978
|
-
# **Amazon Aurora**
|
3979
|
-
#
|
3980
|
-
# Not applicable.
|
3981
|
-
#
|
3982
3968
|
# @option params [Integer] :iops
|
3983
3969
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
3984
3970
|
# be initially allocated for the DB instance. For information about
|
@@ -3990,10 +3976,6 @@ module Aws::RDS
|
|
3990
3976
|
# instance. For SQL Server DB instances, must be a multiple between 1
|
3991
3977
|
# and 50 of the storage amount for the DB instance.
|
3992
3978
|
#
|
3993
|
-
# **Amazon Aurora**
|
3994
|
-
#
|
3995
|
-
# Not applicable. Storage is managed by the DB cluster.
|
3996
|
-
#
|
3997
3979
|
#
|
3998
3980
|
#
|
3999
3981
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
@@ -4009,10 +3991,6 @@ module Aws::RDS
|
|
4009
3991
|
#
|
4010
3992
|
# This setting doesn't apply to RDS Custom.
|
4011
3993
|
#
|
4012
|
-
# **Amazon Aurora**
|
4013
|
-
#
|
4014
|
-
# Not applicable.
|
4015
|
-
#
|
4016
3994
|
# @option params [String] :character_set_name
|
4017
3995
|
# For supported engines, this value indicates that the DB instance
|
4018
3996
|
# should be associated with the specified `CharacterSet`.
|
@@ -4083,20 +4061,12 @@ module Aws::RDS
|
|
4083
4061
|
#
|
4084
4062
|
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
4085
4063
|
#
|
4086
|
-
# **Amazon Aurora**
|
4087
|
-
#
|
4088
|
-
# Not applicable. Storage is managed by the DB cluster.
|
4089
|
-
#
|
4090
4064
|
# @option params [String] :tde_credential_arn
|
4091
4065
|
# The ARN from the key store with which to associate the instance for
|
4092
4066
|
# TDE encryption.
|
4093
4067
|
#
|
4094
4068
|
# This setting doesn't apply to RDS Custom.
|
4095
4069
|
#
|
4096
|
-
# **Amazon Aurora**
|
4097
|
-
#
|
4098
|
-
# Not applicable.
|
4099
|
-
#
|
4100
4070
|
# @option params [String] :tde_credential_password
|
4101
4071
|
# The password for the given ARN from the key store in order to access
|
4102
4072
|
# the device.
|
@@ -4153,10 +4123,6 @@ module Aws::RDS
|
|
4153
4123
|
#
|
4154
4124
|
# This setting doesn't apply to RDS Custom.
|
4155
4125
|
#
|
4156
|
-
# **Amazon Aurora**
|
4157
|
-
#
|
4158
|
-
# Not applicable. The domain is managed by the DB cluster.
|
4159
|
-
#
|
4160
4126
|
#
|
4161
4127
|
#
|
4162
4128
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -4205,10 +4171,6 @@ module Aws::RDS
|
|
4205
4171
|
#
|
4206
4172
|
# This setting doesn't apply to RDS Custom.
|
4207
4173
|
#
|
4208
|
-
# **Amazon Aurora**
|
4209
|
-
#
|
4210
|
-
# Not applicable. The domain is managed by the DB cluster.
|
4211
|
-
#
|
4212
4174
|
# @option params [Integer] :promotion_tier
|
4213
4175
|
# A value that specifies the order in which an Aurora Replica is
|
4214
4176
|
# promoted to the primary instance after a failure of the existing
|
@@ -4238,16 +4200,13 @@ module Aws::RDS
|
|
4238
4200
|
# Services Identity and Access Management (IAM) accounts to database
|
4239
4201
|
# accounts. By default, mapping isn't enabled.
|
4240
4202
|
#
|
4203
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora,
|
4204
|
+
# mapping Amazon Web Services IAM accounts to database accounts is
|
4205
|
+
# managed by the DB cluster.
|
4206
|
+
#
|
4241
4207
|
# For more information, see [ IAM Database Authentication for MySQL and
|
4242
4208
|
# PostgreSQL][1] in the *Amazon RDS User Guide*.
|
4243
4209
|
#
|
4244
|
-
# This setting doesn't apply to RDS Custom.
|
4245
|
-
#
|
4246
|
-
# **Amazon Aurora**
|
4247
|
-
#
|
4248
|
-
# Not applicable. Mapping Amazon Web Services IAM accounts to database
|
4249
|
-
# accounts is managed by the DB cluster.
|
4250
|
-
#
|
4251
4210
|
#
|
4252
4211
|
#
|
4253
4212
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -4278,27 +4237,8 @@ module Aws::RDS
|
|
4278
4237
|
# This setting doesn't apply to RDS Custom.
|
4279
4238
|
#
|
4280
4239
|
# @option params [Integer] :performance_insights_retention_period
|
4281
|
-
# The
|
4282
|
-
#
|
4283
|
-
#
|
4284
|
-
# * 7
|
4285
|
-
#
|
4286
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
4287
|
-
#
|
4288
|
-
# * 731
|
4289
|
-
#
|
4290
|
-
# For example, the following values are valid:
|
4291
|
-
#
|
4292
|
-
# * 93 (3 months * 31)
|
4293
|
-
#
|
4294
|
-
# * 341 (11 months * 31)
|
4295
|
-
#
|
4296
|
-
# * 589 (19 months * 31)
|
4297
|
-
#
|
4298
|
-
# * 731
|
4299
|
-
#
|
4300
|
-
# If you specify a retention period such as 94, which isn't a valid
|
4301
|
-
# value, RDS issues an error.
|
4240
|
+
# The amount of time, in days, to retain Performance Insights data.
|
4241
|
+
# Valid values are 7 or 731 (2 years).
|
4302
4242
|
#
|
4303
4243
|
# This setting doesn't apply to RDS Custom.
|
4304
4244
|
#
|
@@ -4347,10 +4287,6 @@ module Aws::RDS
|
|
4347
4287
|
#
|
4348
4288
|
# This setting doesn't apply to RDS Custom.
|
4349
4289
|
#
|
4350
|
-
# **Amazon Aurora**
|
4351
|
-
#
|
4352
|
-
# Not applicable.
|
4353
|
-
#
|
4354
4290
|
# @option params [Boolean] :deletion_protection
|
4355
4291
|
# A value that indicates whether the DB instance has deletion protection
|
4356
4292
|
# enabled. The database can't be deleted when deletion protection is
|
@@ -4378,10 +4314,6 @@ module Aws::RDS
|
|
4378
4314
|
#
|
4379
4315
|
# This setting doesn't apply to RDS Custom.
|
4380
4316
|
#
|
4381
|
-
# **Amazon Aurora**
|
4382
|
-
#
|
4383
|
-
# Not applicable. Storage is managed by the DB cluster.
|
4384
|
-
#
|
4385
4317
|
#
|
4386
4318
|
#
|
4387
4319
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -4709,8 +4641,8 @@ module Aws::RDS
|
|
4709
4641
|
# information, see [Working with Read Replicas][1] in the *Amazon RDS
|
4710
4642
|
# User Guide*.
|
4711
4643
|
#
|
4712
|
-
# Amazon Aurora doesn't support this
|
4713
|
-
# `CreateDBInstance`
|
4644
|
+
# Amazon Aurora doesn't support this action. Call the
|
4645
|
+
# `CreateDBInstance` action to create a DB instance for an Aurora DB
|
4714
4646
|
# cluster.
|
4715
4647
|
#
|
4716
4648
|
# All read replica DB instances are created with backups disabled. All
|
@@ -4842,7 +4774,7 @@ module Aws::RDS
|
|
4842
4774
|
# specified DB engine for a cross-Region read replica.
|
4843
4775
|
#
|
4844
4776
|
# Specifying a parameter group for this operation is only supported for
|
4845
|
-
#
|
4777
|
+
# Oracle DB instances. It isn't supported for RDS Custom.
|
4846
4778
|
#
|
4847
4779
|
# Constraints:
|
4848
4780
|
#
|
@@ -4981,16 +4913,9 @@ module Aws::RDS
|
|
4981
4913
|
# as the primary replica.
|
4982
4914
|
#
|
4983
4915
|
# @option params [String] :pre_signed_url
|
4984
|
-
#
|
4985
|
-
#
|
4986
|
-
# Region
|
4987
|
-
# request for the `CreateDBInstanceReadReplica` API operation in the
|
4988
|
-
# source Amazon Web Services Region that contains the source DB
|
4989
|
-
# instance.
|
4990
|
-
#
|
4991
|
-
# This setting applies only to Amazon Web Services GovCloud (US) Regions
|
4992
|
-
# and China Amazon Web Services Regions. It's ignored in other Amazon
|
4993
|
-
# Web Services Regions.
|
4916
|
+
# The URL that contains a Signature Version 4 signed request for the
|
4917
|
+
# `CreateDBInstanceReadReplica` API action in the source Amazon Web
|
4918
|
+
# Services Region that contains the source DB instance.
|
4994
4919
|
#
|
4995
4920
|
# You must specify this parameter when you create an encrypted read
|
4996
4921
|
# replica from another Amazon Web Services Region by using the Amazon
|
@@ -4998,31 +4923,32 @@ module Aws::RDS
|
|
4998
4923
|
# encrypted read replica in the same Amazon Web Services Region.
|
4999
4924
|
#
|
5000
4925
|
# The presigned URL must be a valid request for the
|
5001
|
-
# `CreateDBInstanceReadReplica` API
|
5002
|
-
# Amazon Web Services Region that contains the encrypted source
|
5003
|
-
# instance. The presigned URL request must contain the following
|
4926
|
+
# `CreateDBInstanceReadReplica` API action that can be executed in the
|
4927
|
+
# source Amazon Web Services Region that contains the encrypted source
|
4928
|
+
# DB instance. The presigned URL request must contain the following
|
5004
4929
|
# parameter values:
|
5005
4930
|
#
|
5006
4931
|
# * `DestinationRegion` - The Amazon Web Services Region that the
|
5007
4932
|
# encrypted read replica is created in. This Amazon Web Services
|
5008
4933
|
# Region is the same one where the `CreateDBInstanceReadReplica`
|
5009
|
-
#
|
4934
|
+
# action is called that contains this presigned URL.
|
5010
4935
|
#
|
5011
4936
|
# For example, if you create an encrypted DB instance in the us-west-1
|
5012
4937
|
# Amazon Web Services Region, from a source DB instance in the
|
5013
4938
|
# us-east-2 Amazon Web Services Region, then you call the
|
5014
|
-
# `CreateDBInstanceReadReplica`
|
4939
|
+
# `CreateDBInstanceReadReplica` action in the us-east-1 Amazon Web
|
5015
4940
|
# Services Region and provide a presigned URL that contains a call to
|
5016
|
-
# the `CreateDBInstanceReadReplica`
|
5017
|
-
#
|
5018
|
-
#
|
4941
|
+
# the `CreateDBInstanceReadReplica` action in the us-west-2 Amazon Web
|
4942
|
+
# Services Region. For this example, the `DestinationRegion` in the
|
4943
|
+
# presigned URL must be set to the us-east-1 Amazon Web Services
|
5019
4944
|
# Region.
|
5020
4945
|
#
|
5021
|
-
# * `KmsKeyId` - The KMS key identifier for the key
|
5022
|
-
# the read replica in the destination Amazon Web
|
5023
|
-
# is the same identifier for both the
|
5024
|
-
#
|
5025
|
-
# Region, and the
|
4946
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the key
|
4947
|
+
# to use to encrypt the read replica in the destination Amazon Web
|
4948
|
+
# Services Region. This is the same identifier for both the
|
4949
|
+
# `CreateDBInstanceReadReplica` action that is called in the
|
4950
|
+
# destination Amazon Web Services Region, and the action contained in
|
4951
|
+
# the presigned URL.
|
5026
4952
|
#
|
5027
4953
|
# * `SourceDBInstanceIdentifier` - The DB instance identifier for the
|
5028
4954
|
# encrypted DB instance to be replicated. This identifier must be in
|
@@ -5041,10 +4967,11 @@ module Aws::RDS
|
|
5041
4967
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
5042
4968
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
5043
4969
|
# autogenerates a presigned URL that is a valid request for the
|
5044
|
-
# operation that can
|
4970
|
+
# operation that can be executed in the source Amazon Web Services
|
4971
|
+
# Region.
|
5045
4972
|
#
|
5046
|
-
# `SourceRegion` isn't supported for SQL Server, because
|
5047
|
-
#
|
4973
|
+
# `SourceRegion` isn't supported for SQL Server, because SQL Server on
|
4974
|
+
# Amazon RDS doesn't support cross-Region read replicas.
|
5048
4975
|
#
|
5049
4976
|
# </note>
|
5050
4977
|
#
|
@@ -5098,27 +5025,8 @@ module Aws::RDS
|
|
5098
5025
|
# This setting doesn't apply to RDS Custom.
|
5099
5026
|
#
|
5100
5027
|
# @option params [Integer] :performance_insights_retention_period
|
5101
|
-
# The
|
5102
|
-
#
|
5103
|
-
#
|
5104
|
-
# * 7
|
5105
|
-
#
|
5106
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
5107
|
-
#
|
5108
|
-
# * 731
|
5109
|
-
#
|
5110
|
-
# For example, the following values are valid:
|
5111
|
-
#
|
5112
|
-
# * 93 (3 months * 31)
|
5113
|
-
#
|
5114
|
-
# * 341 (11 months * 31)
|
5115
|
-
#
|
5116
|
-
# * 589 (19 months * 31)
|
5117
|
-
#
|
5118
|
-
# * 731
|
5119
|
-
#
|
5120
|
-
# If you specify a retention period such as 94, which isn't a valid
|
5121
|
-
# value, RDS issues an error.
|
5028
|
+
# The amount of time, in days, to retain Performance Insights data.
|
5029
|
+
# Valid values are 7 or 731 (2 years).
|
5122
5030
|
#
|
5123
5031
|
# This setting doesn't apply to RDS Custom.
|
5124
5032
|
#
|
@@ -6138,11 +6046,11 @@ module Aws::RDS
|
|
6138
6046
|
req.send_request(options)
|
6139
6047
|
end
|
6140
6048
|
|
6141
|
-
# Creates an RDS event notification subscription. This
|
6142
|
-
#
|
6143
|
-
#
|
6144
|
-
#
|
6145
|
-
#
|
6049
|
+
# Creates an RDS event notification subscription. This action requires a
|
6050
|
+
# topic Amazon Resource Name (ARN) created by either the RDS console,
|
6051
|
+
# the SNS console, or the SNS API. To obtain an ARN with SNS, you must
|
6052
|
+
# create a topic in Amazon SNS and subscribe to the topic. The ARN is
|
6053
|
+
# displayed in the SNS console.
|
6146
6054
|
#
|
6147
6055
|
# You can specify the type of source (`SourceType`) that you want to be
|
6148
6056
|
# notified of and provide a list of RDS sources (`SourceIds`) that
|
@@ -6325,7 +6233,7 @@ module Aws::RDS
|
|
6325
6233
|
# existing Aurora cluster during the create operation, and this cluster
|
6326
6234
|
# becomes the primary cluster of the global database.
|
6327
6235
|
#
|
6328
|
-
# <note markdown="1"> This action applies
|
6236
|
+
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
6329
6237
|
#
|
6330
6238
|
# </note>
|
6331
6239
|
#
|
@@ -6347,9 +6255,9 @@ module Aws::RDS
|
|
6347
6255
|
# global database can't be deleted when deletion protection is enabled.
|
6348
6256
|
#
|
6349
6257
|
# @option params [String] :database_name
|
6350
|
-
# The name for your database of up to 64
|
6351
|
-
# do not provide a name, Amazon Aurora will not create a database in
|
6352
|
-
# global database cluster you are creating.
|
6258
|
+
# The name for your database of up to 64 alpha-numeric characters. If
|
6259
|
+
# you do not provide a name, Amazon Aurora will not create a database in
|
6260
|
+
# the global database cluster you are creating.
|
6353
6261
|
#
|
6354
6262
|
# @option params [Boolean] :storage_encrypted
|
6355
6263
|
# The storage encryption setting for the new global database cluster.
|
@@ -8918,6 +8826,12 @@ module Aws::RDS
|
|
8918
8826
|
# resp.db_clusters[0].serverless_v2_scaling_configuration.min_capacity #=> Float
|
8919
8827
|
# resp.db_clusters[0].serverless_v2_scaling_configuration.max_capacity #=> Float
|
8920
8828
|
#
|
8829
|
+
#
|
8830
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
8831
|
+
#
|
8832
|
+
# * db_cluster_available
|
8833
|
+
# * db_cluster_deleted
|
8834
|
+
#
|
8921
8835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusters AWS API Documentation
|
8922
8836
|
#
|
8923
8837
|
# @overload describe_db_clusters(params = {})
|
@@ -11029,19 +10943,10 @@ module Aws::RDS
|
|
11029
10943
|
# snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by
|
11030
10944
|
# providing the name as a parameter.
|
11031
10945
|
#
|
11032
|
-
# For more information on working with events, see [Monitoring Amazon
|
11033
|
-
# RDS events][1] in the *Amazon RDS User Guide* and [Monitoring Amazon
|
11034
|
-
# Aurora events][2] in the *Amazon Aurora User Guide*.
|
11035
|
-
#
|
11036
10946
|
# <note markdown="1"> By default, RDS returns events that were generated in the past hour.
|
11037
10947
|
#
|
11038
10948
|
# </note>
|
11039
10949
|
#
|
11040
|
-
#
|
11041
|
-
#
|
11042
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html
|
11043
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html
|
11044
|
-
#
|
11045
10950
|
# @option params [String] :source_identifier
|
11046
10951
|
# The identifier of the event source for which events are returned. If
|
11047
10952
|
# not specified, then all sources are included in the response.
|
@@ -12502,7 +12407,7 @@ module Aws::RDS
|
|
12502
12407
|
#
|
12503
12408
|
# An Amazon Aurora DB cluster automatically fails over to an Aurora
|
12504
12409
|
# Replica, if one exists, when the primary DB instance fails. A Multi-AZ
|
12505
|
-
# DB cluster automatically fails over to a
|
12410
|
+
# DB cluster automatically fails over to a readbable standby DB instance
|
12506
12411
|
# when the primary DB instance fails.
|
12507
12412
|
#
|
12508
12413
|
# To simulate a failure of a primary instance for testing, you can force
|
@@ -13655,27 +13560,8 @@ module Aws::RDS
|
|
13655
13560
|
# Valid for: Multi-AZ DB clusters only
|
13656
13561
|
#
|
13657
13562
|
# @option params [Integer] :performance_insights_retention_period
|
13658
|
-
# The
|
13659
|
-
#
|
13660
|
-
#
|
13661
|
-
# * 7
|
13662
|
-
#
|
13663
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
13664
|
-
#
|
13665
|
-
# * 731
|
13666
|
-
#
|
13667
|
-
# For example, the following values are valid:
|
13668
|
-
#
|
13669
|
-
# * 93 (3 months * 31)
|
13670
|
-
#
|
13671
|
-
# * 341 (11 months * 31)
|
13672
|
-
#
|
13673
|
-
# * 589 (19 months * 31)
|
13674
|
-
#
|
13675
|
-
# * 731
|
13676
|
-
#
|
13677
|
-
# If you specify a retention period such as 94, which isn't a valid
|
13678
|
-
# value, RDS issues an error.
|
13563
|
+
# The amount of time, in days, to retain Performance Insights data.
|
13564
|
+
# Valid values are 7 or 731 (2 years).
|
13679
13565
|
#
|
13680
13566
|
# Valid for: Multi-AZ DB clusters only
|
13681
13567
|
#
|
@@ -13963,7 +13849,7 @@ module Aws::RDS
|
|
13963
13849
|
# database for a DB cluster, such as the character set for the default
|
13964
13850
|
# database defined by the `character_set_database` parameter. You can
|
13965
13851
|
# use the *Parameter Groups* option of the [Amazon RDS console][1] or
|
13966
|
-
# the `DescribeDBClusterParameters`
|
13852
|
+
# the `DescribeDBClusterParameters` action to verify that your DB
|
13967
13853
|
# cluster parameter group has been created or modified.
|
13968
13854
|
#
|
13969
13855
|
# If the modified DB cluster parameter group is used by an Aurora
|
@@ -14090,7 +13976,7 @@ module Aws::RDS
|
|
14090
13976
|
# To view which Amazon Web Services accounts have access to copy or
|
14091
13977
|
# restore a manual DB cluster snapshot, or whether a manual DB cluster
|
14092
13978
|
# snapshot is public or private, use the
|
14093
|
-
# DescribeDBClusterSnapshotAttributes API
|
13979
|
+
# DescribeDBClusterSnapshotAttributes API action. The accounts are
|
14094
13980
|
# returned as values for the `restore` attribute.
|
14095
13981
|
#
|
14096
13982
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
@@ -14104,7 +13990,7 @@ module Aws::RDS
|
|
14104
13990
|
# or restore a manual DB cluster snapshot, set this value to `restore`.
|
14105
13991
|
#
|
14106
13992
|
# <note markdown="1"> To view the list of attributes available to modify, use the
|
14107
|
-
# DescribeDBClusterSnapshotAttributes API
|
13993
|
+
# DescribeDBClusterSnapshotAttributes API action.
|
14108
13994
|
#
|
14109
13995
|
# </note>
|
14110
13996
|
#
|
@@ -14216,11 +14102,10 @@ module Aws::RDS
|
|
14216
14102
|
#
|
14217
14103
|
# @option params [String] :db_instance_class
|
14218
14104
|
# The new compute and memory capacity of the DB instance, for example
|
14219
|
-
# db.
|
14105
|
+
# db.m4.large. Not all DB instance classes are available in all Amazon
|
14220
14106
|
# Web Services Regions, or for all database engines. For the full list
|
14221
14107
|
# of DB instance classes, and availability for your engine, see [DB
|
14222
|
-
#
|
14223
|
-
# instance classes][2] in the *Amazon Aurora User Guide*.
|
14108
|
+
# Instance Class][1] in the *Amazon RDS User Guide*.
|
14224
14109
|
#
|
14225
14110
|
# If you modify the DB instance class, an outage occurs during the
|
14226
14111
|
# change. The change is applied during the next maintenance window,
|
@@ -14233,7 +14118,6 @@ module Aws::RDS
|
|
14233
14118
|
#
|
14234
14119
|
#
|
14235
14120
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
14236
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html
|
14237
14121
|
#
|
14238
14122
|
# @option params [String] :db_subnet_group_name
|
14239
14123
|
# The new DB subnet group for the DB instance. You can use this
|
@@ -14345,7 +14229,7 @@ module Aws::RDS
|
|
14345
14229
|
#
|
14346
14230
|
# Constraints: Must contain from 8 to 128 characters.
|
14347
14231
|
#
|
14348
|
-
# <note markdown="1"> Amazon RDS API
|
14232
|
+
# <note markdown="1"> Amazon RDS API actions never return the password, so this action
|
14349
14233
|
# provides a way to regain access to a primary instance user if the
|
14350
14234
|
# password is lost. This includes restoring privileges that might have
|
14351
14235
|
# been accidentally revoked.
|
@@ -14397,8 +14281,8 @@ module Aws::RDS
|
|
14397
14281
|
# Constraints:
|
14398
14282
|
#
|
14399
14283
|
# * It must be a value from 0 to 35. It can't be set to 0 if the DB
|
14400
|
-
# instance is a source to read replicas. It can't be set to 0
|
14401
|
-
# RDS Custom for Oracle DB instance.
|
14284
|
+
# instance is a source to read replicas. It can't be set to 0 or 35
|
14285
|
+
# for an RDS Custom for Oracle DB instance.
|
14402
14286
|
#
|
14403
14287
|
# * It can be specified for a MySQL read replica only if the source is
|
14404
14288
|
# running MySQL 5.6 or later.
|
@@ -14810,7 +14694,7 @@ module Aws::RDS
|
|
14810
14694
|
# DB instance.
|
14811
14695
|
#
|
14812
14696
|
# For more information, see [Using Amazon Performance Insights][1] in
|
14813
|
-
# the *Amazon RDS User Guide
|
14697
|
+
# the *Amazon RDS User Guide.*.
|
14814
14698
|
#
|
14815
14699
|
# This setting doesn't apply to RDS Custom.
|
14816
14700
|
#
|
@@ -14833,27 +14717,8 @@ module Aws::RDS
|
|
14833
14717
|
# This setting doesn't apply to RDS Custom.
|
14834
14718
|
#
|
14835
14719
|
# @option params [Integer] :performance_insights_retention_period
|
14836
|
-
# The
|
14837
|
-
#
|
14838
|
-
#
|
14839
|
-
# * 7
|
14840
|
-
#
|
14841
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
14842
|
-
#
|
14843
|
-
# * 731
|
14844
|
-
#
|
14845
|
-
# For example, the following values are valid:
|
14846
|
-
#
|
14847
|
-
# * 93 (3 months * 31)
|
14848
|
-
#
|
14849
|
-
# * 341 (11 months * 31)
|
14850
|
-
#
|
14851
|
-
# * 589 (19 months * 31)
|
14852
|
-
#
|
14853
|
-
# * 731
|
14854
|
-
#
|
14855
|
-
# If you specify a retention period such as 94, which isn't a valid
|
14856
|
-
# value, RDS issues an error.
|
14720
|
+
# The amount of time, in days, to retain Performance Insights data.
|
14721
|
+
# Valid values are 7 or 731 (2 years).
|
14857
14722
|
#
|
14858
14723
|
# This setting doesn't apply to RDS Custom.
|
14859
14724
|
#
|
@@ -15529,10 +15394,10 @@ module Aws::RDS
|
|
15529
15394
|
# Modifies the properties of a `DBProxyTargetGroup`.
|
15530
15395
|
#
|
15531
15396
|
# @option params [required, String] :target_group_name
|
15532
|
-
# The name of the target group to
|
15397
|
+
# The name of the new target group to assign to the proxy.
|
15533
15398
|
#
|
15534
15399
|
# @option params [required, String] :db_proxy_name
|
15535
|
-
# The name of the proxy.
|
15400
|
+
# The name of the new proxy to which to assign the target group.
|
15536
15401
|
#
|
15537
15402
|
# @option params [Types::ConnectionPoolConfiguration] :connection_pool_config
|
15538
15403
|
# The settings that determine the size and behavior of the connection
|
@@ -15720,7 +15585,7 @@ module Aws::RDS
|
|
15720
15585
|
#
|
15721
15586
|
# To view which Amazon Web Services accounts have access to copy or
|
15722
15587
|
# restore a manual DB snapshot, or whether a manual DB snapshot public
|
15723
|
-
# or private, use the DescribeDBSnapshotAttributes API
|
15588
|
+
# or private, use the DescribeDBSnapshotAttributes API action. The
|
15724
15589
|
# accounts are returned as values for the `restore` attribute.
|
15725
15590
|
#
|
15726
15591
|
# @option params [required, String] :db_snapshot_identifier
|
@@ -15733,7 +15598,7 @@ module Aws::RDS
|
|
15733
15598
|
# or restore a manual DB snapshot, set this value to `restore`.
|
15734
15599
|
#
|
15735
15600
|
# <note markdown="1"> To view the list of attributes available to modify, use the
|
15736
|
-
# DescribeDBSnapshotAttributes API
|
15601
|
+
# DescribeDBSnapshotAttributes API action.
|
15737
15602
|
#
|
15738
15603
|
# </note>
|
15739
15604
|
#
|
@@ -17666,9 +17531,9 @@ module Aws::RDS
|
|
17666
17531
|
# @option params [required, String] :engine
|
17667
17532
|
# The name of the database engine to be used for this DB cluster.
|
17668
17533
|
#
|
17669
|
-
# Valid Values: `aurora` (for MySQL 5.6-compatible Aurora)
|
17534
|
+
# Valid Values: `aurora` (for MySQL 5.6-compatible Aurora),
|
17670
17535
|
# `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
|
17671
|
-
# Aurora)
|
17536
|
+
# Aurora), and `aurora-postgresql`
|
17672
17537
|
#
|
17673
17538
|
# @option params [String] :engine_version
|
17674
17539
|
# The version number of the database engine to use.
|
@@ -17686,10 +17551,20 @@ module Aws::RDS
|
|
17686
17551
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
17687
17552
|
# "DBEngineVersions[].EngineVersion"`
|
17688
17553
|
#
|
17554
|
+
# To list all of the available engine versions for `aurora-postgresql`,
|
17555
|
+
# use the following command:
|
17556
|
+
#
|
17557
|
+
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
17558
|
+
# --query "DBEngineVersions[].EngineVersion"`
|
17559
|
+
#
|
17689
17560
|
# **Aurora MySQL**
|
17690
17561
|
#
|
17691
|
-
# Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`,
|
17692
|
-
# `5.7.mysql_aurora.2.
|
17562
|
+
# Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`, `5.7.12`,
|
17563
|
+
# `5.7.mysql_aurora.2.04.5`, `8.0.mysql_aurora.3.01.0`
|
17564
|
+
#
|
17565
|
+
# **Aurora PostgreSQL**
|
17566
|
+
#
|
17567
|
+
# Example: `9.6.3`, `10.7`
|
17693
17568
|
#
|
17694
17569
|
# @option params [Integer] :port
|
17695
17570
|
# The port number on which the instances in the restored DB cluster
|
@@ -18323,7 +18198,7 @@ module Aws::RDS
|
|
18323
18198
|
#
|
18324
18199
|
# For more information about exporting CloudWatch Logs for Amazon RDS,
|
18325
18200
|
# see [Publishing Database Logs to Amazon CloudWatch Logs][1] in the
|
18326
|
-
# *Amazon RDS User Guide
|
18201
|
+
# *Amazon RDS User Guide.*.
|
18327
18202
|
#
|
18328
18203
|
# For more information about exporting CloudWatch Logs for Amazon
|
18329
18204
|
# Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in
|
@@ -18905,7 +18780,7 @@ module Aws::RDS
|
|
18905
18780
|
#
|
18906
18781
|
# For more information about exporting CloudWatch Logs for Amazon RDS,
|
18907
18782
|
# see [Publishing Database Logs to Amazon CloudWatch Logs][1] in the
|
18908
|
-
# *Amazon RDS User Guide
|
18783
|
+
# *Amazon RDS User Guide.*.
|
18909
18784
|
#
|
18910
18785
|
# For more information about exporting CloudWatch Logs for Amazon
|
18911
18786
|
# Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in
|
@@ -20312,7 +20187,7 @@ module Aws::RDS
|
|
20312
20187
|
# DB instance.
|
20313
20188
|
#
|
20314
20189
|
# For more information, see [Using Amazon Performance Insights][1] in
|
20315
|
-
# the *Amazon RDS User Guide
|
20190
|
+
# the *Amazon RDS User Guide.*.
|
20316
20191
|
#
|
20317
20192
|
#
|
20318
20193
|
#
|
@@ -20331,27 +20206,8 @@ module Aws::RDS
|
|
20331
20206
|
# a different default KMS key for each Amazon Web Services Region.
|
20332
20207
|
#
|
20333
20208
|
# @option params [Integer] :performance_insights_retention_period
|
20334
|
-
# The
|
20335
|
-
#
|
20336
|
-
#
|
20337
|
-
# * 7
|
20338
|
-
#
|
20339
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
20340
|
-
#
|
20341
|
-
# * 731
|
20342
|
-
#
|
20343
|
-
# For example, the following values are valid:
|
20344
|
-
#
|
20345
|
-
# * 93 (3 months * 31)
|
20346
|
-
#
|
20347
|
-
# * 341 (11 months * 31)
|
20348
|
-
#
|
20349
|
-
# * 589 (19 months * 31)
|
20350
|
-
#
|
20351
|
-
# * 731
|
20352
|
-
#
|
20353
|
-
# If you specify a retention period such as 94, which isn't a valid
|
20354
|
-
# value, RDS issues an error.
|
20209
|
+
# The amount of time, in days, to retain Performance Insights data.
|
20210
|
+
# Valid values are 7 or 731 (2 years).
|
20355
20211
|
#
|
20356
20212
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
20357
20213
|
# The list of logs that the restored DB instance is to export to
|
@@ -21877,36 +21733,14 @@ module Aws::RDS
|
|
21877
21733
|
# `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`.
|
21878
21734
|
#
|
21879
21735
|
# @option params [String] :pre_signed_url
|
21880
|
-
#
|
21881
|
-
#
|
21882
|
-
# `StartDBInstanceAutomatedBackupsReplication` operation to call in the
|
21736
|
+
# A URL that contains a Signature Version 4 signed request for the
|
21737
|
+
# StartDBInstanceAutomatedBackupsReplication action to be called in the
|
21883
21738
|
# Amazon Web Services Region of the source DB instance. The presigned
|
21884
21739
|
# URL must be a valid request for the
|
21885
|
-
#
|
21886
|
-
#
|
21740
|
+
# StartDBInstanceAutomatedBackupsReplication API action that can be
|
21741
|
+
# executed in the Amazon Web Services Region that contains the source DB
|
21887
21742
|
# instance.
|
21888
21743
|
#
|
21889
|
-
# This setting applies only to Amazon Web Services GovCloud (US)
|
21890
|
-
# Regions. It's ignored in other Amazon Web Services Regions.
|
21891
|
-
#
|
21892
|
-
# To learn how to generate a Signature Version 4 signed request, see [
|
21893
|
-
# Authenticating Requests: Using Query Parameters (Amazon Web Services
|
21894
|
-
# Signature Version 4)][1] and [ Signature Version 4 Signing
|
21895
|
-
# Process][2].
|
21896
|
-
#
|
21897
|
-
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
21898
|
-
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
21899
|
-
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
21900
|
-
# autogenerates a presigned URL that is a valid request for the
|
21901
|
-
# operation that can run in the source Amazon Web Services Region.
|
21902
|
-
#
|
21903
|
-
# </note>
|
21904
|
-
#
|
21905
|
-
#
|
21906
|
-
#
|
21907
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
21908
|
-
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
21909
|
-
#
|
21910
21744
|
# @option params [String] :source_region
|
21911
21745
|
# The source region of the snapshot. This is only needed when the
|
21912
21746
|
# shapshot is encrypted and in a different region.
|
@@ -22475,8 +22309,7 @@ module Aws::RDS
|
|
22475
22309
|
|
22476
22310
|
# Stops automated backup replication for a DB instance.
|
22477
22311
|
#
|
22478
|
-
# This command doesn't apply to RDS Custom
|
22479
|
-
# PostgreSQL.
|
22312
|
+
# This command doesn't apply to RDS Custom.
|
22480
22313
|
#
|
22481
22314
|
# For more information, see [ Replicating Automated Backups to Another
|
22482
22315
|
# Amazon Web Services Region][1] in the *Amazon RDS User Guide.*
|
@@ -22554,7 +22387,7 @@ module Aws::RDS
|
|
22554
22387
|
params: params,
|
22555
22388
|
config: config)
|
22556
22389
|
context[:gem_name] = 'aws-sdk-rds'
|
22557
|
-
context[:gem_version] = '1.
|
22390
|
+
context[:gem_version] = '1.148.0'
|
22558
22391
|
Seahorse::Client::Request.new(handlers, context)
|
22559
22392
|
end
|
22560
22393
|
|
@@ -22622,6 +22455,8 @@ module Aws::RDS
|
|
22622
22455
|
#
|
22623
22456
|
# | waiter_name | params | :delay | :max_attempts |
|
22624
22457
|
# | ----------------------------- | -------------------------------------- | -------- | ------------- |
|
22458
|
+
# | db_cluster_available | {Client#describe_db_clusters} | 30 | 60 |
|
22459
|
+
# | db_cluster_deleted | {Client#describe_db_clusters} | 30 | 60 |
|
22625
22460
|
# | db_cluster_snapshot_available | {Client#describe_db_cluster_snapshots} | 30 | 60 |
|
22626
22461
|
# | db_cluster_snapshot_deleted | {Client#describe_db_cluster_snapshots} | 30 | 60 |
|
22627
22462
|
# | db_instance_available | {Client#describe_db_instances} | 30 | 60 |
|
@@ -22678,6 +22513,8 @@ module Aws::RDS
|
|
22678
22513
|
|
22679
22514
|
def waiters
|
22680
22515
|
{
|
22516
|
+
db_cluster_available: Waiters::DBClusterAvailable,
|
22517
|
+
db_cluster_deleted: Waiters::DBClusterDeleted,
|
22681
22518
|
db_cluster_snapshot_available: Waiters::DBClusterSnapshotAvailable,
|
22682
22519
|
db_cluster_snapshot_deleted: Waiters::DBClusterSnapshotDeleted,
|
22683
22520
|
db_instance_available: Waiters::DBInstanceAvailable,
|