aws-sdk-rds 1.146.0 → 1.147.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 +405 -232
- data/lib/aws-sdk-rds/db_cluster.rb +96 -37
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +25 -22
- data/lib/aws-sdk-rds/db_instance.rb +173 -45
- data/lib/aws-sdk-rds/db_snapshot.rb +29 -23
- data/lib/aws-sdk-rds/resource.rb +134 -43
- data/lib/aws-sdk-rds/types.rb +395 -157
- 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 only
|
768
|
+
# <note markdown="1"> This action applies only to Aurora MySQL DB clusters.
|
769
769
|
#
|
770
770
|
# </note>
|
771
771
|
#
|
@@ -1020,60 +1020,16 @@ 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
|
-
# Web Services Region for the encrypted DB cluster snapshot to be
|
1025
|
-
# to. To copy an encrypted DB cluster snapshot from another
|
1026
|
-
# Services Region, you must provide the following values:
|
1023
|
+
# you call the `CopyDBClusterSnapshot` operation is the destination
|
1024
|
+
# Amazon Web Services Region for the encrypted DB cluster snapshot to be
|
1025
|
+
# copied to. To copy an encrypted DB cluster snapshot from another
|
1026
|
+
# Amazon Web 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
|
-
#
|
1077
1033
|
# * `TargetDBClusterSnapshotIdentifier` - The identifier for the new
|
1078
1034
|
# copy of the DB cluster snapshot in the destination Amazon Web
|
1079
1035
|
# Services Region.
|
@@ -1082,7 +1038,7 @@ module Aws::RDS
|
|
1082
1038
|
# identifier for the encrypted DB cluster snapshot to be copied. This
|
1083
1039
|
# identifier must be in the ARN format for the source Amazon Web
|
1084
1040
|
# Services Region and is the same value as the
|
1085
|
-
# `SourceDBClusterSnapshotIdentifier` in the
|
1041
|
+
# `SourceDBClusterSnapshotIdentifier` in the presigned URL.
|
1086
1042
|
#
|
1087
1043
|
# To cancel the copy operation once it is in progress, delete the target
|
1088
1044
|
# DB cluster snapshot identified by `TargetDBClusterSnapshotIdentifier`
|
@@ -1090,22 +1046,20 @@ module Aws::RDS
|
|
1090
1046
|
#
|
1091
1047
|
# For more information on copying encrypted Amazon Aurora DB cluster
|
1092
1048
|
# snapshots from one Amazon Web Services Region to another, see [
|
1093
|
-
# Copying a Snapshot][
|
1049
|
+
# Copying a Snapshot][1] in the *Amazon Aurora User Guide*.
|
1094
1050
|
#
|
1095
1051
|
# For more information on Amazon Aurora DB clusters, see [ What is
|
1096
|
-
# Amazon Aurora?][
|
1052
|
+
# Amazon Aurora?][2] in the *Amazon Aurora User Guide*.
|
1097
1053
|
#
|
1098
1054
|
# For more information on Multi-AZ DB clusters, see [ Multi-AZ
|
1099
|
-
# deployments with two readable standby DB instances][
|
1055
|
+
# deployments with two readable standby DB instances][3] in the *Amazon
|
1100
1056
|
# RDS User Guide*.
|
1101
1057
|
#
|
1102
1058
|
#
|
1103
1059
|
#
|
1104
|
-
# [1]: https://docs.aws.amazon.com/
|
1105
|
-
# [2]: https://docs.aws.amazon.com/
|
1106
|
-
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/
|
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
|
1060
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html
|
1061
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
1062
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
1109
1063
|
#
|
1110
1064
|
# @option params [required, String] :source_db_cluster_snapshot_identifier
|
1111
1065
|
# The identifier of the DB cluster snapshot to copy. This parameter
|
@@ -1173,26 +1127,30 @@ module Aws::RDS
|
|
1173
1127
|
# the `KmsKeyId` parameter, an error is returned.
|
1174
1128
|
#
|
1175
1129
|
# @option params [String] :pre_signed_url
|
1176
|
-
#
|
1177
|
-
#
|
1178
|
-
#
|
1179
|
-
#
|
1180
|
-
# cluster snapshot
|
1181
|
-
#
|
1182
|
-
#
|
1130
|
+
# When you are copying a DB cluster snapshot from one Amazon Web
|
1131
|
+
# Services GovCloud (US) Region to another, the URL that contains a
|
1132
|
+
# Signature Version 4 signed request for the `CopyDBClusterSnapshot` API
|
1133
|
+
# operation in the Amazon Web Services Region that contains the source
|
1134
|
+
# DB cluster snapshot to copy. Use the `PreSignedUrl` parameter when
|
1135
|
+
# copying an encrypted DB cluster snapshot from another Amazon Web
|
1136
|
+
# Services Region. Don't specify `PreSignedUrl` when copying an
|
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.
|
1183
1141
|
#
|
1184
|
-
# The
|
1185
|
-
# `CopyDBClusterSnapshot` API
|
1142
|
+
# The presigned URL must be a valid request for the
|
1143
|
+
# `CopyDBClusterSnapshot` API operation that can run in the source
|
1186
1144
|
# Amazon Web Services Region that contains the encrypted DB cluster
|
1187
|
-
# snapshot to
|
1188
|
-
#
|
1145
|
+
# snapshot to copy. The presigned URL request must contain the following
|
1146
|
+
# parameter values:
|
1189
1147
|
#
|
1190
|
-
# * `KmsKeyId` - The
|
1191
|
-
#
|
1192
|
-
#
|
1193
|
-
#
|
1194
|
-
#
|
1195
|
-
#
|
1148
|
+
# * `KmsKeyId` - The KMS key identifier for the KMS key to use to
|
1149
|
+
# encrypt the copy of the DB cluster snapshot in the destination
|
1150
|
+
# Amazon Web Services Region. This is the same identifier for both the
|
1151
|
+
# `CopyDBClusterSnapshot` operation that is called in the destination
|
1152
|
+
# Amazon Web Services Region, and the operation contained in the
|
1153
|
+
# presigned URL.
|
1196
1154
|
#
|
1197
1155
|
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
1198
1156
|
# that the DB cluster snapshot is to be created in.
|
@@ -1214,9 +1172,8 @@ module Aws::RDS
|
|
1214
1172
|
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
1215
1173
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
1216
1174
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
1217
|
-
# autogenerates a
|
1218
|
-
# operation that can
|
1219
|
-
# Region.
|
1175
|
+
# autogenerates a presigned URL that is a valid request for the
|
1176
|
+
# operation that can run in the source Amazon Web Services Region.
|
1220
1177
|
#
|
1221
1178
|
# </note>
|
1222
1179
|
#
|
@@ -1415,7 +1372,7 @@ module Aws::RDS
|
|
1415
1372
|
#
|
1416
1373
|
# You can copy a snapshot from one Amazon Web Services Region to
|
1417
1374
|
# another. In that case, the Amazon Web Services Region where you call
|
1418
|
-
# the `CopyDBSnapshot`
|
1375
|
+
# the `CopyDBSnapshot` operation is the destination Amazon Web Services
|
1419
1376
|
# Region for the DB snapshot copy.
|
1420
1377
|
#
|
1421
1378
|
# This command doesn't apply to RDS Custom.
|
@@ -1443,8 +1400,7 @@ module Aws::RDS
|
|
1443
1400
|
# must be the Amazon Resource Name (ARN) of the shared DB snapshot.
|
1444
1401
|
#
|
1445
1402
|
# If you are copying an encrypted snapshot this parameter must be in the
|
1446
|
-
# ARN format for the source Amazon Web Services Region
|
1447
|
-
# the `SourceDBSnapshotIdentifier` in the `PreSignedUrl` parameter.
|
1403
|
+
# ARN format for the source Amazon Web Services Region.
|
1448
1404
|
#
|
1449
1405
|
# Constraints:
|
1450
1406
|
#
|
@@ -1510,39 +1466,46 @@ module Aws::RDS
|
|
1510
1466
|
# snapshot to the target DB snapshot. By default, tags are not copied.
|
1511
1467
|
#
|
1512
1468
|
# @option params [String] :pre_signed_url
|
1513
|
-
#
|
1514
|
-
#
|
1515
|
-
#
|
1469
|
+
# When you are copying a snapshot from one Amazon Web Services GovCloud
|
1470
|
+
# (US) Region to another, the URL that contains a Signature Version 4
|
1471
|
+
# signed request for the `CopyDBSnapshot` API operation in the source
|
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.
|
1516
1477
|
#
|
1517
1478
|
# You must specify this parameter when you copy an encrypted DB snapshot
|
1518
1479
|
# from another Amazon Web Services Region by using the Amazon RDS API.
|
1519
1480
|
# Don't specify `PreSignedUrl` when you are copying an encrypted DB
|
1520
1481
|
# snapshot in the same Amazon Web Services Region.
|
1521
1482
|
#
|
1522
|
-
# The presigned URL must be a valid request for the
|
1523
|
-
#
|
1524
|
-
# that contains the encrypted DB
|
1525
|
-
# URL request must contain the following
|
1483
|
+
# The presigned URL must be a valid request for the
|
1484
|
+
# `CopyDBClusterSnapshot` API operation that can run in the source
|
1485
|
+
# Amazon Web Services Region that contains the encrypted DB cluster
|
1486
|
+
# snapshot to copy. The presigned URL request must contain the following
|
1487
|
+
# parameter values:
|
1526
1488
|
#
|
1527
1489
|
# * `DestinationRegion` - The Amazon Web Services Region that the
|
1528
1490
|
# encrypted DB snapshot is copied to. This Amazon Web Services Region
|
1529
|
-
# is the same one where the `CopyDBSnapshot`
|
1491
|
+
# is the same one where the `CopyDBSnapshot` operation is called that
|
1530
1492
|
# contains this presigned URL.
|
1531
1493
|
#
|
1532
1494
|
# For example, if you copy an encrypted DB snapshot from the us-west-2
|
1533
1495
|
# Amazon Web Services Region to the us-east-1 Amazon Web Services
|
1534
|
-
# Region, then you call the `CopyDBSnapshot`
|
1535
|
-
# Amazon Web Services Region and provide a presigned URL
|
1536
|
-
# a call to the `CopyDBSnapshot`
|
1537
|
-
# Services Region. For this example, the
|
1538
|
-
# presigned URL must be set to the
|
1539
|
-
# Region.
|
1540
|
-
#
|
1541
|
-
# * `KmsKeyId` - The
|
1542
|
-
#
|
1543
|
-
#
|
1544
|
-
# `CopyDBSnapshot`
|
1545
|
-
# Services Region, and the
|
1496
|
+
# Region, then you call the `CopyDBSnapshot` operation in the
|
1497
|
+
# us-east-1 Amazon Web Services Region and provide a presigned URL
|
1498
|
+
# that contains a call to the `CopyDBSnapshot` operation in the
|
1499
|
+
# us-west-2 Amazon Web Services Region. For this example, the
|
1500
|
+
# `DestinationRegion` in the presigned URL must be set to the
|
1501
|
+
# us-east-1 Amazon Web Services Region.
|
1502
|
+
#
|
1503
|
+
# * `KmsKeyId` - The KMS key identifier for the KMS key to use to
|
1504
|
+
# encrypt the copy of the DB snapshot in the destination Amazon Web
|
1505
|
+
# Services Region. This is the same identifier for both the
|
1506
|
+
# `CopyDBSnapshot` operation that is called in the destination Amazon
|
1507
|
+
# Web Services Region, and the operation contained in the presigned
|
1508
|
+
# URL.
|
1546
1509
|
#
|
1547
1510
|
# * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
|
1548
1511
|
# encrypted snapshot to be copied. This identifier must be in the
|
@@ -1559,9 +1522,8 @@ module Aws::RDS
|
|
1559
1522
|
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
1560
1523
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
1561
1524
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
1562
|
-
# autogenerates a
|
1563
|
-
# operation that can
|
1564
|
-
# Region.
|
1525
|
+
# autogenerates a presigned URL that is a valid request for the
|
1526
|
+
# operation that can run in the source Amazon Web Services Region.
|
1565
1527
|
#
|
1566
1528
|
# </note>
|
1567
1529
|
#
|
@@ -2040,10 +2002,7 @@ module Aws::RDS
|
|
2040
2002
|
#
|
2041
2003
|
# You can use the `ReplicationSourceIdentifier` parameter to create an
|
2042
2004
|
# Amazon Aurora DB cluster as a read replica of another DB cluster or
|
2043
|
-
# Amazon RDS MySQL or PostgreSQL DB instance.
|
2044
|
-
# replication where the DB cluster identified by
|
2045
|
-
# `ReplicationSourceIdentifier` is encrypted, also specify the
|
2046
|
-
# `PreSignedUrl` parameter.
|
2005
|
+
# Amazon RDS MySQL or PostgreSQL DB instance.
|
2047
2006
|
#
|
2048
2007
|
# For more information on Amazon Aurora, see [ What is Amazon
|
2049
2008
|
# Aurora?][1] in the *Amazon Aurora User Guide*.
|
@@ -2366,25 +2325,25 @@ module Aws::RDS
|
|
2366
2325
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
2367
2326
|
#
|
2368
2327
|
# @option params [String] :pre_signed_url
|
2369
|
-
#
|
2370
|
-
#
|
2371
|
-
#
|
2372
|
-
#
|
2373
|
-
# from
|
2374
|
-
#
|
2375
|
-
#
|
2376
|
-
#
|
2377
|
-
#
|
2378
|
-
#
|
2379
|
-
#
|
2380
|
-
# values:
|
2381
|
-
#
|
2382
|
-
# * `KmsKeyId` - The
|
2383
|
-
#
|
2384
|
-
#
|
2385
|
-
#
|
2386
|
-
#
|
2387
|
-
#
|
2328
|
+
# When you are replicating a DB cluster from one Amazon Web Services
|
2329
|
+
# GovCloud (US) Region to another, an URL that contains a Signature
|
2330
|
+
# Version 4 signed request for the `CreateDBCluster` operation to be
|
2331
|
+
# called in the source Amazon Web Services Region where the DB cluster
|
2332
|
+
# is replicated from. Specify `PreSignedUrl` only when you are
|
2333
|
+
# performing cross-Region replication from an encrypted DB cluster.
|
2334
|
+
#
|
2335
|
+
# The presigned URL must be a valid request for the `CreateDBCluster`
|
2336
|
+
# API operation that can run in the source Amazon Web Services Region
|
2337
|
+
# that contains the encrypted DB cluster to copy.
|
2338
|
+
#
|
2339
|
+
# The presigned URL request must contain the following parameter values:
|
2340
|
+
#
|
2341
|
+
# * `KmsKeyId` - The KMS key identifier for the KMS key to use to
|
2342
|
+
# encrypt the copy of the DB cluster in the destination Amazon Web
|
2343
|
+
# Services Region. This should refer to the same KMS key for both the
|
2344
|
+
# `CreateDBCluster` operation that is called in the destination Amazon
|
2345
|
+
# Web Services Region, and the operation contained in the presigned
|
2346
|
+
# URL.
|
2388
2347
|
#
|
2389
2348
|
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
2390
2349
|
# that Aurora read replica will be created in.
|
@@ -2405,9 +2364,8 @@ module Aws::RDS
|
|
2405
2364
|
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
2406
2365
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
2407
2366
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
2408
|
-
# autogenerates a
|
2409
|
-
# operation that can
|
2410
|
-
# Region.
|
2367
|
+
# autogenerates a presigned URL that is a valid request for the
|
2368
|
+
# operation that can run in the source Amazon Web Services Region.
|
2411
2369
|
#
|
2412
2370
|
# </note>
|
2413
2371
|
#
|
@@ -2424,7 +2382,7 @@ module Aws::RDS
|
|
2424
2382
|
# accounts. By default, mapping isn't enabled.
|
2425
2383
|
#
|
2426
2384
|
# For more information, see [ IAM Database Authentication][1] in the
|
2427
|
-
# *Amazon Aurora User Guide
|
2385
|
+
# *Amazon Aurora User Guide*.
|
2428
2386
|
#
|
2429
2387
|
# Valid for: Aurora DB clusters only
|
2430
2388
|
#
|
@@ -2498,6 +2456,9 @@ module Aws::RDS
|
|
2498
2456
|
# The `multimaster` engine mode only applies for DB clusters created
|
2499
2457
|
# with Aurora MySQL version 5.6.10a.
|
2500
2458
|
#
|
2459
|
+
# The `serverless` engine mode only applies for Aurora Serverless v1 DB
|
2460
|
+
# clusters.
|
2461
|
+
#
|
2501
2462
|
# For Aurora PostgreSQL, the `global` engine mode isn't required, and
|
2502
2463
|
# both the `parallelquery` and the `multimaster` engine modes currently
|
2503
2464
|
# aren't supported.
|
@@ -2506,22 +2467,25 @@ module Aws::RDS
|
|
2506
2467
|
# information, see the following sections in the *Amazon Aurora User
|
2507
2468
|
# Guide*\:
|
2508
2469
|
#
|
2509
|
-
# * [
|
2470
|
+
# * [Limitations of Aurora Serverless v1][1]
|
2471
|
+
#
|
2472
|
+
# * [Requirements for Aurora Serverless v2][2]
|
2510
2473
|
#
|
2511
|
-
# * [
|
2474
|
+
# * [Limitations of Parallel Query][3]
|
2512
2475
|
#
|
2513
|
-
# * [
|
2476
|
+
# * [Limitations of Aurora Global Databases][4]
|
2514
2477
|
#
|
2515
|
-
# * [
|
2478
|
+
# * [Limitations of Multi-Master Clusters][5]
|
2516
2479
|
#
|
2517
2480
|
# Valid for: Aurora DB clusters only
|
2518
2481
|
#
|
2519
2482
|
#
|
2520
2483
|
#
|
2521
2484
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
|
2522
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
2523
|
-
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
2524
|
-
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-
|
2485
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html
|
2486
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations
|
2487
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations
|
2488
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations
|
2525
2489
|
#
|
2526
2490
|
# @option params [Types::ScalingConfiguration] :scaling_configuration
|
2527
2491
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
@@ -2763,8 +2727,27 @@ module Aws::RDS
|
|
2763
2727
|
# Valid for: Multi-AZ DB clusters only
|
2764
2728
|
#
|
2765
2729
|
# @option params [Integer] :performance_insights_retention_period
|
2766
|
-
# The
|
2767
|
-
#
|
2730
|
+
# The number of days to retain Performance Insights data. The default is
|
2731
|
+
# 7 days. The following values are valid:
|
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.
|
2768
2751
|
#
|
2769
2752
|
# Valid for: Multi-AZ DB clusters only
|
2770
2753
|
#
|
@@ -2997,7 +2980,7 @@ module Aws::RDS
|
|
2997
2980
|
# Creates a new custom endpoint and associates it with an Amazon Aurora
|
2998
2981
|
# DB cluster.
|
2999
2982
|
#
|
3000
|
-
# <note markdown="1"> This action only
|
2983
|
+
# <note markdown="1"> This action applies only to Aurora DB clusters.
|
3001
2984
|
#
|
3002
2985
|
# </note>
|
3003
2986
|
#
|
@@ -3109,8 +3092,9 @@ module Aws::RDS
|
|
3109
3092
|
# the default database for a DB cluster, such as the character set for
|
3110
3093
|
# the default database defined by the `character_set_database`
|
3111
3094
|
# parameter. You can use the *Parameter Groups* option of the [Amazon
|
3112
|
-
# RDS console][1] or the `DescribeDBClusterParameters`
|
3113
|
-
# that your DB cluster parameter group has been created or
|
3095
|
+
# RDS console][1] or the `DescribeDBClusterParameters` operation to
|
3096
|
+
# verify that your DB cluster parameter group has been created or
|
3097
|
+
# modified.
|
3114
3098
|
#
|
3115
3099
|
# For more information on Amazon Aurora, see [ What is Amazon
|
3116
3100
|
# Aurora?][2] in the *Amazon Aurora User Guide*.
|
@@ -3363,6 +3347,23 @@ module Aws::RDS
|
|
3363
3347
|
|
3364
3348
|
# Creates a new DB instance.
|
3365
3349
|
#
|
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
|
+
#
|
3366
3367
|
# @option params [String] :db_name
|
3367
3368
|
# The meaning of this parameter differs according to the database engine
|
3368
3369
|
# you use.
|
@@ -3596,14 +3597,16 @@ module Aws::RDS
|
|
3596
3597
|
#
|
3597
3598
|
# @option params [required, String] :db_instance_class
|
3598
3599
|
# The compute and memory capacity of the DB instance, for example
|
3599
|
-
# db.
|
3600
|
+
# db.m5.large. Not all DB instance classes are available in all Amazon
|
3600
3601
|
# Web Services Regions, or for all database engines. For the full list
|
3601
3602
|
# of DB instance classes, and availability for your engine, see [DB
|
3602
|
-
#
|
3603
|
+
# instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB
|
3604
|
+
# instance classes][2] in the *Amazon Aurora User Guide*.
|
3603
3605
|
#
|
3604
3606
|
#
|
3605
3607
|
#
|
3606
3608
|
# [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
|
3607
3610
|
#
|
3608
3611
|
# @option params [required, String] :engine
|
3609
3612
|
# The name of the database engine to be used for this instance.
|
@@ -3702,7 +3705,9 @@ module Aws::RDS
|
|
3702
3705
|
# @option params [Array<String>] :db_security_groups
|
3703
3706
|
# A list of DB security groups to associate with this DB instance.
|
3704
3707
|
#
|
3705
|
-
#
|
3708
|
+
# This setting applies to the legacy EC2-Classic platform, which is no
|
3709
|
+
# longer used to create new DB instances. Use the `VpcSecurityGroupIds`
|
3710
|
+
# setting instead.
|
3706
3711
|
#
|
3707
3712
|
# @option params [Array<String>] :vpc_security_group_ids
|
3708
3713
|
# A list of Amazon EC2 VPC security groups to associate with this DB
|
@@ -3802,7 +3807,7 @@ module Aws::RDS
|
|
3802
3807
|
#
|
3803
3808
|
# * Can't be set to 0 if the DB instance is a source to read replicas
|
3804
3809
|
#
|
3805
|
-
# * Can't be set to 0
|
3810
|
+
# * Can't be set to 0 for an RDS Custom for Oracle DB instance
|
3806
3811
|
#
|
3807
3812
|
# @option params [String] :preferred_backup_window
|
3808
3813
|
# The daily time range during which automated backups are created if
|
@@ -3885,11 +3890,16 @@ module Aws::RDS
|
|
3885
3890
|
#
|
3886
3891
|
# This setting doesn't apply to RDS Custom.
|
3887
3892
|
#
|
3893
|
+
# **Amazon Aurora**
|
3894
|
+
#
|
3895
|
+
# Not applicable. DB instance Availability Zones (AZs) are managed by
|
3896
|
+
# the DB cluster.
|
3897
|
+
#
|
3888
3898
|
# @option params [String] :engine_version
|
3889
3899
|
# The version number of the database engine to use.
|
3890
3900
|
#
|
3891
3901
|
# For a list of valid engine versions, use the
|
3892
|
-
# `DescribeDBEngineVersions`
|
3902
|
+
# `DescribeDBEngineVersions` operation.
|
3893
3903
|
#
|
3894
3904
|
# The following are the database engines and links to information about
|
3895
3905
|
# the major and minor versions that are available with Amazon RDS. Not
|
@@ -3965,6 +3975,10 @@ module Aws::RDS
|
|
3965
3975
|
#
|
3966
3976
|
# This setting doesn't apply to RDS Custom.
|
3967
3977
|
#
|
3978
|
+
# **Amazon Aurora**
|
3979
|
+
#
|
3980
|
+
# Not applicable.
|
3981
|
+
#
|
3968
3982
|
# @option params [Integer] :iops
|
3969
3983
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
3970
3984
|
# be initially allocated for the DB instance. For information about
|
@@ -3976,6 +3990,10 @@ module Aws::RDS
|
|
3976
3990
|
# instance. For SQL Server DB instances, must be a multiple between 1
|
3977
3991
|
# and 50 of the storage amount for the DB instance.
|
3978
3992
|
#
|
3993
|
+
# **Amazon Aurora**
|
3994
|
+
#
|
3995
|
+
# Not applicable. Storage is managed by the DB cluster.
|
3996
|
+
#
|
3979
3997
|
#
|
3980
3998
|
#
|
3981
3999
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
@@ -3991,6 +4009,10 @@ module Aws::RDS
|
|
3991
4009
|
#
|
3992
4010
|
# This setting doesn't apply to RDS Custom.
|
3993
4011
|
#
|
4012
|
+
# **Amazon Aurora**
|
4013
|
+
#
|
4014
|
+
# Not applicable.
|
4015
|
+
#
|
3994
4016
|
# @option params [String] :character_set_name
|
3995
4017
|
# For supported engines, this value indicates that the DB instance
|
3996
4018
|
# should be associated with the specified `CharacterSet`.
|
@@ -4061,12 +4083,20 @@ module Aws::RDS
|
|
4061
4083
|
#
|
4062
4084
|
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
4063
4085
|
#
|
4086
|
+
# **Amazon Aurora**
|
4087
|
+
#
|
4088
|
+
# Not applicable. Storage is managed by the DB cluster.
|
4089
|
+
#
|
4064
4090
|
# @option params [String] :tde_credential_arn
|
4065
4091
|
# The ARN from the key store with which to associate the instance for
|
4066
4092
|
# TDE encryption.
|
4067
4093
|
#
|
4068
4094
|
# This setting doesn't apply to RDS Custom.
|
4069
4095
|
#
|
4096
|
+
# **Amazon Aurora**
|
4097
|
+
#
|
4098
|
+
# Not applicable.
|
4099
|
+
#
|
4070
4100
|
# @option params [String] :tde_credential_password
|
4071
4101
|
# The password for the given ARN from the key store in order to access
|
4072
4102
|
# the device.
|
@@ -4123,6 +4153,10 @@ module Aws::RDS
|
|
4123
4153
|
#
|
4124
4154
|
# This setting doesn't apply to RDS Custom.
|
4125
4155
|
#
|
4156
|
+
# **Amazon Aurora**
|
4157
|
+
#
|
4158
|
+
# Not applicable. The domain is managed by the DB cluster.
|
4159
|
+
#
|
4126
4160
|
#
|
4127
4161
|
#
|
4128
4162
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -4171,6 +4205,10 @@ module Aws::RDS
|
|
4171
4205
|
#
|
4172
4206
|
# This setting doesn't apply to RDS Custom.
|
4173
4207
|
#
|
4208
|
+
# **Amazon Aurora**
|
4209
|
+
#
|
4210
|
+
# Not applicable. The domain is managed by the DB cluster.
|
4211
|
+
#
|
4174
4212
|
# @option params [Integer] :promotion_tier
|
4175
4213
|
# A value that specifies the order in which an Aurora Replica is
|
4176
4214
|
# promoted to the primary instance after a failure of the existing
|
@@ -4200,13 +4238,16 @@ module Aws::RDS
|
|
4200
4238
|
# Services Identity and Access Management (IAM) accounts to database
|
4201
4239
|
# accounts. By default, mapping isn't enabled.
|
4202
4240
|
#
|
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
|
-
#
|
4207
4241
|
# For more information, see [ IAM Database Authentication for MySQL and
|
4208
4242
|
# PostgreSQL][1] in the *Amazon RDS User Guide*.
|
4209
4243
|
#
|
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
|
+
#
|
4210
4251
|
#
|
4211
4252
|
#
|
4212
4253
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -4237,8 +4278,27 @@ module Aws::RDS
|
|
4237
4278
|
# This setting doesn't apply to RDS Custom.
|
4238
4279
|
#
|
4239
4280
|
# @option params [Integer] :performance_insights_retention_period
|
4240
|
-
# The
|
4241
|
-
#
|
4281
|
+
# The number of days to retain Performance Insights data. The default is
|
4282
|
+
# 7 days. The following values are valid:
|
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.
|
4242
4302
|
#
|
4243
4303
|
# This setting doesn't apply to RDS Custom.
|
4244
4304
|
#
|
@@ -4287,6 +4347,10 @@ module Aws::RDS
|
|
4287
4347
|
#
|
4288
4348
|
# This setting doesn't apply to RDS Custom.
|
4289
4349
|
#
|
4350
|
+
# **Amazon Aurora**
|
4351
|
+
#
|
4352
|
+
# Not applicable.
|
4353
|
+
#
|
4290
4354
|
# @option params [Boolean] :deletion_protection
|
4291
4355
|
# A value that indicates whether the DB instance has deletion protection
|
4292
4356
|
# enabled. The database can't be deleted when deletion protection is
|
@@ -4314,6 +4378,10 @@ module Aws::RDS
|
|
4314
4378
|
#
|
4315
4379
|
# This setting doesn't apply to RDS Custom.
|
4316
4380
|
#
|
4381
|
+
# **Amazon Aurora**
|
4382
|
+
#
|
4383
|
+
# Not applicable. Storage is managed by the DB cluster.
|
4384
|
+
#
|
4317
4385
|
#
|
4318
4386
|
#
|
4319
4387
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
@@ -4641,8 +4709,8 @@ module Aws::RDS
|
|
4641
4709
|
# information, see [Working with Read Replicas][1] in the *Amazon RDS
|
4642
4710
|
# User Guide*.
|
4643
4711
|
#
|
4644
|
-
# Amazon Aurora doesn't support this
|
4645
|
-
# `CreateDBInstance`
|
4712
|
+
# Amazon Aurora doesn't support this operation. Call the
|
4713
|
+
# `CreateDBInstance` operation to create a DB instance for an Aurora DB
|
4646
4714
|
# cluster.
|
4647
4715
|
#
|
4648
4716
|
# All read replica DB instances are created with backups disabled. All
|
@@ -4774,7 +4842,7 @@ module Aws::RDS
|
|
4774
4842
|
# specified DB engine for a cross-Region read replica.
|
4775
4843
|
#
|
4776
4844
|
# Specifying a parameter group for this operation is only supported for
|
4777
|
-
# Oracle DB instances. It isn't supported for RDS Custom.
|
4845
|
+
# MySQL and Oracle DB instances. It isn't supported for RDS Custom.
|
4778
4846
|
#
|
4779
4847
|
# Constraints:
|
4780
4848
|
#
|
@@ -4913,9 +4981,16 @@ module Aws::RDS
|
|
4913
4981
|
# as the primary replica.
|
4914
4982
|
#
|
4915
4983
|
# @option params [String] :pre_signed_url
|
4916
|
-
#
|
4917
|
-
#
|
4918
|
-
#
|
4984
|
+
# When you are creating a read replica from one Amazon Web Services
|
4985
|
+
# GovCloud (US) Region to another or from one China Amazon Web Services
|
4986
|
+
# Region to another, the URL that contains a Signature Version 4 signed
|
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.
|
4919
4994
|
#
|
4920
4995
|
# You must specify this parameter when you create an encrypted read
|
4921
4996
|
# replica from another Amazon Web Services Region by using the Amazon
|
@@ -4923,32 +4998,31 @@ module Aws::RDS
|
|
4923
4998
|
# encrypted read replica in the same Amazon Web Services Region.
|
4924
4999
|
#
|
4925
5000
|
# The presigned URL must be a valid request for the
|
4926
|
-
# `CreateDBInstanceReadReplica` API
|
4927
|
-
#
|
4928
|
-
#
|
5001
|
+
# `CreateDBInstanceReadReplica` API operation that can run in the source
|
5002
|
+
# Amazon Web Services Region that contains the encrypted source DB
|
5003
|
+
# instance. The presigned URL request must contain the following
|
4929
5004
|
# parameter values:
|
4930
5005
|
#
|
4931
5006
|
# * `DestinationRegion` - The Amazon Web Services Region that the
|
4932
5007
|
# encrypted read replica is created in. This Amazon Web Services
|
4933
5008
|
# Region is the same one where the `CreateDBInstanceReadReplica`
|
4934
|
-
#
|
5009
|
+
# operation is called that contains this presigned URL.
|
4935
5010
|
#
|
4936
5011
|
# For example, if you create an encrypted DB instance in the us-west-1
|
4937
5012
|
# Amazon Web Services Region, from a source DB instance in the
|
4938
5013
|
# us-east-2 Amazon Web Services Region, then you call the
|
4939
|
-
# `CreateDBInstanceReadReplica`
|
5014
|
+
# `CreateDBInstanceReadReplica` operation in the us-east-1 Amazon Web
|
4940
5015
|
# Services Region and provide a presigned URL that contains a call to
|
4941
|
-
# the `CreateDBInstanceReadReplica`
|
4942
|
-
# Services Region. For this example, the `DestinationRegion` in
|
4943
|
-
# presigned URL must be set to the us-east-1 Amazon Web Services
|
5016
|
+
# the `CreateDBInstanceReadReplica` operation in the us-west-2 Amazon
|
5017
|
+
# Web Services Region. For this example, the `DestinationRegion` in
|
5018
|
+
# the presigned URL must be set to the us-east-1 Amazon Web Services
|
4944
5019
|
# Region.
|
4945
5020
|
#
|
4946
|
-
# * `KmsKeyId` - The
|
4947
|
-
#
|
4948
|
-
#
|
4949
|
-
#
|
4950
|
-
#
|
4951
|
-
# the presigned URL.
|
5021
|
+
# * `KmsKeyId` - The KMS key identifier for the key to use to encrypt
|
5022
|
+
# the read replica in the destination Amazon Web Services Region. This
|
5023
|
+
# is the same identifier for both the `CreateDBInstanceReadReplica`
|
5024
|
+
# operation that is called in the destination Amazon Web Services
|
5025
|
+
# Region, and the operation contained in the presigned URL.
|
4952
5026
|
#
|
4953
5027
|
# * `SourceDBInstanceIdentifier` - The DB instance identifier for the
|
4954
5028
|
# encrypted DB instance to be replicated. This identifier must be in
|
@@ -4967,11 +5041,10 @@ module Aws::RDS
|
|
4967
5041
|
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
4968
5042
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
4969
5043
|
# autogenerates a presigned URL that is a valid request for the
|
4970
|
-
# operation that can
|
4971
|
-
# Region.
|
5044
|
+
# operation that can run in the source Amazon Web Services Region.
|
4972
5045
|
#
|
4973
|
-
# `SourceRegion` isn't supported for SQL Server, because
|
4974
|
-
#
|
5046
|
+
# `SourceRegion` isn't supported for SQL Server, because Amazon RDS for
|
5047
|
+
# SQL Server doesn't support cross-Region read replicas.
|
4975
5048
|
#
|
4976
5049
|
# </note>
|
4977
5050
|
#
|
@@ -5025,8 +5098,27 @@ module Aws::RDS
|
|
5025
5098
|
# This setting doesn't apply to RDS Custom.
|
5026
5099
|
#
|
5027
5100
|
# @option params [Integer] :performance_insights_retention_period
|
5028
|
-
# The
|
5029
|
-
#
|
5101
|
+
# The number of days to retain Performance Insights data. The default is
|
5102
|
+
# 7 days. The following values are valid:
|
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.
|
5030
5122
|
#
|
5031
5123
|
# This setting doesn't apply to RDS Custom.
|
5032
5124
|
#
|
@@ -6046,11 +6138,11 @@ module Aws::RDS
|
|
6046
6138
|
req.send_request(options)
|
6047
6139
|
end
|
6048
6140
|
|
6049
|
-
# Creates an RDS event notification subscription. This
|
6050
|
-
# topic Amazon Resource Name (ARN) created by either the RDS
|
6051
|
-
# the SNS console, or the SNS API. To obtain an ARN with SNS,
|
6052
|
-
# create a topic in Amazon SNS and subscribe to the topic. The
|
6053
|
-
# displayed in the SNS console.
|
6141
|
+
# Creates an RDS event notification subscription. This operation
|
6142
|
+
# requires a topic Amazon Resource Name (ARN) created by either the RDS
|
6143
|
+
# console, the SNS console, or the SNS API. To obtain an ARN with SNS,
|
6144
|
+
# you must create a topic in Amazon SNS and subscribe to the topic. The
|
6145
|
+
# ARN is displayed in the SNS console.
|
6054
6146
|
#
|
6055
6147
|
# You can specify the type of source (`SourceType`) that you want to be
|
6056
6148
|
# notified of and provide a list of RDS sources (`SourceIds`) that
|
@@ -6233,7 +6325,7 @@ module Aws::RDS
|
|
6233
6325
|
# existing Aurora cluster during the create operation, and this cluster
|
6234
6326
|
# becomes the primary cluster of the global database.
|
6235
6327
|
#
|
6236
|
-
# <note markdown="1"> This action only
|
6328
|
+
# <note markdown="1"> This action applies only to Aurora DB clusters.
|
6237
6329
|
#
|
6238
6330
|
# </note>
|
6239
6331
|
#
|
@@ -6255,9 +6347,9 @@ module Aws::RDS
|
|
6255
6347
|
# global database can't be deleted when deletion protection is enabled.
|
6256
6348
|
#
|
6257
6349
|
# @option params [String] :database_name
|
6258
|
-
# The name for your database of up to 64
|
6259
|
-
#
|
6260
|
-
#
|
6350
|
+
# The name for your database of up to 64 alphanumeric characters. If you
|
6351
|
+
# do not provide a name, Amazon Aurora will not create a database in the
|
6352
|
+
# global database cluster you are creating.
|
6261
6353
|
#
|
6262
6354
|
# @option params [Boolean] :storage_encrypted
|
6263
6355
|
# The storage encryption setting for the new global database cluster.
|
@@ -10937,10 +11029,19 @@ module Aws::RDS
|
|
10937
11029
|
# snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by
|
10938
11030
|
# providing the name as a parameter.
|
10939
11031
|
#
|
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
|
+
#
|
10940
11036
|
# <note markdown="1"> By default, RDS returns events that were generated in the past hour.
|
10941
11037
|
#
|
10942
11038
|
# </note>
|
10943
11039
|
#
|
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
|
+
#
|
10944
11045
|
# @option params [String] :source_identifier
|
10945
11046
|
# The identifier of the event source for which events are returned. If
|
10946
11047
|
# not specified, then all sources are included in the response.
|
@@ -12401,7 +12502,7 @@ module Aws::RDS
|
|
12401
12502
|
#
|
12402
12503
|
# An Amazon Aurora DB cluster automatically fails over to an Aurora
|
12403
12504
|
# Replica, if one exists, when the primary DB instance fails. A Multi-AZ
|
12404
|
-
# DB cluster automatically fails over to a
|
12505
|
+
# DB cluster automatically fails over to a readable standby DB instance
|
12405
12506
|
# when the primary DB instance fails.
|
12406
12507
|
#
|
12407
12508
|
# To simulate a failure of a primary instance for testing, you can force
|
@@ -13554,8 +13655,27 @@ module Aws::RDS
|
|
13554
13655
|
# Valid for: Multi-AZ DB clusters only
|
13555
13656
|
#
|
13556
13657
|
# @option params [Integer] :performance_insights_retention_period
|
13557
|
-
# The
|
13558
|
-
#
|
13658
|
+
# The number of days to retain Performance Insights data. The default is
|
13659
|
+
# 7 days. The following values are valid:
|
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.
|
13559
13679
|
#
|
13560
13680
|
# Valid for: Multi-AZ DB clusters only
|
13561
13681
|
#
|
@@ -13843,7 +13963,7 @@ module Aws::RDS
|
|
13843
13963
|
# database for a DB cluster, such as the character set for the default
|
13844
13964
|
# database defined by the `character_set_database` parameter. You can
|
13845
13965
|
# use the *Parameter Groups* option of the [Amazon RDS console][1] or
|
13846
|
-
# the `DescribeDBClusterParameters`
|
13966
|
+
# the `DescribeDBClusterParameters` operation to verify that your DB
|
13847
13967
|
# cluster parameter group has been created or modified.
|
13848
13968
|
#
|
13849
13969
|
# If the modified DB cluster parameter group is used by an Aurora
|
@@ -13970,7 +14090,7 @@ module Aws::RDS
|
|
13970
14090
|
# To view which Amazon Web Services accounts have access to copy or
|
13971
14091
|
# restore a manual DB cluster snapshot, or whether a manual DB cluster
|
13972
14092
|
# snapshot is public or private, use the
|
13973
|
-
# DescribeDBClusterSnapshotAttributes API
|
14093
|
+
# DescribeDBClusterSnapshotAttributes API operation. The accounts are
|
13974
14094
|
# returned as values for the `restore` attribute.
|
13975
14095
|
#
|
13976
14096
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
@@ -13984,7 +14104,7 @@ module Aws::RDS
|
|
13984
14104
|
# or restore a manual DB cluster snapshot, set this value to `restore`.
|
13985
14105
|
#
|
13986
14106
|
# <note markdown="1"> To view the list of attributes available to modify, use the
|
13987
|
-
# DescribeDBClusterSnapshotAttributes API
|
14107
|
+
# DescribeDBClusterSnapshotAttributes API operation.
|
13988
14108
|
#
|
13989
14109
|
# </note>
|
13990
14110
|
#
|
@@ -14096,10 +14216,11 @@ module Aws::RDS
|
|
14096
14216
|
#
|
14097
14217
|
# @option params [String] :db_instance_class
|
14098
14218
|
# The new compute and memory capacity of the DB instance, for example
|
14099
|
-
# db.
|
14219
|
+
# db.m5.large. Not all DB instance classes are available in all Amazon
|
14100
14220
|
# Web Services Regions, or for all database engines. For the full list
|
14101
14221
|
# of DB instance classes, and availability for your engine, see [DB
|
14102
|
-
#
|
14222
|
+
# instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB
|
14223
|
+
# instance classes][2] in the *Amazon Aurora User Guide*.
|
14103
14224
|
#
|
14104
14225
|
# If you modify the DB instance class, an outage occurs during the
|
14105
14226
|
# change. The change is applied during the next maintenance window,
|
@@ -14112,6 +14233,7 @@ module Aws::RDS
|
|
14112
14233
|
#
|
14113
14234
|
#
|
14114
14235
|
# [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
|
14115
14237
|
#
|
14116
14238
|
# @option params [String] :db_subnet_group_name
|
14117
14239
|
# The new DB subnet group for the DB instance. You can use this
|
@@ -14223,7 +14345,7 @@ module Aws::RDS
|
|
14223
14345
|
#
|
14224
14346
|
# Constraints: Must contain from 8 to 128 characters.
|
14225
14347
|
#
|
14226
|
-
# <note markdown="1"> Amazon RDS API
|
14348
|
+
# <note markdown="1"> Amazon RDS API operations never return the password, so this action
|
14227
14349
|
# provides a way to regain access to a primary instance user if the
|
14228
14350
|
# password is lost. This includes restoring privileges that might have
|
14229
14351
|
# been accidentally revoked.
|
@@ -14275,8 +14397,8 @@ module Aws::RDS
|
|
14275
14397
|
# Constraints:
|
14276
14398
|
#
|
14277
14399
|
# * It must be a value from 0 to 35. It can't be set to 0 if the DB
|
14278
|
-
# instance is a source to read replicas. It can't be set to 0
|
14279
|
-
#
|
14400
|
+
# instance is a source to read replicas. It can't be set to 0 for an
|
14401
|
+
# RDS Custom for Oracle DB instance.
|
14280
14402
|
#
|
14281
14403
|
# * It can be specified for a MySQL read replica only if the source is
|
14282
14404
|
# running MySQL 5.6 or later.
|
@@ -14688,7 +14810,7 @@ module Aws::RDS
|
|
14688
14810
|
# DB instance.
|
14689
14811
|
#
|
14690
14812
|
# For more information, see [Using Amazon Performance Insights][1] in
|
14691
|
-
# the *Amazon RDS User Guide
|
14813
|
+
# the *Amazon RDS User Guide*.
|
14692
14814
|
#
|
14693
14815
|
# This setting doesn't apply to RDS Custom.
|
14694
14816
|
#
|
@@ -14711,8 +14833,27 @@ module Aws::RDS
|
|
14711
14833
|
# This setting doesn't apply to RDS Custom.
|
14712
14834
|
#
|
14713
14835
|
# @option params [Integer] :performance_insights_retention_period
|
14714
|
-
# The
|
14715
|
-
#
|
14836
|
+
# The number of days to retain Performance Insights data. The default is
|
14837
|
+
# 7 days. The following values are valid:
|
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.
|
14716
14857
|
#
|
14717
14858
|
# This setting doesn't apply to RDS Custom.
|
14718
14859
|
#
|
@@ -15388,10 +15529,10 @@ module Aws::RDS
|
|
15388
15529
|
# Modifies the properties of a `DBProxyTargetGroup`.
|
15389
15530
|
#
|
15390
15531
|
# @option params [required, String] :target_group_name
|
15391
|
-
# The name of the
|
15532
|
+
# The name of the target group to modify.
|
15392
15533
|
#
|
15393
15534
|
# @option params [required, String] :db_proxy_name
|
15394
|
-
# The name of the
|
15535
|
+
# The name of the proxy.
|
15395
15536
|
#
|
15396
15537
|
# @option params [Types::ConnectionPoolConfiguration] :connection_pool_config
|
15397
15538
|
# The settings that determine the size and behavior of the connection
|
@@ -15579,7 +15720,7 @@ module Aws::RDS
|
|
15579
15720
|
#
|
15580
15721
|
# To view which Amazon Web Services accounts have access to copy or
|
15581
15722
|
# restore a manual DB snapshot, or whether a manual DB snapshot public
|
15582
|
-
# or private, use the DescribeDBSnapshotAttributes API
|
15723
|
+
# or private, use the DescribeDBSnapshotAttributes API operation. The
|
15583
15724
|
# accounts are returned as values for the `restore` attribute.
|
15584
15725
|
#
|
15585
15726
|
# @option params [required, String] :db_snapshot_identifier
|
@@ -15592,7 +15733,7 @@ module Aws::RDS
|
|
15592
15733
|
# or restore a manual DB snapshot, set this value to `restore`.
|
15593
15734
|
#
|
15594
15735
|
# <note markdown="1"> To view the list of attributes available to modify, use the
|
15595
|
-
# DescribeDBSnapshotAttributes API
|
15736
|
+
# DescribeDBSnapshotAttributes API operation.
|
15596
15737
|
#
|
15597
15738
|
# </note>
|
15598
15739
|
#
|
@@ -17525,9 +17666,9 @@ module Aws::RDS
|
|
17525
17666
|
# @option params [required, String] :engine
|
17526
17667
|
# The name of the database engine to be used for this DB cluster.
|
17527
17668
|
#
|
17528
|
-
# Valid Values: `aurora` (for MySQL 5.6-compatible Aurora)
|
17669
|
+
# Valid Values: `aurora` (for MySQL 5.6-compatible Aurora) and
|
17529
17670
|
# `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible
|
17530
|
-
# Aurora)
|
17671
|
+
# Aurora)
|
17531
17672
|
#
|
17532
17673
|
# @option params [String] :engine_version
|
17533
17674
|
# The version number of the database engine to use.
|
@@ -17545,20 +17686,10 @@ module Aws::RDS
|
|
17545
17686
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
17546
17687
|
# "DBEngineVersions[].EngineVersion"`
|
17547
17688
|
#
|
17548
|
-
# To list all of the available engine versions for `aurora-postgresql`,
|
17549
|
-
# use the following command:
|
17550
|
-
#
|
17551
|
-
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
17552
|
-
# --query "DBEngineVersions[].EngineVersion"`
|
17553
|
-
#
|
17554
17689
|
# **Aurora MySQL**
|
17555
17690
|
#
|
17556
|
-
# Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`,
|
17557
|
-
# `5.7.mysql_aurora.2.
|
17558
|
-
#
|
17559
|
-
# **Aurora PostgreSQL**
|
17560
|
-
#
|
17561
|
-
# Example: `9.6.3`, `10.7`
|
17691
|
+
# Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`,
|
17692
|
+
# `5.7.mysql_aurora.2.07.1`, `8.0.mysql_aurora.3.02.0`
|
17562
17693
|
#
|
17563
17694
|
# @option params [Integer] :port
|
17564
17695
|
# The port number on which the instances in the restored DB cluster
|
@@ -18192,7 +18323,7 @@ module Aws::RDS
|
|
18192
18323
|
#
|
18193
18324
|
# For more information about exporting CloudWatch Logs for Amazon RDS,
|
18194
18325
|
# see [Publishing Database Logs to Amazon CloudWatch Logs][1] in the
|
18195
|
-
# *Amazon RDS User Guide
|
18326
|
+
# *Amazon RDS User Guide*.
|
18196
18327
|
#
|
18197
18328
|
# For more information about exporting CloudWatch Logs for Amazon
|
18198
18329
|
# Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in
|
@@ -18774,7 +18905,7 @@ module Aws::RDS
|
|
18774
18905
|
#
|
18775
18906
|
# For more information about exporting CloudWatch Logs for Amazon RDS,
|
18776
18907
|
# see [Publishing Database Logs to Amazon CloudWatch Logs][1] in the
|
18777
|
-
# *Amazon RDS User Guide
|
18908
|
+
# *Amazon RDS User Guide*.
|
18778
18909
|
#
|
18779
18910
|
# For more information about exporting CloudWatch Logs for Amazon
|
18780
18911
|
# Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in
|
@@ -20181,7 +20312,7 @@ module Aws::RDS
|
|
20181
20312
|
# DB instance.
|
20182
20313
|
#
|
20183
20314
|
# For more information, see [Using Amazon Performance Insights][1] in
|
20184
|
-
# the *Amazon RDS User Guide
|
20315
|
+
# the *Amazon RDS User Guide*.
|
20185
20316
|
#
|
20186
20317
|
#
|
20187
20318
|
#
|
@@ -20200,8 +20331,27 @@ module Aws::RDS
|
|
20200
20331
|
# a different default KMS key for each Amazon Web Services Region.
|
20201
20332
|
#
|
20202
20333
|
# @option params [Integer] :performance_insights_retention_period
|
20203
|
-
# The
|
20204
|
-
#
|
20334
|
+
# The number of days to retain Performance Insights data. The default is
|
20335
|
+
# 7 days. The following values are valid:
|
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.
|
20205
20355
|
#
|
20206
20356
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
20207
20357
|
# The list of logs that the restored DB instance is to export to
|
@@ -21727,14 +21877,36 @@ module Aws::RDS
|
|
21727
21877
|
# `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`.
|
21728
21878
|
#
|
21729
21879
|
# @option params [String] :pre_signed_url
|
21730
|
-
#
|
21731
|
-
#
|
21880
|
+
# In an Amazon Web Services GovCloud (US) Region, an URL that contains a
|
21881
|
+
# Signature Version 4 signed request for the
|
21882
|
+
# `StartDBInstanceAutomatedBackupsReplication` operation to call in the
|
21732
21883
|
# Amazon Web Services Region of the source DB instance. The presigned
|
21733
21884
|
# URL must be a valid request for the
|
21734
|
-
# StartDBInstanceAutomatedBackupsReplication API
|
21735
|
-
#
|
21885
|
+
# `StartDBInstanceAutomatedBackupsReplication` API operation that can
|
21886
|
+
# run in the Amazon Web Services Region that contains the source DB
|
21736
21887
|
# instance.
|
21737
21888
|
#
|
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
|
+
#
|
21738
21910
|
# @option params [String] :source_region
|
21739
21911
|
# The source region of the snapshot. This is only needed when the
|
21740
21912
|
# shapshot is encrypted and in a different region.
|
@@ -22303,7 +22475,8 @@ module Aws::RDS
|
|
22303
22475
|
|
22304
22476
|
# Stops automated backup replication for a DB instance.
|
22305
22477
|
#
|
22306
|
-
# This command doesn't apply to RDS Custom
|
22478
|
+
# This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora
|
22479
|
+
# PostgreSQL.
|
22307
22480
|
#
|
22308
22481
|
# For more information, see [ Replicating Automated Backups to Another
|
22309
22482
|
# Amazon Web Services Region][1] in the *Amazon RDS User Guide.*
|
@@ -22381,7 +22554,7 @@ module Aws::RDS
|
|
22381
22554
|
params: params,
|
22382
22555
|
config: config)
|
22383
22556
|
context[:gem_name] = 'aws-sdk-rds'
|
22384
|
-
context[:gem_version] = '1.
|
22557
|
+
context[:gem_version] = '1.147.0'
|
22385
22558
|
Seahorse::Client::Request.new(handlers, context)
|
22386
22559
|
end
|
22387
22560
|
|