aws-sdk-rds 1.105.0 → 1.110.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +638 -195
- data/lib/aws-sdk-rds/client_api.rb +80 -5
- data/lib/aws-sdk-rds/db_cluster.rb +38 -30
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +23 -22
- data/lib/aws-sdk-rds/db_instance.rb +175 -67
- data/lib/aws-sdk-rds/db_snapshot.rb +45 -17
- data/lib/aws-sdk-rds/plugins/cross_region_copying.rb +11 -12
- data/lib/aws-sdk-rds/resource.rb +61 -45
- data/lib/aws-sdk-rds/types.rb +646 -238
- metadata +2 -2
@@ -5,28 +5,26 @@ require 'aws-sigv4'
|
|
5
5
|
module Aws
|
6
6
|
module RDS
|
7
7
|
module Plugins
|
8
|
-
|
9
|
-
#
|
10
|
-
# CopyDBSnapshot API.
|
8
|
+
# This plugin populates the `:pre_signed_url` request param for APIs
|
9
|
+
# that support cross region copying.
|
11
10
|
#
|
12
11
|
# This parameter is required by RDS when copying an encrypted snapshot
|
13
12
|
# across regions. This plugin will be skipped if the `:pre_signed_url`
|
14
13
|
# parameter is provided by the user.
|
15
14
|
class CrossRegionCopying < Seahorse::Client::Plugin
|
16
|
-
|
17
15
|
# @api private
|
18
16
|
class Handler < Seahorse::Client::Handler
|
19
|
-
|
20
17
|
def call(context)
|
21
18
|
params = context.params
|
22
|
-
if params.is_a?(Hash) &&
|
19
|
+
if params.is_a?(Hash) &&
|
20
|
+
params[:source_region] && !params[:pre_signed_url]
|
23
21
|
params[:pre_signed_url] = presigned_url(context, params)
|
24
|
-
params[:destination_region] = context.config.region
|
25
22
|
end
|
26
23
|
@handler.call(context)
|
27
24
|
end
|
28
25
|
|
29
26
|
private
|
27
|
+
|
30
28
|
def presigned_url(context, params)
|
31
29
|
# :source_region is not modeled in the api
|
32
30
|
source_region = params.delete(:source_region)
|
@@ -43,12 +41,13 @@ module Aws
|
|
43
41
|
region: source_region,
|
44
42
|
credentials_provider: context.config.credentials
|
45
43
|
)
|
46
|
-
url = Aws::Partitions::EndpointProvider.resolve(
|
47
|
-
|
44
|
+
url = Aws::Partitions::EndpointProvider.resolve(
|
45
|
+
signer.region, 'rds'
|
46
|
+
)
|
47
|
+
url += "?#{param_list}"
|
48
48
|
signer.presign_url(
|
49
49
|
http_method: 'GET',
|
50
50
|
url: url,
|
51
|
-
body: '',
|
52
51
|
expires_in: 3600
|
53
52
|
).to_s
|
54
53
|
end
|
@@ -61,10 +60,10 @@ module Aws
|
|
61
60
|
:copy_db_snapshot,
|
62
61
|
:create_db_instance_read_replica,
|
63
62
|
:copy_db_cluster_snapshot,
|
64
|
-
:create_db_cluster
|
63
|
+
:create_db_cluster,
|
64
|
+
:start_db_instance_automated_backups_replication
|
65
65
|
]
|
66
66
|
)
|
67
|
-
|
68
67
|
end
|
69
68
|
end
|
70
69
|
end
|
data/lib/aws-sdk-rds/resource.rb
CHANGED
@@ -258,30 +258,27 @@ module Aws::RDS
|
|
258
258
|
# @option options [String] :kms_key_id
|
259
259
|
# The AWS KMS key identifier for an encrypted DB cluster.
|
260
260
|
#
|
261
|
-
# The KMS key identifier is the
|
262
|
-
#
|
263
|
-
# account
|
264
|
-
# cluster, then you can use the KMS key alias instead of the ARN for the
|
265
|
-
# KMS encryption key.
|
261
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
262
|
+
# name for the AWS KMS customer master key (CMK). To use a CMK in a
|
263
|
+
# different AWS account, specify the key ARN or alias ARN.
|
266
264
|
#
|
267
|
-
#
|
265
|
+
# When a CMK isn't specified in `KmsKeyId`\:
|
268
266
|
#
|
269
267
|
# * If `ReplicationSourceIdentifier` identifies an encrypted source,
|
270
|
-
# then Amazon RDS will use the
|
271
|
-
#
|
268
|
+
# then Amazon RDS will use the CMK used to encrypt the source.
|
269
|
+
# Otherwise, Amazon RDS will use your default CMK.
|
272
270
|
#
|
273
271
|
# * If the `StorageEncrypted` parameter is enabled and
|
274
272
|
# `ReplicationSourceIdentifier` isn't specified, then Amazon RDS will
|
275
|
-
# use your default
|
273
|
+
# use your default CMK.
|
276
274
|
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
# Region.
|
275
|
+
# There is a default CMK for your AWS account. Your AWS account has a
|
276
|
+
# different default CMK for each AWS Region.
|
280
277
|
#
|
281
278
|
# If you create a read replica of an encrypted DB cluster in another AWS
|
282
|
-
# Region, you must set `KmsKeyId` to a KMS key
|
283
|
-
# destination AWS Region. This
|
284
|
-
# in that AWS Region.
|
279
|
+
# Region, you must set `KmsKeyId` to a AWS KMS key identifier that is
|
280
|
+
# valid in the destination AWS Region. This CMK is used to encrypt the
|
281
|
+
# read replica in that AWS Region.
|
285
282
|
# @option options [String] :pre_signed_url
|
286
283
|
# A URL that contains a Signature Version 4 signed request for the
|
287
284
|
# `CreateDBCluster` action to be called in the source AWS Region where
|
@@ -298,9 +295,9 @@ module Aws::RDS
|
|
298
295
|
#
|
299
296
|
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
300
297
|
# encrypt the copy of the DB cluster in the destination AWS Region.
|
301
|
-
# This should refer to the same KMS
|
302
|
-
# action that is called in the destination AWS
|
303
|
-
# contained in the pre-signed URL.
|
298
|
+
# This should refer to the same AWS KMS CMK for both the
|
299
|
+
# `CreateDBCluster` action that is called in the destination AWS
|
300
|
+
# Region, and the action contained in the pre-signed URL.
|
304
301
|
#
|
305
302
|
# * `DestinationRegion` - The name of the AWS Region that Aurora read
|
306
303
|
# replica will be created in.
|
@@ -460,7 +457,6 @@ module Aws::RDS
|
|
460
457
|
# This parameter only applies to DB clusters that are secondary clusters
|
461
458
|
# in an Aurora global database. By default, Aurora disallows write
|
462
459
|
# operations for secondary clusters.
|
463
|
-
# @option options [String] :destination_region
|
464
460
|
# @option options [String] :source_region
|
465
461
|
# The source region of the snapshot. This is only needed when the
|
466
462
|
# shapshot is encrypted and in a different region.
|
@@ -588,6 +584,7 @@ module Aws::RDS
|
|
588
584
|
# ],
|
589
585
|
# deletion_protection: false,
|
590
586
|
# max_allocated_storage: 1,
|
587
|
+
# enable_customer_owned_ip: false,
|
591
588
|
# })
|
592
589
|
# @param [Hash] options ({})
|
593
590
|
# @option options [String] :db_name
|
@@ -627,8 +624,8 @@ module Aws::RDS
|
|
627
624
|
# **PostgreSQL**
|
628
625
|
#
|
629
626
|
# The name of the database to create when the DB instance is created. If
|
630
|
-
# this parameter isn't specified,
|
631
|
-
#
|
627
|
+
# this parameter isn't specified, no database is created in the DB
|
628
|
+
# instance.
|
632
629
|
#
|
633
630
|
# Constraints:
|
634
631
|
#
|
@@ -939,8 +936,8 @@ module Aws::RDS
|
|
939
936
|
# specify the identifier of the custom Availability Zone to create the
|
940
937
|
# DB instance in.
|
941
938
|
#
|
942
|
-
# For more information about RDS on VMware, see the [
|
943
|
-
#
|
939
|
+
# For more information about RDS on VMware, see the [ RDS on VMware User
|
940
|
+
# Guide.][2]
|
944
941
|
#
|
945
942
|
# </note>
|
946
943
|
#
|
@@ -1116,8 +1113,8 @@ module Aws::RDS
|
|
1116
1113
|
#
|
1117
1114
|
# **PostgreSQL**
|
1118
1115
|
#
|
1119
|
-
# See [
|
1120
|
-
# User Guide.*
|
1116
|
+
# See [Amazon RDS for PostgreSQL versions and extensions][5] in the
|
1117
|
+
# *Amazon RDS User Guide.*
|
1121
1118
|
#
|
1122
1119
|
#
|
1123
1120
|
#
|
@@ -1125,7 +1122,7 @@ module Aws::RDS
|
|
1125
1122
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
|
1126
1123
|
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
1127
1124
|
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
1128
|
-
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
1125
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
1129
1126
|
# @option options [Boolean] :auto_minor_version_upgrade
|
1130
1127
|
# A value that indicates whether minor engine upgrades are applied
|
1131
1128
|
# automatically to the DB instance during the maintenance window. By
|
@@ -1150,8 +1147,8 @@ module Aws::RDS
|
|
1150
1147
|
#
|
1151
1148
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
1152
1149
|
# @option options [String] :option_group_name
|
1153
|
-
#
|
1154
|
-
# option group.
|
1150
|
+
# A value that indicates that the DB instance should be associated with
|
1151
|
+
# the specified option group.
|
1155
1152
|
#
|
1156
1153
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
1157
1154
|
# TDE, can't be removed from an option group. Also, that option group
|
@@ -1230,22 +1227,19 @@ module Aws::RDS
|
|
1230
1227
|
# @option options [String] :kms_key_id
|
1231
1228
|
# The AWS KMS key identifier for an encrypted DB instance.
|
1232
1229
|
#
|
1233
|
-
# The KMS key identifier is the
|
1234
|
-
#
|
1235
|
-
# account
|
1236
|
-
# instance, then you can use the KMS key alias instead of the ARN for
|
1237
|
-
# the KM encryption key.
|
1230
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1231
|
+
# name for the AWS KMS customer master key (CMK). To use a CMK in a
|
1232
|
+
# different AWS account, specify the key ARN or alias ARN.
|
1238
1233
|
#
|
1239
1234
|
# **Amazon Aurora**
|
1240
1235
|
#
|
1241
|
-
# Not applicable. The KMS key identifier is managed by the DB
|
1242
|
-
# For more information, see `CreateDBCluster`.
|
1236
|
+
# Not applicable. The AWS KMS key identifier is managed by the DB
|
1237
|
+
# cluster. For more information, see `CreateDBCluster`.
|
1243
1238
|
#
|
1244
1239
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
1245
|
-
# the `KmsKeyId` parameter, then Amazon RDS
|
1246
|
-
#
|
1247
|
-
#
|
1248
|
-
# for each AWS Region.
|
1240
|
+
# the `KmsKeyId` parameter, then Amazon RDS uses your default CMK. There
|
1241
|
+
# is a default CMK for your AWS account. Your AWS account has a
|
1242
|
+
# different default CMK for each AWS Region.
|
1249
1243
|
# @option options [String] :domain
|
1250
1244
|
# The Active Directory directory ID to create the DB instance in.
|
1251
1245
|
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
@@ -1337,13 +1331,15 @@ module Aws::RDS
|
|
1337
1331
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
1338
1332
|
# @option options [String] :performance_insights_kms_key_id
|
1339
1333
|
# The AWS KMS key identifier for encryption of Performance Insights
|
1340
|
-
# data.
|
1341
|
-
#
|
1334
|
+
# data.
|
1335
|
+
#
|
1336
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1337
|
+
# name for the AWS KMS customer master key (CMK).
|
1342
1338
|
#
|
1343
1339
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
1344
|
-
# Amazon RDS uses your default
|
1345
|
-
#
|
1346
|
-
#
|
1340
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your AWS
|
1341
|
+
# account. Your AWS account has a different default CMK for each AWS
|
1342
|
+
# Region.
|
1347
1343
|
# @option options [Integer] :performance_insights_retention_period
|
1348
1344
|
# The amount of time, in days, to retain Performance Insights data.
|
1349
1345
|
# Valid values are 7 or 731 (2 years).
|
@@ -1372,7 +1368,8 @@ module Aws::RDS
|
|
1372
1368
|
#
|
1373
1369
|
# **Oracle**
|
1374
1370
|
#
|
1375
|
-
# Possible values are `alert`, `audit`, `listener`,
|
1371
|
+
# Possible values are `alert`, `audit`, `listener`, `trace`, and
|
1372
|
+
# `oemagent`.
|
1376
1373
|
#
|
1377
1374
|
# **PostgreSQL**
|
1378
1375
|
#
|
@@ -1403,6 +1400,25 @@ module Aws::RDS
|
|
1403
1400
|
# @option options [Integer] :max_allocated_storage
|
1404
1401
|
# The upper limit to which Amazon RDS can automatically scale the
|
1405
1402
|
# storage of the DB instance.
|
1403
|
+
# @option options [Boolean] :enable_customer_owned_ip
|
1404
|
+
# A value that indicates whether to enable a customer-owned IP address
|
1405
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
1406
|
+
#
|
1407
|
+
# A *CoIP* provides local or external connectivity to resources in your
|
1408
|
+
# Outpost subnets through your on-premises network. For some use cases,
|
1409
|
+
# a CoIP can provide lower latency for connections to the DB instance
|
1410
|
+
# from outside of its virtual private cloud (VPC) on your local network.
|
1411
|
+
#
|
1412
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
1413
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
1414
|
+
#
|
1415
|
+
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
1416
|
+
# in the *AWS Outposts User Guide*.
|
1417
|
+
#
|
1418
|
+
#
|
1419
|
+
#
|
1420
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
1421
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
1406
1422
|
# @return [DBInstance]
|
1407
1423
|
def create_db_instance(options = {})
|
1408
1424
|
resp = @client.create_db_instance(options)
|
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
|
#
|
@@ -1050,25 +1089,25 @@ module Aws::RDS
|
|
1050
1089
|
# @return [String]
|
1051
1090
|
#
|
1052
1091
|
# @!attribute [rw] kms_key_id
|
1053
|
-
# The AWS KMS key
|
1054
|
-
#
|
1055
|
-
#
|
1092
|
+
# The AWS KMS key identifier for an encrypted DB cluster snapshot. The
|
1093
|
+
# AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
|
1094
|
+
# name for the AWS KMS customer master key (CMK).
|
1056
1095
|
#
|
1057
1096
|
# If you copy an encrypted DB cluster snapshot from your AWS account,
|
1058
1097
|
# you can specify a value for `KmsKeyId` to encrypt the copy with a
|
1059
|
-
# new KMS
|
1060
|
-
#
|
1061
|
-
#
|
1098
|
+
# new AWS KMS CMK. If you don't specify a value for `KmsKeyId`, then
|
1099
|
+
# the copy of the DB cluster snapshot is encrypted with the same AWS
|
1100
|
+
# KMS key as the source DB cluster snapshot.
|
1062
1101
|
#
|
1063
1102
|
# If you copy an encrypted DB cluster snapshot that is shared from
|
1064
1103
|
# another AWS account, then you must specify a value for `KmsKeyId`.
|
1065
1104
|
#
|
1066
1105
|
# 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
|
-
#
|
1106
|
+
# must set `KmsKeyId` to the AWS KMS key identifier you want to use to
|
1107
|
+
# encrypt the copy of the DB cluster snapshot in the destination AWS
|
1108
|
+
# Region. AWS KMS CMKs are specific to the AWS Region that they are
|
1109
|
+
# created in, and you can't use CMKs from one AWS Region in another
|
1110
|
+
# AWS Region.
|
1072
1111
|
#
|
1073
1112
|
# If you copy an unencrypted DB cluster snapshot and specify a value
|
1074
1113
|
# for the `KmsKeyId` parameter, an error is returned.
|
@@ -1088,11 +1127,12 @@ module Aws::RDS
|
|
1088
1127
|
# be copied. The pre-signed URL request must contain the following
|
1089
1128
|
# parameter values:
|
1090
1129
|
#
|
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
|
1130
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the customer master
|
1131
|
+
# key (CMK) to use to encrypt the copy of the DB cluster snapshot in
|
1132
|
+
# the destination AWS Region. This is the same identifier for both
|
1133
|
+
# the `CopyDBClusterSnapshot` action that is called in the
|
1134
|
+
# destination AWS Region, and the action contained in the pre-signed
|
1135
|
+
# URL.
|
1096
1136
|
#
|
1097
1137
|
# * `DestinationRegion` - The name of the AWS Region that the DB
|
1098
1138
|
# cluster snapshot is to be created in.
|
@@ -1139,9 +1179,6 @@ module Aws::RDS
|
|
1139
1179
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1140
1180
|
# @return [Array<Types::Tag>]
|
1141
1181
|
#
|
1142
|
-
# @!attribute [rw] destination_region
|
1143
|
-
# @return [String]
|
1144
|
-
#
|
1145
1182
|
# @!attribute [rw] source_region
|
1146
1183
|
# The source region of the snapshot. This is only needed when the
|
1147
1184
|
# shapshot is encrypted and in a different region.
|
@@ -1156,7 +1193,6 @@ module Aws::RDS
|
|
1156
1193
|
:pre_signed_url,
|
1157
1194
|
:copy_tags,
|
1158
1195
|
:tags,
|
1159
|
-
:destination_region,
|
1160
1196
|
:source_region)
|
1161
1197
|
SENSITIVE = []
|
1162
1198
|
include Aws::Structure
|
@@ -1280,6 +1316,7 @@ module Aws::RDS
|
|
1280
1316
|
# copy_tags: false,
|
1281
1317
|
# pre_signed_url: "String",
|
1282
1318
|
# option_group_name: "String",
|
1319
|
+
# target_custom_availability_zone: "String",
|
1283
1320
|
# source_region: "String",
|
1284
1321
|
# }
|
1285
1322
|
#
|
@@ -1330,15 +1367,15 @@ module Aws::RDS
|
|
1330
1367
|
# @return [String]
|
1331
1368
|
#
|
1332
1369
|
# @!attribute [rw] kms_key_id
|
1333
|
-
# The AWS KMS key
|
1334
|
-
#
|
1335
|
-
#
|
1370
|
+
# The AWS KMS key identifier for an encrypted DB snapshot. The AWS KMS
|
1371
|
+
# key identifier is the key ARN, key ID, alias ARN, or alias name for
|
1372
|
+
# the AWS KMS customer master key (CMK).
|
1336
1373
|
#
|
1337
1374
|
# If you copy an encrypted DB snapshot from your AWS account, you can
|
1338
1375
|
# specify a value for this parameter to encrypt the copy with a new
|
1339
|
-
# KMS
|
1340
|
-
#
|
1341
|
-
#
|
1376
|
+
# AWS KMS CMK. If you don't specify a value for this parameter, then
|
1377
|
+
# the copy of the DB snapshot is encrypted with the same AWS KMS key
|
1378
|
+
# as the source DB snapshot.
|
1342
1379
|
#
|
1343
1380
|
# If you copy an encrypted DB snapshot that is shared from another AWS
|
1344
1381
|
# account, then you must specify a value for this parameter.
|
@@ -1347,10 +1384,10 @@ module Aws::RDS
|
|
1347
1384
|
# the copy is encrypted.
|
1348
1385
|
#
|
1349
1386
|
# If you copy an encrypted snapshot to a different AWS Region, then
|
1350
|
-
# you must specify a KMS key for the destination AWS
|
1351
|
-
#
|
1352
|
-
# in, and you can't use
|
1353
|
-
#
|
1387
|
+
# you must specify a AWS KMS key identifier for the destination AWS
|
1388
|
+
# Region. AWS KMS CMKs are specific to the AWS Region that they are
|
1389
|
+
# created in, and you can't use CMKs from one AWS Region in another
|
1390
|
+
# AWS Region.
|
1354
1391
|
# @return [String]
|
1355
1392
|
#
|
1356
1393
|
# @!attribute [rw] tags
|
@@ -1395,11 +1432,11 @@ module Aws::RDS
|
|
1395
1432
|
# example, the `DestinationRegion` in the presigned URL must be set
|
1396
1433
|
# to the us-east-1 AWS Region.
|
1397
1434
|
#
|
1398
|
-
# * `KmsKeyId` - The AWS KMS key identifier for the
|
1399
|
-
# encrypt the copy of the DB snapshot in the
|
1400
|
-
# This is the same identifier for both the
|
1401
|
-
# that is called in the destination AWS
|
1402
|
-
# contained in the presigned URL.
|
1435
|
+
# * `KmsKeyId` - The AWS KMS key identifier for the customer master
|
1436
|
+
# key (CMK) to use to encrypt the copy of the DB snapshot in the
|
1437
|
+
# destination AWS Region. This is the same identifier for both the
|
1438
|
+
# `CopyDBSnapshot` action that is called in the destination AWS
|
1439
|
+
# Region, and the action contained in the presigned URL.
|
1403
1440
|
#
|
1404
1441
|
# * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
|
1405
1442
|
# encrypted snapshot to be copied. This identifier must be in the
|
@@ -1436,14 +1473,18 @@ module Aws::RDS
|
|
1436
1473
|
# group. If your source DB instance uses Transparent Data Encryption
|
1437
1474
|
# for Oracle or Microsoft SQL Server, you must specify this option
|
1438
1475
|
# when copying across AWS Regions. For more information, see [Option
|
1439
|
-
#
|
1476
|
+
# group considerations][1] in the *Amazon RDS User Guide.*
|
1440
1477
|
#
|
1441
1478
|
#
|
1442
1479
|
#
|
1443
1480
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options
|
1444
1481
|
# @return [String]
|
1445
1482
|
#
|
1446
|
-
# @!attribute [rw]
|
1483
|
+
# @!attribute [rw] target_custom_availability_zone
|
1484
|
+
# The external custom Availability Zone (CAZ) identifier for the
|
1485
|
+
# target CAZ.
|
1486
|
+
#
|
1487
|
+
# Example: `rds-caz-aiqhTgQv`.
|
1447
1488
|
# @return [String]
|
1448
1489
|
#
|
1449
1490
|
# @!attribute [rw] source_region
|
@@ -1461,7 +1502,7 @@ module Aws::RDS
|
|
1461
1502
|
:copy_tags,
|
1462
1503
|
:pre_signed_url,
|
1463
1504
|
:option_group_name,
|
1464
|
-
:
|
1505
|
+
:target_custom_availability_zone,
|
1465
1506
|
:source_region)
|
1466
1507
|
SENSITIVE = []
|
1467
1508
|
include Aws::Structure
|
@@ -1606,8 +1647,8 @@ module Aws::RDS
|
|
1606
1647
|
# A custom Availability Zone (AZ) is an on-premises AZ that is
|
1607
1648
|
# integrated with a VMware vSphere cluster.
|
1608
1649
|
#
|
1609
|
-
# For more information about RDS on VMware, see the [
|
1610
|
-
# User Guide
|
1650
|
+
# For more information about RDS on VMware, see the [ RDS on VMware
|
1651
|
+
# User Guide.][1]
|
1611
1652
|
#
|
1612
1653
|
#
|
1613
1654
|
#
|
@@ -1945,31 +1986,27 @@ module Aws::RDS
|
|
1945
1986
|
# @!attribute [rw] kms_key_id
|
1946
1987
|
# The AWS KMS key identifier for an encrypted DB cluster.
|
1947
1988
|
#
|
1948
|
-
# The KMS key identifier is the
|
1949
|
-
#
|
1950
|
-
#
|
1951
|
-
# cluster, then you can use the KMS key alias instead of the ARN for
|
1952
|
-
# the KMS encryption key.
|
1989
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
1990
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
1991
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
1953
1992
|
#
|
1954
|
-
#
|
1993
|
+
# When a CMK isn't specified in `KmsKeyId`\:
|
1955
1994
|
#
|
1956
1995
|
# * If `ReplicationSourceIdentifier` identifies an encrypted source,
|
1957
|
-
# then Amazon RDS will use the
|
1958
|
-
#
|
1959
|
-
# key.
|
1996
|
+
# then Amazon RDS will use the CMK used to encrypt the source.
|
1997
|
+
# Otherwise, Amazon RDS will use your default CMK.
|
1960
1998
|
#
|
1961
1999
|
# * If the `StorageEncrypted` parameter is enabled and
|
1962
2000
|
# `ReplicationSourceIdentifier` isn't specified, then Amazon RDS
|
1963
|
-
# will use your default
|
2001
|
+
# will use your default CMK.
|
1964
2002
|
#
|
1965
|
-
#
|
1966
|
-
#
|
1967
|
-
# Region.
|
2003
|
+
# There is a default CMK for your AWS account. Your AWS account has a
|
2004
|
+
# different default CMK for each AWS Region.
|
1968
2005
|
#
|
1969
2006
|
# If you create a read replica of an encrypted DB cluster in another
|
1970
|
-
# AWS Region, you must set `KmsKeyId` to a KMS key
|
1971
|
-
# the destination AWS Region. This
|
1972
|
-
# replica in that AWS Region.
|
2007
|
+
# AWS Region, you must set `KmsKeyId` to a AWS KMS key identifier that
|
2008
|
+
# is valid in the destination AWS Region. This CMK is used to encrypt
|
2009
|
+
# the read replica in that AWS Region.
|
1973
2010
|
# @return [String]
|
1974
2011
|
#
|
1975
2012
|
# @!attribute [rw] pre_signed_url
|
@@ -1988,7 +2025,7 @@ module Aws::RDS
|
|
1988
2025
|
#
|
1989
2026
|
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
1990
2027
|
# encrypt the copy of the DB cluster in the destination AWS Region.
|
1991
|
-
# This should refer to the same KMS
|
2028
|
+
# This should refer to the same AWS KMS CMK for both the
|
1992
2029
|
# `CreateDBCluster` action that is called in the destination AWS
|
1993
2030
|
# Region, and the action contained in the pre-signed URL.
|
1994
2031
|
#
|
@@ -2176,9 +2213,6 @@ module Aws::RDS
|
|
2176
2213
|
# disallows write operations for secondary clusters.
|
2177
2214
|
# @return [Boolean]
|
2178
2215
|
#
|
2179
|
-
# @!attribute [rw] destination_region
|
2180
|
-
# @return [String]
|
2181
|
-
#
|
2182
2216
|
# @!attribute [rw] source_region
|
2183
2217
|
# The source region of the snapshot. This is only needed when the
|
2184
2218
|
# shapshot is encrypted and in a different region.
|
@@ -2220,7 +2254,6 @@ module Aws::RDS
|
|
2220
2254
|
:domain,
|
2221
2255
|
:domain_iam_role_name,
|
2222
2256
|
:enable_global_write_forwarding,
|
2223
|
-
:destination_region,
|
2224
2257
|
:source_region)
|
2225
2258
|
SENSITIVE = []
|
2226
2259
|
include Aws::Structure
|
@@ -2452,6 +2485,7 @@ module Aws::RDS
|
|
2452
2485
|
# ],
|
2453
2486
|
# deletion_protection: false,
|
2454
2487
|
# max_allocated_storage: 1,
|
2488
|
+
# enable_customer_owned_ip: false,
|
2455
2489
|
# }
|
2456
2490
|
#
|
2457
2491
|
# @!attribute [rw] db_name
|
@@ -2491,8 +2525,8 @@ module Aws::RDS
|
|
2491
2525
|
# **PostgreSQL**
|
2492
2526
|
#
|
2493
2527
|
# The name of the database to create when the DB instance is created.
|
2494
|
-
# If this parameter isn't specified, the
|
2495
|
-
#
|
2528
|
+
# If this parameter isn't specified, no database is created in the DB
|
2529
|
+
# instance.
|
2496
2530
|
#
|
2497
2531
|
# Constraints:
|
2498
2532
|
#
|
@@ -2822,8 +2856,8 @@ module Aws::RDS
|
|
2822
2856
|
# specify the identifier of the custom Availability Zone to create the
|
2823
2857
|
# DB instance in.
|
2824
2858
|
#
|
2825
|
-
# For more information about RDS on VMware, see the [
|
2826
|
-
# User Guide
|
2859
|
+
# For more information about RDS on VMware, see the [ RDS on VMware
|
2860
|
+
# User Guide.][2]
|
2827
2861
|
#
|
2828
2862
|
# </note>
|
2829
2863
|
#
|
@@ -3016,8 +3050,8 @@ module Aws::RDS
|
|
3016
3050
|
#
|
3017
3051
|
# **PostgreSQL**
|
3018
3052
|
#
|
3019
|
-
# See [
|
3020
|
-
# User Guide.*
|
3053
|
+
# See [Amazon RDS for PostgreSQL versions and extensions][5] in the
|
3054
|
+
# *Amazon RDS User Guide.*
|
3021
3055
|
#
|
3022
3056
|
#
|
3023
3057
|
#
|
@@ -3025,7 +3059,7 @@ module Aws::RDS
|
|
3025
3059
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport
|
3026
3060
|
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
3027
3061
|
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
|
3028
|
-
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
3062
|
+
# [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
3029
3063
|
# @return [String]
|
3030
3064
|
#
|
3031
3065
|
# @!attribute [rw] auto_minor_version_upgrade
|
@@ -3058,8 +3092,8 @@ module Aws::RDS
|
|
3058
3092
|
# @return [Integer]
|
3059
3093
|
#
|
3060
3094
|
# @!attribute [rw] option_group_name
|
3061
|
-
#
|
3062
|
-
# specified option group.
|
3095
|
+
# A value that indicates that the DB instance should be associated
|
3096
|
+
# with the specified option group.
|
3063
3097
|
#
|
3064
3098
|
# Permanent options, such as the TDE option for Oracle Advanced
|
3065
3099
|
# Security TDE, can't be removed from an option group. Also, that
|
@@ -3159,22 +3193,19 @@ module Aws::RDS
|
|
3159
3193
|
# @!attribute [rw] kms_key_id
|
3160
3194
|
# The AWS KMS key identifier for an encrypted DB instance.
|
3161
3195
|
#
|
3162
|
-
# The KMS key identifier is the
|
3163
|
-
#
|
3164
|
-
#
|
3165
|
-
# instance, then you can use the KMS key alias instead of the ARN for
|
3166
|
-
# the KM encryption key.
|
3196
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
3197
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
3198
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
3167
3199
|
#
|
3168
3200
|
# **Amazon Aurora**
|
3169
3201
|
#
|
3170
|
-
# Not applicable. The KMS key identifier is managed by the DB
|
3171
|
-
# For more information, see `CreateDBCluster`.
|
3202
|
+
# Not applicable. The AWS KMS key identifier is managed by the DB
|
3203
|
+
# cluster. For more information, see `CreateDBCluster`.
|
3172
3204
|
#
|
3173
3205
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
3174
|
-
# the `KmsKeyId` parameter, then Amazon RDS
|
3175
|
-
#
|
3176
|
-
#
|
3177
|
-
# for each AWS Region.
|
3206
|
+
# the `KmsKeyId` parameter, then Amazon RDS uses your default CMK.
|
3207
|
+
# There is a default CMK for your AWS account. Your AWS account has a
|
3208
|
+
# different default CMK for each AWS Region.
|
3178
3209
|
# @return [String]
|
3179
3210
|
#
|
3180
3211
|
# @!attribute [rw] domain
|
@@ -3286,13 +3317,15 @@ module Aws::RDS
|
|
3286
3317
|
#
|
3287
3318
|
# @!attribute [rw] performance_insights_kms_key_id
|
3288
3319
|
# The AWS KMS key identifier for encryption of Performance Insights
|
3289
|
-
# data.
|
3290
|
-
#
|
3320
|
+
# data.
|
3321
|
+
#
|
3322
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
3323
|
+
# alias name for the AWS KMS customer master key (CMK).
|
3291
3324
|
#
|
3292
3325
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
3293
|
-
# then Amazon RDS uses your default
|
3294
|
-
#
|
3295
|
-
#
|
3326
|
+
# then Amazon RDS uses your default CMK. There is a default CMK for
|
3327
|
+
# your AWS account. Your AWS account has a different default CMK for
|
3328
|
+
# each AWS Region.
|
3296
3329
|
# @return [String]
|
3297
3330
|
#
|
3298
3331
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -3326,7 +3359,8 @@ module Aws::RDS
|
|
3326
3359
|
#
|
3327
3360
|
# **Oracle**
|
3328
3361
|
#
|
3329
|
-
# Possible values are `alert`, `audit`, `listener`,
|
3362
|
+
# Possible values are `alert`, `audit`, `listener`, `trace`, and
|
3363
|
+
# `oemagent`.
|
3330
3364
|
#
|
3331
3365
|
# **PostgreSQL**
|
3332
3366
|
#
|
@@ -3365,6 +3399,28 @@ module Aws::RDS
|
|
3365
3399
|
# storage of the DB instance.
|
3366
3400
|
# @return [Integer]
|
3367
3401
|
#
|
3402
|
+
# @!attribute [rw] enable_customer_owned_ip
|
3403
|
+
# A value that indicates whether to enable a customer-owned IP address
|
3404
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
3405
|
+
#
|
3406
|
+
# A *CoIP* provides local or external connectivity to resources in
|
3407
|
+
# your Outpost subnets through your on-premises network. For some use
|
3408
|
+
# cases, a CoIP can provide lower latency for connections to the DB
|
3409
|
+
# instance from outside of its virtual private cloud (VPC) on your
|
3410
|
+
# local network.
|
3411
|
+
#
|
3412
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
3413
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
3414
|
+
#
|
3415
|
+
# For more information about CoIPs, see [Customer-owned IP
|
3416
|
+
# addresses][2] in the *AWS Outposts User Guide*.
|
3417
|
+
#
|
3418
|
+
#
|
3419
|
+
#
|
3420
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
3421
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
3422
|
+
# @return [Boolean]
|
3423
|
+
#
|
3368
3424
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceMessage AWS API Documentation
|
3369
3425
|
#
|
3370
3426
|
class CreateDBInstanceMessage < Struct.new(
|
@@ -3414,7 +3470,8 @@ module Aws::RDS
|
|
3414
3470
|
:enable_cloudwatch_logs_exports,
|
3415
3471
|
:processor_features,
|
3416
3472
|
:deletion_protection,
|
3417
|
-
:max_allocated_storage
|
3473
|
+
:max_allocated_storage,
|
3474
|
+
:enable_customer_owned_ip)
|
3418
3475
|
SENSITIVE = []
|
3419
3476
|
include Aws::Structure
|
3420
3477
|
end
|
@@ -3710,19 +3767,20 @@ module Aws::RDS
|
|
3710
3767
|
# @return [String]
|
3711
3768
|
#
|
3712
3769
|
# @!attribute [rw] kms_key_id
|
3713
|
-
# The AWS KMS key
|
3714
|
-
#
|
3715
|
-
#
|
3770
|
+
# The AWS KMS key identifier for an encrypted read replica.
|
3771
|
+
#
|
3772
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
3773
|
+
# alias name for the AWS KMS CMK.
|
3716
3774
|
#
|
3717
3775
|
# If you create an encrypted read replica in the same AWS Region as
|
3718
|
-
# the source DB instance, then
|
3719
|
-
#
|
3720
|
-
# as the source DB instance.
|
3776
|
+
# the source DB instance, then do not specify a value for this
|
3777
|
+
# parameter. A read replica in the same Region is always encrypted
|
3778
|
+
# with the same AWS KMS CMK as the source DB instance.
|
3721
3779
|
#
|
3722
3780
|
# If you create an encrypted read replica in a different AWS Region,
|
3723
|
-
# then you must specify a KMS key for the destination
|
3724
|
-
#
|
3725
|
-
# in, and you can't use
|
3781
|
+
# then you must specify a AWS KMS key identifier for the destination
|
3782
|
+
# AWS Region. AWS KMS CMKs are specific to the AWS Region that they
|
3783
|
+
# are created in, and you can't use CMKs from one AWS Region in
|
3726
3784
|
# another AWS Region.
|
3727
3785
|
#
|
3728
3786
|
# You can't create an encrypted read replica from an unencrypted DB
|
@@ -3821,13 +3879,15 @@ module Aws::RDS
|
|
3821
3879
|
#
|
3822
3880
|
# @!attribute [rw] performance_insights_kms_key_id
|
3823
3881
|
# The AWS KMS key identifier for encryption of Performance Insights
|
3824
|
-
# data.
|
3825
|
-
#
|
3882
|
+
# data.
|
3883
|
+
#
|
3884
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
3885
|
+
# alias name for the AWS KMS customer master key (CMK).
|
3826
3886
|
#
|
3827
3887
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
3828
|
-
# then Amazon RDS uses your default
|
3829
|
-
#
|
3830
|
-
#
|
3888
|
+
# then Amazon RDS uses your default CMK. There is a default CMK for
|
3889
|
+
# your AWS account. Your AWS account has a different default CMK for
|
3890
|
+
# each AWS Region.
|
3831
3891
|
# @return [String]
|
3832
3892
|
#
|
3833
3893
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -3914,9 +3974,6 @@ module Aws::RDS
|
|
3914
3974
|
# storage of the DB instance.
|
3915
3975
|
# @return [Integer]
|
3916
3976
|
#
|
3917
|
-
# @!attribute [rw] destination_region
|
3918
|
-
# @return [String]
|
3919
|
-
#
|
3920
3977
|
# @!attribute [rw] source_region
|
3921
3978
|
# The source region of the snapshot. This is only needed when the
|
3922
3979
|
# shapshot is encrypted and in a different region.
|
@@ -3957,7 +4014,6 @@ module Aws::RDS
|
|
3957
4014
|
:domain_iam_role_name,
|
3958
4015
|
:replica_mode,
|
3959
4016
|
:max_allocated_storage,
|
3960
|
-
:destination_region,
|
3961
4017
|
:source_region)
|
3962
4018
|
SENSITIVE = []
|
3963
4019
|
include Aws::Structure
|
@@ -4666,8 +4722,8 @@ module Aws::RDS
|
|
4666
4722
|
# A custom Availability Zone (AZ) is an on-premises AZ that is
|
4667
4723
|
# integrated with a VMware vSphere cluster.
|
4668
4724
|
#
|
4669
|
-
# For more information about RDS on VMware, see the [
|
4670
|
-
#
|
4725
|
+
# For more information about RDS on VMware, see the [ RDS on VMware User
|
4726
|
+
# Guide.][1]
|
4671
4727
|
#
|
4672
4728
|
#
|
4673
4729
|
#
|
@@ -4905,12 +4961,15 @@ module Aws::RDS
|
|
4905
4961
|
# @!attribute [rw] kms_key_id
|
4906
4962
|
# If `StorageEncrypted` is enabled, the AWS KMS key identifier for the
|
4907
4963
|
# encrypted DB cluster.
|
4964
|
+
#
|
4965
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
4966
|
+
# alias name for the AWS KMS customer master key (CMK).
|
4908
4967
|
# @return [String]
|
4909
4968
|
#
|
4910
4969
|
# @!attribute [rw] db_cluster_resource_id
|
4911
4970
|
# The AWS Region-unique, immutable identifier for the DB cluster. This
|
4912
4971
|
# identifier is found in AWS CloudTrail log entries whenever the AWS
|
4913
|
-
# KMS
|
4972
|
+
# KMS CMK for the DB cluster is accessed.
|
4914
4973
|
# @return [String]
|
4915
4974
|
#
|
4916
4975
|
# @!attribute [rw] db_cluster_arn
|
@@ -5036,6 +5095,9 @@ module Aws::RDS
|
|
5036
5095
|
# @!attribute [rw] activity_stream_kms_key_id
|
5037
5096
|
# The AWS KMS key identifier used for encrypting messages in the
|
5038
5097
|
# database activity stream.
|
5098
|
+
#
|
5099
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
5100
|
+
# alias name for the AWS KMS customer master key (CMK).
|
5039
5101
|
# @return [String]
|
5040
5102
|
#
|
5041
5103
|
# @!attribute [rw] activity_stream_kinesis_stream_name
|
@@ -5082,6 +5144,12 @@ module Aws::RDS
|
|
5082
5144
|
# cluster.
|
5083
5145
|
# @return [Boolean]
|
5084
5146
|
#
|
5147
|
+
# @!attribute [rw] pending_modified_values
|
5148
|
+
# A value that specifies that changes to the DB cluster are pending.
|
5149
|
+
# This element is only included when changes are pending. Specific
|
5150
|
+
# changes are identified by subelements.
|
5151
|
+
# @return [Types::ClusterPendingModifiedValues]
|
5152
|
+
#
|
5085
5153
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBCluster AWS API Documentation
|
5086
5154
|
#
|
5087
5155
|
class DBCluster < Struct.new(
|
@@ -5139,7 +5207,8 @@ module Aws::RDS
|
|
5139
5207
|
:domain_memberships,
|
5140
5208
|
:tag_list,
|
5141
5209
|
:global_write_forwarding_status,
|
5142
|
-
:global_write_forwarding_requested
|
5210
|
+
:global_write_forwarding_requested,
|
5211
|
+
:pending_modified_values)
|
5143
5212
|
SENSITIVE = []
|
5144
5213
|
include Aws::Structure
|
5145
5214
|
end
|
@@ -5729,6 +5798,9 @@ module Aws::RDS
|
|
5729
5798
|
# @!attribute [rw] kms_key_id
|
5730
5799
|
# If `StorageEncrypted` is true, the AWS KMS key identifier for the
|
5731
5800
|
# encrypted DB cluster snapshot.
|
5801
|
+
#
|
5802
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
5803
|
+
# alias name for the AWS KMS customer master key (CMK).
|
5732
5804
|
# @return [String]
|
5733
5805
|
#
|
5734
5806
|
# @!attribute [rw] db_cluster_snapshot_arn
|
@@ -6129,9 +6201,9 @@ module Aws::RDS
|
|
6129
6201
|
# @return [String]
|
6130
6202
|
#
|
6131
6203
|
# @!attribute [rw] pending_modified_values
|
6132
|
-
#
|
6133
|
-
# is only included when changes are pending. Specific
|
6134
|
-
# identified by subelements.
|
6204
|
+
# A value that specifies that changes to the DB instance are pending.
|
6205
|
+
# This element is only included when changes are pending. Specific
|
6206
|
+
# changes are identified by subelements.
|
6135
6207
|
# @return [Types::PendingModifiedValues]
|
6136
6208
|
#
|
6137
6209
|
# @!attribute [rw] latest_restorable_time
|
@@ -6148,7 +6220,8 @@ module Aws::RDS
|
|
6148
6220
|
# @return [String]
|
6149
6221
|
#
|
6150
6222
|
# @!attribute [rw] auto_minor_version_upgrade
|
6151
|
-
#
|
6223
|
+
# A value that indicates that minor version patches are applied
|
6224
|
+
# automatically.
|
6152
6225
|
# @return [Boolean]
|
6153
6226
|
#
|
6154
6227
|
# @!attribute [rw] read_replica_source_db_instance_identifier
|
@@ -6265,12 +6338,15 @@ module Aws::RDS
|
|
6265
6338
|
# @!attribute [rw] kms_key_id
|
6266
6339
|
# If `StorageEncrypted` is true, the AWS KMS key identifier for the
|
6267
6340
|
# encrypted DB instance.
|
6341
|
+
#
|
6342
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
6343
|
+
# alias name for the AWS KMS customer master key (CMK).
|
6268
6344
|
# @return [String]
|
6269
6345
|
#
|
6270
6346
|
# @!attribute [rw] dbi_resource_id
|
6271
6347
|
# The AWS Region-unique, immutable identifier for the DB instance.
|
6272
6348
|
# This identifier is found in AWS CloudTrail log entries whenever the
|
6273
|
-
# AWS KMS key for the DB instance is accessed.
|
6349
|
+
# AWS KMS customer master key (CMK) for the DB instance is accessed.
|
6274
6350
|
# @return [String]
|
6275
6351
|
#
|
6276
6352
|
# @!attribute [rw] ca_certificate_identifier
|
@@ -6352,8 +6428,10 @@ module Aws::RDS
|
|
6352
6428
|
#
|
6353
6429
|
# @!attribute [rw] performance_insights_kms_key_id
|
6354
6430
|
# The AWS KMS key identifier for encryption of Performance Insights
|
6355
|
-
# data.
|
6356
|
-
#
|
6431
|
+
# data.
|
6432
|
+
#
|
6433
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
6434
|
+
# alias name for the AWS KMS customer master key (CMK).
|
6357
6435
|
# @return [String]
|
6358
6436
|
#
|
6359
6437
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -6412,6 +6490,33 @@ module Aws::RDS
|
|
6412
6490
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
6413
6491
|
# @return [Array<Types::Tag>]
|
6414
6492
|
#
|
6493
|
+
# @!attribute [rw] db_instance_automated_backups_replications
|
6494
|
+
# The list of replicated automated backups associated with the DB
|
6495
|
+
# instance.
|
6496
|
+
# @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
|
6497
|
+
#
|
6498
|
+
# @!attribute [rw] customer_owned_ip_enabled
|
6499
|
+
# Specifies whether a customer-owned IP address (CoIP) is enabled for
|
6500
|
+
# an RDS on Outposts DB instance.
|
6501
|
+
#
|
6502
|
+
# A <i>CoIP </i>provides local or external connectivity to resources
|
6503
|
+
# in your Outpost subnets through your on-premises network. For some
|
6504
|
+
# use cases, a CoIP can provide lower latency for connections to the
|
6505
|
+
# DB instance from outside of its virtual private cloud (VPC) on your
|
6506
|
+
# local network.
|
6507
|
+
#
|
6508
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
6509
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
6510
|
+
#
|
6511
|
+
# For more information about CoIPs, see [Customer-owned IP
|
6512
|
+
# addresses][2] in the *AWS Outposts User Guide*.
|
6513
|
+
#
|
6514
|
+
#
|
6515
|
+
#
|
6516
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
6517
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
6518
|
+
# @return [Boolean]
|
6519
|
+
#
|
6415
6520
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstance AWS API Documentation
|
6416
6521
|
#
|
6417
6522
|
class DBInstance < Struct.new(
|
@@ -6475,7 +6580,9 @@ module Aws::RDS
|
|
6475
6580
|
:associated_roles,
|
6476
6581
|
:listener_endpoint,
|
6477
6582
|
:max_allocated_storage,
|
6478
|
-
:tag_list
|
6583
|
+
:tag_list,
|
6584
|
+
:db_instance_automated_backups_replications,
|
6585
|
+
:customer_owned_ip_enabled)
|
6479
6586
|
SENSITIVE = []
|
6480
6587
|
include Aws::Structure
|
6481
6588
|
end
|
@@ -6486,12 +6593,12 @@ module Aws::RDS
|
|
6486
6593
|
#
|
6487
6594
|
class DBInstanceAlreadyExistsFault < Aws::EmptyStructure; end
|
6488
6595
|
|
6489
|
-
# An automated backup of a DB instance. It
|
6490
|
-
#
|
6491
|
-
#
|
6596
|
+
# An automated backup of a DB instance. It consists of system backups,
|
6597
|
+
# transaction logs, and the database instance properties that existed at
|
6598
|
+
# the time you deleted the source instance.
|
6492
6599
|
#
|
6493
6600
|
# @!attribute [rw] db_instance_arn
|
6494
|
-
# The Amazon Resource Name (ARN) for the automated
|
6601
|
+
# The Amazon Resource Name (ARN) for the automated backups.
|
6495
6602
|
# @return [String]
|
6496
6603
|
#
|
6497
6604
|
# @!attribute [rw] dbi_resource_id
|
@@ -6592,9 +6699,10 @@ module Aws::RDS
|
|
6592
6699
|
# @return [String]
|
6593
6700
|
#
|
6594
6701
|
# @!attribute [rw] kms_key_id
|
6595
|
-
# The AWS KMS key ID for an automated backup.
|
6596
|
-
#
|
6597
|
-
#
|
6702
|
+
# The AWS KMS key ID for an automated backup.
|
6703
|
+
#
|
6704
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
6705
|
+
# alias name for the AWS KMS customer master key (CMK).
|
6598
6706
|
# @return [String]
|
6599
6707
|
#
|
6600
6708
|
# @!attribute [rw] timezone
|
@@ -6608,6 +6716,19 @@ module Aws::RDS
|
|
6608
6716
|
# to database accounts is enabled, and otherwise false.
|
6609
6717
|
# @return [Boolean]
|
6610
6718
|
#
|
6719
|
+
# @!attribute [rw] backup_retention_period
|
6720
|
+
# The retention period for the automated backups.
|
6721
|
+
# @return [Integer]
|
6722
|
+
#
|
6723
|
+
# @!attribute [rw] db_instance_automated_backups_arn
|
6724
|
+
# The Amazon Resource Name (ARN) for the replicated automated backups.
|
6725
|
+
# @return [String]
|
6726
|
+
#
|
6727
|
+
# @!attribute [rw] db_instance_automated_backups_replications
|
6728
|
+
# The list of replications to different AWS Regions associated with
|
6729
|
+
# the automated backup.
|
6730
|
+
# @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
|
6731
|
+
#
|
6611
6732
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstanceAutomatedBackup AWS API Documentation
|
6612
6733
|
#
|
6613
6734
|
class DBInstanceAutomatedBackup < Struct.new(
|
@@ -6633,7 +6754,10 @@ module Aws::RDS
|
|
6633
6754
|
:storage_type,
|
6634
6755
|
:kms_key_id,
|
6635
6756
|
:timezone,
|
6636
|
-
:iam_database_authentication_enabled
|
6757
|
+
:iam_database_authentication_enabled,
|
6758
|
+
:backup_retention_period,
|
6759
|
+
:db_instance_automated_backups_arn,
|
6760
|
+
:db_instance_automated_backups_replications)
|
6637
6761
|
SENSITIVE = []
|
6638
6762
|
include Aws::Structure
|
6639
6763
|
end
|
@@ -6674,6 +6798,22 @@ module Aws::RDS
|
|
6674
6798
|
#
|
6675
6799
|
class DBInstanceAutomatedBackupQuotaExceededFault < Aws::EmptyStructure; end
|
6676
6800
|
|
6801
|
+
# Automated backups of a DB instance replicated to another AWS Region.
|
6802
|
+
# They consist of system backups, transaction logs, and database
|
6803
|
+
# instance properties.
|
6804
|
+
#
|
6805
|
+
# @!attribute [rw] db_instance_automated_backups_arn
|
6806
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups.
|
6807
|
+
# @return [String]
|
6808
|
+
#
|
6809
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstanceAutomatedBackupsReplication AWS API Documentation
|
6810
|
+
#
|
6811
|
+
class DBInstanceAutomatedBackupsReplication < Struct.new(
|
6812
|
+
:db_instance_automated_backups_arn)
|
6813
|
+
SENSITIVE = []
|
6814
|
+
include Aws::Structure
|
6815
|
+
end
|
6816
|
+
|
6677
6817
|
# Contains the result of a successful invocation of the
|
6678
6818
|
# `DescribeDBInstances` action.
|
6679
6819
|
#
|
@@ -7441,6 +7581,9 @@ module Aws::RDS
|
|
7441
7581
|
# @!attribute [rw] kms_key_id
|
7442
7582
|
# If `Encrypted` is true, the AWS KMS key identifier for the encrypted
|
7443
7583
|
# DB snapshot.
|
7584
|
+
#
|
7585
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
7586
|
+
# alias name for the AWS KMS customer master key (CMK).
|
7444
7587
|
# @return [String]
|
7445
7588
|
#
|
7446
7589
|
# @!attribute [rw] db_snapshot_arn
|
@@ -7742,8 +7885,8 @@ module Aws::RDS
|
|
7742
7885
|
# A custom Availability Zone (AZ) is an on-premises AZ that is
|
7743
7886
|
# integrated with a VMware vSphere cluster.
|
7744
7887
|
#
|
7745
|
-
# For more information about RDS on VMware, see the [
|
7746
|
-
# User Guide
|
7888
|
+
# For more information about RDS on VMware, see the [ RDS on VMware
|
7889
|
+
# User Guide.][1]
|
7747
7890
|
#
|
7748
7891
|
#
|
7749
7892
|
#
|
@@ -7926,7 +8069,8 @@ module Aws::RDS
|
|
7926
8069
|
# data as a hash:
|
7927
8070
|
#
|
7928
8071
|
# {
|
7929
|
-
# dbi_resource_id: "String",
|
8072
|
+
# dbi_resource_id: "String",
|
8073
|
+
# db_instance_automated_backups_arn: "String",
|
7930
8074
|
# }
|
7931
8075
|
#
|
7932
8076
|
# @!attribute [rw] dbi_resource_id
|
@@ -7934,18 +8078,25 @@ module Aws::RDS
|
|
7934
8078
|
# and which is unique to an AWS Region.
|
7935
8079
|
# @return [String]
|
7936
8080
|
#
|
8081
|
+
# @!attribute [rw] db_instance_automated_backups_arn
|
8082
|
+
# The Amazon Resource Name (ARN) of the automated backups to delete,
|
8083
|
+
# for example,
|
8084
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
8085
|
+
# @return [String]
|
8086
|
+
#
|
7937
8087
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceAutomatedBackupMessage AWS API Documentation
|
7938
8088
|
#
|
7939
8089
|
class DeleteDBInstanceAutomatedBackupMessage < Struct.new(
|
7940
|
-
:dbi_resource_id
|
8090
|
+
:dbi_resource_id,
|
8091
|
+
:db_instance_automated_backups_arn)
|
7941
8092
|
SENSITIVE = []
|
7942
8093
|
include Aws::Structure
|
7943
8094
|
end
|
7944
8095
|
|
7945
8096
|
# @!attribute [rw] db_instance_automated_backup
|
7946
|
-
# An automated backup of a DB instance. It
|
7947
|
-
#
|
7948
|
-
#
|
8097
|
+
# An automated backup of a DB instance. It consists of system backups,
|
8098
|
+
# transaction logs, and the database instance properties that existed
|
8099
|
+
# at the time you deleted the source instance.
|
7949
8100
|
# @return [Types::DBInstanceAutomatedBackup]
|
7950
8101
|
#
|
7951
8102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstanceAutomatedBackupResult AWS API Documentation
|
@@ -9163,6 +9314,7 @@ module Aws::RDS
|
|
9163
9314
|
# ],
|
9164
9315
|
# max_records: 1,
|
9165
9316
|
# marker: "String",
|
9317
|
+
# db_instance_automated_backups_arn: "String",
|
9166
9318
|
# }
|
9167
9319
|
#
|
9168
9320
|
# @!attribute [rw] dbi_resource_id
|
@@ -9186,20 +9338,19 @@ module Aws::RDS
|
|
9186
9338
|
#
|
9187
9339
|
# * `active` - automated backups for current instances
|
9188
9340
|
#
|
9189
|
-
# * `retained` - automated backups for deleted instances
|
9341
|
+
# * `retained` - automated backups for deleted instances and after
|
9342
|
+
# backup replication is stopped
|
9190
9343
|
#
|
9191
9344
|
# * `creating` - automated backups that are waiting for the first
|
9192
9345
|
# automated snapshot to be available
|
9193
9346
|
#
|
9194
9347
|
# * `db-instance-id` - Accepts DB instance identifiers and Amazon
|
9195
|
-
# Resource Names (ARNs)
|
9196
|
-
#
|
9197
|
-
# identified by these ARNs.
|
9348
|
+
# Resource Names (ARNs). The results list includes only information
|
9349
|
+
# about the DB instance automated backups identified by these ARNs.
|
9198
9350
|
#
|
9199
|
-
# * `dbi-resource-id` - Accepts DB
|
9200
|
-
#
|
9201
|
-
#
|
9202
|
-
# identified by these ARNs.
|
9351
|
+
# * `dbi-resource-id` - Accepts DB resource identifiers and Amazon
|
9352
|
+
# Resource Names (ARNs). The results list includes only information
|
9353
|
+
# about the DB instance resources identified by these ARNs.
|
9203
9354
|
#
|
9204
9355
|
# Returns all resources by default. The status for each resource is
|
9205
9356
|
# specified in the response.
|
@@ -9218,6 +9369,12 @@ module Aws::RDS
|
|
9218
9369
|
# marker, up to `MaxRecords`.
|
9219
9370
|
# @return [String]
|
9220
9371
|
#
|
9372
|
+
# @!attribute [rw] db_instance_automated_backups_arn
|
9373
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups,
|
9374
|
+
# for example,
|
9375
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
9376
|
+
# @return [String]
|
9377
|
+
#
|
9221
9378
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstanceAutomatedBackupsMessage AWS API Documentation
|
9222
9379
|
#
|
9223
9380
|
class DescribeDBInstanceAutomatedBackupsMessage < Struct.new(
|
@@ -9225,7 +9382,8 @@ module Aws::RDS
|
|
9225
9382
|
:db_instance_identifier,
|
9226
9383
|
:filters,
|
9227
9384
|
:max_records,
|
9228
|
-
:marker
|
9385
|
+
:marker,
|
9386
|
+
:db_instance_automated_backups_arn)
|
9229
9387
|
SENSITIVE = []
|
9230
9388
|
include Aws::Structure
|
9231
9389
|
end
|
@@ -11733,11 +11891,11 @@ module Aws::RDS
|
|
11733
11891
|
# @return [String]
|
11734
11892
|
#
|
11735
11893
|
# @!attribute [rw] kms_key_id
|
11736
|
-
# The
|
11737
|
-
# it's exported to Amazon S3. The
|
11738
|
-
#
|
11739
|
-
#
|
11740
|
-
#
|
11894
|
+
# The key identifier of the AWS KMS customer master key (CMK) that is
|
11895
|
+
# used to encrypt the snapshot when it's exported to Amazon S3. The
|
11896
|
+
# AWS KMS CMK identifier is its key ARN, key ID, alias ARN, or alias
|
11897
|
+
# name. The IAM role used for the snapshot export must have encryption
|
11898
|
+
# and decryption permissions to use this AWS KMS CMK.
|
11741
11899
|
# @return [String]
|
11742
11900
|
#
|
11743
11901
|
# @!attribute [rw] status
|
@@ -11921,7 +12079,8 @@ module Aws::RDS
|
|
11921
12079
|
# @!attribute [rw] global_cluster_resource_id
|
11922
12080
|
# The AWS Region-unique, immutable identifier for the global database
|
11923
12081
|
# cluster. This identifier is found in AWS CloudTrail log entries
|
11924
|
-
# whenever the AWS KMS key for the DB cluster is
|
12082
|
+
# whenever the AWS KMS customer master key (CMK) for the DB cluster is
|
12083
|
+
# accessed.
|
11925
12084
|
# @return [String]
|
11926
12085
|
#
|
11927
12086
|
# @!attribute [rw] global_cluster_arn
|
@@ -11974,6 +12133,10 @@ module Aws::RDS
|
|
11974
12133
|
include Aws::Structure
|
11975
12134
|
end
|
11976
12135
|
|
12136
|
+
# The `GlobalClusterIdentifier` already exists. Choose a new global
|
12137
|
+
# database identifier (unique name) to create a new global database
|
12138
|
+
# cluster.
|
12139
|
+
#
|
11977
12140
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/GlobalClusterAlreadyExistsFault AWS API Documentation
|
11978
12141
|
#
|
11979
12142
|
class GlobalClusterAlreadyExistsFault < Aws::EmptyStructure; end
|
@@ -12013,10 +12176,16 @@ module Aws::RDS
|
|
12013
12176
|
include Aws::Structure
|
12014
12177
|
end
|
12015
12178
|
|
12179
|
+
# The `GlobalClusterIdentifier` doesn't refer to an existing global
|
12180
|
+
# database cluster.
|
12181
|
+
#
|
12016
12182
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/GlobalClusterNotFoundFault AWS API Documentation
|
12017
12183
|
#
|
12018
12184
|
class GlobalClusterNotFoundFault < Aws::EmptyStructure; end
|
12019
12185
|
|
12186
|
+
# The number of global database clusters for this account is already at
|
12187
|
+
# the maximum allowed.
|
12188
|
+
#
|
12020
12189
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/GlobalClusterQuotaExceededFault AWS API Documentation
|
12021
12190
|
#
|
12022
12191
|
class GlobalClusterQuotaExceededFault < Aws::EmptyStructure; end
|
@@ -12404,6 +12573,9 @@ module Aws::RDS
|
|
12404
12573
|
#
|
12405
12574
|
class InvalidExportTaskStateFault < Aws::EmptyStructure; end
|
12406
12575
|
|
12576
|
+
# The global cluster is in an invalid state and can't perform the
|
12577
|
+
# requested operation.
|
12578
|
+
#
|
12407
12579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/InvalidGlobalClusterStateFault AWS API Documentation
|
12408
12580
|
#
|
12409
12581
|
class InvalidGlobalClusterStateFault < Aws::EmptyStructure; end
|
@@ -13213,6 +13385,7 @@ module Aws::RDS
|
|
13213
13385
|
# max_allocated_storage: 1,
|
13214
13386
|
# certificate_rotation_restart: false,
|
13215
13387
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
13388
|
+
# enable_customer_owned_ip: false,
|
13216
13389
|
# }
|
13217
13390
|
#
|
13218
13391
|
# @!attribute [rw] db_instance_identifier
|
@@ -13261,8 +13434,8 @@ module Aws::RDS
|
|
13261
13434
|
# The new DB subnet group for the DB instance. You can use this
|
13262
13435
|
# parameter to move your DB instance to a different VPC. If your DB
|
13263
13436
|
# instance isn't in a VPC, you can also use this parameter to move
|
13264
|
-
# your DB instance into a VPC. For more information, see [
|
13265
|
-
#
|
13437
|
+
# your DB instance into a VPC. For more information, see [Working with
|
13438
|
+
# a DB instance in a VPC][1] in the *Amazon RDS User Guide.*
|
13266
13439
|
#
|
13267
13440
|
# Changing the subnet group causes an outage during the change. The
|
13268
13441
|
# change is applied during the next maintenance window, unless you
|
@@ -13275,7 +13448,7 @@ module Aws::RDS
|
|
13275
13448
|
#
|
13276
13449
|
#
|
13277
13450
|
#
|
13278
|
-
# [1]:
|
13451
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC
|
13279
13452
|
# @return [String]
|
13280
13453
|
#
|
13281
13454
|
# @!attribute [rw] db_security_groups
|
@@ -13483,8 +13656,10 @@ module Aws::RDS
|
|
13483
13656
|
# parameter group can be the default for that DB parameter group
|
13484
13657
|
# family.
|
13485
13658
|
#
|
13486
|
-
#
|
13487
|
-
#
|
13659
|
+
# If you specify only a major version, Amazon RDS will update the DB
|
13660
|
+
# instance to the default minor version if the current minor version
|
13661
|
+
# is lower. For information about valid engine versions, see
|
13662
|
+
# `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
13488
13663
|
# @return [String]
|
13489
13664
|
#
|
13490
13665
|
# @!attribute [rw] allow_major_version_upgrade
|
@@ -13550,7 +13725,7 @@ module Aws::RDS
|
|
13550
13725
|
# @return [Integer]
|
13551
13726
|
#
|
13552
13727
|
# @!attribute [rw] option_group_name
|
13553
|
-
#
|
13728
|
+
# A value that indicates the DB instance should be associated with the
|
13554
13729
|
# specified option group. Changing this parameter doesn't result in
|
13555
13730
|
# an outage except in the following case and the change is applied
|
13556
13731
|
# during the next maintenance window unless the `ApplyImmediately`
|
@@ -13802,13 +13977,15 @@ module Aws::RDS
|
|
13802
13977
|
#
|
13803
13978
|
# @!attribute [rw] performance_insights_kms_key_id
|
13804
13979
|
# The AWS KMS key identifier for encryption of Performance Insights
|
13805
|
-
# data.
|
13806
|
-
#
|
13980
|
+
# data.
|
13981
|
+
#
|
13982
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
13983
|
+
# alias name for the AWS KMS customer master key (CMK).
|
13807
13984
|
#
|
13808
13985
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
13809
|
-
# then Amazon RDS uses your default
|
13810
|
-
#
|
13811
|
-
#
|
13986
|
+
# then Amazon RDS uses your default CMK. There is a default CMK for
|
13987
|
+
# your AWS account. Your AWS account has a different default CMK for
|
13988
|
+
# each AWS Region.
|
13812
13989
|
# @return [String]
|
13813
13990
|
#
|
13814
13991
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -13901,6 +14078,28 @@ module Aws::RDS
|
|
13901
14078
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
13902
14079
|
# @return [String]
|
13903
14080
|
#
|
14081
|
+
# @!attribute [rw] enable_customer_owned_ip
|
14082
|
+
# A value that indicates whether to enable a customer-owned IP address
|
14083
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
14084
|
+
#
|
14085
|
+
# A *CoIP* provides local or external connectivity to resources in
|
14086
|
+
# your Outpost subnets through your on-premises network. For some use
|
14087
|
+
# cases, a CoIP can provide lower latency for connections to the DB
|
14088
|
+
# instance from outside of its virtual private cloud (VPC) on your
|
14089
|
+
# local network.
|
14090
|
+
#
|
14091
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
14092
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
14093
|
+
#
|
14094
|
+
# For more information about CoIPs, see [Customer-owned IP
|
14095
|
+
# addresses][2] in the *AWS Outposts User Guide*.
|
14096
|
+
#
|
14097
|
+
#
|
14098
|
+
#
|
14099
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
14100
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
14101
|
+
# @return [Boolean]
|
14102
|
+
#
|
13904
14103
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
|
13905
14104
|
#
|
13906
14105
|
class ModifyDBInstanceMessage < Struct.new(
|
@@ -13946,7 +14145,8 @@ module Aws::RDS
|
|
13946
14145
|
:deletion_protection,
|
13947
14146
|
:max_allocated_storage,
|
13948
14147
|
:certificate_rotation_restart,
|
13949
|
-
:replica_mode
|
14148
|
+
:replica_mode,
|
14149
|
+
:enable_customer_owned_ip)
|
13950
14150
|
SENSITIVE = []
|
13951
14151
|
include Aws::Structure
|
13952
14152
|
end
|
@@ -14308,11 +14508,11 @@ module Aws::RDS
|
|
14308
14508
|
# You can specify this parameter when you upgrade an Oracle DB
|
14309
14509
|
# snapshot. The same option group considerations apply when upgrading
|
14310
14510
|
# a DB snapshot as when upgrading a DB instance. For more information,
|
14311
|
-
# see [Option
|
14511
|
+
# see [Option group considerations][1] in the *Amazon RDS User Guide.*
|
14312
14512
|
#
|
14313
14513
|
#
|
14314
14514
|
#
|
14315
|
-
# [1]:
|
14515
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Oracle.html#USER_UpgradeDBInstance.Oracle.OGPG.OG
|
14316
14516
|
# @return [String]
|
14317
14517
|
#
|
14318
14518
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBSnapshotMessage AWS API Documentation
|
@@ -14470,6 +14670,8 @@ module Aws::RDS
|
|
14470
14670
|
# global_cluster_identifier: "String",
|
14471
14671
|
# new_global_cluster_identifier: "String",
|
14472
14672
|
# deletion_protection: false,
|
14673
|
+
# engine_version: "String",
|
14674
|
+
# allow_major_version_upgrade: false,
|
14473
14675
|
# }
|
14474
14676
|
#
|
14475
14677
|
# @!attribute [rw] global_cluster_identifier
|
@@ -14505,12 +14707,53 @@ module Aws::RDS
|
|
14505
14707
|
# protection is enabled.
|
14506
14708
|
# @return [Boolean]
|
14507
14709
|
#
|
14710
|
+
# @!attribute [rw] engine_version
|
14711
|
+
# The version number of the database engine to which you want to
|
14712
|
+
# upgrade. Changing this parameter results in an outage. The change is
|
14713
|
+
# applied during the next maintenance window unless `ApplyImmediately`
|
14714
|
+
# is enabled.
|
14715
|
+
#
|
14716
|
+
# To list all of the available engine versions for `aurora` (for MySQL
|
14717
|
+
# 5.6-compatible Aurora), use the following command:
|
14718
|
+
#
|
14719
|
+
# `` aws rds describe-db-engine-versions --engine aurora --query
|
14720
|
+
# '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' ``
|
14721
|
+
#
|
14722
|
+
# To list all of the available engine versions for `aurora-mysql` (for
|
14723
|
+
# MySQL 5.7-compatible Aurora), use the following command:
|
14724
|
+
#
|
14725
|
+
# `` aws rds describe-db-engine-versions --engine aurora-mysql --query
|
14726
|
+
# '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]' ``
|
14727
|
+
#
|
14728
|
+
# To list all of the available engine versions for
|
14729
|
+
# `aurora-postgresql`, use the following command:
|
14730
|
+
#
|
14731
|
+
# `` aws rds describe-db-engine-versions --engine aurora-postgresql
|
14732
|
+
# --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
|
14733
|
+
# ``
|
14734
|
+
# @return [String]
|
14735
|
+
#
|
14736
|
+
# @!attribute [rw] allow_major_version_upgrade
|
14737
|
+
# A value that indicates whether major version upgrades are allowed.
|
14738
|
+
#
|
14739
|
+
# Constraints: You must allow major version upgrades when specifying a
|
14740
|
+
# value for the `EngineVersion` parameter that is a different major
|
14741
|
+
# version than the DB cluster's current version.
|
14742
|
+
#
|
14743
|
+
# If you upgrade the major version of a global database, the cluster
|
14744
|
+
# and DB instance parameter groups are set to the default parameter
|
14745
|
+
# groups for the new version. Apply any custom parameter groups after
|
14746
|
+
# completing the upgrade.
|
14747
|
+
# @return [Boolean]
|
14748
|
+
#
|
14508
14749
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyGlobalClusterMessage AWS API Documentation
|
14509
14750
|
#
|
14510
14751
|
class ModifyGlobalClusterMessage < Struct.new(
|
14511
14752
|
:global_cluster_identifier,
|
14512
14753
|
:new_global_cluster_identifier,
|
14513
|
-
:deletion_protection
|
14754
|
+
:deletion_protection,
|
14755
|
+
:engine_version,
|
14756
|
+
:allow_major_version_upgrade)
|
14514
14757
|
SENSITIVE = []
|
14515
14758
|
include Aws::Structure
|
14516
14759
|
end
|
@@ -15508,39 +15751,38 @@ module Aws::RDS
|
|
15508
15751
|
end
|
15509
15752
|
|
15510
15753
|
# This data type is used as a response element in the `ModifyDBInstance`
|
15511
|
-
#
|
15754
|
+
# operation and contains changes that will be applied during the next
|
15755
|
+
# maintenance window.
|
15512
15756
|
#
|
15513
15757
|
# @!attribute [rw] db_instance_class
|
15514
|
-
#
|
15515
|
-
#
|
15758
|
+
# The name of the compute and memory capacity class for the DB
|
15759
|
+
# instance.
|
15516
15760
|
# @return [String]
|
15517
15761
|
#
|
15518
15762
|
# @!attribute [rw] allocated_storage
|
15519
|
-
#
|
15520
|
-
#
|
15763
|
+
# The allocated storage size for the DB instance specified in
|
15764
|
+
# gibibytes .
|
15521
15765
|
# @return [Integer]
|
15522
15766
|
#
|
15523
15767
|
# @!attribute [rw] master_user_password
|
15524
|
-
#
|
15525
|
-
# credentials for the DB instance.
|
15768
|
+
# The master credentials for the DB instance.
|
15526
15769
|
# @return [String]
|
15527
15770
|
#
|
15528
15771
|
# @!attribute [rw] port
|
15529
|
-
#
|
15772
|
+
# The port for the DB instance.
|
15530
15773
|
# @return [Integer]
|
15531
15774
|
#
|
15532
15775
|
# @!attribute [rw] backup_retention_period
|
15533
|
-
#
|
15534
|
-
# retained.
|
15776
|
+
# The number of days for which automated backups are retained.
|
15535
15777
|
# @return [Integer]
|
15536
15778
|
#
|
15537
15779
|
# @!attribute [rw] multi_az
|
15538
|
-
#
|
15539
|
-
# deployment.
|
15780
|
+
# A value that indicates that the Single-AZ DB instance will change to
|
15781
|
+
# a Multi-AZ deployment.
|
15540
15782
|
# @return [Boolean]
|
15541
15783
|
#
|
15542
15784
|
# @!attribute [rw] engine_version
|
15543
|
-
#
|
15785
|
+
# The database engine version.
|
15544
15786
|
# @return [String]
|
15545
15787
|
#
|
15546
15788
|
# @!attribute [rw] license_model
|
@@ -15551,25 +15793,23 @@ module Aws::RDS
|
|
15551
15793
|
# @return [String]
|
15552
15794
|
#
|
15553
15795
|
# @!attribute [rw] iops
|
15554
|
-
#
|
15555
|
-
# will be applied or is currently being applied.
|
15796
|
+
# The Provisioned IOPS value for the DB instance.
|
15556
15797
|
# @return [Integer]
|
15557
15798
|
#
|
15558
15799
|
# @!attribute [rw] db_instance_identifier
|
15559
|
-
#
|
15560
|
-
# will be applied or is currently being applied.
|
15800
|
+
# The database identifier for the DB instance.
|
15561
15801
|
# @return [String]
|
15562
15802
|
#
|
15563
15803
|
# @!attribute [rw] storage_type
|
15564
|
-
#
|
15804
|
+
# The storage type of the DB instance.
|
15565
15805
|
# @return [String]
|
15566
15806
|
#
|
15567
15807
|
# @!attribute [rw] ca_certificate_identifier
|
15568
|
-
#
|
15808
|
+
# The identifier of the CA certificate for the DB instance.
|
15569
15809
|
# @return [String]
|
15570
15810
|
#
|
15571
15811
|
# @!attribute [rw] db_subnet_group_name
|
15572
|
-
# The
|
15812
|
+
# The DB subnet group for the DB instance.
|
15573
15813
|
# @return [String]
|
15574
15814
|
#
|
15575
15815
|
# @!attribute [rw] pending_cloudwatch_logs_exports
|
@@ -15583,6 +15823,11 @@ module Aws::RDS
|
|
15583
15823
|
# DB instance class of the DB instance.
|
15584
15824
|
# @return [Array<Types::ProcessorFeature>]
|
15585
15825
|
#
|
15826
|
+
# @!attribute [rw] iam_database_authentication_enabled
|
15827
|
+
# Whether mapping of AWS Identity and Access Management (IAM) accounts
|
15828
|
+
# to database accounts is enabled.
|
15829
|
+
# @return [Boolean]
|
15830
|
+
#
|
15586
15831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PendingModifiedValues AWS API Documentation
|
15587
15832
|
#
|
15588
15833
|
class PendingModifiedValues < Struct.new(
|
@@ -15600,7 +15845,8 @@ module Aws::RDS
|
|
15600
15845
|
:ca_certificate_identifier,
|
15601
15846
|
:db_subnet_group_name,
|
15602
15847
|
:pending_cloudwatch_logs_exports,
|
15603
|
-
:processor_features
|
15848
|
+
:processor_features,
|
15849
|
+
:iam_database_authentication_enabled)
|
15604
15850
|
SENSITIVE = []
|
15605
15851
|
include Aws::Structure
|
15606
15852
|
end
|
@@ -16131,7 +16377,7 @@ module Aws::RDS
|
|
16131
16377
|
#
|
16132
16378
|
# @!attribute [rw] role_arn
|
16133
16379
|
# The Amazon Resource Name (ARN) of the IAM role to disassociate from
|
16134
|
-
# the DB instance, for example
|
16380
|
+
# the DB instance, for example,
|
16135
16381
|
# `arn:aws:iam::123456789012:role/AccessRole`.
|
16136
16382
|
# @return [String]
|
16137
16383
|
#
|
@@ -16848,17 +17094,14 @@ module Aws::RDS
|
|
16848
17094
|
# @!attribute [rw] kms_key_id
|
16849
17095
|
# The AWS KMS key identifier for an encrypted DB cluster.
|
16850
17096
|
#
|
16851
|
-
# The KMS key identifier is the
|
16852
|
-
#
|
16853
|
-
#
|
16854
|
-
# cluster, then you can use the KMS key alias instead of the ARN for
|
16855
|
-
# the KM encryption key.
|
17097
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
17098
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
17099
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
16856
17100
|
#
|
16857
17101
|
# If the StorageEncrypted parameter is enabled, and you do not specify
|
16858
17102
|
# a value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
16859
|
-
# default
|
16860
|
-
#
|
16861
|
-
# encryption key for each AWS Region.
|
17103
|
+
# default CMK. There is a default CMK for your AWS account. Your AWS
|
17104
|
+
# account has a different default CMK for each AWS Region.
|
16862
17105
|
# @return [String]
|
16863
17106
|
#
|
16864
17107
|
# @!attribute [rw] enable_iam_database_authentication
|
@@ -17176,18 +17419,16 @@ module Aws::RDS
|
|
17176
17419
|
# The AWS KMS key identifier to use when restoring an encrypted DB
|
17177
17420
|
# cluster from a DB snapshot or DB cluster snapshot.
|
17178
17421
|
#
|
17179
|
-
# The KMS key identifier is the
|
17180
|
-
#
|
17181
|
-
#
|
17182
|
-
# cluster, then you can use the KMS key alias instead of the ARN for
|
17183
|
-
# the KMS encryption key.
|
17422
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
17423
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
17424
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
17184
17425
|
#
|
17185
|
-
#
|
17186
|
-
# following occurs:
|
17426
|
+
# When you don't specify a value for the `KmsKeyId` parameter, then
|
17427
|
+
# the following occurs:
|
17187
17428
|
#
|
17188
17429
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
17189
17430
|
# is encrypted, then the restored DB cluster is encrypted using the
|
17190
|
-
# KMS
|
17431
|
+
# AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster
|
17191
17432
|
# snapshot.
|
17192
17433
|
#
|
17193
17434
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
@@ -17482,23 +17723,21 @@ module Aws::RDS
|
|
17482
17723
|
# The AWS KMS key identifier to use when restoring an encrypted DB
|
17483
17724
|
# cluster from an encrypted DB cluster.
|
17484
17725
|
#
|
17485
|
-
# The KMS key identifier is the
|
17486
|
-
#
|
17487
|
-
#
|
17488
|
-
# cluster, then you can use the KMS key alias instead of the ARN for
|
17489
|
-
# the KMS encryption key.
|
17726
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
17727
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
17728
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
17490
17729
|
#
|
17491
17730
|
# You can restore to a new DB cluster and encrypt the new DB cluster
|
17492
|
-
# with a KMS
|
17493
|
-
# the source DB cluster. The new DB cluster is encrypted with
|
17494
|
-
#
|
17731
|
+
# with a AWS KMS CMK that is different than the AWS KMS key used to
|
17732
|
+
# encrypt the source DB cluster. The new DB cluster is encrypted with
|
17733
|
+
# the AWS KMS CMK identified by the `KmsKeyId` parameter.
|
17495
17734
|
#
|
17496
17735
|
# If you don't specify a value for the `KmsKeyId` parameter, then the
|
17497
17736
|
# following occurs:
|
17498
17737
|
#
|
17499
17738
|
# * If the DB cluster is encrypted, then the restored DB cluster is
|
17500
|
-
# encrypted using the KMS
|
17501
|
-
# cluster.
|
17739
|
+
# encrypted using the AWS KMS CMK that was used to encrypt the
|
17740
|
+
# source DB cluster.
|
17502
17741
|
#
|
17503
17742
|
# * If the DB cluster isn't encrypted, then the restored DB cluster
|
17504
17743
|
# isn't encrypted.
|
@@ -17680,6 +17919,7 @@ module Aws::RDS
|
|
17680
17919
|
# use_default_processor_features: false,
|
17681
17920
|
# db_parameter_group_name: "String",
|
17682
17921
|
# deletion_protection: false,
|
17922
|
+
# enable_customer_owned_ip: false,
|
17683
17923
|
# }
|
17684
17924
|
#
|
17685
17925
|
# @!attribute [rw] db_instance_identifier
|
@@ -17989,6 +18229,28 @@ module Aws::RDS
|
|
17989
18229
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
|
17990
18230
|
# @return [Boolean]
|
17991
18231
|
#
|
18232
|
+
# @!attribute [rw] enable_customer_owned_ip
|
18233
|
+
# A value that indicates whether to enable a customer-owned IP address
|
18234
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
18235
|
+
#
|
18236
|
+
# A *CoIP* provides local or external connectivity to resources in
|
18237
|
+
# your Outpost subnets through your on-premises network. For some use
|
18238
|
+
# cases, a CoIP can provide lower latency for connections to the DB
|
18239
|
+
# instance from outside of its virtual private cloud (VPC) on your
|
18240
|
+
# local network.
|
18241
|
+
#
|
18242
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
18243
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
18244
|
+
#
|
18245
|
+
# For more information about CoIPs, see [Customer-owned IP
|
18246
|
+
# addresses][2] in the *AWS Outposts User Guide*.
|
18247
|
+
#
|
18248
|
+
#
|
18249
|
+
#
|
18250
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
18251
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
18252
|
+
# @return [Boolean]
|
18253
|
+
#
|
17992
18254
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshotMessage AWS API Documentation
|
17993
18255
|
#
|
17994
18256
|
class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
|
@@ -18019,7 +18281,8 @@ module Aws::RDS
|
|
18019
18281
|
:processor_features,
|
18020
18282
|
:use_default_processor_features,
|
18021
18283
|
:db_parameter_group_name,
|
18022
|
-
:deletion_protection
|
18284
|
+
:deletion_protection,
|
18285
|
+
:enable_customer_owned_ip)
|
18023
18286
|
SENSITIVE = []
|
18024
18287
|
include Aws::Structure
|
18025
18288
|
end
|
@@ -18357,17 +18620,14 @@ module Aws::RDS
|
|
18357
18620
|
# @!attribute [rw] kms_key_id
|
18358
18621
|
# The AWS KMS key identifier for an encrypted DB instance.
|
18359
18622
|
#
|
18360
|
-
# The KMS key identifier is the
|
18361
|
-
#
|
18362
|
-
#
|
18363
|
-
# instance, then you can use the KMS key alias instead of the ARN for
|
18364
|
-
# the KM encryption key.
|
18623
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
18624
|
+
# alias name for the AWS KMS customer master key (CMK). To use a CMK
|
18625
|
+
# in a different AWS account, specify the key ARN or alias ARN.
|
18365
18626
|
#
|
18366
18627
|
# If the `StorageEncrypted` parameter is enabled, and you do not
|
18367
18628
|
# specify a value for the `KmsKeyId` parameter, then Amazon RDS will
|
18368
|
-
# use your default
|
18369
|
-
#
|
18370
|
-
# different default encryption key for each AWS Region.
|
18629
|
+
# use your default CMK. There is a default CMK for your AWS account.
|
18630
|
+
# Your AWS account has a different default CMK for each AWS Region.
|
18371
18631
|
# @return [String]
|
18372
18632
|
#
|
18373
18633
|
# @!attribute [rw] copy_tags_to_snapshot
|
@@ -18459,13 +18719,15 @@ module Aws::RDS
|
|
18459
18719
|
#
|
18460
18720
|
# @!attribute [rw] performance_insights_kms_key_id
|
18461
18721
|
# The AWS KMS key identifier for encryption of Performance Insights
|
18462
|
-
# data.
|
18463
|
-
#
|
18722
|
+
# data.
|
18723
|
+
#
|
18724
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
18725
|
+
# alias name for the AWS KMS customer master key (CMK).
|
18464
18726
|
#
|
18465
18727
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`,
|
18466
|
-
# then Amazon RDS uses your default
|
18467
|
-
#
|
18468
|
-
#
|
18728
|
+
# then Amazon RDS uses your default CMK. There is a default CMK for
|
18729
|
+
# your AWS account. Your AWS account has a different default CMK for
|
18730
|
+
# each AWS Region.
|
18469
18731
|
# @return [String]
|
18470
18732
|
#
|
18471
18733
|
# @!attribute [rw] performance_insights_retention_period
|
@@ -18622,6 +18884,8 @@ module Aws::RDS
|
|
18622
18884
|
# deletion_protection: false,
|
18623
18885
|
# source_dbi_resource_id: "String",
|
18624
18886
|
# max_allocated_storage: 1,
|
18887
|
+
# source_db_instance_automated_backups_arn: "String",
|
18888
|
+
# enable_customer_owned_ip: false,
|
18625
18889
|
# }
|
18626
18890
|
#
|
18627
18891
|
# @!attribute [rw] source_db_instance_identifier
|
@@ -18950,6 +19214,34 @@ module Aws::RDS
|
|
18950
19214
|
# storage of the DB instance.
|
18951
19215
|
# @return [Integer]
|
18952
19216
|
#
|
19217
|
+
# @!attribute [rw] source_db_instance_automated_backups_arn
|
19218
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups
|
19219
|
+
# from which to restore, for example,
|
19220
|
+
# `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
19221
|
+
# @return [String]
|
19222
|
+
#
|
19223
|
+
# @!attribute [rw] enable_customer_owned_ip
|
19224
|
+
# A value that indicates whether to enable a customer-owned IP address
|
19225
|
+
# (CoIP) for an RDS on Outposts DB instance.
|
19226
|
+
#
|
19227
|
+
# A *CoIP* provides local or external connectivity to resources in
|
19228
|
+
# your Outpost subnets through your on-premises network. For some use
|
19229
|
+
# cases, a CoIP can provide lower latency for connections to the DB
|
19230
|
+
# instance from outside of its virtual private cloud (VPC) on your
|
19231
|
+
# local network.
|
19232
|
+
#
|
19233
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
19234
|
+
# RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
|
19235
|
+
#
|
19236
|
+
# For more information about CoIPs, see [Customer-owned IP
|
19237
|
+
# addresses][2] in the *AWS Outposts User Guide*.
|
19238
|
+
#
|
19239
|
+
#
|
19240
|
+
#
|
19241
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
19242
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
19243
|
+
# @return [Boolean]
|
19244
|
+
#
|
18953
19245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTimeMessage AWS API Documentation
|
18954
19246
|
#
|
18955
19247
|
class RestoreDBInstanceToPointInTimeMessage < Struct.new(
|
@@ -18984,7 +19276,9 @@ module Aws::RDS
|
|
18984
19276
|
:db_parameter_group_name,
|
18985
19277
|
:deletion_protection,
|
18986
19278
|
:source_dbi_resource_id,
|
18987
|
-
:max_allocated_storage
|
19279
|
+
:max_allocated_storage,
|
19280
|
+
:source_db_instance_automated_backups_arn,
|
19281
|
+
:enable_customer_owned_ip)
|
18988
19282
|
SENSITIVE = []
|
18989
19283
|
include Aws::Structure
|
18990
19284
|
end
|
@@ -19297,12 +19591,18 @@ module Aws::RDS
|
|
19297
19591
|
# The status of the source AWS Region.
|
19298
19592
|
# @return [String]
|
19299
19593
|
#
|
19594
|
+
# @!attribute [rw] supports_db_instance_automated_backups_replication
|
19595
|
+
# Whether the source AWS Region supports replicating automated backups
|
19596
|
+
# to the current AWS Region.
|
19597
|
+
# @return [Boolean]
|
19598
|
+
#
|
19300
19599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/SourceRegion AWS API Documentation
|
19301
19600
|
#
|
19302
19601
|
class SourceRegion < Struct.new(
|
19303
19602
|
:region_name,
|
19304
19603
|
:endpoint,
|
19305
|
-
:status
|
19604
|
+
:status,
|
19605
|
+
:supports_db_instance_automated_backups_replication)
|
19306
19606
|
SENSITIVE = []
|
19307
19607
|
include Aws::Structure
|
19308
19608
|
end
|
@@ -19342,7 +19642,7 @@ module Aws::RDS
|
|
19342
19642
|
# }
|
19343
19643
|
#
|
19344
19644
|
# @!attribute [rw] resource_arn
|
19345
|
-
# The Amazon Resource Name (ARN) of the DB cluster, for example
|
19645
|
+
# The Amazon Resource Name (ARN) of the DB cluster, for example,
|
19346
19646
|
# `arn:aws:rds:us-east-1:12345667890:cluster:das-cluster`.
|
19347
19647
|
# @return [String]
|
19348
19648
|
#
|
@@ -19355,8 +19655,8 @@ module Aws::RDS
|
|
19355
19655
|
#
|
19356
19656
|
# @!attribute [rw] kms_key_id
|
19357
19657
|
# The AWS KMS key identifier for encrypting messages in the database
|
19358
|
-
# activity stream. The key identifier
|
19359
|
-
# ARN, or
|
19658
|
+
# activity stream. The AWS KMS key identifier is the key ARN, key ID,
|
19659
|
+
# alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
19360
19660
|
# @return [String]
|
19361
19661
|
#
|
19362
19662
|
# @!attribute [rw] apply_immediately
|
@@ -19447,6 +19747,75 @@ module Aws::RDS
|
|
19447
19747
|
include Aws::Structure
|
19448
19748
|
end
|
19449
19749
|
|
19750
|
+
# @note When making an API call, you may pass StartDBInstanceAutomatedBackupsReplicationMessage
|
19751
|
+
# data as a hash:
|
19752
|
+
#
|
19753
|
+
# {
|
19754
|
+
# source_db_instance_arn: "String", # required
|
19755
|
+
# backup_retention_period: 1,
|
19756
|
+
# kms_key_id: "String",
|
19757
|
+
# pre_signed_url: "String",
|
19758
|
+
# source_region: "String",
|
19759
|
+
# }
|
19760
|
+
#
|
19761
|
+
# @!attribute [rw] source_db_instance_arn
|
19762
|
+
# The Amazon Resource Name (ARN) of the source DB instance for the
|
19763
|
+
# replicated automated backups, for example,
|
19764
|
+
# `arn:aws:rds:us-west-2:123456789012:db:mydatabase`.
|
19765
|
+
# @return [String]
|
19766
|
+
#
|
19767
|
+
# @!attribute [rw] backup_retention_period
|
19768
|
+
# The retention period for the replicated automated backups.
|
19769
|
+
# @return [Integer]
|
19770
|
+
#
|
19771
|
+
# @!attribute [rw] kms_key_id
|
19772
|
+
# The AWS KMS key identifier for encryption of the replicated
|
19773
|
+
# automated backups. The KMS key ID is the Amazon Resource Name (ARN)
|
19774
|
+
# for the KMS encryption key in the destination AWS Region, for
|
19775
|
+
# example,
|
19776
|
+
# `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`.
|
19777
|
+
# @return [String]
|
19778
|
+
#
|
19779
|
+
# @!attribute [rw] pre_signed_url
|
19780
|
+
# A URL that contains a Signature Version 4 signed request for the
|
19781
|
+
# StartDBInstanceAutomatedBackupsReplication action to be called in
|
19782
|
+
# the AWS Region of the source DB instance. The presigned URL must be
|
19783
|
+
# a valid request for the StartDBInstanceAutomatedBackupsReplication
|
19784
|
+
# API action that can be executed in the AWS Region that contains the
|
19785
|
+
# source DB instance.
|
19786
|
+
# @return [String]
|
19787
|
+
#
|
19788
|
+
# @!attribute [rw] source_region
|
19789
|
+
# The source region of the snapshot. This is only needed when the
|
19790
|
+
# shapshot is encrypted and in a different region.
|
19791
|
+
# @return [String]
|
19792
|
+
#
|
19793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplicationMessage AWS API Documentation
|
19794
|
+
#
|
19795
|
+
class StartDBInstanceAutomatedBackupsReplicationMessage < Struct.new(
|
19796
|
+
:source_db_instance_arn,
|
19797
|
+
:backup_retention_period,
|
19798
|
+
:kms_key_id,
|
19799
|
+
:pre_signed_url,
|
19800
|
+
:source_region)
|
19801
|
+
SENSITIVE = []
|
19802
|
+
include Aws::Structure
|
19803
|
+
end
|
19804
|
+
|
19805
|
+
# @!attribute [rw] db_instance_automated_backup
|
19806
|
+
# An automated backup of a DB instance. It consists of system backups,
|
19807
|
+
# transaction logs, and the database instance properties that existed
|
19808
|
+
# at the time you deleted the source instance.
|
19809
|
+
# @return [Types::DBInstanceAutomatedBackup]
|
19810
|
+
#
|
19811
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstanceAutomatedBackupsReplicationResult AWS API Documentation
|
19812
|
+
#
|
19813
|
+
class StartDBInstanceAutomatedBackupsReplicationResult < Struct.new(
|
19814
|
+
:db_instance_automated_backup)
|
19815
|
+
SENSITIVE = []
|
19816
|
+
include Aws::Structure
|
19817
|
+
end
|
19818
|
+
|
19450
19819
|
# @note When making an API call, you may pass StartDBInstanceMessage
|
19451
19820
|
# data as a hash:
|
19452
19821
|
#
|
@@ -19515,11 +19884,12 @@ module Aws::RDS
|
|
19515
19884
|
# @return [String]
|
19516
19885
|
#
|
19517
19886
|
# @!attribute [rw] kms_key_id
|
19518
|
-
# The ID of the AWS KMS key to use to encrypt
|
19519
|
-
# Amazon S3. The KMS key
|
19520
|
-
# key
|
19521
|
-
# caller of this operation must be
|
19522
|
-
# operations. These can be set in
|
19887
|
+
# The ID of the AWS KMS customer master key (CMK) to use to encrypt
|
19888
|
+
# the snapshot exported to Amazon S3. The AWS KMS key identifier is
|
19889
|
+
# the key ARN, key ID, alias ARN, or alias name for the AWS KMS
|
19890
|
+
# customer master key (CMK). The caller of this operation must be
|
19891
|
+
# authorized to execute the following operations. These can be set in
|
19892
|
+
# the AWS KMS key policy:
|
19523
19893
|
#
|
19524
19894
|
# * GrantOperation.Encrypt
|
19525
19895
|
#
|
@@ -19611,6 +19981,9 @@ module Aws::RDS
|
|
19611
19981
|
# @!attribute [rw] kms_key_id
|
19612
19982
|
# The AWS KMS key identifier used for encrypting messages in the
|
19613
19983
|
# database activity stream.
|
19984
|
+
#
|
19985
|
+
# The AWS KMS key identifier is the key ARN, key ID, alias ARN, or
|
19986
|
+
# alias name for the AWS KMS customer master key (CMK).
|
19614
19987
|
# @return [String]
|
19615
19988
|
#
|
19616
19989
|
# @!attribute [rw] kinesis_stream_name
|
@@ -19667,6 +20040,41 @@ module Aws::RDS
|
|
19667
20040
|
include Aws::Structure
|
19668
20041
|
end
|
19669
20042
|
|
20043
|
+
# @note When making an API call, you may pass StopDBInstanceAutomatedBackupsReplicationMessage
|
20044
|
+
# data as a hash:
|
20045
|
+
#
|
20046
|
+
# {
|
20047
|
+
# source_db_instance_arn: "String", # required
|
20048
|
+
# }
|
20049
|
+
#
|
20050
|
+
# @!attribute [rw] source_db_instance_arn
|
20051
|
+
# The Amazon Resource Name (ARN) of the source DB instance for which
|
20052
|
+
# to stop replicating automated backups, for example,
|
20053
|
+
# `arn:aws:rds:us-west-2:123456789012:db:mydatabase`.
|
20054
|
+
# @return [String]
|
20055
|
+
#
|
20056
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplicationMessage AWS API Documentation
|
20057
|
+
#
|
20058
|
+
class StopDBInstanceAutomatedBackupsReplicationMessage < Struct.new(
|
20059
|
+
:source_db_instance_arn)
|
20060
|
+
SENSITIVE = []
|
20061
|
+
include Aws::Structure
|
20062
|
+
end
|
20063
|
+
|
20064
|
+
# @!attribute [rw] db_instance_automated_backup
|
20065
|
+
# An automated backup of a DB instance. It consists of system backups,
|
20066
|
+
# transaction logs, and the database instance properties that existed
|
20067
|
+
# at the time you deleted the source instance.
|
20068
|
+
# @return [Types::DBInstanceAutomatedBackup]
|
20069
|
+
#
|
20070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstanceAutomatedBackupsReplicationResult AWS API Documentation
|
20071
|
+
#
|
20072
|
+
class StopDBInstanceAutomatedBackupsReplicationResult < Struct.new(
|
20073
|
+
:db_instance_automated_backup)
|
20074
|
+
SENSITIVE = []
|
20075
|
+
include Aws::Structure
|
20076
|
+
end
|
20077
|
+
|
19670
20078
|
# @note When making an API call, you may pass StopDBInstanceMessage
|
19671
20079
|
# data as a hash:
|
19672
20080
|
#
|
@@ -20096,8 +20504,8 @@ module Aws::RDS
|
|
20096
20504
|
# Information about the virtual private network (VPN) between the VMware
|
20097
20505
|
# vSphere cluster and the AWS website.
|
20098
20506
|
#
|
20099
|
-
# For more information about RDS on VMware, see the [
|
20100
|
-
#
|
20507
|
+
# For more information about RDS on VMware, see the [ RDS on VMware User
|
20508
|
+
# Guide.][1]
|
20101
20509
|
#
|
20102
20510
|
#
|
20103
20511
|
#
|