aws-sdk-rds 1.106.0 → 1.111.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/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +828 -211
- data/lib/aws-sdk-rds/client_api.rb +78 -5
- data/lib/aws-sdk-rds/db_cluster.rb +39 -31
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +23 -22
- data/lib/aws-sdk-rds/db_instance.rb +229 -72
- data/lib/aws-sdk-rds/db_snapshot.rb +39 -17
- data/lib/aws-sdk-rds/option_group.rb +24 -0
- data/lib/aws-sdk-rds/plugins/cross_region_copying.rb +11 -12
- data/lib/aws-sdk-rds/resource.rb +170 -51
- data/lib/aws-sdk-rds/types.rb +837 -257
- metadata +2 -2
data/lib/aws-sdk-rds/types.rb
CHANGED
@@ -157,7 +157,7 @@ module Aws::RDS
|
|
157
157
|
#
|
158
158
|
# @!attribute [rw] role_arn
|
159
159
|
# The Amazon Resource Name (ARN) of the IAM role to associate with the
|
160
|
-
# Aurora DB cluster, for example
|
160
|
+
# Aurora DB cluster, for example,
|
161
161
|
# `arn:aws:iam::123456789012:role/AuroraAccessRole`.
|
162
162
|
# @return [String]
|
163
163
|
#
|
@@ -755,6 +755,45 @@ module Aws::RDS
|
|
755
755
|
include Aws::Structure
|
756
756
|
end
|
757
757
|
|
758
|
+
# This data type is used as a response element in the `ModifyDBCluster`
|
759
|
+
# operation and contains changes that will be applied during the next
|
760
|
+
# maintenance window.
|
761
|
+
#
|
762
|
+
# @!attribute [rw] pending_cloudwatch_logs_exports
|
763
|
+
# A list of the log types whose configuration is still pending. In
|
764
|
+
# other words, these log types are in the process of being activated
|
765
|
+
# or deactivated.
|
766
|
+
# @return [Types::PendingCloudwatchLogsExports]
|
767
|
+
#
|
768
|
+
# @!attribute [rw] db_cluster_identifier
|
769
|
+
# The DBClusterIdentifier value for the DB cluster.
|
770
|
+
# @return [String]
|
771
|
+
#
|
772
|
+
# @!attribute [rw] master_user_password
|
773
|
+
# The master credentials for the DB cluster.
|
774
|
+
# @return [String]
|
775
|
+
#
|
776
|
+
# @!attribute [rw] iam_database_authentication_enabled
|
777
|
+
# A value that indicates whether mapping of AWS Identity and Access
|
778
|
+
# Management (IAM) accounts to database accounts is enabled.
|
779
|
+
# @return [Boolean]
|
780
|
+
#
|
781
|
+
# @!attribute [rw] engine_version
|
782
|
+
# The database engine version.
|
783
|
+
# @return [String]
|
784
|
+
#
|
785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ClusterPendingModifiedValues AWS API Documentation
|
786
|
+
#
|
787
|
+
class ClusterPendingModifiedValues < Struct.new(
|
788
|
+
:pending_cloudwatch_logs_exports,
|
789
|
+
:db_cluster_identifier,
|
790
|
+
:master_user_password,
|
791
|
+
:iam_database_authentication_enabled,
|
792
|
+
:engine_version)
|
793
|
+
SENSITIVE = []
|
794
|
+
include Aws::Structure
|
795
|
+
end
|
796
|
+
|
758
797
|
# Specifies the settings that control the size and behavior of the
|
759
798
|
# connection pool associated with a `DBProxyTargetGroup`.
|
760
799
|
#
|
@@ -921,14 +960,7 @@ module Aws::RDS
|
|
921
960
|
#
|
922
961
|
# * Must specify a valid DB cluster parameter group.
|
923
962
|
#
|
924
|
-
#
|
925
|
-
# as the copy, specify a valid DB parameter group identifier, for
|
926
|
-
# example `my-db-cluster-param-group`, or a valid ARN.
|
927
|
-
#
|
928
|
-
# * If the source DB parameter group is in a different AWS Region than
|
929
|
-
# the copy, specify a valid DB cluster parameter group ARN, for
|
930
|
-
# example
|
931
|
-
# `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
|
963
|
+
# ^
|
932
964
|
#
|
933
965
|
#
|
934
966
|
#
|
@@ -1050,25 +1082,25 @@ module Aws::RDS
|
|
1050
1082
|
# @return [String]
|
1051
1083
|
#
|
1052
1084
|
# @!attribute [rw] kms_key_id
|
1053
|
-
# The AWS KMS key
|
1054
|
-
#
|
1055
|
-
#
|
1085
|
+
# The AWS KMS key identifier for an encrypted DB cluster snapshot. The
|
1086
|
+
# AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1087
|
+
# name for the AWS KMS customer master key (CMK).
|
1056
1088
|
#
|
1057
1089
|
# If you copy an encrypted DB cluster snapshot from your AWS account,
|
1058
1090
|
# you can specify a value for `KmsKeyId` to encrypt the copy with a
|
1059
|
-
# new KMS
|
1060
|
-
#
|
1061
|
-
#
|
1091
|
+
# new AWS KMS CMK. If you don't specify a value for `KmsKeyId`, then
|
1092
|
+
# the copy of the DB cluster snapshot is encrypted with the same AWS
|
1093
|
+
# KMS key as the source DB cluster snapshot.
|
1062
1094
|
#
|
1063
1095
|
# If you copy an encrypted DB cluster snapshot that is shared from
|
1064
1096
|
# another AWS account, then you must specify a value for `KmsKeyId`.
|
1065
1097
|
#
|
1066
1098
|
# To copy an encrypted DB cluster snapshot to another AWS Region, you
|
1067
|
-
# must set `KmsKeyId` to the KMS key
|
1068
|
-
# copy of the DB cluster snapshot in the destination AWS
|
1069
|
-
#
|
1070
|
-
# in, and you can't use
|
1071
|
-
#
|
1099
|
+
# must set `KmsKeyId` to the AWS KMS key identifier you want to use to
|
1100
|
+
# encrypt the copy of the DB cluster snapshot in the destination AWS
|
1101
|
+
# Region. AWS KMS CMKs are specific to the AWS Region that they are
|
1102
|
+
# created in, and you can't use CMKs from one AWS Region in another
|
1103
|
+
# AWS Region.
|
1072
1104
|
#
|
1073
1105
|
# If you copy an unencrypted DB cluster snapshot and specify a value
|
1074
1106
|
# for the `KmsKeyId` parameter, an error is returned.
|
@@ -1088,11 +1120,12 @@ module Aws::RDS
|
|
1088
1120
|
# be copied. The pre-signed URL request must contain the following
|
1089
1121
|
# parameter values:
|
1090
1122
|
#
|
1091
|
-
# * `KmsKeyId` - The AWS KMS key identifier for the
|
1092
|
-
# encrypt the copy of the DB cluster snapshot in
|
1093
|
-
# Region. This is the same identifier for both
|
1094
|
-
# `CopyDBClusterSnapshot` action that is called in the
|
1095
|
-
# AWS Region, and the action contained in the pre-signed
|
1123
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the customer master
|
1124
|
+
# key (CMK) to use to encrypt the copy of the DB cluster snapshot in
|
1125
|
+
# the destination AWS Region. This is the same identifier for both
|
1126
|
+
# the `CopyDBClusterSnapshot` action that is called in the
|
1127
|
+
# destination AWS Region, and the action contained in the pre-signed
|
1128
|
+
# URL.
|
1096
1129
|
#
|
1097
1130
|
# * `DestinationRegion` - The name of the AWS Region that the DB
|
1098
1131
|
# cluster snapshot is to be created in.
|
@@ -1139,9 +1172,6 @@ module Aws::RDS
|
|
1139
1172
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1140
1173
|
# @return [Array<Types::Tag>]
|
1141
1174
|
#
|
1142
|
-
# @!attribute [rw] destination_region
|
1143
|
-
# @return [String]
|
1144
|
-
#
|
1145
1175
|
# @!attribute [rw] source_region
|
1146
1176
|
# The source region of the snapshot. This is only needed when the
|
1147
1177
|
# shapshot is encrypted and in a different region.
|
@@ -1156,7 +1186,6 @@ module Aws::RDS
|
|
1156
1186
|
:pre_signed_url,
|
1157
1187
|
:copy_tags,
|
1158
1188
|
:tags,
|
1159
|
-
:destination_region,
|
1160
1189
|
:source_region)
|
1161
1190
|
SENSITIVE = []
|
1162
1191
|
include Aws::Structure
|
@@ -1201,8 +1230,7 @@ module Aws::RDS
|
|
1201
1230
|
#
|
1202
1231
|
# * Must specify a valid DB parameter group.
|
1203
1232
|
#
|
1204
|
-
#
|
1205
|
-
# `my-db-param-group`, or a valid ARN.
|
1233
|
+
# ^
|
1206
1234
|
#
|
1207
1235
|
#
|
1208
1236
|
#
|
@@ -1331,15 +1359,15 @@ module Aws::RDS
|
|
1331
1359
|
# @return [String]
|
1332
1360
|
#
|
1333
1361
|
# @!attribute [rw] kms_key_id
|
1334
|
-
# The AWS KMS key
|
1335
|
-
#
|
1336
|
-
#
|
1362
|
+
# The AWS KMS key identifier for an encrypted DB snapshot. The AWS KMS
|
1363
|
+
# key identifier is the key ARN, key ID, alias ARN, or alias name for
|
1364
|
+
# the AWS KMS customer master key (CMK).
|
1337
1365
|
#
|
1338
1366
|
# If you copy an encrypted DB snapshot from your AWS account, you can
|
1339
1367
|
# specify a value for this parameter to encrypt the copy with a new
|
1340
|
-
# KMS
|
1341
|
-
#
|
1342
|
-
#
|
1368
|
+
# AWS KMS CMK. If you don't specify a value for this parameter, then
|
1369
|
+
# the copy of the DB snapshot is encrypted with the same AWS KMS key
|
1370
|
+
# as the source DB snapshot.
|
1343
1371
|
#
|
1344
1372
|
# If you copy an encrypted DB snapshot that is shared from another AWS
|
1345
1373
|
# account, then you must specify a value for this parameter.
|
@@ -1348,10 +1376,10 @@ module Aws::RDS
|
|
1348
1376
|
# the copy is encrypted.
|
1349
1377
|
#
|
1350
1378
|
# If you copy an encrypted snapshot to a different AWS Region, then
|
1351
|
-
# you must specify a KMS key for the destination AWS
|
1352
|
-
#
|
1353
|
-
# in, and you can't use
|
1354
|
-
#
|
1379
|
+
# you must specify a AWS KMS key identifier for the destination AWS
|
1380
|
+
# Region. AWS KMS CMKs are specific to the AWS Region that they are
|
1381
|
+
# created in, and you can't use CMKs from one AWS Region in another
|
1382
|
+
# AWS Region.
|
1355
1383
|
# @return [String]
|
1356
1384
|
#
|
1357
1385
|
# @!attribute [rw] tags
|
@@ -1396,11 +1424,11 @@ module Aws::RDS
|
|
1396
1424
|
# example, the `DestinationRegion` in the presigned URL must be set
|
1397
1425
|
# to the us-east-1 AWS Region.
|
1398
1426
|
#
|
1399
|
-
# * `KmsKeyId` - The AWS KMS key identifier for the
|
1400
|
-
# encrypt the copy of the DB snapshot in the
|
1401
|
-
# This is the same identifier for both the
|
1402
|
-
# that is called in the destination AWS
|
1403
|
-
# contained in the presigned URL.
|
1427
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the customer master
|
1428
|
+
# key (CMK) to use to encrypt the copy of the DB snapshot in the
|
1429
|
+
# destination AWS Region. This is the same identifier for both the
|
1430
|
+
# `CopyDBSnapshot` action that is called in the destination AWS
|
1431
|
+
# Region, and the action contained in the presigned URL.
|
1404
1432
|
#
|
1405
1433
|
# * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
|
1406
1434
|
# encrypted snapshot to be copied. This identifier must be in the
|
@@ -1437,7 +1465,7 @@ module Aws::RDS
|
|
1437
1465
|
# group. If your source DB instance uses Transparent Data Encryption
|
1438
1466
|
# for Oracle or Microsoft SQL Server, you must specify this option
|
1439
1467
|
# when copying across AWS Regions. For more information, see [Option
|
1440
|
-
#
|
1468
|
+
# group considerations][1] in the *Amazon RDS User Guide.*
|
1441
1469
|
#
|
1442
1470
|
#
|
1443
1471
|
#
|
@@ -1451,9 +1479,6 @@ module Aws::RDS
|
|
1451
1479
|
# Example: `rds-caz-aiqhTgQv`.
|
1452
1480
|
# @return [String]
|
1453
1481
|
#
|
1454
|
-
# @!attribute [rw] destination_region
|
1455
|
-
# @return [String]
|
1456
|
-
#
|
1457
1482
|
# @!attribute [rw] source_region
|
1458
1483
|
# The source region of the snapshot. This is only needed when the
|
1459
1484
|
# shapshot is encrypted and in a different region.
|
@@ -1470,7 +1495,6 @@ module Aws::RDS
|
|
1470
1495
|
:pre_signed_url,
|
1471
1496
|
:option_group_name,
|
1472
1497
|
:target_custom_availability_zone,
|
1473
|
-
:destination_region,
|
1474
1498
|
:source_region)
|
1475
1499
|
SENSITIVE = []
|
1476
1500
|
include Aws::Structure
|
@@ -1615,8 +1639,8 @@ module Aws::RDS
|
|
1615
1639
|
# A custom Availability Zone (AZ) is an on-premises AZ that is
|
1616
1640
|
# integrated with a VMware vSphere cluster.
|
1617
1641
|
#
|
1618
|
-
# For more information about RDS on VMware, see the [
|
1619
|
-
# User Guide
|
1642
|
+
# For more information about RDS on VMware, see the [ RDS on VMware
|
1643
|
+
# User Guide.][1]
|
1620
1644
|
#
|
1621
1645
|
#
|
1622
1646
|
#
|
@@ -1954,31 +1978,27 @@ module Aws::RDS
|
|
1954
1978
|
# @!attribute [rw] kms_key_id
|
1955
1979
|
# The AWS KMS key identifier for an encrypted DB cluster.
|
1956
1980
|
#
|
1957
|
-
# The KMS key identifier is the
|
1958
|
-
#
|
1959
|
-
#
|
1960
|
-
# cluster, then you can use the KMS key alias instead of the ARN for
|
1961
|
-
# the KMS encryption key.
|
1981
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
1982
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
1983
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
1962
1984
|
#
|
1963
|
-
#
|
1985
|
+
# When a CMK isn't specified in `KmsKeyId`\:
|
1964
1986
|
#
|
1965
1987
|
# * If `ReplicationSourceIdentifier` identifies an encrypted source,
|
1966
|
-
# then Amazon RDS will use the
|
1967
|
-
#
|
1968
|
-
# key.
|
1988
|
+
# then Amazon RDS will use the CMK used to encrypt the source.
|
1989
|
+
# Otherwise, Amazon RDS will use your default CMK.
|
1969
1990
|
#
|
1970
1991
|
# * If the `StorageEncrypted` parameter is enabled and
|
1971
1992
|
# `ReplicationSourceIdentifier` isn't specified, then Amazon RDS
|
1972
|
-
# will use your default
|
1993
|
+
# will use your default CMK.
|
1973
1994
|
#
|
1974
|
-
#
|
1975
|
-
#
|
1976
|
-
# Region.
|
1995
|
+
# There is a default CMK for your AWS account. Your AWS account has a
|
1996
|
+
# different default CMK for each AWS Region.
|
1977
1997
|
#
|
1978
1998
|
# If you create a read replica of an encrypted DB cluster in another
|
1979
|
-
# AWS Region, you must set `KmsKeyId` to a KMS key
|
1980
|
-
# the destination AWS Region. This
|
1981
|
-
# replica in that AWS Region.
|
1999
|
+
# AWS Region, you must set `KmsKeyId` to a AWS KMS key identifier that
|
2000
|
+
# is valid in the destination AWS Region. This CMK is used to encrypt
|
2001
|
+
# the read replica in that AWS Region.
|
1982
2002
|
# @return [String]
|
1983
2003
|
#
|
1984
2004
|
# @!attribute [rw] pre_signed_url
|
@@ -1997,7 +2017,7 @@ module Aws::RDS
|
|
1997
2017
|
#
|
1998
2018
|
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
1999
2019
|
# encrypt the copy of the DB cluster in the destination AWS Region.
|
2000
|
-
# This should refer to the same KMS
|
2020
|
+
# This should refer to the same AWS KMS CMK for both the
|
2001
2021
|
# `CreateDBCluster` action that is called in the destination AWS
|
2002
2022
|
# Region, and the action contained in the pre-signed URL.
|
2003
2023
|
#
|
@@ -2081,7 +2101,7 @@ module Aws::RDS
|
|
2081
2101
|
# @return [Array<String>]
|
2082
2102
|
#
|
2083
2103
|
# @!attribute [rw] engine_mode
|
2084
|
-
# The DB engine mode of the DB cluster, either `provisioned
|
2104
|
+
# The DB engine mode of the DB cluster, either `provisioned`,
|
2085
2105
|
# `serverless`, `parallelquery`, `global`, or `multimaster`.
|
2086
2106
|
#
|
2087
2107
|
# The `parallelquery` engine mode isn't required for Aurora MySQL
|
@@ -2185,9 +2205,6 @@ module Aws::RDS
|
|
2185
2205
|
# disallows write operations for secondary clusters.
|
2186
2206
|
# @return [Boolean]
|
2187
2207
|
#
|
2188
|
-
# @!attribute [rw] destination_region
|
2189
|
-
# @return [String]
|
2190
|
-
#
|
2191
2208
|
# @!attribute [rw] source_region
|
2192
2209
|
# The source region of the snapshot. This is only needed when the
|
2193
2210
|
# shapshot is encrypted and in a different region.
|
@@ -2229,7 +2246,6 @@ module Aws::RDS
|
|
2229
2246
|
:domain,
|
2230
2247
|
:domain_iam_role_name,
|
2231
2248
|
:enable_global_write_forwarding,
|
2232
|
-
:destination_region,
|
2233
2249
|
:source_region)
|
2234
2250
|
SENSITIVE = []
|
2235
2251
|
include Aws::Structure
|
@@ -2461,6 +2477,7 @@ module Aws::RDS
|
|
2461
2477
|
# ],
|
2462
2478
|
# deletion_protection: false,
|
2463
2479
|
# max_allocated_storage: 1,
|
2480
|
+
# enable_customer_owned_ip: false,
|
2464
2481
|
# }
|
2465
2482
|
#
|
2466
2483
|
# @!attribute [rw] db_name
|
@@ -2500,8 +2517,8 @@ module Aws::RDS
|
|
2500
2517
|
# **PostgreSQL**
|
2501
2518
|
#
|
2502
2519
|
# The name of the database to create when the DB instance is created.
|
2503
|
-
# If this parameter isn't specified,
|
2504
|
-
#
|
2520
|
+
# If this parameter isn't specified, a database named `postgres` is
|
2521
|
+
# created in the DB instance.
|
2505
2522
|
#
|
2506
2523
|
# Constraints:
|
2507
2524
|
#
|
@@ -2530,17 +2547,34 @@ module Aws::RDS
|
|
2530
2547
|
#
|
2531
2548
|
# Not applicable. Must be null.
|
2532
2549
|
#
|
2533
|
-
# **Amazon Aurora**
|
2550
|
+
# **Amazon Aurora MySQL**
|
2534
2551
|
#
|
2535
|
-
# The name of the database to create when the primary instance of
|
2536
|
-
# DB cluster is created. If this parameter isn't
|
2537
|
-
# database is created in
|
2552
|
+
# The name of the database to create when the primary DB instance of
|
2553
|
+
# the Aurora MySQL DB cluster is created. If this parameter isn't
|
2554
|
+
# specified for an Aurora MySQL DB cluster, no database is created in
|
2555
|
+
# the DB cluster.
|
2538
2556
|
#
|
2539
2557
|
# Constraints:
|
2540
2558
|
#
|
2541
|
-
# *
|
2559
|
+
# * It must contain 1 to 64 alphanumeric characters.
|
2542
2560
|
#
|
2543
|
-
# *
|
2561
|
+
# * It can't be a word reserved by the database engine.
|
2562
|
+
#
|
2563
|
+
# **Amazon Aurora PostgreSQL**
|
2564
|
+
#
|
2565
|
+
# The name of the database to create when the primary DB instance of
|
2566
|
+
# the Aurora PostgreSQL DB cluster is created. If this parameter
|
2567
|
+
# isn't specified for an Aurora PostgreSQL DB cluster, a database
|
2568
|
+
# named `postgres` is created in the DB cluster.
|
2569
|
+
#
|
2570
|
+
# Constraints:
|
2571
|
+
#
|
2572
|
+
# * It must contain 1 to 63 alphanumeric characters.
|
2573
|
+
#
|
2574
|
+
# * It must begin with a letter or an underscore. Subsequent
|
2575
|
+
# characters can be letters, underscores, or digits (0 to 9).
|
2576
|
+
#
|
2577
|
+
# * It can't be a word reserved by the database engine.
|
2544
2578
|
# @return [String]
|
2545
2579
|
#
|
2546
2580
|
# @!attribute [rw] db_instance_identifier
|
@@ -2831,8 +2865,8 @@ module Aws::RDS
|
|
2831
2865
|
# specify the identifier of the custom Availability Zone to create the
|
2832
2866
|
# DB instance in.
|
2833
2867
|
#
|
2834
|
-
# For more information about RDS on VMware, see the [
|
2835
|
-
# User Guide
|
2868
|
+
# For more information about RDS on VMware, see the [ RDS on VMware
|
2869
|
+
# User Guide.][2]
|
2836
2870
|
#
|
2837
2871
|
# </note>
|
2838
2872
|
#
|
@@ -3025,8 +3059,8 @@ module Aws::RDS
|
|
3025
3059
|
#
|
3026
3060
|
# **PostgreSQL**
|
3027
3061
|
#
|
3028
|
-
# See [
|
3029
|
-
# User Guide.*
|
3062
|
+
# See [Amazon RDS for PostgreSQL versions and extensions][5] in the
|
3063
|
+
# *Amazon RDS User Guide.*
|
3030
3064
|
#
|
3031
3065
|
#
|
3032
3066
|
#
|
@@ -3034,7 +3068,7 @@ module Aws::RDS
|
|
3034
3068
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
|
3035
3069
|
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
3036
3070
|
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
3037
|
-
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
3071
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
3038
3072
|
# @return [String]
|
3039
3073
|
#
|
3040
3074
|
# @!attribute [rw] auto_minor_version_upgrade
|
@@ -3067,8 +3101,8 @@ module Aws::RDS
|
|
3067
3101
|
# @return [Integer]
|
3068
3102
|
#
|
3069
3103
|
# @!attribute [rw] option_group_name
|
3070
|
-
#
|
3071
|
-
# specified option group.
|
3104
|
+
# A value that indicates that the DB instance should be associated
|
3105
|
+
# with the specified option group.
|
3072
3106
|
#
|
3073
3107
|
# Permanent options, such as the TDE option for Oracle Advanced
|
3074
3108
|
# Security TDE, can't be removed from an option group. Also, that
|
@@ -3168,22 +3202,19 @@ module Aws::RDS
|
|
3168
3202
|
# @!attribute [rw] kms_key_id
|
3169
3203
|
# The AWS KMS key identifier for an encrypted DB instance.
|
3170
3204
|
#
|
3171
|
-
# The KMS key identifier is the
|
3172
|
-
#
|
3173
|
-
#
|
3174
|
-
# instance, then you can use the KMS key alias instead of the ARN for
|
3175
|
-
# the KM encryption key.
|
3205
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
3206
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
3207
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
3176
3208
|
#
|
3177
3209
|
# **Amazon Aurora**
|
3178
3210
|
#
|
3179
|
-
# Not applicable. The KMS key identifier is managed by the DB
|
3180
|
-
# For more information, see `CreateDBCluster`.
|
3211
|
+
# Not applicable. The AWS KMS key identifier is managed by the DB
|
3212
|
+
# cluster. For more information, see `CreateDBCluster`.
|
3181
3213
|
#
|
3182
3214
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
3183
|
-
# the `KmsKeyId` parameter, then Amazon RDS
|
3184
|
-
#
|
3185
|
-
#
|
3186
|
-
# for each AWS Region.
|
3215
|
+
# the `KmsKeyId` parameter, then Amazon RDS uses your default CMK.
|
3216
|
+
# There is a default CMK for your AWS account. Your AWS account has a
|
3217
|
+
# different default CMK for each AWS Region.
|
3187
3218
|
# @return [String]
|
3188
3219
|
#
|
3189
3220
|
# @!attribute [rw] domain
|
@@ -3295,13 +3326,15 @@ module Aws::RDS
|
|
3295
3326
|
#
|
3296
3327
|
# @!attribute [rw] performance_insights_kms_key_id
|
3297
3328
|
# The AWS KMS key identifier for encryption of Performance Insights
|
3298
|
-
# data.
|
3299
|
-
#
|
3329
|
+
# data.
|
3330
|
+
#
|
3331
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
3332
|
+
# alias name for the AWS KMS customer master key (CMK).
|
3300
3333
|
#
|
3301
3334
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
3302
|
-
# then Amazon RDS uses your default
|
3303
|
-
#
|
3304
|
-
#
|
3335
|
+
# then Amazon RDS uses your default CMK. There is a default CMK for
|
3336
|
+
# your AWS account. Your AWS account has a different default CMK for
|
3337
|
+
# each AWS Region.
|
3305
3338
|
# @return [String]
|
3306
3339
|
#
|
3307
3340
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -3335,7 +3368,8 @@ module Aws::RDS
|
|
3335
3368
|
#
|
3336
3369
|
# **Oracle**
|
3337
3370
|
#
|
3338
|
-
# Possible values are `alert`, `audit`, `listener`,
|
3371
|
+
# Possible values are `alert`, `audit`, `listener`, `trace`, and
|
3372
|
+
# `oemagent`.
|
3339
3373
|
#
|
3340
3374
|
# **PostgreSQL**
|
3341
3375
|
#
|
@@ -3372,8 +3406,38 @@ module Aws::RDS
|
|
3372
3406
|
# @!attribute [rw] max_allocated_storage
|
3373
3407
|
# The upper limit to which Amazon RDS can automatically scale the
|
3374
3408
|
# storage of the DB instance.
|
3409
|
+
#
|
3410
|
+
# For more information about this setting, including limitations that
|
3411
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
3412
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
3413
|
+
#
|
3414
|
+
#
|
3415
|
+
#
|
3416
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
3375
3417
|
# @return [Integer]
|
3376
3418
|
#
|
3419
|
+
# @!attribute [rw] enable_customer_owned_ip
|
3420
|
+
# A value that indicates whether to enable a customer-owned IP address
|
3421
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
3422
|
+
#
|
3423
|
+
# A *CoIP* provides local or external connectivity to resources in
|
3424
|
+
# your Outpost subnets through your on-premises network. For some use
|
3425
|
+
# cases, a CoIP can provide lower latency for connections to the DB
|
3426
|
+
# instance from outside of its virtual private cloud (VPC) on your
|
3427
|
+
# local network.
|
3428
|
+
#
|
3429
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
3430
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
3431
|
+
#
|
3432
|
+
# For more information about CoIPs, see [Customer-owned IP
|
3433
|
+
# addresses][2] in the *AWS Outposts User Guide*.
|
3434
|
+
#
|
3435
|
+
#
|
3436
|
+
#
|
3437
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
3438
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
3439
|
+
# @return [Boolean]
|
3440
|
+
#
|
3377
3441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceMessage AWS API Documentation
|
3378
3442
|
#
|
3379
3443
|
class CreateDBInstanceMessage < Struct.new(
|
@@ -3423,7 +3487,8 @@ module Aws::RDS
|
|
3423
3487
|
:enable_cloudwatch_logs_exports,
|
3424
3488
|
:processor_features,
|
3425
3489
|
:deletion_protection,
|
3426
|
-
:max_allocated_storage
|
3490
|
+
:max_allocated_storage,
|
3491
|
+
:enable_customer_owned_ip)
|
3427
3492
|
SENSITIVE = []
|
3428
3493
|
include Aws::Structure
|
3429
3494
|
end
|
@@ -3719,19 +3784,20 @@ module Aws::RDS
|
|
3719
3784
|
# @return [String]
|
3720
3785
|
#
|
3721
3786
|
# @!attribute [rw] kms_key_id
|
3722
|
-
# The AWS KMS key
|
3723
|
-
#
|
3724
|
-
#
|
3787
|
+
# The AWS KMS key identifier for an encrypted read replica.
|
3788
|
+
#
|
3789
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
3790
|
+
# alias name for the AWS KMS CMK.
|
3725
3791
|
#
|
3726
3792
|
# If you create an encrypted read replica in the same AWS Region as
|
3727
|
-
# the source DB instance, then
|
3728
|
-
#
|
3729
|
-
# as the source DB instance.
|
3793
|
+
# the source DB instance, then do not specify a value for this
|
3794
|
+
# parameter. A read replica in the same Region is always encrypted
|
3795
|
+
# with the same AWS KMS CMK as the source DB instance.
|
3730
3796
|
#
|
3731
3797
|
# If you create an encrypted read replica in a different AWS Region,
|
3732
|
-
# then you must specify a KMS key for the destination
|
3733
|
-
#
|
3734
|
-
# in, and you can't use
|
3798
|
+
# then you must specify a AWS KMS key identifier for the destination
|
3799
|
+
# AWS Region. AWS KMS CMKs are specific to the AWS Region that they
|
3800
|
+
# are created in, and you can't use CMKs from one AWS Region in
|
3735
3801
|
# another AWS Region.
|
3736
3802
|
#
|
3737
3803
|
# You can't create an encrypted read replica from an unencrypted DB
|
@@ -3830,13 +3896,15 @@ module Aws::RDS
|
|
3830
3896
|
#
|
3831
3897
|
# @!attribute [rw] performance_insights_kms_key_id
|
3832
3898
|
# The AWS KMS key identifier for encryption of Performance Insights
|
3833
|
-
# data.
|
3834
|
-
#
|
3899
|
+
# data.
|
3900
|
+
#
|
3901
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
3902
|
+
# alias name for the AWS KMS customer master key (CMK).
|
3835
3903
|
#
|
3836
3904
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
3837
|
-
# then Amazon RDS uses your default
|
3838
|
-
#
|
3839
|
-
#
|
3905
|
+
# then Amazon RDS uses your default CMK. There is a default CMK for
|
3906
|
+
# your AWS account. Your AWS account has a different default CMK for
|
3907
|
+
# each AWS Region.
|
3840
3908
|
# @return [String]
|
3841
3909
|
#
|
3842
3910
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -3921,10 +3989,15 @@ module Aws::RDS
|
|
3921
3989
|
# @!attribute [rw] max_allocated_storage
|
3922
3990
|
# The upper limit to which Amazon RDS can automatically scale the
|
3923
3991
|
# storage of the DB instance.
|
3924
|
-
# @return [Integer]
|
3925
3992
|
#
|
3926
|
-
#
|
3927
|
-
#
|
3993
|
+
# For more information about this setting, including limitations that
|
3994
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
3995
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
3996
|
+
#
|
3997
|
+
#
|
3998
|
+
#
|
3999
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
4000
|
+
# @return [Integer]
|
3928
4001
|
#
|
3929
4002
|
# @!attribute [rw] source_region
|
3930
4003
|
# The source region of the snapshot. This is only needed when the
|
@@ -3966,7 +4039,6 @@ module Aws::RDS
|
|
3966
4039
|
:domain_iam_role_name,
|
3967
4040
|
:replica_mode,
|
3968
4041
|
:max_allocated_storage,
|
3969
|
-
:destination_region,
|
3970
4042
|
:source_region)
|
3971
4043
|
SENSITIVE = []
|
3972
4044
|
include Aws::Structure
|
@@ -4634,6 +4706,30 @@ module Aws::RDS
|
|
4634
4706
|
# @!attribute [rw] engine_name
|
4635
4707
|
# Specifies the name of the engine that this option group should be
|
4636
4708
|
# associated with.
|
4709
|
+
#
|
4710
|
+
# Valid Values:
|
4711
|
+
#
|
4712
|
+
# * `mariadb`
|
4713
|
+
#
|
4714
|
+
# * `mysql`
|
4715
|
+
#
|
4716
|
+
# * `oracle-ee`
|
4717
|
+
#
|
4718
|
+
# * `oracle-se2`
|
4719
|
+
#
|
4720
|
+
# * `oracle-se1`
|
4721
|
+
#
|
4722
|
+
# * `oracle-se`
|
4723
|
+
#
|
4724
|
+
# * `postgres`
|
4725
|
+
#
|
4726
|
+
# * `sqlserver-ee`
|
4727
|
+
#
|
4728
|
+
# * `sqlserver-se`
|
4729
|
+
#
|
4730
|
+
# * `sqlserver-ex`
|
4731
|
+
#
|
4732
|
+
# * `sqlserver-web`
|
4637
4733
|
# @return [String]
|
4638
4734
|
#
|
4639
4735
|
# @!attribute [rw] major_engine_version
|
@@ -4675,8 +4771,8 @@ module Aws::RDS
|
|
4675
4771
|
# A custom Availability Zone (AZ) is an on-premises AZ that is
|
4676
4772
|
# integrated with a VMware vSphere cluster.
|
4677
4773
|
#
|
4678
|
-
# For more information about RDS on VMware, see the [
|
4679
|
-
#
|
4774
|
+
# For more information about RDS on VMware, see the [ RDS on VMware User
|
4775
|
+
# Guide.][1]
|
4680
4776
|
#
|
4681
4777
|
#
|
4682
4778
|
#
|
@@ -4914,12 +5010,15 @@ module Aws::RDS
|
|
4914
5010
|
# @!attribute [rw] kms_key_id
|
4915
5011
|
# If `StorageEncrypted` is enabled, the AWS KMS key identifier for the
|
4916
5012
|
# encrypted DB cluster.
|
5013
|
+
#
|
5014
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
5015
|
+
# alias name for the AWS KMS customer master key (CMK).
|
4917
5016
|
# @return [String]
|
4918
5017
|
#
|
4919
5018
|
# @!attribute [rw] db_cluster_resource_id
|
4920
5019
|
# The AWS Region-unique, immutable identifier for the DB cluster. This
|
4921
5020
|
# identifier is found in AWS CloudTrail log entries whenever the AWS
|
4922
|
-
# KMS
|
5021
|
+
# KMS CMK for the DB cluster is accessed.
|
4923
5022
|
# @return [String]
|
4924
5023
|
#
|
4925
5024
|
# @!attribute [rw] db_cluster_arn
|
@@ -5045,6 +5144,9 @@ module Aws::RDS
|
|
5045
5144
|
# @!attribute [rw] activity_stream_kms_key_id
|
5046
5145
|
# The AWS KMS key identifier used for encrypting messages in the
|
5047
5146
|
# database activity stream.
|
5147
|
+
#
|
5148
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
5149
|
+
# alias name for the AWS KMS customer master key (CMK).
|
5048
5150
|
# @return [String]
|
5049
5151
|
#
|
5050
5152
|
# @!attribute [rw] activity_stream_kinesis_stream_name
|
@@ -5091,6 +5193,12 @@ module Aws::RDS
|
|
5091
5193
|
# cluster.
|
5092
5194
|
# @return [Boolean]
|
5093
5195
|
#
|
5196
|
+
# @!attribute [rw] pending_modified_values
|
5197
|
+
# A value that specifies that changes to the DB cluster are pending.
|
5198
|
+
# This element is only included when changes are pending. Specific
|
5199
|
+
# changes are identified by subelements.
|
5200
|
+
# @return [Types::ClusterPendingModifiedValues]
|
5201
|
+
#
|
5094
5202
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBCluster AWS API Documentation
|
5095
5203
|
#
|
5096
5204
|
class DBCluster < Struct.new(
|
@@ -5148,7 +5256,8 @@ module Aws::RDS
|
|
5148
5256
|
:domain_memberships,
|
5149
5257
|
:tag_list,
|
5150
5258
|
:global_write_forwarding_status,
|
5151
|
-
:global_write_forwarding_requested
|
5259
|
+
:global_write_forwarding_requested,
|
5260
|
+
:pending_modified_values)
|
5152
5261
|
SENSITIVE = []
|
5153
5262
|
include Aws::Structure
|
5154
5263
|
end
|
@@ -5738,6 +5847,9 @@ module Aws::RDS
|
|
5738
5847
|
# @!attribute [rw] kms_key_id
|
5739
5848
|
# If `StorageEncrypted` is true, the AWS KMS key identifier for the
|
5740
5849
|
# encrypted DB cluster snapshot.
|
5850
|
+
#
|
5851
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
5852
|
+
# alias name for the AWS KMS customer master key (CMK).
|
5741
5853
|
# @return [String]
|
5742
5854
|
#
|
5743
5855
|
# @!attribute [rw] db_cluster_snapshot_arn
|
@@ -6138,9 +6250,9 @@ module Aws::RDS
|
|
6138
6250
|
# @return [String]
|
6139
6251
|
#
|
6140
6252
|
# @!attribute [rw] pending_modified_values
|
6141
|
-
#
|
6142
|
-
# is only included when changes are pending. Specific
|
6143
|
-
# identified by subelements.
|
6253
|
+
# A value that specifies that changes to the DB instance are pending.
|
6254
|
+
# This element is only included when changes are pending. Specific
|
6255
|
+
# changes are identified by subelements.
|
6144
6256
|
# @return [Types::PendingModifiedValues]
|
6145
6257
|
#
|
6146
6258
|
# @!attribute [rw] latest_restorable_time
|
@@ -6157,7 +6269,8 @@ module Aws::RDS
|
|
6157
6269
|
# @return [String]
|
6158
6270
|
#
|
6159
6271
|
# @!attribute [rw] auto_minor_version_upgrade
|
6160
|
-
#
|
6272
|
+
# A value that indicates that minor version patches are applied
|
6273
|
+
# automatically.
|
6161
6274
|
# @return [Boolean]
|
6162
6275
|
#
|
6163
6276
|
# @!attribute [rw] read_replica_source_db_instance_identifier
|
@@ -6274,12 +6387,15 @@ module Aws::RDS
|
|
6274
6387
|
# @!attribute [rw] kms_key_id
|
6275
6388
|
# If `StorageEncrypted` is true, the AWS KMS key identifier for the
|
6276
6389
|
# encrypted DB instance.
|
6390
|
+
#
|
6391
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
6392
|
+
# alias name for the AWS KMS customer master key (CMK).
|
6277
6393
|
# @return [String]
|
6278
6394
|
#
|
6279
6395
|
# @!attribute [rw] dbi_resource_id
|
6280
6396
|
# The AWS Region-unique, immutable identifier for the DB instance.
|
6281
6397
|
# This identifier is found in AWS CloudTrail log entries whenever the
|
6282
|
-
# AWS KMS key for the DB instance is accessed.
|
6398
|
+
# AWS KMS customer master key (CMK) for the DB instance is accessed.
|
6283
6399
|
# @return [String]
|
6284
6400
|
#
|
6285
6401
|
# @!attribute [rw] ca_certificate_identifier
|
@@ -6361,8 +6477,10 @@ module Aws::RDS
|
|
6361
6477
|
#
|
6362
6478
|
# @!attribute [rw] performance_insights_kms_key_id
|
6363
6479
|
# The AWS KMS key identifier for encryption of Performance Insights
|
6364
|
-
# data.
|
6365
|
-
#
|
6480
|
+
# data.
|
6481
|
+
#
|
6482
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
6483
|
+
# alias name for the AWS KMS customer master key (CMK).
|
6366
6484
|
# @return [String]
|
6367
6485
|
#
|
6368
6486
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -6421,6 +6539,33 @@ module Aws::RDS
|
|
6421
6539
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
6422
6540
|
# @return [Array<Types::Tag>]
|
6423
6541
|
#
|
6542
|
+
# @!attribute [rw] db_instance_automated_backups_replications
|
6543
|
+
# The list of replicated automated backups associated with the DB
|
6544
|
+
# instance.
|
6545
|
+
# @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
|
6546
|
+
#
|
6547
|
+
# @!attribute [rw] customer_owned_ip_enabled
|
6548
|
+
# Specifies whether a customer-owned IP address (CoIP) is enabled for
|
6549
|
+
# an RDS on Outposts DB instance.
|
6550
|
+
#
|
6551
|
+
# A <i>CoIP </i>provides local or external connectivity to resources
|
6552
|
+
# in your Outpost subnets through your on-premises network. For some
|
6553
|
+
# use cases, a CoIP can provide lower latency for connections to the
|
6554
|
+
# DB instance from outside of its virtual private cloud (VPC) on your
|
6555
|
+
# local network.
|
6556
|
+
#
|
6557
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
6558
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
6559
|
+
#
|
6560
|
+
# For more information about CoIPs, see [Customer-owned IP
|
6561
|
+
# addresses][2] in the *AWS Outposts User Guide*.
|
6562
|
+
#
|
6563
|
+
#
|
6564
|
+
#
|
6565
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
6566
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
6567
|
+
# @return [Boolean]
|
6568
|
+
#
|
6424
6569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstance AWS API Documentation
|
6425
6570
|
#
|
6426
6571
|
class DBInstance < Struct.new(
|
@@ -6484,7 +6629,9 @@ module Aws::RDS
|
|
6484
6629
|
:associated_roles,
|
6485
6630
|
:listener_endpoint,
|
6486
6631
|
:max_allocated_storage,
|
6487
|
-
:tag_list
|
6632
|
+
:tag_list,
|
6633
|
+
:db_instance_automated_backups_replications,
|
6634
|
+
:customer_owned_ip_enabled)
|
6488
6635
|
SENSITIVE = []
|
6489
6636
|
include Aws::Structure
|
6490
6637
|
end
|
@@ -6495,12 +6642,12 @@ module Aws::RDS
|
|
6495
6642
|
#
|
6496
6643
|
class DBInstanceAlreadyExistsFault < Aws::EmptyStructure; end
|
6497
6644
|
|
6498
|
-
# An automated backup of a DB instance. It
|
6499
|
-
#
|
6500
|
-
#
|
6645
|
+
# An automated backup of a DB instance. It consists of system backups,
|
6646
|
+
# transaction logs, and the database instance properties that existed at
|
6647
|
+
# the time you deleted the source instance.
|
6501
6648
|
#
|
6502
6649
|
# @!attribute [rw] db_instance_arn
|
6503
|
-
# The Amazon Resource Name (ARN) for the automated
|
6650
|
+
# The Amazon Resource Name (ARN) for the automated backups.
|
6504
6651
|
# @return [String]
|
6505
6652
|
#
|
6506
6653
|
# @!attribute [rw] dbi_resource_id
|
@@ -6601,9 +6748,10 @@ module Aws::RDS
|
|
6601
6748
|
# @return [String]
|
6602
6749
|
#
|
6603
6750
|
# @!attribute [rw] kms_key_id
|
6604
|
-
# The AWS KMS key ID for an automated backup.
|
6605
|
-
#
|
6606
|
-
#
|
6751
|
+
# The AWS KMS key ID for an automated backup.
|
6752
|
+
#
|
6753
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
6754
|
+
# alias name for the AWS KMS customer master key (CMK).
|
6607
6755
|
# @return [String]
|
6608
6756
|
#
|
6609
6757
|
# @!attribute [rw] timezone
|
@@ -6617,6 +6765,19 @@ module Aws::RDS
|
|
6617
6765
|
# to database accounts is enabled, and otherwise false.
|
6618
6766
|
# @return [Boolean]
|
6619
6767
|
#
|
6768
|
+
# @!attribute [rw] backup_retention_period
|
6769
|
+
# The retention period for the automated backups.
|
6770
|
+
# @return [Integer]
|
6771
|
+
#
|
6772
|
+
# @!attribute [rw] db_instance_automated_backups_arn
|
6773
|
+
# The Amazon Resource Name (ARN) for the replicated automated backups.
|
6774
|
+
# @return [String]
|
6775
|
+
#
|
6776
|
+
# @!attribute [rw] db_instance_automated_backups_replications
|
6777
|
+
# The list of replications to different AWS Regions associated with
|
6778
|
+
# the automated backup.
|
6779
|
+
# @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
|
6780
|
+
#
|
6620
6781
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstanceAutomatedBackup AWS API Documentation
|
6621
6782
|
#
|
6622
6783
|
class DBInstanceAutomatedBackup < Struct.new(
|
@@ -6642,7 +6803,10 @@ module Aws::RDS
|
|
6642
6803
|
:storage_type,
|
6643
6804
|
:kms_key_id,
|
6644
6805
|
:timezone,
|
6645
|
-
:iam_database_authentication_enabled
|
6806
|
+
:iam_database_authentication_enabled,
|
6807
|
+
:backup_retention_period,
|
6808
|
+
:db_instance_automated_backups_arn,
|
6809
|
+
:db_instance_automated_backups_replications)
|
6646
6810
|
SENSITIVE = []
|
6647
6811
|
include Aws::Structure
|
6648
6812
|
end
|
@@ -6683,6 +6847,22 @@ module Aws::RDS
|
|
6683
6847
|
#
|
6684
6848
|
class DBInstanceAutomatedBackupQuotaExceededFault < Aws::EmptyStructure; end
|
6685
6849
|
|
6850
|
+
# Automated backups of a DB instance replicated to another AWS Region.
|
6851
|
+
# They consist of system backups, transaction logs, and database
|
6852
|
+
# instance properties.
|
6853
|
+
#
|
6854
|
+
# @!attribute [rw] db_instance_automated_backups_arn
|
6855
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups.
|
6856
|
+
# @return [String]
|
6857
|
+
#
|
6858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstanceAutomatedBackupsReplication AWS API Documentation
|
6859
|
+
#
|
6860
|
+
class DBInstanceAutomatedBackupsReplication < Struct.new(
|
6861
|
+
:db_instance_automated_backups_arn)
|
6862
|
+
SENSITIVE = []
|
6863
|
+
include Aws::Structure
|
6864
|
+
end
|
6865
|
+
|
6686
6866
|
# Contains the result of a successful invocation of the
|
6687
6867
|
# `DescribeDBInstances` action.
|
6688
6868
|
#
|
@@ -7450,6 +7630,9 @@ module Aws::RDS
|
|
7450
7630
|
# @!attribute [rw] kms_key_id
|
7451
7631
|
# If `Encrypted` is true, the AWS KMS key identifier for the encrypted
|
7452
7632
|
# DB snapshot.
|
7633
|
+
#
|
7634
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
7635
|
+
# alias name for the AWS KMS customer master key (CMK).
|
7453
7636
|
# @return [String]
|
7454
7637
|
#
|
7455
7638
|
# @!attribute [rw] db_snapshot_arn
|
@@ -7751,8 +7934,8 @@ module Aws::RDS
|
|
7751
7934
|
# A custom Availability Zone (AZ) is an on-premises AZ that is
|
7752
7935
|
# integrated with a VMware vSphere cluster.
|
7753
7936
|
#
|
7754
|
-
# For more information about RDS on VMware, see the [
|
7755
|
-
# User Guide
|
7937
|
+
# For more information about RDS on VMware, see the [ RDS on VMware
|
7938
|
+
# User Guide.][1]
|
7756
7939
|
#
|
7757
7940
|
#
|
7758
7941
|
#
|
@@ -7935,7 +8118,8 @@ module Aws::RDS
|
|
7935
8118
|
# data as a hash:
|
7936
8119
|
#
|
7937
8120
|
# {
|
7938
|
-
# dbi_resource_id: "String",
|
8121
|
+
# dbi_resource_id: "String",
|
8122
|
+
# db_instance_automated_backups_arn: "String",
|
7939
8123
|
# }
|
7940
8124
|
#
|
7941
8125
|
# @!attribute [rw] dbi_resource_id
|
@@ -7943,18 +8127,25 @@ module Aws::RDS
|
|
7943
8127
|
# and which is unique to an AWS Region.
|
7944
8128
|
# @return [String]
|
7945
8129
|
#
|
8130
|
+
# @!attribute [rw] db_instance_automated_backups_arn
|
8131
|
+
# The Amazon Resource Name (ARN) of the automated backups to delete,
|
8132
|
+
# for example,
|
8133
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
8134
|
+
# @return [String]
|
8135
|
+
#
|
7946
8136
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceAutomatedBackupMessage AWS API Documentation
|
7947
8137
|
#
|
7948
8138
|
class DeleteDBInstanceAutomatedBackupMessage < Struct.new(
|
7949
|
-
:dbi_resource_id
|
8139
|
+
:dbi_resource_id,
|
8140
|
+
:db_instance_automated_backups_arn)
|
7950
8141
|
SENSITIVE = []
|
7951
8142
|
include Aws::Structure
|
7952
8143
|
end
|
7953
8144
|
|
7954
8145
|
# @!attribute [rw] db_instance_automated_backup
|
7955
|
-
# An automated backup of a DB instance. It
|
7956
|
-
#
|
7957
|
-
#
|
8146
|
+
# An automated backup of a DB instance. It consists of system backups,
|
8147
|
+
# transaction logs, and the database instance properties that existed
|
8148
|
+
# at the time you deleted the source instance.
|
7958
8149
|
# @return [Types::DBInstanceAutomatedBackup]
|
7959
8150
|
#
|
7960
8151
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceAutomatedBackupResult AWS API Documentation
|
@@ -9069,6 +9260,36 @@ module Aws::RDS
|
|
9069
9260
|
#
|
9070
9261
|
# @!attribute [rw] engine
|
9071
9262
|
# The database engine to return.
|
9263
|
+
#
|
9264
|
+
# Valid Values:
|
9265
|
+
#
|
9266
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
9267
|
+
#
|
9268
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
9269
|
+
#
|
9270
|
+
# * `aurora-postgresql`
|
9271
|
+
#
|
9272
|
+
# * `mariadb`
|
9273
|
+
#
|
9274
|
+
# * `mysql`
|
9275
|
+
#
|
9276
|
+
# * `oracle-ee`
|
9277
|
+
#
|
9278
|
+
# * `oracle-se2`
|
9279
|
+
#
|
9280
|
+
# * `oracle-se1`
|
9281
|
+
#
|
9282
|
+
# * `oracle-se`
|
9283
|
+
#
|
9284
|
+
# * `postgres`
|
9285
|
+
#
|
9286
|
+
# * `sqlserver-ee`
|
9287
|
+
#
|
9288
|
+
# * `sqlserver-se`
|
9289
|
+
#
|
9290
|
+
# * `sqlserver-ex`
|
9291
|
+
#
|
9292
|
+
# * `sqlserver-web`
|
9072
9293
|
# @return [String]
|
9073
9294
|
#
|
9074
9295
|
# @!attribute [rw] engine_version
|
@@ -9172,6 +9393,7 @@ module Aws::RDS
|
|
9172
9393
|
# ],
|
9173
9394
|
# max_records: 1,
|
9174
9395
|
# marker: "String",
|
9396
|
+
# db_instance_automated_backups_arn: "String",
|
9175
9397
|
# }
|
9176
9398
|
#
|
9177
9399
|
# @!attribute [rw] dbi_resource_id
|
@@ -9195,20 +9417,19 @@ module Aws::RDS
|
|
9195
9417
|
#
|
9196
9418
|
# * `active` - automated backups for current instances
|
9197
9419
|
#
|
9198
|
-
# * `retained` - automated backups for deleted instances
|
9420
|
+
# * `retained` - automated backups for deleted instances and after
|
9421
|
+
# backup replication is stopped
|
9199
9422
|
#
|
9200
9423
|
# * `creating` - automated backups that are waiting for the first
|
9201
9424
|
# automated snapshot to be available
|
9202
9425
|
#
|
9203
9426
|
# * `db-instance-id` - Accepts DB instance identifiers and Amazon
|
9204
|
-
# Resource Names (ARNs)
|
9205
|
-
#
|
9206
|
-
# identified by these ARNs.
|
9427
|
+
# Resource Names (ARNs). The results list includes only information
|
9428
|
+
# about the DB instance automated backups identified by these ARNs.
|
9207
9429
|
#
|
9208
|
-
# * `dbi-resource-id` - Accepts DB
|
9209
|
-
#
|
9210
|
-
#
|
9211
|
-
# identified by these ARNs.
|
9430
|
+
# * `dbi-resource-id` - Accepts DB resource identifiers and Amazon
|
9431
|
+
# Resource Names (ARNs). The results list includes only information
|
9432
|
+
# about the DB instance resources identified by these ARNs.
|
9212
9433
|
#
|
9213
9434
|
# Returns all resources by default. The status for each resource is
|
9214
9435
|
# specified in the response.
|
@@ -9227,6 +9448,12 @@ module Aws::RDS
|
|
9227
9448
|
# marker, up to `MaxRecords`.
|
9228
9449
|
# @return [String]
|
9229
9450
|
#
|
9451
|
+
# @!attribute [rw] db_instance_automated_backups_arn
|
9452
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups,
|
9453
|
+
# for example,
|
9454
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
9455
|
+
# @return [String]
|
9456
|
+
#
|
9230
9457
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstanceAutomatedBackupsMessage AWS API Documentation
|
9231
9458
|
#
|
9232
9459
|
class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
|
@@ -9234,7 +9461,8 @@ module Aws::RDS
|
|
9234
9461
|
:db_instance_identifier,
|
9235
9462
|
:filters,
|
9236
9463
|
:max_records,
|
9237
|
-
:marker
|
9464
|
+
:marker,
|
9465
|
+
:db_instance_automated_backups_arn)
|
9238
9466
|
SENSITIVE = []
|
9239
9467
|
include Aws::Structure
|
9240
9468
|
end
|
@@ -10660,6 +10888,30 @@ module Aws::RDS
|
|
10660
10888
|
# @!attribute [rw] engine_name
|
10661
10889
|
# A required parameter. Options available for the given engine name
|
10662
10890
|
# are described.
|
10891
|
+
#
|
10892
|
+
# Valid Values:
|
10893
|
+
#
|
10894
|
+
# * `mariadb`
|
10895
|
+
#
|
10896
|
+
# * `mysql`
|
10897
|
+
#
|
10898
|
+
# * `oracle-ee`
|
10899
|
+
#
|
10900
|
+
# * `oracle-se2`
|
10901
|
+
#
|
10902
|
+
# * `oracle-se1`
|
10903
|
+
#
|
10904
|
+
# * `oracle-se`
|
10905
|
+
#
|
10906
|
+
# * `postgres`
|
10907
|
+
#
|
10908
|
+
# * `sqlserver-ee`
|
10909
|
+
#
|
10910
|
+
# * `sqlserver-se`
|
10911
|
+
#
|
10912
|
+
# * `sqlserver-ex`
|
10913
|
+
#
|
10914
|
+
# * `sqlserver-web`
|
10663
10915
|
# @return [String]
|
10664
10916
|
#
|
10665
10917
|
# @!attribute [rw] major_engine_version
|
@@ -10747,6 +10999,30 @@ module Aws::RDS
|
|
10747
10999
|
# @!attribute [rw] engine_name
|
10748
11000
|
# Filters the list of option groups to only include groups associated
|
10749
11001
|
# with a specific database engine.
|
11002
|
+
#
|
11003
|
+
# Valid Values:
|
11004
|
+
#
|
11005
|
+
# * `mariadb`
|
11006
|
+
#
|
11007
|
+
# * `mysql`
|
11008
|
+
#
|
11009
|
+
# * `oracle-ee`
|
11010
|
+
#
|
11011
|
+
# * `oracle-se2`
|
11012
|
+
#
|
11013
|
+
# * `oracle-se1`
|
11014
|
+
#
|
11015
|
+
# * `oracle-se`
|
11016
|
+
#
|
11017
|
+
# * `postgres`
|
11018
|
+
#
|
11019
|
+
# * `sqlserver-ee`
|
11020
|
+
#
|
11021
|
+
# * `sqlserver-se`
|
11022
|
+
#
|
11023
|
+
# * `sqlserver-ex`
|
11024
|
+
#
|
11025
|
+
# * `sqlserver-web`
|
10750
11026
|
# @return [String]
|
10751
11027
|
#
|
10752
11028
|
# @!attribute [rw] major_engine_version
|
@@ -10790,6 +11066,36 @@ module Aws::RDS
|
|
10790
11066
|
#
|
10791
11067
|
# @!attribute [rw] engine
|
10792
11068
|
# The name of the engine to retrieve DB instance options for.
|
11069
|
+
#
|
11070
|
+
# Valid Values:
|
11071
|
+
#
|
11072
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
11073
|
+
#
|
11074
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
11075
|
+
#
|
11076
|
+
# * `aurora-postgresql`
|
11077
|
+
#
|
11078
|
+
# * `mariadb`
|
11079
|
+
#
|
11080
|
+
# * `mysql`
|
11081
|
+
#
|
11082
|
+
# * `oracle-ee`
|
11083
|
+
#
|
11084
|
+
# * `oracle-se2`
|
11085
|
+
#
|
11086
|
+
# * `oracle-se1`
|
11087
|
+
#
|
11088
|
+
# * `oracle-se`
|
11089
|
+
#
|
11090
|
+
# * `postgres`
|
11091
|
+
#
|
11092
|
+
# * `sqlserver-ee`
|
11093
|
+
#
|
11094
|
+
# * `sqlserver-se`
|
11095
|
+
#
|
11096
|
+
# * `sqlserver-ex`
|
11097
|
+
#
|
11098
|
+
# * `sqlserver-web`
|
10793
11099
|
# @return [String]
|
10794
11100
|
#
|
10795
11101
|
# @!attribute [rw] engine_version
|
@@ -11742,11 +12048,11 @@ module Aws::RDS
|
|
11742
12048
|
# @return [String]
|
11743
12049
|
#
|
11744
12050
|
# @!attribute [rw] kms_key_id
|
11745
|
-
# The
|
11746
|
-
# it's exported to Amazon S3. The
|
11747
|
-
#
|
11748
|
-
#
|
11749
|
-
#
|
12051
|
+
# The key identifier of the AWS KMS customer master key (CMK) that is
|
12052
|
+
# used to encrypt the snapshot when it's exported to Amazon S3. The
|
12053
|
+
# AWS KMS CMK identifier is its key ARN, key ID, alias ARN, or alias
|
12054
|
+
# name. The IAM role used for the snapshot export must have encryption
|
12055
|
+
# and decryption permissions to use this AWS KMS CMK.
|
11750
12056
|
# @return [String]
|
11751
12057
|
#
|
11752
12058
|
# @!attribute [rw] status
|
@@ -11930,7 +12236,8 @@ module Aws::RDS
|
|
11930
12236
|
# @!attribute [rw] global_cluster_resource_id
|
11931
12237
|
# The AWS Region-unique, immutable identifier for the global database
|
11932
12238
|
# cluster. This identifier is found in AWS CloudTrail log entries
|
11933
|
-
# whenever the AWS KMS key for the DB cluster is
|
12239
|
+
# whenever the AWS KMS customer master key (CMK) for the DB cluster is
|
12240
|
+
# accessed.
|
11934
12241
|
# @return [String]
|
11935
12242
|
#
|
11936
12243
|
# @!attribute [rw] global_cluster_arn
|
@@ -11983,6 +12290,10 @@ module Aws::RDS
|
|
11983
12290
|
include Aws::Structure
|
11984
12291
|
end
|
11985
12292
|
|
12293
|
+
# The `GlobalClusterIdentifier` already exists. Choose a new global
|
12294
|
+
# database identifier (unique name) to create a new global database
|
12295
|
+
# cluster.
|
12296
|
+
#
|
11986
12297
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/GlobalClusterAlreadyExistsFault AWS API Documentation
|
11987
12298
|
#
|
11988
12299
|
class GlobalClusterAlreadyExistsFault < Aws::EmptyStructure; end
|
@@ -12022,10 +12333,16 @@ module Aws::RDS
|
|
12022
12333
|
include Aws::Structure
|
12023
12334
|
end
|
12024
12335
|
|
12336
|
+
# The `GlobalClusterIdentifier` doesn't refer to an existing global
|
12337
|
+
# database cluster.
|
12338
|
+
#
|
12025
12339
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/GlobalClusterNotFoundFault AWS API Documentation
|
12026
12340
|
#
|
12027
12341
|
class GlobalClusterNotFoundFault < Aws::EmptyStructure; end
|
12028
12342
|
|
12343
|
+
# The number of global database clusters for this account is already at
|
12344
|
+
# the maximum allowed.
|
12345
|
+
#
|
12029
12346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/GlobalClusterQuotaExceededFault AWS API Documentation
|
12030
12347
|
#
|
12031
12348
|
class GlobalClusterQuotaExceededFault < Aws::EmptyStructure; end
|
@@ -12413,6 +12730,9 @@ module Aws::RDS
|
|
12413
12730
|
#
|
12414
12731
|
class InvalidExportTaskStateFault < Aws::EmptyStructure; end
|
12415
12732
|
|
12733
|
+
# The global cluster is in an invalid state and can't perform the
|
12734
|
+
# requested operation.
|
12735
|
+
#
|
12416
12736
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/InvalidGlobalClusterStateFault AWS API Documentation
|
12417
12737
|
#
|
12418
12738
|
class InvalidGlobalClusterStateFault < Aws::EmptyStructure; end
|
@@ -13222,6 +13542,7 @@ module Aws::RDS
|
|
13222
13542
|
# max_allocated_storage: 1,
|
13223
13543
|
# certificate_rotation_restart: false,
|
13224
13544
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
13545
|
+
# enable_customer_owned_ip: false,
|
13225
13546
|
# }
|
13226
13547
|
#
|
13227
13548
|
# @!attribute [rw] db_instance_identifier
|
@@ -13270,8 +13591,8 @@ module Aws::RDS
|
|
13270
13591
|
# The new DB subnet group for the DB instance. You can use this
|
13271
13592
|
# parameter to move your DB instance to a different VPC. If your DB
|
13272
13593
|
# instance isn't in a VPC, you can also use this parameter to move
|
13273
|
-
# your DB instance into a VPC. For more information, see [
|
13274
|
-
#
|
13594
|
+
# your DB instance into a VPC. For more information, see [Working with
|
13595
|
+
# a DB instance in a VPC][1] in the *Amazon RDS User Guide.*
|
13275
13596
|
#
|
13276
13597
|
# Changing the subnet group causes an outage during the change. The
|
13277
13598
|
# change is applied during the next maintenance window, unless you
|
@@ -13284,7 +13605,7 @@ module Aws::RDS
|
|
13284
13605
|
#
|
13285
13606
|
#
|
13286
13607
|
#
|
13287
|
-
# [1]:
|
13608
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC
|
13288
13609
|
# @return [String]
|
13289
13610
|
#
|
13290
13611
|
# @!attribute [rw] db_security_groups
|
@@ -13492,8 +13813,10 @@ module Aws::RDS
|
|
13492
13813
|
# parameter group can be the default for that DB parameter group
|
13493
13814
|
# family.
|
13494
13815
|
#
|
13495
|
-
#
|
13496
|
-
#
|
13816
|
+
# If you specify only a major version, Amazon RDS will update the DB
|
13817
|
+
# instance to the default minor version if the current minor version
|
13818
|
+
# is lower. For information about valid engine versions, see
|
13819
|
+
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
13497
13820
|
# @return [String]
|
13498
13821
|
#
|
13499
13822
|
# @!attribute [rw] allow_major_version_upgrade
|
@@ -13559,7 +13882,7 @@ module Aws::RDS
|
|
13559
13882
|
# @return [Integer]
|
13560
13883
|
#
|
13561
13884
|
# @!attribute [rw] option_group_name
|
13562
|
-
#
|
13885
|
+
# A value that indicates the DB instance should be associated with the
|
13563
13886
|
# specified option group. Changing this parameter doesn't result in
|
13564
13887
|
# an outage except in the following case and the change is applied
|
13565
13888
|
# during the next maintenance window unless the `ApplyImmediately`
|
@@ -13811,13 +14134,15 @@ module Aws::RDS
|
|
13811
14134
|
#
|
13812
14135
|
# @!attribute [rw] performance_insights_kms_key_id
|
13813
14136
|
# The AWS KMS key identifier for encryption of Performance Insights
|
13814
|
-
# data.
|
13815
|
-
#
|
14137
|
+
# data.
|
14138
|
+
#
|
14139
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
14140
|
+
# alias name for the AWS KMS customer master key (CMK).
|
13816
14141
|
#
|
13817
14142
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
13818
|
-
# then Amazon RDS uses your default
|
13819
|
-
#
|
13820
|
-
#
|
14143
|
+
# then Amazon RDS uses your default CMK. There is a default CMK for
|
14144
|
+
# your AWS account. Your AWS account has a different default CMK for
|
14145
|
+
# each AWS Region.
|
13821
14146
|
# @return [String]
|
13822
14147
|
#
|
13823
14148
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -13858,6 +14183,14 @@ module Aws::RDS
|
|
13858
14183
|
# @!attribute [rw] max_allocated_storage
|
13859
14184
|
# The upper limit to which Amazon RDS can automatically scale the
|
13860
14185
|
# storage of the DB instance.
|
14186
|
+
#
|
14187
|
+
# For more information about this setting, including limitations that
|
14188
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
14189
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
14190
|
+
#
|
14191
|
+
#
|
14192
|
+
#
|
14193
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
13861
14194
|
# @return [Integer]
|
13862
14195
|
#
|
13863
14196
|
# @!attribute [rw] certificate_rotation_restart
|
@@ -13910,6 +14243,28 @@ module Aws::RDS
|
|
13910
14243
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
13911
14244
|
# @return [String]
|
13912
14245
|
#
|
14246
|
+
# @!attribute [rw] enable_customer_owned_ip
|
14247
|
+
# A value that indicates whether to enable a customer-owned IP address
|
14248
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
14249
|
+
#
|
14250
|
+
# A *CoIP* provides local or external connectivity to resources in
|
14251
|
+
# your Outpost subnets through your on-premises network. For some use
|
14252
|
+
# cases, a CoIP can provide lower latency for connections to the DB
|
14253
|
+
# instance from outside of its virtual private cloud (VPC) on your
|
14254
|
+
# local network.
|
14255
|
+
#
|
14256
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
14257
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
14258
|
+
#
|
14259
|
+
# For more information about CoIPs, see [Customer-owned IP
|
14260
|
+
# addresses][2] in the *AWS Outposts User Guide*.
|
14261
|
+
#
|
14262
|
+
#
|
14263
|
+
#
|
14264
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
14265
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
14266
|
+
# @return [Boolean]
|
14267
|
+
#
|
13913
14268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
|
13914
14269
|
#
|
13915
14270
|
class ModifyDBInstanceMessage < Struct.new(
|
@@ -13955,7 +14310,8 @@ module Aws::RDS
|
|
13955
14310
|
:deletion_protection,
|
13956
14311
|
:max_allocated_storage,
|
13957
14312
|
:certificate_rotation_restart,
|
13958
|
-
:replica_mode
|
14313
|
+
:replica_mode,
|
14314
|
+
:enable_customer_owned_ip)
|
13959
14315
|
SENSITIVE = []
|
13960
14316
|
include Aws::Structure
|
13961
14317
|
end
|
@@ -14317,11 +14673,11 @@ module Aws::RDS
|
|
14317
14673
|
# You can specify this parameter when you upgrade an Oracle DB
|
14318
14674
|
# snapshot. The same option group considerations apply when upgrading
|
14319
14675
|
# a DB snapshot as when upgrading a DB instance. For more information,
|
14320
|
-
# see [Option
|
14676
|
+
# see [Option group considerations][1] in the *Amazon RDS User Guide.*
|
14321
14677
|
#
|
14322
14678
|
#
|
14323
14679
|
#
|
14324
|
-
# [1]:
|
14680
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG
|
14325
14681
|
# @return [String]
|
14326
14682
|
#
|
14327
14683
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSnapshotMessage AWS API Documentation
|
@@ -14479,6 +14835,8 @@ module Aws::RDS
|
|
14479
14835
|
# global_cluster_identifier: "String",
|
14480
14836
|
# new_global_cluster_identifier: "String",
|
14481
14837
|
# deletion_protection: false,
|
14838
|
+
# engine_version: "String",
|
14839
|
+
# allow_major_version_upgrade: false,
|
14482
14840
|
# }
|
14483
14841
|
#
|
14484
14842
|
# @!attribute [rw] global_cluster_identifier
|
@@ -14514,12 +14872,53 @@ module Aws::RDS
|
|
14514
14872
|
# protection is enabled.
|
14515
14873
|
# @return [Boolean]
|
14516
14874
|
#
|
14875
|
+
# @!attribute [rw] engine_version
|
14876
|
+
# The version number of the database engine to which you want to
|
14877
|
+
# upgrade. Changing this parameter results in an outage. The change is
|
14878
|
+
# applied during the next maintenance window unless `ApplyImmediately`
|
14879
|
+
# is enabled.
|
14880
|
+
#
|
14881
|
+
# To list all of the available engine versions for `aurora` (for MySQL
|
14882
|
+
# 5.6-compatible Aurora), use the following command:
|
14883
|
+
#
|
14884
|
+
# `` aws rds describe-db-engine-versions --engine aurora --query
|
14885
|
+
# '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' ``
|
14886
|
+
#
|
14887
|
+
# To list all of the available engine versions for `aurora-mysql` (for
|
14888
|
+
# MySQL 5.7-compatible Aurora), use the following command:
|
14889
|
+
#
|
14890
|
+
# `` aws rds describe-db-engine-versions --engine aurora-mysql --query
|
14891
|
+
# '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' ``
|
14892
|
+
#
|
14893
|
+
# To list all of the available engine versions for
|
14894
|
+
# `aurora-postgresql`, use the following command:
|
14895
|
+
#
|
14896
|
+
# `` aws rds describe-db-engine-versions --engine aurora-postgresql
|
14897
|
+
# --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
|
14898
|
+
# ``
|
14899
|
+
# @return [String]
|
14900
|
+
#
|
14901
|
+
# @!attribute [rw] allow_major_version_upgrade
|
14902
|
+
# A value that indicates whether major version upgrades are allowed.
|
14903
|
+
#
|
14904
|
+
# Constraints: You must allow major version upgrades when specifying a
|
14905
|
+
# value for the `EngineVersion` parameter that is a different major
|
14906
|
+
# version than the DB cluster's current version.
|
14907
|
+
#
|
14908
|
+
# If you upgrade the major version of a global database, the cluster
|
14909
|
+
# and DB instance parameter groups are set to the default parameter
|
14910
|
+
# groups for the new version. Apply any custom parameter groups after
|
14911
|
+
# completing the upgrade.
|
14912
|
+
# @return [Boolean]
|
14913
|
+
#
|
14517
14914
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyGlobalClusterMessage AWS API Documentation
|
14518
14915
|
#
|
14519
14916
|
class ModifyGlobalClusterMessage < Struct.new(
|
14520
14917
|
:global_cluster_identifier,
|
14521
14918
|
:new_global_cluster_identifier,
|
14522
|
-
:deletion_protection
|
14919
|
+
:deletion_protection,
|
14920
|
+
:engine_version,
|
14921
|
+
:allow_major_version_upgrade)
|
14523
14922
|
SENSITIVE = []
|
14524
14923
|
include Aws::Structure
|
14525
14924
|
end
|
@@ -15517,39 +15916,38 @@ module Aws::RDS
|
|
15517
15916
|
end
|
15518
15917
|
|
15519
15918
|
# This data type is used as a response element in the `ModifyDBInstance`
|
15520
|
-
#
|
15919
|
+
# operation and contains changes that will be applied during the next
|
15920
|
+
# maintenance window.
|
15521
15921
|
#
|
15522
15922
|
# @!attribute [rw] db_instance_class
|
15523
|
-
#
|
15524
|
-
#
|
15923
|
+
# The name of the compute and memory capacity class for the DB
|
15924
|
+
# instance.
|
15525
15925
|
# @return [String]
|
15526
15926
|
#
|
15527
15927
|
# @!attribute [rw] allocated_storage
|
15528
|
-
#
|
15529
|
-
#
|
15928
|
+
# The allocated storage size for the DB instance specified in
|
15929
|
+
# gibibytes .
|
15530
15930
|
# @return [Integer]
|
15531
15931
|
#
|
15532
15932
|
# @!attribute [rw] master_user_password
|
15533
|
-
#
|
15534
|
-
# credentials for the DB instance.
|
15933
|
+
# The master credentials for the DB instance.
|
15535
15934
|
# @return [String]
|
15536
15935
|
#
|
15537
15936
|
# @!attribute [rw] port
|
15538
|
-
#
|
15937
|
+
# The port for the DB instance.
|
15539
15938
|
# @return [Integer]
|
15540
15939
|
#
|
15541
15940
|
# @!attribute [rw] backup_retention_period
|
15542
|
-
#
|
15543
|
-
# retained.
|
15941
|
+
# The number of days for which automated backups are retained.
|
15544
15942
|
# @return [Integer]
|
15545
15943
|
#
|
15546
15944
|
# @!attribute [rw] multi_az
|
15547
|
-
#
|
15548
|
-
# deployment.
|
15945
|
+
# A value that indicates that the Single-AZ DB instance will change to
|
15946
|
+
# a Multi-AZ deployment.
|
15549
15947
|
# @return [Boolean]
|
15550
15948
|
#
|
15551
15949
|
# @!attribute [rw] engine_version
|
15552
|
-
#
|
15950
|
+
# The database engine version.
|
15553
15951
|
# @return [String]
|
15554
15952
|
#
|
15555
15953
|
# @!attribute [rw] license_model
|
@@ -15560,25 +15958,23 @@ module Aws::RDS
|
|
15560
15958
|
# @return [String]
|
15561
15959
|
#
|
15562
15960
|
# @!attribute [rw] iops
|
15563
|
-
#
|
15564
|
-
# will be applied or is currently being applied.
|
15961
|
+
# The Provisioned IOPS value for the DB instance.
|
15565
15962
|
# @return [Integer]
|
15566
15963
|
#
|
15567
15964
|
# @!attribute [rw] db_instance_identifier
|
15568
|
-
#
|
15569
|
-
# will be applied or is currently being applied.
|
15965
|
+
# The database identifier for the DB instance.
|
15570
15966
|
# @return [String]
|
15571
15967
|
#
|
15572
15968
|
# @!attribute [rw] storage_type
|
15573
|
-
#
|
15969
|
+
# The storage type of the DB instance.
|
15574
15970
|
# @return [String]
|
15575
15971
|
#
|
15576
15972
|
# @!attribute [rw] ca_certificate_identifier
|
15577
|
-
#
|
15973
|
+
# The identifier of the CA certificate for the DB instance.
|
15578
15974
|
# @return [String]
|
15579
15975
|
#
|
15580
15976
|
# @!attribute [rw] db_subnet_group_name
|
15581
|
-
# The
|
15977
|
+
# The DB subnet group for the DB instance.
|
15582
15978
|
# @return [String]
|
15583
15979
|
#
|
15584
15980
|
# @!attribute [rw] pending_cloudwatch_logs_exports
|
@@ -15592,6 +15988,11 @@ module Aws::RDS
|
|
15592
15988
|
# DB instance class of the DB instance.
|
15593
15989
|
# @return [Array<Types::ProcessorFeature>]
|
15594
15990
|
#
|
15991
|
+
# @!attribute [rw] iam_database_authentication_enabled
|
15992
|
+
# Whether mapping of AWS Identity and Access Management (IAM) accounts
|
15993
|
+
# to database accounts is enabled.
|
15994
|
+
# @return [Boolean]
|
15995
|
+
#
|
15595
15996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PendingModifiedValues AWS API Documentation
|
15596
15997
|
#
|
15597
15998
|
class PendingModifiedValues < Struct.new(
|
@@ -15609,7 +16010,8 @@ module Aws::RDS
|
|
15609
16010
|
:ca_certificate_identifier,
|
15610
16011
|
:db_subnet_group_name,
|
15611
16012
|
:pending_cloudwatch_logs_exports,
|
15612
|
-
:processor_features
|
16013
|
+
:processor_features,
|
16014
|
+
:iam_database_authentication_enabled)
|
15613
16015
|
SENSITIVE = []
|
15614
16016
|
include Aws::Structure
|
15615
16017
|
end
|
@@ -16140,7 +16542,7 @@ module Aws::RDS
|
|
16140
16542
|
#
|
16141
16543
|
# @!attribute [rw] role_arn
|
16142
16544
|
# The Amazon Resource Name (ARN) of the IAM role to disassociate from
|
16143
|
-
# the DB instance, for example
|
16545
|
+
# the DB instance, for example,
|
16144
16546
|
# `arn:aws:iam::123456789012:role/AccessRole`.
|
16145
16547
|
# @return [String]
|
16146
16548
|
#
|
@@ -16857,17 +17259,14 @@ module Aws::RDS
|
|
16857
17259
|
# @!attribute [rw] kms_key_id
|
16858
17260
|
# The AWS KMS key identifier for an encrypted DB cluster.
|
16859
17261
|
#
|
16860
|
-
# The KMS key identifier is the
|
16861
|
-
#
|
16862
|
-
#
|
16863
|
-
# cluster, then you can use the KMS key alias instead of the ARN for
|
16864
|
-
# the KM encryption key.
|
17262
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
17263
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
17264
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
16865
17265
|
#
|
16866
17266
|
# If the StorageEncrypted parameter is enabled, and you do not specify
|
16867
17267
|
# a value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
16868
|
-
# default
|
16869
|
-
#
|
16870
|
-
# encryption key for each AWS Region.
|
17268
|
+
# default CMK. There is a default CMK for your AWS account. Your AWS
|
17269
|
+
# account has a different default CMK for each AWS Region.
|
16871
17270
|
# @return [String]
|
16872
17271
|
#
|
16873
17272
|
# @!attribute [rw] enable_iam_database_authentication
|
@@ -17185,18 +17584,16 @@ module Aws::RDS
|
|
17185
17584
|
# The AWS KMS key identifier to use when restoring an encrypted DB
|
17186
17585
|
# cluster from a DB snapshot or DB cluster snapshot.
|
17187
17586
|
#
|
17188
|
-
# The KMS key identifier is the
|
17189
|
-
#
|
17190
|
-
#
|
17191
|
-
# cluster, then you can use the KMS key alias instead of the ARN for
|
17192
|
-
# the KMS encryption key.
|
17587
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
17588
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
17589
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
17193
17590
|
#
|
17194
|
-
#
|
17195
|
-
# following occurs:
|
17591
|
+
# When you don't specify a value for the `KmsKeyId` parameter, then
|
17592
|
+
# the following occurs:
|
17196
17593
|
#
|
17197
17594
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
17198
17595
|
# is encrypted, then the restored DB cluster is encrypted using the
|
17199
|
-
# KMS
|
17596
|
+
# AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster
|
17200
17597
|
# snapshot.
|
17201
17598
|
#
|
17202
17599
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
@@ -17491,23 +17888,21 @@ module Aws::RDS
|
|
17491
17888
|
# The AWS KMS key identifier to use when restoring an encrypted DB
|
17492
17889
|
# cluster from an encrypted DB cluster.
|
17493
17890
|
#
|
17494
|
-
# The KMS key identifier is the
|
17495
|
-
#
|
17496
|
-
#
|
17497
|
-
# cluster, then you can use the KMS key alias instead of the ARN for
|
17498
|
-
# the KMS encryption key.
|
17891
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
17892
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
17893
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
17499
17894
|
#
|
17500
17895
|
# You can restore to a new DB cluster and encrypt the new DB cluster
|
17501
|
-
# with a KMS
|
17502
|
-
# the source DB cluster. The new DB cluster is encrypted with
|
17503
|
-
#
|
17896
|
+
# with a AWS KMS CMK that is different than the AWS KMS key used to
|
17897
|
+
# encrypt the source DB cluster. The new DB cluster is encrypted with
|
17898
|
+
# the AWS KMS CMK identified by the `KmsKeyId` parameter.
|
17504
17899
|
#
|
17505
17900
|
# If you don't specify a value for the `KmsKeyId` parameter, then the
|
17506
17901
|
# following occurs:
|
17507
17902
|
#
|
17508
17903
|
# * If the DB cluster is encrypted, then the restored DB cluster is
|
17509
|
-
# encrypted using the KMS
|
17510
|
-
# cluster.
|
17904
|
+
# encrypted using the AWS KMS CMK that was used to encrypt the
|
17905
|
+
# source DB cluster.
|
17511
17906
|
#
|
17512
17907
|
# * If the DB cluster isn't encrypted, then the restored DB cluster
|
17513
17908
|
# isn't encrypted.
|
@@ -17689,6 +18084,7 @@ module Aws::RDS
|
|
17689
18084
|
# use_default_processor_features: false,
|
17690
18085
|
# db_parameter_group_name: "String",
|
17691
18086
|
# deletion_protection: false,
|
18087
|
+
# enable_customer_owned_ip: false,
|
17692
18088
|
# }
|
17693
18089
|
#
|
17694
18090
|
# @!attribute [rw] db_instance_identifier
|
@@ -17998,6 +18394,28 @@ module Aws::RDS
|
|
17998
18394
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
|
17999
18395
|
# @return [Boolean]
|
18000
18396
|
#
|
18397
|
+
# @!attribute [rw] enable_customer_owned_ip
|
18398
|
+
# A value that indicates whether to enable a customer-owned IP address
|
18399
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
18400
|
+
#
|
18401
|
+
# A *CoIP* provides local or external connectivity to resources in
|
18402
|
+
# your Outpost subnets through your on-premises network. For some use
|
18403
|
+
# cases, a CoIP can provide lower latency for connections to the DB
|
18404
|
+
# instance from outside of its virtual private cloud (VPC) on your
|
18405
|
+
# local network.
|
18406
|
+
#
|
18407
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
18408
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
18409
|
+
#
|
18410
|
+
# For more information about CoIPs, see [Customer-owned IP
|
18411
|
+
# addresses][2] in the *AWS Outposts User Guide*.
|
18412
|
+
#
|
18413
|
+
#
|
18414
|
+
#
|
18415
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
18416
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
18417
|
+
# @return [Boolean]
|
18418
|
+
#
|
18001
18419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshotMessage AWS API Documentation
|
18002
18420
|
#
|
18003
18421
|
class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
|
@@ -18028,7 +18446,8 @@ module Aws::RDS
|
|
18028
18446
|
:processor_features,
|
18029
18447
|
:use_default_processor_features,
|
18030
18448
|
:db_parameter_group_name,
|
18031
|
-
:deletion_protection
|
18449
|
+
:deletion_protection,
|
18450
|
+
:enable_customer_owned_ip)
|
18032
18451
|
SENSITIVE = []
|
18033
18452
|
include Aws::Structure
|
18034
18453
|
end
|
@@ -18366,17 +18785,14 @@ module Aws::RDS
|
|
18366
18785
|
# @!attribute [rw] kms_key_id
|
18367
18786
|
# The AWS KMS key identifier for an encrypted DB instance.
|
18368
18787
|
#
|
18369
|
-
# The KMS key identifier is the
|
18370
|
-
#
|
18371
|
-
#
|
18372
|
-
# instance, then you can use the KMS key alias instead of the ARN for
|
18373
|
-
# the KM encryption key.
|
18788
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
18789
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
18790
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
18374
18791
|
#
|
18375
18792
|
# If the `StorageEncrypted` parameter is enabled, and you do not
|
18376
18793
|
# specify a value for the `KmsKeyId` parameter, then Amazon RDS will
|
18377
|
-
# use your default
|
18378
|
-
#
|
18379
|
-
# different default encryption key for each AWS Region.
|
18794
|
+
# use your default CMK. There is a default CMK for your AWS account.
|
18795
|
+
# Your AWS account has a different default CMK for each AWS Region.
|
18380
18796
|
# @return [String]
|
18381
18797
|
#
|
18382
18798
|
# @!attribute [rw] copy_tags_to_snapshot
|
@@ -18468,13 +18884,15 @@ module Aws::RDS
|
|
18468
18884
|
#
|
18469
18885
|
# @!attribute [rw] performance_insights_kms_key_id
|
18470
18886
|
# The AWS KMS key identifier for encryption of Performance Insights
|
18471
|
-
# data.
|
18472
|
-
#
|
18887
|
+
# data.
|
18888
|
+
#
|
18889
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
18890
|
+
# alias name for the AWS KMS customer master key (CMK).
|
18473
18891
|
#
|
18474
18892
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
18475
|
-
# then Amazon RDS uses your default
|
18476
|
-
#
|
18477
|
-
#
|
18893
|
+
# then Amazon RDS uses your default CMK. There is a default CMK for
|
18894
|
+
# your AWS account. Your AWS account has a different default CMK for
|
18895
|
+
# each AWS Region.
|
18478
18896
|
# @return [String]
|
18479
18897
|
#
|
18480
18898
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -18517,6 +18935,14 @@ module Aws::RDS
|
|
18517
18935
|
# @!attribute [rw] max_allocated_storage
|
18518
18936
|
# The upper limit to which Amazon RDS can automatically scale the
|
18519
18937
|
# storage of the DB instance.
|
18938
|
+
#
|
18939
|
+
# For more information about this setting, including limitations that
|
18940
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
18941
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
18942
|
+
#
|
18943
|
+
#
|
18944
|
+
#
|
18945
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
18520
18946
|
# @return [Integer]
|
18521
18947
|
#
|
18522
18948
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3Message AWS API Documentation
|
@@ -18631,6 +19057,8 @@ module Aws::RDS
|
|
18631
19057
|
# deletion_protection: false,
|
18632
19058
|
# source_dbi_resource_id: "String",
|
18633
19059
|
# max_allocated_storage: 1,
|
19060
|
+
# source_db_instance_automated_backups_arn: "String",
|
19061
|
+
# enable_customer_owned_ip: false,
|
18634
19062
|
# }
|
18635
19063
|
#
|
18636
19064
|
# @!attribute [rw] source_db_instance_identifier
|
@@ -18957,8 +19385,44 @@ module Aws::RDS
|
|
18957
19385
|
# @!attribute [rw] max_allocated_storage
|
18958
19386
|
# The upper limit to which Amazon RDS can automatically scale the
|
18959
19387
|
# storage of the DB instance.
|
19388
|
+
#
|
19389
|
+
# For more information about this setting, including limitations that
|
19390
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
19391
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
19392
|
+
#
|
19393
|
+
#
|
19394
|
+
#
|
19395
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
18960
19396
|
# @return [Integer]
|
18961
19397
|
#
|
19398
|
+
# @!attribute [rw] source_db_instance_automated_backups_arn
|
19399
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups
|
19400
|
+
# from which to restore, for example,
|
19401
|
+
# `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
19402
|
+
# @return [String]
|
19403
|
+
#
|
19404
|
+
# @!attribute [rw] enable_customer_owned_ip
|
19405
|
+
# A value that indicates whether to enable a customer-owned IP address
|
19406
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
19407
|
+
#
|
19408
|
+
# A *CoIP* provides local or external connectivity to resources in
|
19409
|
+
# your Outpost subnets through your on-premises network. For some use
|
19410
|
+
# cases, a CoIP can provide lower latency for connections to the DB
|
19411
|
+
# instance from outside of its virtual private cloud (VPC) on your
|
19412
|
+
# local network.
|
19413
|
+
#
|
19414
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
19415
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
19416
|
+
#
|
19417
|
+
# For more information about CoIPs, see [Customer-owned IP
|
19418
|
+
# addresses][2] in the *AWS Outposts User Guide*.
|
19419
|
+
#
|
19420
|
+
#
|
19421
|
+
#
|
19422
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
19423
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
19424
|
+
# @return [Boolean]
|
19425
|
+
#
|
18962
19426
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTimeMessage AWS API Documentation
|
18963
19427
|
#
|
18964
19428
|
class RestoreDBInstanceToPointInTimeMessage < Struct.new(
|
@@ -18993,7 +19457,9 @@ module Aws::RDS
|
|
18993
19457
|
:db_parameter_group_name,
|
18994
19458
|
:deletion_protection,
|
18995
19459
|
:source_dbi_resource_id,
|
18996
|
-
:max_allocated_storage
|
19460
|
+
:max_allocated_storage,
|
19461
|
+
:source_db_instance_automated_backups_arn,
|
19462
|
+
:enable_customer_owned_ip)
|
18997
19463
|
SENSITIVE = []
|
18998
19464
|
include Aws::Structure
|
18999
19465
|
end
|
@@ -19306,12 +19772,18 @@ module Aws::RDS
|
|
19306
19772
|
# The status of the source AWS Region.
|
19307
19773
|
# @return [String]
|
19308
19774
|
#
|
19775
|
+
# @!attribute [rw] supports_db_instance_automated_backups_replication
|
19776
|
+
# Whether the source AWS Region supports replicating automated backups
|
19777
|
+
# to the current AWS Region.
|
19778
|
+
# @return [Boolean]
|
19779
|
+
#
|
19309
19780
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/SourceRegion AWS API Documentation
|
19310
19781
|
#
|
19311
19782
|
class SourceRegion < Struct.new(
|
19312
19783
|
:region_name,
|
19313
19784
|
:endpoint,
|
19314
|
-
:status
|
19785
|
+
:status,
|
19786
|
+
:supports_db_instance_automated_backups_replication)
|
19315
19787
|
SENSITIVE = []
|
19316
19788
|
include Aws::Structure
|
19317
19789
|
end
|
@@ -19351,7 +19823,7 @@ module Aws::RDS
|
|
19351
19823
|
# }
|
19352
19824
|
#
|
19353
19825
|
# @!attribute [rw] resource_arn
|
19354
|
-
# The Amazon Resource Name (ARN) of the DB cluster, for example
|
19826
|
+
# The Amazon Resource Name (ARN) of the DB cluster, for example,
|
19355
19827
|
# `arn:aws:rds:us-east-1:12345667890:cluster:das-cluster`.
|
19356
19828
|
# @return [String]
|
19357
19829
|
#
|
@@ -19364,8 +19836,8 @@ module Aws::RDS
|
|
19364
19836
|
#
|
19365
19837
|
# @!attribute [rw] kms_key_id
|
19366
19838
|
# The AWS KMS key identifier for encrypting messages in the database
|
19367
|
-
# activity stream. The key identifier
|
19368
|
-
# ARN, or
|
19839
|
+
# activity stream. The AWS KMS key identifier is the key ARN, key ID,
|
19840
|
+
# alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
19369
19841
|
# @return [String]
|
19370
19842
|
#
|
19371
19843
|
# @!attribute [rw] apply_immediately
|
@@ -19456,6 +19928,75 @@ module Aws::RDS
|
|
19456
19928
|
include Aws::Structure
|
19457
19929
|
end
|
19458
19930
|
|
19931
|
+
# @note When making an API call, you may pass StartDBInstanceAutomatedBackupsReplicationMessage
|
19932
|
+
# data as a hash:
|
19933
|
+
#
|
19934
|
+
# {
|
19935
|
+
# source_db_instance_arn: "String", # required
|
19936
|
+
# backup_retention_period: 1,
|
19937
|
+
# kms_key_id: "String",
|
19938
|
+
# pre_signed_url: "String",
|
19939
|
+
# source_region: "String",
|
19940
|
+
# }
|
19941
|
+
#
|
19942
|
+
# @!attribute [rw] source_db_instance_arn
|
19943
|
+
# The Amazon Resource Name (ARN) of the source DB instance for the
|
19944
|
+
# replicated automated backups, for example,
|
19945
|
+
# `arn:aws:rds:us-west-2:123456789012:db:mydatabase`.
|
19946
|
+
# @return [String]
|
19947
|
+
#
|
19948
|
+
# @!attribute [rw] backup_retention_period
|
19949
|
+
# The retention period for the replicated automated backups.
|
19950
|
+
# @return [Integer]
|
19951
|
+
#
|
19952
|
+
# @!attribute [rw] kms_key_id
|
19953
|
+
# The AWS KMS key identifier for encryption of the replicated
|
19954
|
+
# automated backups. The KMS key ID is the Amazon Resource Name (ARN)
|
19955
|
+
# for the KMS encryption key in the destination AWS Region, for
|
19956
|
+
# example,
|
19957
|
+
# `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`.
|
19958
|
+
# @return [String]
|
19959
|
+
#
|
19960
|
+
# @!attribute [rw] pre_signed_url
|
19961
|
+
# A URL that contains a Signature Version 4 signed request for the
|
19962
|
+
# StartDBInstanceAutomatedBackupsReplication action to be called in
|
19963
|
+
# the AWS Region of the source DB instance. The presigned URL must be
|
19964
|
+
# a valid request for the StartDBInstanceAutomatedBackupsReplication
|
19965
|
+
# API action that can be executed in the AWS Region that contains the
|
19966
|
+
# source DB instance.
|
19967
|
+
# @return [String]
|
19968
|
+
#
|
19969
|
+
# @!attribute [rw] source_region
|
19970
|
+
# The source region of the snapshot. This is only needed when the
|
19971
|
+
# shapshot is encrypted and in a different region.
|
19972
|
+
# @return [String]
|
19973
|
+
#
|
19974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplicationMessage AWS API Documentation
|
19975
|
+
#
|
19976
|
+
class StartDBInstanceAutomatedBackupsReplicationMessage < Struct.new(
|
19977
|
+
:source_db_instance_arn,
|
19978
|
+
:backup_retention_period,
|
19979
|
+
:kms_key_id,
|
19980
|
+
:pre_signed_url,
|
19981
|
+
:source_region)
|
19982
|
+
SENSITIVE = []
|
19983
|
+
include Aws::Structure
|
19984
|
+
end
|
19985
|
+
|
19986
|
+
# @!attribute [rw] db_instance_automated_backup
|
19987
|
+
# An automated backup of a DB instance. It consists of system backups,
|
19988
|
+
# transaction logs, and the database instance properties that existed
|
19989
|
+
# at the time you deleted the source instance.
|
19990
|
+
# @return [Types::DBInstanceAutomatedBackup]
|
19991
|
+
#
|
19992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplicationResult AWS API Documentation
|
19993
|
+
#
|
19994
|
+
class StartDBInstanceAutomatedBackupsReplicationResult < Struct.new(
|
19995
|
+
:db_instance_automated_backup)
|
19996
|
+
SENSITIVE = []
|
19997
|
+
include Aws::Structure
|
19998
|
+
end
|
19999
|
+
|
19459
20000
|
# @note When making an API call, you may pass StartDBInstanceMessage
|
19460
20001
|
# data as a hash:
|
19461
20002
|
#
|
@@ -19524,11 +20065,12 @@ module Aws::RDS
|
|
19524
20065
|
# @return [String]
|
19525
20066
|
#
|
19526
20067
|
# @!attribute [rw] kms_key_id
|
19527
|
-
# The ID of the AWS KMS key to use to encrypt
|
19528
|
-
# Amazon S3. The KMS key
|
19529
|
-
# key
|
19530
|
-
# caller of this operation must be
|
19531
|
-
# operations. These can be set in
|
20068
|
+
# The ID of the AWS KMS customer master key (CMK) to use to encrypt
|
20069
|
+
# the snapshot exported to Amazon S3. The AWS KMS key identifier is
|
20070
|
+
# the key ARN, key ID, alias ARN, or alias name for the AWS KMS
|
20071
|
+
# customer master key (CMK). The caller of this operation must be
|
20072
|
+
# authorized to execute the following operations. These can be set in
|
20073
|
+
# the AWS KMS key policy:
|
19532
20074
|
#
|
19533
20075
|
# * GrantOperation.Encrypt
|
19534
20076
|
#
|
@@ -19620,6 +20162,9 @@ module Aws::RDS
|
|
19620
20162
|
# @!attribute [rw] kms_key_id
|
19621
20163
|
# The AWS KMS key identifier used for encrypting messages in the
|
19622
20164
|
# database activity stream.
|
20165
|
+
#
|
20166
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
20167
|
+
# alias name for the AWS KMS customer master key (CMK).
|
19623
20168
|
# @return [String]
|
19624
20169
|
#
|
19625
20170
|
# @!attribute [rw] kinesis_stream_name
|
@@ -19676,6 +20221,41 @@ module Aws::RDS
|
|
19676
20221
|
include Aws::Structure
|
19677
20222
|
end
|
19678
20223
|
|
20224
|
+
# @note When making an API call, you may pass StopDBInstanceAutomatedBackupsReplicationMessage
|
20225
|
+
# data as a hash:
|
20226
|
+
#
|
20227
|
+
# {
|
20228
|
+
# source_db_instance_arn: "String", # required
|
20229
|
+
# }
|
20230
|
+
#
|
20231
|
+
# @!attribute [rw] source_db_instance_arn
|
20232
|
+
# The Amazon Resource Name (ARN) of the source DB instance for which
|
20233
|
+
# to stop replicating automated backups, for example,
|
20234
|
+
# `arn:aws:rds:us-west-2:123456789012:db:mydatabase`.
|
20235
|
+
# @return [String]
|
20236
|
+
#
|
20237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplicationMessage AWS API Documentation
|
20238
|
+
#
|
20239
|
+
class StopDBInstanceAutomatedBackupsReplicationMessage < Struct.new(
|
20240
|
+
:source_db_instance_arn)
|
20241
|
+
SENSITIVE = []
|
20242
|
+
include Aws::Structure
|
20243
|
+
end
|
20244
|
+
|
20245
|
+
# @!attribute [rw] db_instance_automated_backup
|
20246
|
+
# An automated backup of a DB instance. It consists of system backups,
|
20247
|
+
# transaction logs, and the database instance properties that existed
|
20248
|
+
# at the time you deleted the source instance.
|
20249
|
+
# @return [Types::DBInstanceAutomatedBackup]
|
20250
|
+
#
|
20251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplicationResult AWS API Documentation
|
20252
|
+
#
|
20253
|
+
class StopDBInstanceAutomatedBackupsReplicationResult < Struct.new(
|
20254
|
+
:db_instance_automated_backup)
|
20255
|
+
SENSITIVE = []
|
20256
|
+
include Aws::Structure
|
20257
|
+
end
|
20258
|
+
|
19679
20259
|
# @note When making an API call, you may pass StopDBInstanceMessage
|
19680
20260
|
# data as a hash:
|
19681
20261
|
#
|
@@ -20105,8 +20685,8 @@ module Aws::RDS
|
|
20105
20685
|
# Information about the virtual private network (VPN) between the VMware
|
20106
20686
|
# vSphere cluster and the AWS website.
|
20107
20687
|
#
|
20108
|
-
# For more information about RDS on VMware, see the [
|
20109
|
-
#
|
20688
|
+
# For more information about RDS on VMware, see the [ RDS on VMware User
|
20689
|
+
# Guide.][1]
|
20110
20690
|
#
|
20111
20691
|
#
|
20112
20692
|
#
|