aws-sdk-rds 1.120.0 → 1.121.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +880 -644
- data/lib/aws-sdk-rds/client_api.rb +11 -0
- data/lib/aws-sdk-rds/db_cluster.rb +111 -93
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +41 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +67 -57
- data/lib/aws-sdk-rds/db_instance.rb +241 -175
- data/lib/aws-sdk-rds/db_parameter_group.rb +54 -11
- data/lib/aws-sdk-rds/db_security_group.rb +12 -10
- data/lib/aws-sdk-rds/db_snapshot.rb +85 -71
- data/lib/aws-sdk-rds/db_snapshot_attribute.rb +15 -13
- data/lib/aws-sdk-rds/event_subscription.rb +2 -2
- data/lib/aws-sdk-rds/option_group.rb +3 -3
- data/lib/aws-sdk-rds/reserved_db_instance.rb +2 -2
- data/lib/aws-sdk-rds/resource.rb +193 -113
- data/lib/aws-sdk-rds/types.rb +963 -707
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 67b544e9fb4f538501cdfab6d32b0dab2399d41cbf4741dc9f91acc1da2d0a08
|
4
|
+
data.tar.gz: 279168bbbc7ba2400fe68ea0bb83c50fb64c901f964131490c2c5984fad825ef
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1419fe011fc01af7d1fd4801b4c94e872c933a73ae5b215be158ece98ce0e84632a8c8a6c150849ce56e1cde6edf3f7f0d262c209d6ac59245217915e53dbf78
|
7
|
+
data.tar.gz: 7208d04938132c838e60281395590715518e4fec0fa7a763767db6733977c1fc32e6b456b34bc0a4ee453ad06ee02bde9e4f239e02d2315844ddc5858db8edad
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.121.0
|
data/lib/aws-sdk-rds.rb
CHANGED
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -331,8 +331,8 @@ module Aws::RDS
|
|
331
331
|
|
332
332
|
# Associates an Identity and Access Management (IAM) role from an Amazon
|
333
333
|
# Aurora DB cluster. For more information, see [Authorizing Amazon
|
334
|
-
# Aurora MySQL to Access Other
|
335
|
-
# *Amazon Aurora User Guide*.
|
334
|
+
# Aurora MySQL to Access Other Amazon Web Services Services on Your
|
335
|
+
# Behalf][1] in the *Amazon Aurora User Guide*.
|
336
336
|
#
|
337
337
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
338
338
|
#
|
@@ -374,8 +374,8 @@ module Aws::RDS
|
|
374
374
|
req.send_request(options)
|
375
375
|
end
|
376
376
|
|
377
|
-
# Associates an
|
378
|
-
# instance.
|
377
|
+
# Associates an Amazon Web Services Identity and Access Management (IAM)
|
378
|
+
# role with a DB instance.
|
379
379
|
#
|
380
380
|
# <note markdown="1"> To add a role to a DB instance, the status of the DB instance must be
|
381
381
|
# `available`.
|
@@ -646,10 +646,10 @@ module Aws::RDS
|
|
646
646
|
# EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either
|
647
647
|
# EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
|
648
648
|
#
|
649
|
-
# <note markdown="1"> You can't authorize ingress from an EC2 security group in one
|
650
|
-
# Region to an Amazon RDS DB instance in another. You
|
651
|
-
# ingress from a VPC security group in one VPC to an
|
652
|
-
# instance in another.
|
649
|
+
# <note markdown="1"> You can't authorize ingress from an EC2 security group in one Amazon
|
650
|
+
# Web Services Region to an Amazon RDS DB instance in another. You
|
651
|
+
# can't authorize ingress from a VPC security group in one VPC to an
|
652
|
+
# Amazon RDS DB instance in another.
|
653
653
|
#
|
654
654
|
# </note>
|
655
655
|
#
|
@@ -678,11 +678,12 @@ module Aws::RDS
|
|
678
678
|
# `EC2SecurityGroupId` must be provided.
|
679
679
|
#
|
680
680
|
# @option params [String] :ec2_security_group_owner_id
|
681
|
-
#
|
682
|
-
# the `EC2SecurityGroupName` parameter. The
|
683
|
-
# acceptable value. For VPC DB
|
684
|
-
# must be provided. Otherwise,
|
685
|
-
# `
|
681
|
+
# Amazon Web Services account number of the owner of the EC2 security
|
682
|
+
# group specified in the `EC2SecurityGroupName` parameter. The Amazon
|
683
|
+
# Web Services access key ID isn't an acceptable value. For VPC DB
|
684
|
+
# security groups, `EC2SecurityGroupId` must be provided. Otherwise,
|
685
|
+
# `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or
|
686
|
+
# `EC2SecurityGroupId` must be provided.
|
686
687
|
#
|
687
688
|
# @return [Types::AuthorizeDBSecurityGroupIngressResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
688
689
|
#
|
@@ -1002,75 +1003,79 @@ module Aws::RDS
|
|
1002
1003
|
# snapshot, `SourceDBClusterSnapshotIdentifier` must be the Amazon
|
1003
1004
|
# Resource Name (ARN) of the shared DB cluster snapshot.
|
1004
1005
|
#
|
1005
|
-
# You can copy an encrypted DB cluster snapshot from another
|
1006
|
-
# In that case, the
|
1007
|
-
# `CopyDBClusterSnapshot` action is the destination
|
1008
|
-
# encrypted DB cluster snapshot to be copied
|
1009
|
-
# cluster snapshot from another
|
1010
|
-
# following values:
|
1006
|
+
# You can copy an encrypted DB cluster snapshot from another Amazon Web
|
1007
|
+
# Services Region. In that case, the Amazon Web Services Region where
|
1008
|
+
# you call the `CopyDBClusterSnapshot` action is the destination Amazon
|
1009
|
+
# Web Services Region for the encrypted DB cluster snapshot to be copied
|
1010
|
+
# to. To copy an encrypted DB cluster snapshot from another Amazon Web
|
1011
|
+
# Services Region, you must provide the following values:
|
1011
1012
|
#
|
1012
|
-
# * `KmsKeyId` - The
|
1013
|
-
# for the key to use to encrypt the
|
1014
|
-
# the destination
|
1013
|
+
# * `KmsKeyId` - The Amazon Web Services Key Management System (Amazon
|
1014
|
+
# Web Services KMS) key identifier for the key to use to encrypt the
|
1015
|
+
# copy of the DB cluster snapshot in the destination Amazon Web
|
1016
|
+
# Services Region.
|
1015
1017
|
#
|
1016
1018
|
# * `PreSignedUrl` - A URL that contains a Signature Version 4 signed
|
1017
1019
|
# request for the `CopyDBClusterSnapshot` action to be called in the
|
1018
|
-
# source
|
1019
|
-
# pre-signed URL must be a valid request for the
|
1020
|
+
# source Amazon Web Services Region where the DB cluster snapshot is
|
1021
|
+
# copied from. The pre-signed URL must be a valid request for the
|
1020
1022
|
# `CopyDBClusterSnapshot` API action that can be executed in the
|
1021
|
-
# source
|
1022
|
-
# be copied.
|
1023
|
+
# source Amazon Web Services Region that contains the encrypted DB
|
1024
|
+
# cluster snapshot to be copied.
|
1023
1025
|
#
|
1024
1026
|
# The pre-signed URL request must contain the following parameter
|
1025
1027
|
# values:
|
1026
1028
|
#
|
1027
|
-
# * `KmsKeyId` - The
|
1028
|
-
# key (CMK) to use to encrypt the copy of the DB
|
1029
|
-
#
|
1030
|
-
#
|
1031
|
-
#
|
1032
|
-
# URL.
|
1029
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
1030
|
+
# customer master key (CMK) to use to encrypt the copy of the DB
|
1031
|
+
# cluster snapshot in the destination Amazon Web Services Region.
|
1032
|
+
# This is the same identifier for both the `CopyDBClusterSnapshot`
|
1033
|
+
# action that is called in the destination Amazon Web Services
|
1034
|
+
# Region, and the action contained in the pre-signed URL.
|
1033
1035
|
#
|
1034
|
-
# * `DestinationRegion` - The name of the
|
1035
|
-
# cluster snapshot is to be created in.
|
1036
|
+
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
1037
|
+
# that the DB cluster snapshot is to be created in.
|
1036
1038
|
#
|
1037
1039
|
# * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot
|
1038
1040
|
# identifier for the encrypted DB cluster snapshot to be copied.
|
1039
1041
|
# This identifier must be in the Amazon Resource Name (ARN) format
|
1040
|
-
# for the source
|
1041
|
-
# encrypted DB cluster snapshot from the us-west-2
|
1042
|
-
# your `SourceDBClusterSnapshotIdentifier`
|
1043
|
-
# example:
|
1042
|
+
# for the source Amazon Web Services Region. For example, if you are
|
1043
|
+
# copying an encrypted DB cluster snapshot from the us-west-2 Amazon
|
1044
|
+
# Web Services Region, then your `SourceDBClusterSnapshotIdentifier`
|
1045
|
+
# looks like the following example:
|
1044
1046
|
# `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115`.
|
1045
1047
|
#
|
1046
1048
|
# To learn how to generate a Signature Version 4 signed request, see [
|
1047
|
-
# Authenticating Requests: Using Query Parameters (
|
1048
|
-
# Version 4)][1] and [ Signature Version 4 Signing
|
1049
|
+
# Authenticating Requests: Using Query Parameters (Amazon Web Services
|
1050
|
+
# Signature Version 4)][1] and [ Signature Version 4 Signing
|
1051
|
+
# Process][2].
|
1049
1052
|
#
|
1050
|
-
# <note markdown="1"> If you are using an
|
1051
|
-
# `SourceRegion` (or `--source-region` for the
|
1053
|
+
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
1054
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
1052
1055
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
1053
1056
|
# autogenerates a pre-signed URL that is a valid request for the
|
1054
|
-
# operation that can be executed in the source
|
1057
|
+
# operation that can be executed in the source Amazon Web Services
|
1058
|
+
# Region.
|
1055
1059
|
#
|
1056
1060
|
# </note>
|
1057
1061
|
#
|
1058
1062
|
# * `TargetDBClusterSnapshotIdentifier` - The identifier for the new
|
1059
|
-
# copy of the DB cluster snapshot in the destination
|
1063
|
+
# copy of the DB cluster snapshot in the destination Amazon Web
|
1064
|
+
# Services Region.
|
1060
1065
|
#
|
1061
1066
|
# * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot
|
1062
1067
|
# identifier for the encrypted DB cluster snapshot to be copied. This
|
1063
|
-
# identifier must be in the ARN format for the source
|
1064
|
-
# is the same value as the
|
1065
|
-
# pre-signed URL.
|
1068
|
+
# identifier must be in the ARN format for the source Amazon Web
|
1069
|
+
# Services Region and is the same value as the
|
1070
|
+
# `SourceDBClusterSnapshotIdentifier` in the pre-signed URL.
|
1066
1071
|
#
|
1067
1072
|
# To cancel the copy operation once it is in progress, delete the target
|
1068
1073
|
# DB cluster snapshot identified by `TargetDBClusterSnapshotIdentifier`
|
1069
1074
|
# while that DB cluster snapshot is in "copying" status.
|
1070
1075
|
#
|
1071
1076
|
# For more information on copying encrypted DB cluster snapshots from
|
1072
|
-
# one
|
1073
|
-
# Aurora User Guide.*
|
1077
|
+
# one Amazon Web Services Region to another, see [ Copying a
|
1078
|
+
# Snapshot][3] in the *Amazon Aurora User Guide.*
|
1074
1079
|
#
|
1075
1080
|
# For more information on Amazon Aurora, see [ What Is Amazon
|
1076
1081
|
# Aurora?][4] in the *Amazon Aurora User Guide.*
|
@@ -1090,20 +1095,20 @@ module Aws::RDS
|
|
1090
1095
|
# The identifier of the DB cluster snapshot to copy. This parameter
|
1091
1096
|
# isn't case-sensitive.
|
1092
1097
|
#
|
1093
|
-
# You can't copy an encrypted, shared DB cluster snapshot from one
|
1094
|
-
# Region to another.
|
1098
|
+
# You can't copy an encrypted, shared DB cluster snapshot from one
|
1099
|
+
# Amazon Web Services Region to another.
|
1095
1100
|
#
|
1096
1101
|
# Constraints:
|
1097
1102
|
#
|
1098
1103
|
# * Must specify a valid system snapshot in the "available" state.
|
1099
1104
|
#
|
1100
|
-
# * If the source snapshot is in the same
|
1101
|
-
# specify a valid DB snapshot identifier.
|
1105
|
+
# * If the source snapshot is in the same Amazon Web Services Region as
|
1106
|
+
# the copy, specify a valid DB snapshot identifier.
|
1102
1107
|
#
|
1103
|
-
# * If the source snapshot is in a different
|
1104
|
-
# specify a valid DB cluster snapshot ARN. For more
|
1105
|
-
# [ Copying Snapshots Across
|
1106
|
-
# User Guide.*
|
1108
|
+
# * If the source snapshot is in a different Amazon Web Services Region
|
1109
|
+
# than the copy, specify a valid DB cluster snapshot ARN. For more
|
1110
|
+
# information, go to [ Copying Snapshots Across Amazon Web Services
|
1111
|
+
# Regions][1] in the *Amazon Aurora User Guide.*
|
1107
1112
|
#
|
1108
1113
|
# Example: `my-cluster-snapshot1`
|
1109
1114
|
#
|
@@ -1126,70 +1131,78 @@ module Aws::RDS
|
|
1126
1131
|
# Example: `my-cluster-snapshot2`
|
1127
1132
|
#
|
1128
1133
|
# @option params [String] :kms_key_id
|
1129
|
-
# The
|
1130
|
-
#
|
1131
|
-
# name for the
|
1132
|
-
#
|
1133
|
-
#
|
1134
|
-
# you
|
1135
|
-
#
|
1136
|
-
# copy
|
1137
|
-
#
|
1134
|
+
# The Amazon Web Services KMS key identifier for an encrypted DB cluster
|
1135
|
+
# snapshot. The Amazon Web Services KMS key identifier is the key ARN,
|
1136
|
+
# key ID, alias ARN, or alias name for the Amazon Web Services KMS
|
1137
|
+
# customer master key (CMK).
|
1138
|
+
#
|
1139
|
+
# If you copy an encrypted DB cluster snapshot from your Amazon Web
|
1140
|
+
# Services account, you can specify a value for `KmsKeyId` to encrypt
|
1141
|
+
# the copy with a new Amazon Web Services KMS CMK. If you don't specify
|
1142
|
+
# a value for `KmsKeyId`, then the copy of the DB cluster snapshot is
|
1143
|
+
# encrypted with the same Amazon Web Services KMS key as the source DB
|
1144
|
+
# cluster snapshot.
|
1138
1145
|
#
|
1139
1146
|
# If you copy an encrypted DB cluster snapshot that is shared from
|
1140
|
-
# another
|
1147
|
+
# another Amazon Web Services account, then you must specify a value for
|
1148
|
+
# `KmsKeyId`.
|
1141
1149
|
#
|
1142
|
-
# To copy an encrypted DB cluster snapshot to another
|
1143
|
-
# must set `KmsKeyId` to the
|
1144
|
-
#
|
1145
|
-
#
|
1146
|
-
#
|
1147
|
-
#
|
1150
|
+
# To copy an encrypted DB cluster snapshot to another Amazon Web
|
1151
|
+
# Services Region, you must set `KmsKeyId` to the Amazon Web Services
|
1152
|
+
# KMS key identifier you want to use to encrypt the copy of the DB
|
1153
|
+
# cluster snapshot in the destination Amazon Web Services Region. Amazon
|
1154
|
+
# Web Services KMS CMKs are specific to the Amazon Web Services Region
|
1155
|
+
# that they are created in, and you can't use CMKs from one Amazon Web
|
1156
|
+
# Services Region in another Amazon Web Services Region.
|
1148
1157
|
#
|
1149
1158
|
# If you copy an unencrypted DB cluster snapshot and specify a value for
|
1150
1159
|
# the `KmsKeyId` parameter, an error is returned.
|
1151
1160
|
#
|
1152
1161
|
# @option params [String] :pre_signed_url
|
1153
1162
|
# The URL that contains a Signature Version 4 signed request for the
|
1154
|
-
# `CopyDBClusterSnapshot` API action in the
|
1155
|
-
# source DB cluster snapshot to copy. The
|
1156
|
-
# be used when copying an encrypted DB
|
1157
|
-
#
|
1158
|
-
#
|
1163
|
+
# `CopyDBClusterSnapshot` API action in the Amazon Web Services Region
|
1164
|
+
# that contains the source DB cluster snapshot to copy. The
|
1165
|
+
# `PreSignedUrl` parameter must be used when copying an encrypted DB
|
1166
|
+
# cluster snapshot from another Amazon Web Services Region. Don't
|
1167
|
+
# specify `PreSignedUrl` when you are copying an encrypted DB cluster
|
1168
|
+
# snapshot in the same Amazon Web Services Region.
|
1159
1169
|
#
|
1160
1170
|
# The pre-signed URL must be a valid request for the
|
1161
1171
|
# `CopyDBClusterSnapshot` API action that can be executed in the source
|
1162
|
-
#
|
1163
|
-
# copied. The pre-signed URL request must contain the
|
1164
|
-
# parameter values:
|
1172
|
+
# Amazon Web Services Region that contains the encrypted DB cluster
|
1173
|
+
# snapshot to be copied. The pre-signed URL request must contain the
|
1174
|
+
# following parameter values:
|
1165
1175
|
#
|
1166
|
-
# * `KmsKeyId` - The
|
1167
|
-
# (CMK) to use to encrypt the copy of the DB
|
1168
|
-
#
|
1169
|
-
#
|
1170
|
-
#
|
1176
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
1177
|
+
# customer master key (CMK) to use to encrypt the copy of the DB
|
1178
|
+
# cluster snapshot in the destination Amazon Web Services Region. This
|
1179
|
+
# is the same identifier for both the `CopyDBClusterSnapshot` action
|
1180
|
+
# that is called in the destination Amazon Web Services Region, and
|
1181
|
+
# the action contained in the pre-signed URL.
|
1171
1182
|
#
|
1172
|
-
# * `DestinationRegion` - The name of the
|
1173
|
-
# snapshot is to be created in.
|
1183
|
+
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
1184
|
+
# that the DB cluster snapshot is to be created in.
|
1174
1185
|
#
|
1175
1186
|
# * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot
|
1176
1187
|
# identifier for the encrypted DB cluster snapshot to be copied. This
|
1177
1188
|
# identifier must be in the Amazon Resource Name (ARN) format for the
|
1178
|
-
# source
|
1179
|
-
# cluster snapshot from the us-west-2
|
1180
|
-
# `SourceDBClusterSnapshotIdentifier` looks
|
1181
|
-
# example:
|
1189
|
+
# source Amazon Web Services Region. For example, if you are copying
|
1190
|
+
# an encrypted DB cluster snapshot from the us-west-2 Amazon Web
|
1191
|
+
# Services Region, then your `SourceDBClusterSnapshotIdentifier` looks
|
1192
|
+
# like the following example:
|
1182
1193
|
# `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115`.
|
1183
1194
|
#
|
1184
1195
|
# To learn how to generate a Signature Version 4 signed request, see [
|
1185
|
-
# Authenticating Requests: Using Query Parameters (
|
1186
|
-
# 4)][1] and [ Signature Version 4 Signing
|
1196
|
+
# Authenticating Requests: Using Query Parameters (Amazon Web Services
|
1197
|
+
# Signature Version 4)][1] and [ Signature Version 4 Signing
|
1198
|
+
# Process][2].
|
1187
1199
|
#
|
1188
|
-
# <note markdown="1"> If you are using an
|
1189
|
-
# `SourceRegion` (or `--source-region` for the
|
1200
|
+
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
1201
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
1190
1202
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
1191
1203
|
# autogenerates a pre-signed URL that is a valid request for the
|
1192
|
-
# operation that can be executed in the source
|
1204
|
+
# operation that can be executed in the source Amazon Web Services
|
1205
|
+
# Region.
|
1193
1206
|
#
|
1194
1207
|
# </note>
|
1195
1208
|
#
|
@@ -1386,9 +1399,10 @@ module Aws::RDS
|
|
1386
1399
|
# Copies the specified DB snapshot. The source DB snapshot must be in
|
1387
1400
|
# the `available` state.
|
1388
1401
|
#
|
1389
|
-
# You can copy a snapshot from one
|
1390
|
-
# the
|
1391
|
-
#
|
1402
|
+
# You can copy a snapshot from one Amazon Web Services Region to
|
1403
|
+
# another. In that case, the Amazon Web Services Region where you call
|
1404
|
+
# the `CopyDBSnapshot` action is the destination Amazon Web Services
|
1405
|
+
# Region for the DB snapshot copy.
|
1392
1406
|
#
|
1393
1407
|
# For more information about copying snapshots, see [Copying a DB
|
1394
1408
|
# Snapshot][1] in the *Amazon RDS User Guide.*
|
@@ -1400,20 +1414,21 @@ module Aws::RDS
|
|
1400
1414
|
# @option params [required, String] :source_db_snapshot_identifier
|
1401
1415
|
# The identifier for the source DB snapshot.
|
1402
1416
|
#
|
1403
|
-
# If the source snapshot is in the same
|
1404
|
-
# a valid DB snapshot identifier. For example, you
|
1405
|
-
# `rds:mysql-instance1-snapshot-20130805`.
|
1417
|
+
# If the source snapshot is in the same Amazon Web Services Region as
|
1418
|
+
# the copy, specify a valid DB snapshot identifier. For example, you
|
1419
|
+
# might specify `rds:mysql-instance1-snapshot-20130805`.
|
1406
1420
|
#
|
1407
|
-
# If the source snapshot is in a different
|
1408
|
-
# specify a valid DB snapshot ARN. For example, you might
|
1421
|
+
# If the source snapshot is in a different Amazon Web Services Region
|
1422
|
+
# than the copy, specify a valid DB snapshot ARN. For example, you might
|
1423
|
+
# specify
|
1409
1424
|
# `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805`.
|
1410
1425
|
#
|
1411
1426
|
# If you are copying from a shared manual DB snapshot, this parameter
|
1412
1427
|
# must be the Amazon Resource Name (ARN) of the shared DB snapshot.
|
1413
1428
|
#
|
1414
1429
|
# If you are copying an encrypted snapshot this parameter must be in the
|
1415
|
-
# ARN format for the source
|
1416
|
-
# `SourceDBSnapshotIdentifier` in the `PreSignedUrl` parameter.
|
1430
|
+
# ARN format for the source Amazon Web Services Region, and must match
|
1431
|
+
# the `SourceDBSnapshotIdentifier` in the `PreSignedUrl` parameter.
|
1417
1432
|
#
|
1418
1433
|
# Constraints:
|
1419
1434
|
#
|
@@ -1442,26 +1457,31 @@ module Aws::RDS
|
|
1442
1457
|
# Example: `my-db-snapshot`
|
1443
1458
|
#
|
1444
1459
|
# @option params [String] :kms_key_id
|
1445
|
-
# The
|
1446
|
-
# key identifier is the key ARN,
|
1447
|
-
#
|
1448
|
-
#
|
1449
|
-
#
|
1450
|
-
#
|
1451
|
-
#
|
1452
|
-
# copy
|
1453
|
-
#
|
1460
|
+
# The Amazon Web Services KMS key identifier for an encrypted DB
|
1461
|
+
# snapshot. The Amazon Web Services KMS key identifier is the key ARN,
|
1462
|
+
# key ID, alias ARN, or alias name for the Amazon Web Services KMS
|
1463
|
+
# customer master key (CMK).
|
1464
|
+
#
|
1465
|
+
# If you copy an encrypted DB snapshot from your Amazon Web Services
|
1466
|
+
# account, you can specify a value for this parameter to encrypt the
|
1467
|
+
# copy with a new Amazon Web Services KMS CMK. If you don't specify a
|
1468
|
+
# value for this parameter, then the copy of the DB snapshot is
|
1469
|
+
# encrypted with the same Amazon Web Services KMS key as the source DB
|
1470
|
+
# snapshot.
|
1454
1471
|
#
|
1455
|
-
# If you copy an encrypted DB snapshot that is shared from another
|
1456
|
-
# account, then you must specify a value for this
|
1472
|
+
# If you copy an encrypted DB snapshot that is shared from another
|
1473
|
+
# Amazon Web Services account, then you must specify a value for this
|
1474
|
+
# parameter.
|
1457
1475
|
#
|
1458
1476
|
# If you specify this parameter when you copy an unencrypted snapshot,
|
1459
1477
|
# the copy is encrypted.
|
1460
1478
|
#
|
1461
|
-
# If you copy an encrypted snapshot to a different
|
1462
|
-
# must specify a
|
1463
|
-
#
|
1464
|
-
#
|
1479
|
+
# If you copy an encrypted snapshot to a different Amazon Web Services
|
1480
|
+
# Region, then you must specify a Amazon Web Services KMS key identifier
|
1481
|
+
# for the destination Amazon Web Services Region. Amazon Web Services
|
1482
|
+
# KMS CMKs are specific to the Amazon Web Services Region that they are
|
1483
|
+
# created in, and you can't use CMKs from one Amazon Web Services
|
1484
|
+
# Region in another Amazon Web Services Region.
|
1465
1485
|
#
|
1466
1486
|
# @option params [Array<Types::Tag>] :tags
|
1467
1487
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -1477,53 +1497,58 @@ module Aws::RDS
|
|
1477
1497
|
#
|
1478
1498
|
# @option params [String] :pre_signed_url
|
1479
1499
|
# The URL that contains a Signature Version 4 signed request for the
|
1480
|
-
# `CopyDBSnapshot` API action in the source
|
1481
|
-
# source DB snapshot to copy.
|
1500
|
+
# `CopyDBSnapshot` API action in the source Amazon Web Services Region
|
1501
|
+
# that contains the source DB snapshot to copy.
|
1482
1502
|
#
|
1483
1503
|
# You must specify this parameter when you copy an encrypted DB snapshot
|
1484
|
-
# from another
|
1485
|
-
# `PreSignedUrl` when you are copying an encrypted DB
|
1486
|
-
# same
|
1504
|
+
# from another Amazon Web Services Region by using the Amazon RDS API.
|
1505
|
+
# Don't specify `PreSignedUrl` when you are copying an encrypted DB
|
1506
|
+
# snapshot in the same Amazon Web Services Region.
|
1487
1507
|
#
|
1488
1508
|
# The presigned URL must be a valid request for the `CopyDBSnapshot` API
|
1489
|
-
# action that can be executed in the source
|
1490
|
-
# encrypted DB snapshot to be copied. The presigned
|
1491
|
-
# contain the following parameter values:
|
1509
|
+
# action that can be executed in the source Amazon Web Services Region
|
1510
|
+
# that contains the encrypted DB snapshot to be copied. The presigned
|
1511
|
+
# URL request must contain the following parameter values:
|
1492
1512
|
#
|
1493
|
-
# * `DestinationRegion` - The
|
1494
|
-
# is copied to. This
|
1495
|
-
# `CopyDBSnapshot` action is called that
|
1513
|
+
# * `DestinationRegion` - The Amazon Web Services Region that the
|
1514
|
+
# encrypted DB snapshot is copied to. This Amazon Web Services Region
|
1515
|
+
# is the same one where the `CopyDBSnapshot` action is called that
|
1516
|
+
# contains this presigned URL.
|
1496
1517
|
#
|
1497
1518
|
# For example, if you copy an encrypted DB snapshot from the us-west-2
|
1498
|
-
#
|
1499
|
-
# `CopyDBSnapshot` action in the us-east-1
|
1500
|
-
#
|
1501
|
-
# the us-west-2
|
1502
|
-
#
|
1503
|
-
#
|
1504
|
-
#
|
1505
|
-
#
|
1506
|
-
#
|
1507
|
-
#
|
1508
|
-
#
|
1519
|
+
# Amazon Web Services Region to the us-east-1 Amazon Web Services
|
1520
|
+
# Region, then you call the `CopyDBSnapshot` action in the us-east-1
|
1521
|
+
# Amazon Web Services Region and provide a presigned URL that contains
|
1522
|
+
# a call to the `CopyDBSnapshot` action in the us-west-2 Amazon Web
|
1523
|
+
# Services Region. For this example, the `DestinationRegion` in the
|
1524
|
+
# presigned URL must be set to the us-east-1 Amazon Web Services
|
1525
|
+
# Region.
|
1526
|
+
#
|
1527
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
1528
|
+
# customer master key (CMK) to use to encrypt the copy of the DB
|
1529
|
+
# snapshot in the destination Amazon Web Services Region. This is the
|
1530
|
+
# same identifier for both the `CopyDBSnapshot` action that is called
|
1531
|
+
# in the destination Amazon Web Services Region, and the action
|
1532
|
+
# contained in the presigned URL.
|
1509
1533
|
#
|
1510
1534
|
# * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
|
1511
1535
|
# encrypted snapshot to be copied. This identifier must be in the
|
1512
|
-
# Amazon Resource Name (ARN) format for the source
|
1513
|
-
# example, if you are copying an encrypted DB snapshot
|
1514
|
-
# us-west-2
|
1515
|
-
# like the following example:
|
1536
|
+
# Amazon Resource Name (ARN) format for the source Amazon Web Services
|
1537
|
+
# Region. For example, if you are copying an encrypted DB snapshot
|
1538
|
+
# from the us-west-2 Amazon Web Services Region, then your
|
1539
|
+
# `SourceDBSnapshotIdentifier` looks like the following example:
|
1516
1540
|
# `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115`.
|
1517
1541
|
#
|
1518
1542
|
# To learn how to generate a Signature Version 4 signed request, see
|
1519
|
-
# [Authenticating Requests: Using Query Parameters (
|
1520
|
-
# Version 4)][1] and [Signature Version 4 Signing Process][2].
|
1543
|
+
# [Authenticating Requests: Using Query Parameters (Amazon Web Services
|
1544
|
+
# Signature Version 4)][1] and [Signature Version 4 Signing Process][2].
|
1521
1545
|
#
|
1522
|
-
# <note markdown="1"> If you are using an
|
1523
|
-
# `SourceRegion` (or `--source-region` for the
|
1546
|
+
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
1547
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
1524
1548
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
1525
1549
|
# autogenerates a pre-signed URL that is a valid request for the
|
1526
|
-
# operation that can be executed in the source
|
1550
|
+
# operation that can be executed in the source Amazon Web Services
|
1551
|
+
# Region.
|
1527
1552
|
#
|
1528
1553
|
# </note>
|
1529
1554
|
#
|
@@ -1536,12 +1561,13 @@ module Aws::RDS
|
|
1536
1561
|
# The name of an option group to associate with the copy of the
|
1537
1562
|
# snapshot.
|
1538
1563
|
#
|
1539
|
-
# Specify this option if you are copying a snapshot from one
|
1540
|
-
# to another, and your DB instance uses a nondefault
|
1541
|
-
# your source DB instance uses Transparent Data
|
1542
|
-
# Microsoft SQL Server, you must specify this
|
1543
|
-
#
|
1544
|
-
# considerations][1] in the *Amazon RDS
|
1564
|
+
# Specify this option if you are copying a snapshot from one Amazon Web
|
1565
|
+
# Services Region to another, and your DB instance uses a nondefault
|
1566
|
+
# option group. If your source DB instance uses Transparent Data
|
1567
|
+
# Encryption for Oracle or Microsoft SQL Server, you must specify this
|
1568
|
+
# option when copying across Amazon Web Services Regions. For more
|
1569
|
+
# information, see [Option group considerations][1] in the *Amazon RDS
|
1570
|
+
# User Guide.*
|
1545
1571
|
#
|
1546
1572
|
#
|
1547
1573
|
#
|
@@ -1824,9 +1850,9 @@ module Aws::RDS
|
|
1824
1850
|
#
|
1825
1851
|
# You can use the `ReplicationSourceIdentifier` parameter to create the
|
1826
1852
|
# DB cluster as a read replica of another DB cluster or Amazon RDS MySQL
|
1827
|
-
# DB instance. For cross-region replication where the DB
|
1828
|
-
# identified by `ReplicationSourceIdentifier` is encrypted, you
|
1829
|
-
# also specify the `PreSignedUrl` parameter.
|
1853
|
+
# or PostgreSQL DB instance. For cross-region replication where the DB
|
1854
|
+
# cluster identified by `ReplicationSourceIdentifier` is encrypted, you
|
1855
|
+
# must also specify the `PreSignedUrl` parameter.
|
1830
1856
|
#
|
1831
1857
|
# For more information on Amazon Aurora, see [ What Is Amazon
|
1832
1858
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
@@ -1841,9 +1867,9 @@ module Aws::RDS
|
|
1841
1867
|
#
|
1842
1868
|
# @option params [Array<String>] :availability_zones
|
1843
1869
|
# A list of Availability Zones (AZs) where instances in the DB cluster
|
1844
|
-
# can be created. For information on
|
1845
|
-
# see [Choosing the Regions and Availability
|
1846
|
-
# Aurora User Guide*.
|
1870
|
+
# can be created. For information on Amazon Web Services Regions and
|
1871
|
+
# Availability Zones, see [Choosing the Regions and Availability
|
1872
|
+
# Zones][1] in the *Amazon Aurora User Guide*.
|
1847
1873
|
#
|
1848
1874
|
#
|
1849
1875
|
#
|
@@ -1981,8 +2007,9 @@ module Aws::RDS
|
|
1981
2007
|
# parameter.
|
1982
2008
|
#
|
1983
2009
|
# The default is a 30-minute window selected at random from an 8-hour
|
1984
|
-
# block of time for each
|
1985
|
-
# see [ Backup window][1] in the *Amazon Aurora User
|
2010
|
+
# block of time for each Amazon Web Services Region. To view the time
|
2011
|
+
# blocks available, see [ Backup window][1] in the *Amazon Aurora User
|
2012
|
+
# Guide.*
|
1986
2013
|
#
|
1987
2014
|
# Constraints:
|
1988
2015
|
#
|
@@ -2005,9 +2032,10 @@ module Aws::RDS
|
|
2005
2032
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
2006
2033
|
#
|
2007
2034
|
# The default is a 30-minute window selected at random from an 8-hour
|
2008
|
-
# block of time for each
|
2009
|
-
# week. To see the time blocks available, see [
|
2010
|
-
# DB Cluster Maintenance Window][1] in the
|
2035
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
2036
|
+
# random day of the week. To see the time blocks available, see [
|
2037
|
+
# Adjusting the Preferred DB Cluster Maintenance Window][1] in the
|
2038
|
+
# *Amazon Aurora User Guide.*
|
2011
2039
|
#
|
2012
2040
|
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
2013
2041
|
#
|
@@ -2028,11 +2056,13 @@ module Aws::RDS
|
|
2028
2056
|
# A value that indicates whether the DB cluster is encrypted.
|
2029
2057
|
#
|
2030
2058
|
# @option params [String] :kms_key_id
|
2031
|
-
# The
|
2059
|
+
# The Amazon Web Services KMS key identifier for an encrypted DB
|
2060
|
+
# cluster.
|
2032
2061
|
#
|
2033
|
-
# The
|
2034
|
-
#
|
2035
|
-
#
|
2062
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
2063
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
2064
|
+
# master key (CMK). To use a CMK in a different Amazon Web Services
|
2065
|
+
# account, specify the key ARN or alias ARN.
|
2036
2066
|
#
|
2037
2067
|
# When a CMK isn't specified in `KmsKeyId`\:
|
2038
2068
|
#
|
@@ -2044,54 +2074,59 @@ module Aws::RDS
|
|
2044
2074
|
# `ReplicationSourceIdentifier` isn't specified, then Amazon RDS will
|
2045
2075
|
# use your default CMK.
|
2046
2076
|
#
|
2047
|
-
# There is a default CMK for your
|
2048
|
-
# different default CMK for each
|
2077
|
+
# There is a default CMK for your Amazon Web Services account. Your
|
2078
|
+
# Amazon Web Services account has a different default CMK for each
|
2079
|
+
# Amazon Web Services Region.
|
2049
2080
|
#
|
2050
|
-
# If you create a read replica of an encrypted DB cluster in another
|
2051
|
-
# Region, you must set `KmsKeyId` to a
|
2052
|
-
#
|
2053
|
-
# read replica in
|
2081
|
+
# If you create a read replica of an encrypted DB cluster in another
|
2082
|
+
# Amazon Web Services Region, you must set `KmsKeyId` to a Amazon Web
|
2083
|
+
# Services KMS key identifier that is valid in the destination Amazon
|
2084
|
+
# Web Services Region. This CMK is used to encrypt the read replica in
|
2085
|
+
# that Amazon Web Services Region.
|
2054
2086
|
#
|
2055
2087
|
# @option params [String] :pre_signed_url
|
2056
2088
|
# A URL that contains a Signature Version 4 signed request for the
|
2057
|
-
# `CreateDBCluster` action to be called in the source
|
2058
|
-
# the DB cluster is replicated from. You only need
|
2059
|
-
# `PreSignedUrl` when you are performing cross-region
|
2060
|
-
# an encrypted DB cluster.
|
2089
|
+
# `CreateDBCluster` action to be called in the source Amazon Web
|
2090
|
+
# Services Region where the DB cluster is replicated from. You only need
|
2091
|
+
# to specify `PreSignedUrl` when you are performing cross-region
|
2092
|
+
# replication from an encrypted DB cluster.
|
2061
2093
|
#
|
2062
2094
|
# The pre-signed URL must be a valid request for the `CreateDBCluster`
|
2063
|
-
# API action that can be executed in the source
|
2064
|
-
# the encrypted DB cluster to be copied.
|
2095
|
+
# API action that can be executed in the source Amazon Web Services
|
2096
|
+
# Region that contains the encrypted DB cluster to be copied.
|
2065
2097
|
#
|
2066
2098
|
# The pre-signed URL request must contain the following parameter
|
2067
2099
|
# values:
|
2068
2100
|
#
|
2069
|
-
# * `KmsKeyId` - The
|
2070
|
-
# encrypt the copy of the DB cluster in the destination
|
2071
|
-
# This should refer to the same
|
2072
|
-
# `CreateDBCluster` action that is
|
2073
|
-
#
|
2101
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the key
|
2102
|
+
# to use to encrypt the copy of the DB cluster in the destination
|
2103
|
+
# Amazon Web Services Region. This should refer to the same Amazon Web
|
2104
|
+
# Services KMS CMK for both the `CreateDBCluster` action that is
|
2105
|
+
# called in the destination Amazon Web Services Region, and the action
|
2106
|
+
# contained in the pre-signed URL.
|
2074
2107
|
#
|
2075
|
-
# * `DestinationRegion` - The name of the
|
2076
|
-
# replica will be created in.
|
2108
|
+
# * `DestinationRegion` - The name of the Amazon Web Services Region
|
2109
|
+
# that Aurora read replica will be created in.
|
2077
2110
|
#
|
2078
2111
|
# * `ReplicationSourceIdentifier` - The DB cluster identifier for the
|
2079
2112
|
# encrypted DB cluster to be copied. This identifier must be in the
|
2080
|
-
# Amazon Resource Name (ARN) format for the source
|
2081
|
-
# example, if you are copying an encrypted DB cluster from
|
2082
|
-
# us-west-2
|
2083
|
-
# look like Example:
|
2113
|
+
# Amazon Resource Name (ARN) format for the source Amazon Web Services
|
2114
|
+
# Region. For example, if you are copying an encrypted DB cluster from
|
2115
|
+
# the us-west-2 Amazon Web Services Region, then your
|
2116
|
+
# `ReplicationSourceIdentifier` would look like Example:
|
2084
2117
|
# `arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1`.
|
2085
2118
|
#
|
2086
2119
|
# To learn how to generate a Signature Version 4 signed request, see [
|
2087
|
-
# Authenticating Requests: Using Query Parameters (
|
2088
|
-
# 4)][1] and [ Signature Version 4 Signing
|
2120
|
+
# Authenticating Requests: Using Query Parameters (Amazon Web Services
|
2121
|
+
# Signature Version 4)][1] and [ Signature Version 4 Signing
|
2122
|
+
# Process][2].
|
2089
2123
|
#
|
2090
|
-
# <note markdown="1"> If you are using an
|
2091
|
-
# `SourceRegion` (or `--source-region` for the
|
2124
|
+
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
2125
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
2092
2126
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
2093
2127
|
# autogenerates a pre-signed URL that is a valid request for the
|
2094
|
-
# operation that can be executed in the source
|
2128
|
+
# operation that can be executed in the source Amazon Web Services
|
2129
|
+
# Region.
|
2095
2130
|
#
|
2096
2131
|
# </note>
|
2097
2132
|
#
|
@@ -2101,9 +2136,9 @@ module Aws::RDS
|
|
2101
2136
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
2102
2137
|
#
|
2103
2138
|
# @option params [Boolean] :enable_iam_database_authentication
|
2104
|
-
# A value that indicates whether to enable mapping of
|
2105
|
-
# Access Management (IAM) accounts to database
|
2106
|
-
# mapping is disabled.
|
2139
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
2140
|
+
# Services Identity and Access Management (IAM) accounts to database
|
2141
|
+
# accounts. By default, mapping is disabled.
|
2107
2142
|
#
|
2108
2143
|
# For more information, see [ IAM Database Authentication][1] in the
|
2109
2144
|
# *Amazon Aurora User Guide.*
|
@@ -2586,6 +2621,31 @@ module Aws::RDS
|
|
2586
2621
|
#
|
2587
2622
|
# Example: `aurora-postgresql9.6`
|
2588
2623
|
#
|
2624
|
+
# To list all of the available parameter group families for a DB engine,
|
2625
|
+
# use the following command:
|
2626
|
+
#
|
2627
|
+
# `aws rds describe-db-engine-versions --query
|
2628
|
+
# "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`
|
2629
|
+
#
|
2630
|
+
# For example, to list all of the available parameter group families for
|
2631
|
+
# the Aurora PostgreSQL DB engine, use the following command:
|
2632
|
+
#
|
2633
|
+
# `aws rds describe-db-engine-versions --query
|
2634
|
+
# "DBEngineVersions[].DBParameterGroupFamily" --engine
|
2635
|
+
# aurora-postgresql`
|
2636
|
+
#
|
2637
|
+
# <note markdown="1"> The output contains duplicates.
|
2638
|
+
#
|
2639
|
+
# </note>
|
2640
|
+
#
|
2641
|
+
# The following are the valid DB engine values:
|
2642
|
+
#
|
2643
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
2644
|
+
#
|
2645
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
2646
|
+
#
|
2647
|
+
# * `aurora-postgresql`
|
2648
|
+
#
|
2589
2649
|
# @option params [required, String] :description
|
2590
2650
|
# The description for the DB cluster parameter group.
|
2591
2651
|
#
|
@@ -2957,10 +3017,10 @@ module Aws::RDS
|
|
2957
3017
|
#
|
2958
3018
|
# @option params [required, String] :db_instance_class
|
2959
3019
|
# The compute and memory capacity of the DB instance, for example,
|
2960
|
-
# `db.m4.large`. Not all DB instance classes are available in all
|
2961
|
-
# Regions, or for all database engines. For the full list
|
2962
|
-
# classes, and availability for your engine, see [DB
|
2963
|
-
# in the *Amazon RDS User Guide.*
|
3020
|
+
# `db.m4.large`. Not all DB instance classes are available in all Amazon
|
3021
|
+
# Web Services Regions, or for all database engines. For the full list
|
3022
|
+
# of DB instance classes, and availability for your engine, see [DB
|
3023
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
2964
3024
|
#
|
2965
3025
|
#
|
2966
3026
|
#
|
@@ -2969,7 +3029,8 @@ module Aws::RDS
|
|
2969
3029
|
# @option params [required, String] :engine
|
2970
3030
|
# The name of the database engine to be used for this instance.
|
2971
3031
|
#
|
2972
|
-
# Not every database engine is available for every
|
3032
|
+
# Not every database engine is available for every Amazon Web Services
|
3033
|
+
# Region.
|
2973
3034
|
#
|
2974
3035
|
# Valid Values:
|
2975
3036
|
#
|
@@ -2985,11 +3046,11 @@ module Aws::RDS
|
|
2985
3046
|
#
|
2986
3047
|
# * `oracle-ee`
|
2987
3048
|
#
|
2988
|
-
# * `oracle-
|
3049
|
+
# * `oracle-ee-cdb`
|
2989
3050
|
#
|
2990
|
-
# * `oracle-
|
3051
|
+
# * `oracle-se2`
|
2991
3052
|
#
|
2992
|
-
# * `oracle-
|
3053
|
+
# * `oracle-se2-cdb`
|
2993
3054
|
#
|
2994
3055
|
# * `postgres`
|
2995
3056
|
#
|
@@ -3115,17 +3176,18 @@ module Aws::RDS
|
|
3115
3176
|
#
|
3116
3177
|
# @option params [String] :availability_zone
|
3117
3178
|
# The Availability Zone (AZ) where the database will be created. For
|
3118
|
-
# information on
|
3119
|
-
# Availability Zones][1].
|
3179
|
+
# information on Amazon Web Services Regions and Availability Zones, see
|
3180
|
+
# [Regions and Availability Zones][1].
|
3120
3181
|
#
|
3121
3182
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
3122
|
-
#
|
3183
|
+
# Amazon Web Services Region.
|
3123
3184
|
#
|
3124
3185
|
# Example: `us-east-1d`
|
3125
3186
|
#
|
3126
3187
|
# Constraint: The `AvailabilityZone` parameter can't be specified if
|
3127
3188
|
# the DB instance is a Multi-AZ deployment. The specified Availability
|
3128
|
-
# Zone must be in the same
|
3189
|
+
# Zone must be in the same Amazon Web Services Region as the current
|
3190
|
+
# endpoint.
|
3129
3191
|
#
|
3130
3192
|
# <note markdown="1"> If you're creating a DB instance in an RDS on VMware environment,
|
3131
3193
|
# specify the identifier of the custom Availability Zone to create the
|
@@ -3154,8 +3216,8 @@ module Aws::RDS
|
|
3154
3216
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
3155
3217
|
#
|
3156
3218
|
# The default is a 30-minute window selected at random from an 8-hour
|
3157
|
-
# block of time for each
|
3158
|
-
# week.
|
3219
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
3220
|
+
# random day of the week.
|
3159
3221
|
#
|
3160
3222
|
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
3161
3223
|
#
|
@@ -3200,8 +3262,8 @@ module Aws::RDS
|
|
3200
3262
|
# The daily time range during which automated backups are created if
|
3201
3263
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
3202
3264
|
# parameter. The default is a 30-minute window selected at random from
|
3203
|
-
# an 8-hour block of time for each
|
3204
|
-
# [Backup window][1] in the *Amazon RDS User Guide*.
|
3265
|
+
# an 8-hour block of time for each Amazon Web Services Region. For more
|
3266
|
+
# information, see [Backup window][1] in the *Amazon RDS User Guide*.
|
3205
3267
|
#
|
3206
3268
|
# **Amazon Aurora**
|
3207
3269
|
#
|
@@ -3283,7 +3345,8 @@ module Aws::RDS
|
|
3283
3345
|
#
|
3284
3346
|
# The following are the database engines and links to information about
|
3285
3347
|
# the major and minor versions that are available with Amazon RDS. Not
|
3286
|
-
# every database engine is available for every
|
3348
|
+
# every database engine is available for every Amazon Web Services
|
3349
|
+
# Region.
|
3287
3350
|
#
|
3288
3351
|
# **Amazon Aurora**
|
3289
3352
|
#
|
@@ -3437,21 +3500,24 @@ module Aws::RDS
|
|
3437
3500
|
# cluster.
|
3438
3501
|
#
|
3439
3502
|
# @option params [String] :kms_key_id
|
3440
|
-
# The
|
3503
|
+
# The Amazon Web Services KMS key identifier for an encrypted DB
|
3504
|
+
# instance.
|
3441
3505
|
#
|
3442
|
-
# The
|
3443
|
-
#
|
3444
|
-
#
|
3506
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
3507
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
3508
|
+
# master key (CMK). To use a CMK in a different Amazon Web Services
|
3509
|
+
# account, specify the key ARN or alias ARN.
|
3445
3510
|
#
|
3446
3511
|
# **Amazon Aurora**
|
3447
3512
|
#
|
3448
|
-
# Not applicable. The
|
3449
|
-
# cluster. For more information, see `CreateDBCluster`.
|
3513
|
+
# Not applicable. The Amazon Web Services KMS key identifier is managed
|
3514
|
+
# by the DB cluster. For more information, see `CreateDBCluster`.
|
3450
3515
|
#
|
3451
3516
|
# If `StorageEncrypted` is enabled, and you do not specify a value for
|
3452
3517
|
# the `KmsKeyId` parameter, then Amazon RDS uses your default CMK. There
|
3453
|
-
# is a default CMK for your
|
3454
|
-
# different default CMK for each
|
3518
|
+
# is a default CMK for your Amazon Web Services account. Your Amazon Web
|
3519
|
+
# Services account has a different default CMK for each Amazon Web
|
3520
|
+
# Services Region.
|
3455
3521
|
#
|
3456
3522
|
# @option params [String] :domain
|
3457
3523
|
# The Active Directory directory ID to create the DB instance in.
|
@@ -3526,12 +3592,13 @@ module Aws::RDS
|
|
3526
3592
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
|
3527
3593
|
#
|
3528
3594
|
# @option params [Boolean] :enable_iam_database_authentication
|
3529
|
-
# A value that indicates whether to enable mapping of
|
3530
|
-
# Access Management (IAM) accounts to database
|
3531
|
-
# mapping is disabled.
|
3595
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
3596
|
+
# Services Identity and Access Management (IAM) accounts to database
|
3597
|
+
# accounts. By default, mapping is disabled.
|
3532
3598
|
#
|
3533
|
-
# This setting doesn't apply to Amazon Aurora. Mapping
|
3534
|
-
# to database accounts is managed by the DB
|
3599
|
+
# This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
|
3600
|
+
# Services IAM accounts to database accounts is managed by the DB
|
3601
|
+
# cluster.
|
3535
3602
|
#
|
3536
3603
|
# For more information, see [ IAM Database Authentication for MySQL and
|
3537
3604
|
# PostgreSQL][1] in the *Amazon RDS User Guide.*
|
@@ -3552,16 +3619,17 @@ module Aws::RDS
|
|
3552
3619
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
3553
3620
|
#
|
3554
3621
|
# @option params [String] :performance_insights_kms_key_id
|
3555
|
-
# The
|
3556
|
-
# data.
|
3622
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
3623
|
+
# Performance Insights data.
|
3557
3624
|
#
|
3558
|
-
# The
|
3559
|
-
# name for the
|
3625
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
3626
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
3627
|
+
# master key (CMK).
|
3560
3628
|
#
|
3561
3629
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
3562
|
-
# Amazon RDS uses your default CMK. There is a default CMK for your
|
3563
|
-
# account. Your
|
3564
|
-
# Region.
|
3630
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your
|
3631
|
+
# Amazon Web Services account. Your Amazon Web Services account has a
|
3632
|
+
# different default CMK for each Amazon Web Services Region.
|
3565
3633
|
#
|
3566
3634
|
# @option params [Integer] :performance_insights_retention_period
|
3567
3635
|
# The amount of time, in days, to retain Performance Insights data.
|
@@ -3646,10 +3714,11 @@ module Aws::RDS
|
|
3646
3714
|
# from outside of its virtual private cloud (VPC) on your local network.
|
3647
3715
|
#
|
3648
3716
|
# For more information about RDS on Outposts, see [Working with Amazon
|
3649
|
-
# RDS on
|
3717
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
3718
|
+
# Guide*.
|
3650
3719
|
#
|
3651
3720
|
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
3652
|
-
# in the *
|
3721
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
3653
3722
|
#
|
3654
3723
|
#
|
3655
3724
|
#
|
@@ -3869,6 +3938,11 @@ module Aws::RDS
|
|
3869
3938
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
3870
3939
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
3871
3940
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
3941
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
3942
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
3943
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
3944
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
3945
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
3872
3946
|
#
|
3873
3947
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstance AWS API Documentation
|
3874
3948
|
#
|
@@ -3931,14 +4005,14 @@ module Aws::RDS
|
|
3931
4005
|
# * The specified DB instance must have automatic backups enabled, that
|
3932
4006
|
# is, its backup retention period must be greater than 0.
|
3933
4007
|
#
|
3934
|
-
# * If the source DB instance is in the same
|
3935
|
-
# replica, specify a valid DB instance identifier.
|
4008
|
+
# * If the source DB instance is in the same Amazon Web Services Region
|
4009
|
+
# as the read replica, specify a valid DB instance identifier.
|
3936
4010
|
#
|
3937
|
-
# * If the source DB instance is in a different
|
3938
|
-
# replica, specify a valid DB instance ARN. For
|
3939
|
-
# [Constructing an ARN for Amazon RDS][3] in the
|
3940
|
-
# Guide*. This doesn't apply to SQL Server, which
|
3941
|
-
# cross-region replicas.
|
4011
|
+
# * If the source DB instance is in a different Amazon Web Services
|
4012
|
+
# Region from the read replica, specify a valid DB instance ARN. For
|
4013
|
+
# more information, see [Constructing an ARN for Amazon RDS][3] in the
|
4014
|
+
# *Amazon RDS User Guide*. This doesn't apply to SQL Server, which
|
4015
|
+
# doesn't support cross-region replicas.
|
3942
4016
|
#
|
3943
4017
|
#
|
3944
4018
|
#
|
@@ -3948,10 +4022,10 @@ module Aws::RDS
|
|
3948
4022
|
#
|
3949
4023
|
# @option params [String] :db_instance_class
|
3950
4024
|
# The compute and memory capacity of the read replica, for example,
|
3951
|
-
# `db.m4.large`. Not all DB instance classes are available in all
|
3952
|
-
# Regions, or for all database engines. For the full list
|
3953
|
-
# classes, and availability for your engine, see [DB
|
3954
|
-
# in the *Amazon RDS User Guide.*
|
4025
|
+
# `db.m4.large`. Not all DB instance classes are available in all Amazon
|
4026
|
+
# Web Services Regions, or for all database engines. For the full list
|
4027
|
+
# of DB instance classes, and availability for your engine, see [DB
|
4028
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
3955
4029
|
#
|
3956
4030
|
# Default: Inherits from the source DB instance.
|
3957
4031
|
#
|
@@ -3963,7 +4037,7 @@ module Aws::RDS
|
|
3963
4037
|
# The Availability Zone (AZ) where the read replica will be created.
|
3964
4038
|
#
|
3965
4039
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
3966
|
-
#
|
4040
|
+
# Amazon Web Services Region.
|
3967
4041
|
#
|
3968
4042
|
# Example: `us-east-1d`
|
3969
4043
|
#
|
@@ -4056,15 +4130,15 @@ module Aws::RDS
|
|
4056
4130
|
# Constraints:
|
4057
4131
|
#
|
4058
4132
|
# * Can only be specified if the source DB instance identifier specifies
|
4059
|
-
# a DB instance in another
|
4133
|
+
# a DB instance in another Amazon Web Services Region.
|
4060
4134
|
#
|
4061
4135
|
# * If supplied, must match the name of an existing DBSubnetGroup.
|
4062
4136
|
#
|
4063
|
-
# * The specified DB subnet group must be in the same
|
4064
|
-
# which the operation is running.
|
4137
|
+
# * The specified DB subnet group must be in the same Amazon Web
|
4138
|
+
# Services Region in which the operation is running.
|
4065
4139
|
#
|
4066
|
-
# * All read replicas in one
|
4067
|
-
# source DB instance must either:>
|
4140
|
+
# * All read replicas in one Amazon Web Services Region that are created
|
4141
|
+
# from the same source DB instance must either:>
|
4068
4142
|
#
|
4069
4143
|
# * Specify DB subnet groups from the same VPC. All these read
|
4070
4144
|
# replicas are created in the same VPC.
|
@@ -4119,76 +4193,85 @@ module Aws::RDS
|
|
4119
4193
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
4120
4194
|
#
|
4121
4195
|
# @option params [String] :kms_key_id
|
4122
|
-
# The
|
4196
|
+
# The Amazon Web Services KMS key identifier for an encrypted read
|
4197
|
+
# replica.
|
4123
4198
|
#
|
4124
|
-
# The
|
4125
|
-
# name for the
|
4199
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
4200
|
+
# alias ARN, or alias name for the Amazon Web Services KMS CMK.
|
4126
4201
|
#
|
4127
|
-
# If you create an encrypted read replica in the same
|
4128
|
-
# source DB instance, then do not specify a value
|
4129
|
-
# read replica in the same Region is always
|
4130
|
-
# KMS CMK as the source DB
|
4202
|
+
# If you create an encrypted read replica in the same Amazon Web
|
4203
|
+
# Services Region as the source DB instance, then do not specify a value
|
4204
|
+
# for this parameter. A read replica in the same Region is always
|
4205
|
+
# encrypted with the same Amazon Web Services KMS CMK as the source DB
|
4206
|
+
# instance.
|
4131
4207
|
#
|
4132
|
-
# If you create an encrypted read replica in a different
|
4133
|
-
# then you must specify a
|
4134
|
-
#
|
4135
|
-
#
|
4136
|
-
#
|
4208
|
+
# If you create an encrypted read replica in a different Amazon Web
|
4209
|
+
# Services Region, then you must specify a Amazon Web Services KMS key
|
4210
|
+
# identifier for the destination Amazon Web Services Region. Amazon Web
|
4211
|
+
# Services KMS CMKs are specific to the Amazon Web Services Region that
|
4212
|
+
# they are created in, and you can't use CMKs from one Amazon Web
|
4213
|
+
# Services Region in another Amazon Web Services Region.
|
4137
4214
|
#
|
4138
4215
|
# You can't create an encrypted read replica from an unencrypted DB
|
4139
4216
|
# instance.
|
4140
4217
|
#
|
4141
4218
|
# @option params [String] :pre_signed_url
|
4142
4219
|
# The URL that contains a Signature Version 4 signed request for the
|
4143
|
-
# `CreateDBInstanceReadReplica` API action in the source
|
4144
|
-
# contains the source DB instance.
|
4220
|
+
# `CreateDBInstanceReadReplica` API action in the source Amazon Web
|
4221
|
+
# Services Region that contains the source DB instance.
|
4145
4222
|
#
|
4146
4223
|
# You must specify this parameter when you create an encrypted read
|
4147
|
-
# replica from another
|
4148
|
-
# specify `PreSignedUrl` when you are creating an
|
4149
|
-
# in the same
|
4224
|
+
# replica from another Amazon Web Services Region by using the Amazon
|
4225
|
+
# RDS API. Don't specify `PreSignedUrl` when you are creating an
|
4226
|
+
# encrypted read replica in the same Amazon Web Services Region.
|
4150
4227
|
#
|
4151
4228
|
# The presigned URL must be a valid request for the
|
4152
4229
|
# `CreateDBInstanceReadReplica` API action that can be executed in the
|
4153
|
-
# source
|
4154
|
-
# presigned URL request must contain the following
|
4230
|
+
# source Amazon Web Services Region that contains the encrypted source
|
4231
|
+
# DB instance. The presigned URL request must contain the following
|
4232
|
+
# parameter values:
|
4155
4233
|
#
|
4156
|
-
# * `DestinationRegion` - The
|
4157
|
-
# is created in. This
|
4158
|
-
#
|
4159
|
-
# presigned URL.
|
4234
|
+
# * `DestinationRegion` - The Amazon Web Services Region that the
|
4235
|
+
# encrypted read replica is created in. This Amazon Web Services
|
4236
|
+
# Region is the same one where the `CreateDBInstanceReadReplica`
|
4237
|
+
# action is called that contains this presigned URL.
|
4160
4238
|
#
|
4161
4239
|
# For example, if you create an encrypted DB instance in the us-west-1
|
4162
|
-
#
|
4163
|
-
#
|
4164
|
-
# us-east-1
|
4165
|
-
#
|
4166
|
-
#
|
4167
|
-
#
|
4168
|
-
#
|
4169
|
-
#
|
4170
|
-
#
|
4171
|
-
#
|
4172
|
-
#
|
4173
|
-
#
|
4240
|
+
# Amazon Web Services Region, from a source DB instance in the
|
4241
|
+
# us-east-2 Amazon Web Services Region, then you call the
|
4242
|
+
# `CreateDBInstanceReadReplica` action in the us-east-1 Amazon Web
|
4243
|
+
# Services Region and provide a presigned URL that contains a call to
|
4244
|
+
# the `CreateDBInstanceReadReplica` action in the us-west-2 Amazon Web
|
4245
|
+
# Services Region. For this example, the `DestinationRegion` in the
|
4246
|
+
# presigned URL must be set to the us-east-1 Amazon Web Services
|
4247
|
+
# Region.
|
4248
|
+
#
|
4249
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the key
|
4250
|
+
# to use to encrypt the read replica in the destination Amazon Web
|
4251
|
+
# Services Region. This is the same identifier for both the
|
4252
|
+
# `CreateDBInstanceReadReplica` action that is called in the
|
4253
|
+
# destination Amazon Web Services Region, and the action contained in
|
4254
|
+
# the presigned URL.
|
4174
4255
|
#
|
4175
4256
|
# * `SourceDBInstanceIdentifier` - The DB instance identifier for the
|
4176
4257
|
# encrypted DB instance to be replicated. This identifier must be in
|
4177
|
-
# the Amazon Resource Name (ARN) format for the source
|
4178
|
-
# example, if you are creating an encrypted read
|
4179
|
-
# instance in the us-west-2
|
4180
|
-
# `SourceDBInstanceIdentifier` looks like the
|
4258
|
+
# the Amazon Resource Name (ARN) format for the source Amazon Web
|
4259
|
+
# Services Region. For example, if you are creating an encrypted read
|
4260
|
+
# replica from a DB instance in the us-west-2 Amazon Web Services
|
4261
|
+
# Region, then your `SourceDBInstanceIdentifier` looks like the
|
4262
|
+
# following example:
|
4181
4263
|
# `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`.
|
4182
4264
|
#
|
4183
4265
|
# To learn how to generate a Signature Version 4 signed request, see
|
4184
|
-
# [Authenticating Requests: Using Query Parameters (
|
4185
|
-
# Version 4)][1] and [Signature Version 4 Signing Process][2].
|
4266
|
+
# [Authenticating Requests: Using Query Parameters (Amazon Web Services
|
4267
|
+
# Signature Version 4)][1] and [Signature Version 4 Signing Process][2].
|
4186
4268
|
#
|
4187
|
-
# <note markdown="1"> If you are using an
|
4188
|
-
# `SourceRegion` (or `--source-region` for the
|
4269
|
+
# <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
|
4270
|
+
# specify `SourceRegion` (or `--source-region` for the CLI) instead of
|
4189
4271
|
# specifying `PreSignedUrl` manually. Specifying `SourceRegion`
|
4190
4272
|
# autogenerates a presigned URL that is a valid request for the
|
4191
|
-
# operation that can be executed in the source
|
4273
|
+
# operation that can be executed in the source Amazon Web Services
|
4274
|
+
# Region.
|
4192
4275
|
#
|
4193
4276
|
# `SourceRegion` isn't supported for SQL Server, because SQL Server on
|
4194
4277
|
# Amazon RDS doesn't support cross-region read replicas.
|
@@ -4201,9 +4284,9 @@ module Aws::RDS
|
|
4201
4284
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
4202
4285
|
#
|
4203
4286
|
# @option params [Boolean] :enable_iam_database_authentication
|
4204
|
-
# A value that indicates whether to enable mapping of
|
4205
|
-
# Access Management (IAM) accounts to database
|
4206
|
-
# mapping is disabled.
|
4287
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
4288
|
+
# Services Identity and Access Management (IAM) accounts to database
|
4289
|
+
# accounts. By default, mapping is disabled.
|
4207
4290
|
#
|
4208
4291
|
# For more information about IAM database authentication, see [ IAM
|
4209
4292
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -4225,16 +4308,17 @@ module Aws::RDS
|
|
4225
4308
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
4226
4309
|
#
|
4227
4310
|
# @option params [String] :performance_insights_kms_key_id
|
4228
|
-
# The
|
4229
|
-
# data.
|
4311
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
4312
|
+
# Performance Insights data.
|
4230
4313
|
#
|
4231
|
-
# The
|
4232
|
-
# name for the
|
4314
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
4315
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
4316
|
+
# master key (CMK).
|
4233
4317
|
#
|
4234
4318
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
4235
|
-
# Amazon RDS uses your default CMK. There is a default CMK for your
|
4236
|
-
# account. Your
|
4237
|
-
# Region.
|
4319
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your
|
4320
|
+
# Amazon Web Services account. Your Amazon Web Services account has a
|
4321
|
+
# different default CMK for each Amazon Web Services Region.
|
4238
4322
|
#
|
4239
4323
|
# @option params [Integer] :performance_insights_retention_period
|
4240
4324
|
# The amount of time, in days, to retain Performance Insights data.
|
@@ -4527,6 +4611,11 @@ module Aws::RDS
|
|
4527
4611
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
4528
4612
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
4529
4613
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
4614
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
4615
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
4616
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
4617
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
4618
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
4530
4619
|
#
|
4531
4620
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplica AWS API Documentation
|
4532
4621
|
#
|
@@ -4586,16 +4675,52 @@ module Aws::RDS
|
|
4586
4675
|
# applied only to a DB instance running a database engine and engine
|
4587
4676
|
# version compatible with that DB parameter group family.
|
4588
4677
|
#
|
4589
|
-
# To list all of the available parameter group families
|
4590
|
-
# following command:
|
4678
|
+
# To list all of the available parameter group families for a DB engine,
|
4679
|
+
# use the following command:
|
4680
|
+
#
|
4681
|
+
# `aws rds describe-db-engine-versions --query
|
4682
|
+
# "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`
|
4683
|
+
#
|
4684
|
+
# For example, to list all of the available parameter group families for
|
4685
|
+
# the MySQL DB engine, use the following command:
|
4591
4686
|
#
|
4592
4687
|
# `aws rds describe-db-engine-versions --query
|
4593
|
-
# "DBEngineVersions[].DBParameterGroupFamily"`
|
4688
|
+
# "DBEngineVersions[].DBParameterGroupFamily" --engine mysql`
|
4594
4689
|
#
|
4595
4690
|
# <note markdown="1"> The output contains duplicates.
|
4596
4691
|
#
|
4597
4692
|
# </note>
|
4598
4693
|
#
|
4694
|
+
# The following are the valid DB engine values:
|
4695
|
+
#
|
4696
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
4697
|
+
#
|
4698
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
4699
|
+
#
|
4700
|
+
# * `aurora-postgresql`
|
4701
|
+
#
|
4702
|
+
# * `mariadb`
|
4703
|
+
#
|
4704
|
+
# * `mysql`
|
4705
|
+
#
|
4706
|
+
# * `oracle-ee`
|
4707
|
+
#
|
4708
|
+
# * `oracle-ee-cdb`
|
4709
|
+
#
|
4710
|
+
# * `oracle-se2`
|
4711
|
+
#
|
4712
|
+
# * `oracle-se2-cdb`
|
4713
|
+
#
|
4714
|
+
# * `postgres`
|
4715
|
+
#
|
4716
|
+
# * `sqlserver-ee`
|
4717
|
+
#
|
4718
|
+
# * `sqlserver-se`
|
4719
|
+
#
|
4720
|
+
# * `sqlserver-ex`
|
4721
|
+
#
|
4722
|
+
# * `sqlserver-web`
|
4723
|
+
#
|
4599
4724
|
# @option params [required, String] :description
|
4600
4725
|
# The description for the DB parameter group.
|
4601
4726
|
#
|
@@ -4657,10 +4782,10 @@ module Aws::RDS
|
|
4657
4782
|
#
|
4658
4783
|
# @option params [required, String] :db_proxy_name
|
4659
4784
|
# The identifier for the proxy. This name must be unique for all proxies
|
4660
|
-
# owned by your
|
4661
|
-
# must begin with a letter and must
|
4662
|
-
# and hyphens; it can't end with a
|
4663
|
-
# hyphens.
|
4785
|
+
# owned by your Amazon Web Services account in the specified Amazon Web
|
4786
|
+
# Services Region. An identifier must begin with a letter and must
|
4787
|
+
# contain only ASCII letters, digits, and hyphens; it can't end with a
|
4788
|
+
# hyphen or contain two consecutive hyphens.
|
4664
4789
|
#
|
4665
4790
|
# @option params [required, String] :engine_family
|
4666
4791
|
# The kinds of databases that the proxy can connect to. This value
|
@@ -4673,7 +4798,7 @@ module Aws::RDS
|
|
4673
4798
|
#
|
4674
4799
|
# @option params [required, String] :role_arn
|
4675
4800
|
# The Amazon Resource Name (ARN) of the IAM role that the proxy uses to
|
4676
|
-
# access secrets in
|
4801
|
+
# access secrets in Amazon Web Services Secrets Manager.
|
4677
4802
|
#
|
4678
4803
|
# @option params [required, Array<String>] :vpc_subnet_ids
|
4679
4804
|
# One or more VPC subnet IDs to associate with the new proxy.
|
@@ -5053,7 +5178,7 @@ module Aws::RDS
|
|
5053
5178
|
end
|
5054
5179
|
|
5055
5180
|
# Creates a new DB subnet group. DB subnet groups must contain at least
|
5056
|
-
# one subnet in at least two AZs in the
|
5181
|
+
# one subnet in at least two AZs in the Amazon Web Services Region.
|
5057
5182
|
#
|
5058
5183
|
# @option params [required, String] :db_subnet_group_name
|
5059
5184
|
# The name for the DB subnet group. This value is stored as a lowercase
|
@@ -5302,11 +5427,11 @@ module Aws::RDS
|
|
5302
5427
|
req.send_request(options)
|
5303
5428
|
end
|
5304
5429
|
|
5305
|
-
# Creates an Aurora global database spread across multiple
|
5306
|
-
# The global database contains a single primary
|
5307
|
-
# capability, and a read-only secondary cluster
|
5308
|
-
# the primary cluster through high-speed
|
5309
|
-
# Aurora storage subsystem.
|
5430
|
+
# Creates an Aurora global database spread across multiple Amazon Web
|
5431
|
+
# Services Regions. The global database contains a single primary
|
5432
|
+
# cluster with read-write capability, and a read-only secondary cluster
|
5433
|
+
# that receives data from the primary cluster through high-speed
|
5434
|
+
# replication performed by the Aurora storage subsystem.
|
5310
5435
|
#
|
5311
5436
|
# You can create a global database that is initially empty, and then add
|
5312
5437
|
# a primary cluster and a secondary cluster to it. Or you can specify an
|
@@ -5415,11 +5540,11 @@ module Aws::RDS
|
|
5415
5540
|
#
|
5416
5541
|
# * `oracle-ee`
|
5417
5542
|
#
|
5418
|
-
# * `oracle-
|
5543
|
+
# * `oracle-ee-cdb`
|
5419
5544
|
#
|
5420
|
-
# * `oracle-
|
5545
|
+
# * `oracle-se2`
|
5421
5546
|
#
|
5422
|
-
# * `oracle-
|
5547
|
+
# * `oracle-se2-cdb`
|
5423
5548
|
#
|
5424
5549
|
# * `postgres`
|
5425
5550
|
#
|
@@ -6185,6 +6310,11 @@ module Aws::RDS
|
|
6185
6310
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
6186
6311
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
6187
6312
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
6313
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
6314
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
6315
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
6316
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
6317
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
6188
6318
|
#
|
6189
6319
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstance AWS API Documentation
|
6190
6320
|
#
|
@@ -6201,7 +6331,7 @@ module Aws::RDS
|
|
6201
6331
|
#
|
6202
6332
|
# @option params [String] :dbi_resource_id
|
6203
6333
|
# The identifier for the source DB instance, which can't be changed and
|
6204
|
-
# which is unique to an
|
6334
|
+
# which is unique to an Amazon Web Services Region.
|
6205
6335
|
#
|
6206
6336
|
# @option params [String] :db_instance_automated_backups_arn
|
6207
6337
|
# The Amazon Resource Name (ARN) of the automated backups to delete, for
|
@@ -6830,8 +6960,8 @@ module Aws::RDS
|
|
6830
6960
|
req.send_request(options)
|
6831
6961
|
end
|
6832
6962
|
|
6833
|
-
# Lists the set of CA certificates provided by Amazon RDS for this
|
6834
|
-
# account.
|
6963
|
+
# Lists the set of CA certificates provided by Amazon RDS for this
|
6964
|
+
# Amazon Web Services account.
|
6835
6965
|
#
|
6836
6966
|
# @option params [String] :certificate_identifier
|
6837
6967
|
# The user-supplied certificate identifier. If this parameter is
|
@@ -7426,16 +7556,18 @@ module Aws::RDS
|
|
7426
7556
|
# Returns a list of DB cluster snapshot attribute names and values for a
|
7427
7557
|
# manual DB cluster snapshot.
|
7428
7558
|
#
|
7429
|
-
# When sharing snapshots with other
|
7559
|
+
# When sharing snapshots with other Amazon Web Services accounts,
|
7430
7560
|
# `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute
|
7431
|
-
# and a list of IDs for the
|
7432
|
-
# restore the manual DB cluster snapshot. If `all`
|
7433
|
-
# list of values for the `restore` attribute, then
|
7434
|
-
# snapshot is public and can be copied or restored
|
7561
|
+
# and a list of IDs for the Amazon Web Services accounts that are
|
7562
|
+
# authorized to copy or restore the manual DB cluster snapshot. If `all`
|
7563
|
+
# is included in the list of values for the `restore` attribute, then
|
7564
|
+
# the manual DB cluster snapshot is public and can be copied or restored
|
7565
|
+
# by all Amazon Web Services accounts.
|
7435
7566
|
#
|
7436
|
-
# To add or remove access for an
|
7437
|
-
# DB cluster snapshot, or to make the manual DB cluster
|
7438
|
-
# or private, use the `ModifyDBClusterSnapshotAttribute`
|
7567
|
+
# To add or remove access for an Amazon Web Services account to copy or
|
7568
|
+
# restore a manual DB cluster snapshot, or to make the manual DB cluster
|
7569
|
+
# snapshot public or private, use the `ModifyDBClusterSnapshotAttribute`
|
7570
|
+
# API action.
|
7439
7571
|
#
|
7440
7572
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
7441
7573
|
#
|
@@ -7531,13 +7663,14 @@ module Aws::RDS
|
|
7531
7663
|
# of the following values:
|
7532
7664
|
#
|
7533
7665
|
# * `automated` - Return all DB cluster snapshots that have been
|
7534
|
-
# automatically taken by Amazon RDS for my
|
7666
|
+
# automatically taken by Amazon RDS for my Amazon Web Services
|
7667
|
+
# account.
|
7535
7668
|
#
|
7536
7669
|
# * `manual` - Return all DB cluster snapshots that have been taken by
|
7537
|
-
# my
|
7670
|
+
# my Amazon Web Services account.
|
7538
7671
|
#
|
7539
7672
|
# * `shared` - Return all manual DB cluster snapshots that have been
|
7540
|
-
# shared to my
|
7673
|
+
# shared to my Amazon Web Services account.
|
7541
7674
|
#
|
7542
7675
|
# * `public` - Return all DB cluster snapshots that have been marked as
|
7543
7676
|
# public.
|
@@ -7586,18 +7719,18 @@ module Aws::RDS
|
|
7586
7719
|
#
|
7587
7720
|
# @option params [Boolean] :include_shared
|
7588
7721
|
# A value that indicates whether to include shared manual DB cluster
|
7589
|
-
# snapshots from other
|
7590
|
-
# permission to copy or restore. By
|
7591
|
-
# included.
|
7722
|
+
# snapshots from other Amazon Web Services accounts that this Amazon Web
|
7723
|
+
# Services account has been given permission to copy or restore. By
|
7724
|
+
# default, these snapshots are not included.
|
7592
7725
|
#
|
7593
|
-
# You can give an
|
7594
|
-
# snapshot from another
|
7595
|
-
# `ModifyDBClusterSnapshotAttribute` API action.
|
7726
|
+
# You can give an Amazon Web Services account permission to restore a
|
7727
|
+
# manual DB cluster snapshot from another Amazon Web Services account by
|
7728
|
+
# the `ModifyDBClusterSnapshotAttribute` API action.
|
7596
7729
|
#
|
7597
7730
|
# @option params [Boolean] :include_public
|
7598
7731
|
# A value that indicates whether to include manual DB cluster snapshots
|
7599
|
-
# that are public and can be copied or restored by any
|
7600
|
-
# default, the public snapshots are not included.
|
7732
|
+
# that are public and can be copied or restored by any Amazon Web
|
7733
|
+
# Services account. By default, the public snapshots are not included.
|
7601
7734
|
#
|
7602
7735
|
# You can share a manual DB cluster snapshot as public by using the
|
7603
7736
|
# ModifyDBClusterSnapshotAttribute API action.
|
@@ -7741,7 +7874,8 @@ module Aws::RDS
|
|
7741
7874
|
#
|
7742
7875
|
# @option params [Boolean] :include_shared
|
7743
7876
|
# Optional Boolean parameter that specifies whether the output includes
|
7744
|
-
# information about clusters shared from other
|
7877
|
+
# information about clusters shared from other Amazon Web Services
|
7878
|
+
# accounts.
|
7745
7879
|
#
|
7746
7880
|
# @return [Types::DBClusterMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7747
7881
|
#
|
@@ -7899,11 +8033,11 @@ module Aws::RDS
|
|
7899
8033
|
#
|
7900
8034
|
# * `oracle-ee`
|
7901
8035
|
#
|
7902
|
-
# * `oracle-
|
8036
|
+
# * `oracle-ee-cdb`
|
7903
8037
|
#
|
7904
|
-
# * `oracle-
|
8038
|
+
# * `oracle-se2`
|
7905
8039
|
#
|
7906
|
-
# * `oracle-
|
8040
|
+
# * `oracle-se2-cdb`
|
7907
8041
|
#
|
7908
8042
|
# * `postgres`
|
7909
8043
|
#
|
@@ -8415,6 +8549,11 @@ module Aws::RDS
|
|
8415
8549
|
# resp.db_instances[0].db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
8416
8550
|
# resp.db_instances[0].customer_owned_ip_enabled #=> Boolean
|
8417
8551
|
# resp.db_instances[0].aws_backup_recovery_point_arn #=> String
|
8552
|
+
# resp.db_instances[0].activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
8553
|
+
# resp.db_instances[0].activity_stream_kms_key_id #=> String
|
8554
|
+
# resp.db_instances[0].activity_stream_kinesis_stream_name #=> String
|
8555
|
+
# resp.db_instances[0].activity_stream_mode #=> String, one of "sync", "async"
|
8556
|
+
# resp.db_instances[0].activity_stream_engine_native_audit_fields_included #=> Boolean
|
8418
8557
|
#
|
8419
8558
|
#
|
8420
8559
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -8717,8 +8856,8 @@ module Aws::RDS
|
|
8717
8856
|
#
|
8718
8857
|
# @option params [String] :db_proxy_name
|
8719
8858
|
# The name of the DB proxy. If you omit this parameter, the output
|
8720
|
-
# includes information about all DB proxies owned by your
|
8721
|
-
# ID.
|
8859
|
+
# includes information about all DB proxies owned by your Amazon Web
|
8860
|
+
# Services account ID.
|
8722
8861
|
#
|
8723
8862
|
# @option params [Array<Types::Filter>] :filters
|
8724
8863
|
# This parameter is not currently supported.
|
@@ -9113,16 +9252,17 @@ module Aws::RDS
|
|
9113
9252
|
# Returns a list of DB snapshot attribute names and values for a manual
|
9114
9253
|
# DB snapshot.
|
9115
9254
|
#
|
9116
|
-
# When sharing snapshots with other
|
9255
|
+
# When sharing snapshots with other Amazon Web Services accounts,
|
9117
9256
|
# `DescribeDBSnapshotAttributes` returns the `restore` attribute and a
|
9118
|
-
# list of IDs for the
|
9119
|
-
# restore the manual DB snapshot. If `all` is included in the
|
9120
|
-
# values for the `restore` attribute, then the manual DB
|
9121
|
-
# public and can be copied or restored by all
|
9257
|
+
# list of IDs for the Amazon Web Services accounts that are authorized
|
9258
|
+
# to copy or restore the manual DB snapshot. If `all` is included in the
|
9259
|
+
# list of values for the `restore` attribute, then the manual DB
|
9260
|
+
# snapshot is public and can be copied or restored by all Amazon Web
|
9261
|
+
# Services accounts.
|
9122
9262
|
#
|
9123
|
-
# To add or remove access for an
|
9124
|
-
# DB snapshot, or to make the manual DB snapshot public
|
9125
|
-
# the `ModifyDBSnapshotAttribute` API action.
|
9263
|
+
# To add or remove access for an Amazon Web Services account to copy or
|
9264
|
+
# restore a manual DB snapshot, or to make the manual DB snapshot public
|
9265
|
+
# or private, use the `ModifyDBSnapshotAttribute` API action.
|
9126
9266
|
#
|
9127
9267
|
# @option params [required, String] :db_snapshot_identifier
|
9128
9268
|
# The identifier for the DB snapshot to describe the attributes for.
|
@@ -9200,21 +9340,21 @@ module Aws::RDS
|
|
9200
9340
|
# following values:
|
9201
9341
|
#
|
9202
9342
|
# * `automated` - Return all DB snapshots that have been automatically
|
9203
|
-
# taken by Amazon RDS for my
|
9343
|
+
# taken by Amazon RDS for my Amazon Web Services account.
|
9204
9344
|
#
|
9205
|
-
# * `manual` - Return all DB snapshots that have been taken by my
|
9206
|
-
# account.
|
9345
|
+
# * `manual` - Return all DB snapshots that have been taken by my Amazon
|
9346
|
+
# Web Services account.
|
9207
9347
|
#
|
9208
9348
|
# * `shared` - Return all manual DB snapshots that have been shared to
|
9209
|
-
# my
|
9349
|
+
# my Amazon Web Services account.
|
9210
9350
|
#
|
9211
9351
|
# * `public` - Return all DB snapshots that have been marked as public.
|
9212
9352
|
#
|
9213
|
-
# * `awsbackup` - Return the DB snapshots managed by the
|
9214
|
-
# service.
|
9353
|
+
# * `awsbackup` - Return the DB snapshots managed by the Amazon Web
|
9354
|
+
# Services Backup service.
|
9215
9355
|
#
|
9216
|
-
# For information about
|
9217
|
-
# Guide.* ][1]
|
9356
|
+
# For information about Amazon Web Services Backup, see the [ *Amazon
|
9357
|
+
# Web Services Backup Developer Guide.* ][1]
|
9218
9358
|
#
|
9219
9359
|
# The `awsbackup` type does not apply to Aurora.
|
9220
9360
|
#
|
@@ -9269,18 +9409,18 @@ module Aws::RDS
|
|
9269
9409
|
#
|
9270
9410
|
# @option params [Boolean] :include_shared
|
9271
9411
|
# A value that indicates whether to include shared manual DB cluster
|
9272
|
-
# snapshots from other
|
9273
|
-
# permission to copy or restore. By
|
9274
|
-
# included.
|
9412
|
+
# snapshots from other Amazon Web Services accounts that this Amazon Web
|
9413
|
+
# Services account has been given permission to copy or restore. By
|
9414
|
+
# default, these snapshots are not included.
|
9275
9415
|
#
|
9276
|
-
# You can give an
|
9277
|
-
# from another
|
9278
|
-
# action.
|
9416
|
+
# You can give an Amazon Web Services account permission to restore a
|
9417
|
+
# manual DB snapshot from another Amazon Web Services account by using
|
9418
|
+
# the `ModifyDBSnapshotAttribute` API action.
|
9279
9419
|
#
|
9280
9420
|
# @option params [Boolean] :include_public
|
9281
9421
|
# A value that indicates whether to include manual DB cluster snapshots
|
9282
|
-
# that are public and can be copied or restored by any
|
9283
|
-
# default, the public snapshots are not included.
|
9422
|
+
# that are public and can be copied or restored by any Amazon Web
|
9423
|
+
# Services account. By default, the public snapshots are not included.
|
9284
9424
|
#
|
9285
9425
|
# You can share a manual DB snapshot as public by using the
|
9286
9426
|
# ModifyDBSnapshotAttribute API.
|
@@ -10256,11 +10396,11 @@ module Aws::RDS
|
|
10256
10396
|
#
|
10257
10397
|
# * `oracle-ee`
|
10258
10398
|
#
|
10259
|
-
# * `oracle-
|
10399
|
+
# * `oracle-ee-cdb`
|
10260
10400
|
#
|
10261
|
-
# * `oracle-
|
10401
|
+
# * `oracle-se2`
|
10262
10402
|
#
|
10263
|
-
# * `oracle-
|
10403
|
+
# * `oracle-se2-cdb`
|
10264
10404
|
#
|
10265
10405
|
# * `postgres`
|
10266
10406
|
#
|
@@ -10411,11 +10551,11 @@ module Aws::RDS
|
|
10411
10551
|
#
|
10412
10552
|
# * `oracle-ee`
|
10413
10553
|
#
|
10414
|
-
# * `oracle-
|
10554
|
+
# * `oracle-ee-cdb`
|
10415
10555
|
#
|
10416
|
-
# * `oracle-
|
10556
|
+
# * `oracle-se2`
|
10417
10557
|
#
|
10418
|
-
# * `oracle-
|
10558
|
+
# * `oracle-se2-cdb`
|
10419
10559
|
#
|
10420
10560
|
# * `postgres`
|
10421
10561
|
#
|
@@ -10533,11 +10673,11 @@ module Aws::RDS
|
|
10533
10673
|
#
|
10534
10674
|
# * `oracle-ee`
|
10535
10675
|
#
|
10536
|
-
# * `oracle-
|
10676
|
+
# * `oracle-ee-cdb`
|
10537
10677
|
#
|
10538
|
-
# * `oracle-
|
10678
|
+
# * `oracle-se2`
|
10539
10679
|
#
|
10540
|
-
# * `oracle-
|
10680
|
+
# * `oracle-se2-cdb`
|
10541
10681
|
#
|
10542
10682
|
# * `postgres`
|
10543
10683
|
#
|
@@ -10567,7 +10707,7 @@ module Aws::RDS
|
|
10567
10707
|
# group.
|
10568
10708
|
#
|
10569
10709
|
# Omit this parameter to show the available offerings in the specified
|
10570
|
-
#
|
10710
|
+
# Amazon Web Services Region.
|
10571
10711
|
#
|
10572
10712
|
# @option params [Boolean] :vpc
|
10573
10713
|
# A value that indicates whether to show only VPC or non-VPC offerings.
|
@@ -10669,6 +10809,8 @@ module Aws::RDS
|
|
10669
10809
|
# resp.orderable_db_instance_options[0].supports_storage_autoscaling #=> Boolean
|
10670
10810
|
# resp.orderable_db_instance_options[0].supports_kerberos_authentication #=> Boolean
|
10671
10811
|
# resp.orderable_db_instance_options[0].outpost_capable #=> Boolean
|
10812
|
+
# resp.orderable_db_instance_options[0].supported_activity_stream_modes #=> Array
|
10813
|
+
# resp.orderable_db_instance_options[0].supported_activity_stream_modes[0] #=> String
|
10672
10814
|
# resp.orderable_db_instance_options[0].supports_global_databases #=> Boolean
|
10673
10815
|
# resp.marker #=> String
|
10674
10816
|
#
|
@@ -10815,8 +10957,8 @@ module Aws::RDS
|
|
10815
10957
|
# The lease identifier filter value. Specify this parameter to show only
|
10816
10958
|
# the reservation that matches the specified lease ID.
|
10817
10959
|
#
|
10818
|
-
# <note markdown="1">
|
10819
|
-
# reserved DB instance.
|
10960
|
+
# <note markdown="1"> Amazon Web Services Support might request the lease ID for an issue
|
10961
|
+
# related to a reserved DB instance.
|
10820
10962
|
#
|
10821
10963
|
# </note>
|
10822
10964
|
#
|
@@ -11042,16 +11184,17 @@ module Aws::RDS
|
|
11042
11184
|
req.send_request(options)
|
11043
11185
|
end
|
11044
11186
|
|
11045
|
-
# Returns a list of the source
|
11046
|
-
# can create a read replica, copy a
|
11047
|
-
# automated backups from. This API action
|
11187
|
+
# Returns a list of the source Amazon Web Services Regions where the
|
11188
|
+
# current Amazon Web Services Region can create a read replica, copy a
|
11189
|
+
# DB snapshot from, or replicate automated backups from. This API action
|
11190
|
+
# supports pagination.
|
11048
11191
|
#
|
11049
11192
|
# @option params [String] :region_name
|
11050
|
-
# The source
|
11193
|
+
# The source Amazon Web Services Region name. For example, `us-east-1`.
|
11051
11194
|
#
|
11052
11195
|
# Constraints:
|
11053
11196
|
#
|
11054
|
-
# * Must specify a valid
|
11197
|
+
# * Must specify a valid Amazon Web Services Region name.
|
11055
11198
|
#
|
11056
11199
|
# ^
|
11057
11200
|
#
|
@@ -11528,7 +11671,7 @@ module Aws::RDS
|
|
11528
11671
|
# Identifier of the secondary Aurora DB cluster that you want to promote
|
11529
11672
|
# to primary for the Aurora global database (GlobalCluster.) Use the
|
11530
11673
|
# Amazon Resource Name (ARN) for the identifier so that Aurora can
|
11531
|
-
# locate the cluster in its
|
11674
|
+
# locate the cluster in its Amazon Web Services Region.
|
11532
11675
|
#
|
11533
11676
|
# @return [Types::FailoverGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11534
11677
|
#
|
@@ -11746,13 +11889,13 @@ module Aws::RDS
|
|
11746
11889
|
#
|
11747
11890
|
# * You already migrated your applications to support the latest
|
11748
11891
|
# certificate authority (CA) certificate, but the new CA certificate
|
11749
|
-
# is not yet the RDS default CA certificate for the specified
|
11750
|
-
# Region.
|
11892
|
+
# is not yet the RDS default CA certificate for the specified Amazon
|
11893
|
+
# Web Services Region.
|
11751
11894
|
#
|
11752
11895
|
# * RDS has already moved to a new default CA certificate for the
|
11753
|
-
# specified
|
11754
|
-
# the new CA certificate. In this case, you
|
11755
|
-
# additional time to finish your application changes.
|
11896
|
+
# specified Amazon Web Services Region, but you are still in the
|
11897
|
+
# process of supporting the new CA certificate. In this case, you
|
11898
|
+
# temporarily need additional time to finish your application changes.
|
11756
11899
|
#
|
11757
11900
|
# For more information about rotating your SSL/TLS certificate for RDS
|
11758
11901
|
# DB engines, see [ Rotating Your SSL/TLS Certificate][1] in the *Amazon
|
@@ -11771,7 +11914,7 @@ module Aws::RDS
|
|
11771
11914
|
# The new default certificate identifier to override the current one
|
11772
11915
|
# with.
|
11773
11916
|
#
|
11774
|
-
# To determine the valid values, use the `describe-certificates`
|
11917
|
+
# To determine the valid values, use the `describe-certificates` CLI
|
11775
11918
|
# command or the `DescribeCertificates` API operation.
|
11776
11919
|
#
|
11777
11920
|
# @option params [Boolean] :remove_customer_override
|
@@ -12022,8 +12165,9 @@ module Aws::RDS
|
|
12022
12165
|
# parameter.
|
12023
12166
|
#
|
12024
12167
|
# The default is a 30-minute window selected at random from an 8-hour
|
12025
|
-
# block of time for each
|
12026
|
-
# see [ Backup window][1] in the *Amazon Aurora User
|
12168
|
+
# block of time for each Amazon Web Services Region. To view the time
|
12169
|
+
# blocks available, see [ Backup window][1] in the *Amazon Aurora User
|
12170
|
+
# Guide.*
|
12027
12171
|
#
|
12028
12172
|
# Constraints:
|
12029
12173
|
#
|
@@ -12046,9 +12190,10 @@ module Aws::RDS
|
|
12046
12190
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
12047
12191
|
#
|
12048
12192
|
# The default is a 30-minute window selected at random from an 8-hour
|
12049
|
-
# block of time for each
|
12050
|
-
# week. To see the time blocks available, see [
|
12051
|
-
# DB Cluster Maintenance Window][1] in the
|
12193
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
12194
|
+
# random day of the week. To see the time blocks available, see [
|
12195
|
+
# Adjusting the Preferred DB Cluster Maintenance Window][1] in the
|
12196
|
+
# *Amazon Aurora User Guide.*
|
12052
12197
|
#
|
12053
12198
|
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
12054
12199
|
#
|
@@ -12059,9 +12204,9 @@ module Aws::RDS
|
|
12059
12204
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
12060
12205
|
#
|
12061
12206
|
# @option params [Boolean] :enable_iam_database_authentication
|
12062
|
-
# A value that indicates whether to enable mapping of
|
12063
|
-
# Access Management (IAM) accounts to database
|
12064
|
-
# mapping is disabled.
|
12207
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
12208
|
+
# Services Identity and Access Management (IAM) accounts to database
|
12209
|
+
# accounts. By default, mapping is disabled.
|
12065
12210
|
#
|
12066
12211
|
# For more information, see [ IAM Database Authentication][1] in the
|
12067
12212
|
# *Amazon Aurora User Guide.*
|
@@ -12442,12 +12587,6 @@ module Aws::RDS
|
|
12442
12587
|
# For more information on Amazon Aurora, see [ What Is Amazon
|
12443
12588
|
# Aurora?][1] in the *Amazon Aurora User Guide.*
|
12444
12589
|
#
|
12445
|
-
# <note markdown="1"> Changes to dynamic parameters are applied immediately. Changes to
|
12446
|
-
# static parameters require a reboot without failover to the DB cluster
|
12447
|
-
# associated with the parameter group before the change can take effect.
|
12448
|
-
#
|
12449
|
-
# </note>
|
12450
|
-
#
|
12451
12590
|
# After you create a DB cluster parameter group, you should wait at
|
12452
12591
|
# least 5 minutes before creating your first DB cluster that uses that
|
12453
12592
|
# DB cluster parameter group as the default parameter group. This allows
|
@@ -12481,6 +12620,22 @@ module Aws::RDS
|
|
12481
12620
|
# @option params [required, Array<Types::Parameter>] :parameters
|
12482
12621
|
# A list of parameters in the DB cluster parameter group to modify.
|
12483
12622
|
#
|
12623
|
+
# Valid Values (for the application method): `immediate |
|
12624
|
+
# pending-reboot`
|
12625
|
+
#
|
12626
|
+
# <note markdown="1"> You can use the `immediate` value with dynamic parameters only. You
|
12627
|
+
# can use the `pending-reboot` value for both dynamic and static
|
12628
|
+
# parameters.
|
12629
|
+
#
|
12630
|
+
# When the application method is `immediate`, changes to dynamic
|
12631
|
+
# parameters are applied immediately to the DB clusters associated with
|
12632
|
+
# the parameter group. When the application method is `pending-reboot`,
|
12633
|
+
# changes to dynamic and static parameters are applied after a reboot
|
12634
|
+
# without failover to the DB clusters associated with the parameter
|
12635
|
+
# group.
|
12636
|
+
#
|
12637
|
+
# </note>
|
12638
|
+
#
|
12484
12639
|
# @return [Types::DBClusterParameterGroupNameMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12485
12640
|
#
|
12486
12641
|
# * {Types::DBClusterParameterGroupNameMessage#db_cluster_parameter_group_name #db_cluster_parameter_group_name} => String
|
@@ -12542,28 +12697,30 @@ module Aws::RDS
|
|
12542
12697
|
# Adds an attribute and values to, or removes an attribute and values
|
12543
12698
|
# from, a manual DB cluster snapshot.
|
12544
12699
|
#
|
12545
|
-
# To share a manual DB cluster snapshot with other
|
12546
|
-
# `restore` as the `AttributeName` and use the
|
12547
|
-
# to add a list of IDs of the
|
12548
|
-
#
|
12549
|
-
#
|
12550
|
-
# copied or restored by all
|
12700
|
+
# To share a manual DB cluster snapshot with other Amazon Web Services
|
12701
|
+
# accounts, specify `restore` as the `AttributeName` and use the
|
12702
|
+
# `ValuesToAdd` parameter to add a list of IDs of the Amazon Web
|
12703
|
+
# Services accounts that are authorized to restore the manual DB cluster
|
12704
|
+
# snapshot. Use the value `all` to make the manual DB cluster snapshot
|
12705
|
+
# public, which means that it can be copied or restored by all Amazon
|
12706
|
+
# Web Services accounts.
|
12551
12707
|
#
|
12552
12708
|
# <note markdown="1"> Don't add the `all` value for any manual DB cluster snapshots that
|
12553
|
-
# contain private information that you don't want available to all
|
12554
|
-
# accounts.
|
12709
|
+
# contain private information that you don't want available to all
|
12710
|
+
# Amazon Web Services accounts.
|
12555
12711
|
#
|
12556
12712
|
# </note>
|
12557
12713
|
#
|
12558
12714
|
# If a manual DB cluster snapshot is encrypted, it can be shared, but
|
12559
|
-
# only by specifying a list of authorized
|
12560
|
-
# `ValuesToAdd` parameter. You can't use `all` as a value
|
12561
|
-
# parameter in this case.
|
12715
|
+
# only by specifying a list of authorized Amazon Web Services account
|
12716
|
+
# IDs for the `ValuesToAdd` parameter. You can't use `all` as a value
|
12717
|
+
# for that parameter in this case.
|
12562
12718
|
#
|
12563
|
-
# To view which
|
12564
|
-
# cluster snapshot, or whether a manual DB cluster
|
12565
|
-
# private, use the
|
12566
|
-
#
|
12719
|
+
# To view which Amazon Web Services accounts have access to copy or
|
12720
|
+
# restore a manual DB cluster snapshot, or whether a manual DB cluster
|
12721
|
+
# snapshot is public or private, use the
|
12722
|
+
# DescribeDBClusterSnapshotAttributes API action. The accounts are
|
12723
|
+
# returned as values for the `restore` attribute.
|
12567
12724
|
#
|
12568
12725
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
12569
12726
|
#
|
@@ -12576,8 +12733,8 @@ module Aws::RDS
|
|
12576
12733
|
# @option params [required, String] :attribute_name
|
12577
12734
|
# The name of the DB cluster snapshot attribute to modify.
|
12578
12735
|
#
|
12579
|
-
# To manage authorization for other
|
12580
|
-
# manual DB cluster snapshot, set this value to `restore`.
|
12736
|
+
# To manage authorization for other Amazon Web Services accounts to copy
|
12737
|
+
# or restore a manual DB cluster snapshot, set this value to `restore`.
|
12581
12738
|
#
|
12582
12739
|
# <note markdown="1"> To view the list of attributes available to modify, use the
|
12583
12740
|
# DescribeDBClusterSnapshotAttributes API action.
|
@@ -12588,24 +12745,25 @@ module Aws::RDS
|
|
12588
12745
|
# A list of DB cluster snapshot attributes to add to the attribute
|
12589
12746
|
# specified by `AttributeName`.
|
12590
12747
|
#
|
12591
|
-
# To authorize other
|
12592
|
-
# snapshot, set this list to include one or more
|
12593
|
-
# `all` to make the manual DB
|
12594
|
-
#
|
12595
|
-
#
|
12596
|
-
# available to all
|
12748
|
+
# To authorize other Amazon Web Services accounts to copy or restore a
|
12749
|
+
# manual DB cluster snapshot, set this list to include one or more
|
12750
|
+
# Amazon Web Services account IDs, or `all` to make the manual DB
|
12751
|
+
# cluster snapshot restorable by any Amazon Web Services account. Do not
|
12752
|
+
# add the `all` value for any manual DB cluster snapshots that contain
|
12753
|
+
# private information that you don't want available to all Amazon Web
|
12754
|
+
# Services accounts.
|
12597
12755
|
#
|
12598
12756
|
# @option params [Array<String>] :values_to_remove
|
12599
12757
|
# A list of DB cluster snapshot attributes to remove from the attribute
|
12600
12758
|
# specified by `AttributeName`.
|
12601
12759
|
#
|
12602
|
-
# To remove authorization for other
|
12603
|
-
# manual DB cluster snapshot, set this list to include one
|
12604
|
-
# account identifiers, or `all` to remove
|
12605
|
-
#
|
12606
|
-
#
|
12607
|
-
#
|
12608
|
-
# snapshot.
|
12760
|
+
# To remove authorization for other Amazon Web Services accounts to copy
|
12761
|
+
# or restore a manual DB cluster snapshot, set this list to include one
|
12762
|
+
# or more Amazon Web Services account identifiers, or `all` to remove
|
12763
|
+
# authorization for any Amazon Web Services account to copy or restore
|
12764
|
+
# the DB cluster snapshot. If you specify `all`, an Amazon Web Services
|
12765
|
+
# account whose account ID is explicitly added to the `restore`
|
12766
|
+
# attribute can still copy or restore a manual DB cluster snapshot.
|
12609
12767
|
#
|
12610
12768
|
# @return [Types::ModifyDBClusterSnapshotAttributeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12611
12769
|
#
|
@@ -12691,10 +12849,10 @@ module Aws::RDS
|
|
12691
12849
|
#
|
12692
12850
|
# @option params [String] :db_instance_class
|
12693
12851
|
# The new compute and memory capacity of the DB instance, for example,
|
12694
|
-
# `db.m4.large`. Not all DB instance classes are available in all
|
12695
|
-
# Regions, or for all database engines. For the full list
|
12696
|
-
# classes, and availability for your engine, see [DB
|
12697
|
-
# in the *Amazon RDS User Guide.*
|
12852
|
+
# `db.m4.large`. Not all DB instance classes are available in all Amazon
|
12853
|
+
# Web Services Regions, or for all database engines. For the full list
|
12854
|
+
# of DB instance classes, and availability for your engine, see [DB
|
12855
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
12698
12856
|
#
|
12699
12857
|
# If you modify the DB instance class, an outage occurs during the
|
12700
12858
|
# change. The change is applied during the next maintenance window,
|
@@ -12870,8 +13028,8 @@ module Aws::RDS
|
|
12870
13028
|
# `BackupRetentionPeriod` parameter. Changing this parameter doesn't
|
12871
13029
|
# result in an outage and the change is asynchronously applied as soon
|
12872
13030
|
# as possible. The default is a 30-minute window selected at random from
|
12873
|
-
# an 8-hour block of time for each
|
12874
|
-
# [Backup window][1] in the *Amazon RDS User Guide.*
|
13031
|
+
# an 8-hour block of time for each Amazon Web Services Region. For more
|
13032
|
+
# information, see [Backup window][1] in the *Amazon RDS User Guide.*
|
12875
13033
|
#
|
12876
13034
|
# **Amazon Aurora**
|
12877
13035
|
#
|
@@ -13203,12 +13361,13 @@ module Aws::RDS
|
|
13203
13361
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
|
13204
13362
|
#
|
13205
13363
|
# @option params [Boolean] :enable_iam_database_authentication
|
13206
|
-
# A value that indicates whether to enable mapping of
|
13207
|
-
# Access Management (IAM) accounts to database
|
13208
|
-
# mapping is disabled.
|
13364
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
13365
|
+
# Services Identity and Access Management (IAM) accounts to database
|
13366
|
+
# accounts. By default, mapping is disabled.
|
13209
13367
|
#
|
13210
|
-
# This setting doesn't apply to Amazon Aurora. Mapping
|
13211
|
-
# to database accounts is managed by the DB
|
13368
|
+
# This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
|
13369
|
+
# Services IAM accounts to database accounts is managed by the DB
|
13370
|
+
# cluster.
|
13212
13371
|
#
|
13213
13372
|
# For more information about IAM database authentication, see [ IAM
|
13214
13373
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -13230,16 +13389,17 @@ module Aws::RDS
|
|
13230
13389
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
13231
13390
|
#
|
13232
13391
|
# @option params [String] :performance_insights_kms_key_id
|
13233
|
-
# The
|
13234
|
-
# data.
|
13392
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
13393
|
+
# Performance Insights data.
|
13235
13394
|
#
|
13236
|
-
# The
|
13237
|
-
# name for the
|
13395
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
13396
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
13397
|
+
# master key (CMK).
|
13238
13398
|
#
|
13239
13399
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
13240
|
-
# Amazon RDS uses your default CMK. There is a default CMK for your
|
13241
|
-
# account. Your
|
13242
|
-
# Region.
|
13400
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your
|
13401
|
+
# Amazon Web Services account. Your Amazon Web Services account has a
|
13402
|
+
# different default CMK for each Amazon Web Services Region.
|
13243
13403
|
#
|
13244
13404
|
# @option params [Integer] :performance_insights_retention_period
|
13245
13405
|
# The amount of time, in days, to retain Performance Insights data.
|
@@ -13341,10 +13501,11 @@ module Aws::RDS
|
|
13341
13501
|
# from outside of its virtual private cloud (VPC) on your local network.
|
13342
13502
|
#
|
13343
13503
|
# For more information about RDS on Outposts, see [Working with Amazon
|
13344
|
-
# RDS on
|
13504
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
13505
|
+
# Guide*.
|
13345
13506
|
#
|
13346
13507
|
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
13347
|
-
# in the *
|
13508
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
13348
13509
|
#
|
13349
13510
|
#
|
13350
13511
|
#
|
@@ -13352,7 +13513,8 @@ module Aws::RDS
|
|
13352
13513
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
13353
13514
|
#
|
13354
13515
|
# @option params [String] :aws_backup_recovery_point_arn
|
13355
|
-
# The Amazon Resource Name (ARN) of the recovery point in
|
13516
|
+
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
13517
|
+
# Services Backup.
|
13356
13518
|
#
|
13357
13519
|
# @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13358
13520
|
#
|
@@ -13564,6 +13726,11 @@ module Aws::RDS
|
|
13564
13726
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
13565
13727
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
13566
13728
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
13729
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
13730
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
13731
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
13732
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
13733
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
13567
13734
|
#
|
13568
13735
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstance AWS API Documentation
|
13569
13736
|
#
|
@@ -13579,12 +13746,6 @@ module Aws::RDS
|
|
13579
13746
|
# `ParameterValue`, and `ApplyMethod`. A maximum of 20 parameters can be
|
13580
13747
|
# modified in a single request.
|
13581
13748
|
#
|
13582
|
-
# <note markdown="1"> Changes to dynamic parameters are applied immediately. Changes to
|
13583
|
-
# static parameters require a reboot without failover to the DB instance
|
13584
|
-
# associated with the parameter group before the change can take effect.
|
13585
|
-
#
|
13586
|
-
# </note>
|
13587
|
-
#
|
13588
13749
|
# After you modify a DB parameter group, you should wait at least 5
|
13589
13750
|
# minutes before creating your first DB instance that uses that DB
|
13590
13751
|
# parameter group as the default parameter group. This allows Amazon RDS
|
@@ -13611,18 +13772,25 @@ module Aws::RDS
|
|
13611
13772
|
# ^
|
13612
13773
|
#
|
13613
13774
|
# @option params [required, Array<Types::Parameter>] :parameters
|
13614
|
-
# An array of parameter names, values, and the
|
13615
|
-
# parameter update. At least one parameter name, value, and
|
13616
|
-
# must be supplied; later arguments are
|
13617
|
-
# parameters can be modified in a single
|
13775
|
+
# An array of parameter names, values, and the application methods for
|
13776
|
+
# the parameter update. At least one parameter name, value, and
|
13777
|
+
# application method method must be supplied; later arguments are
|
13778
|
+
# optional. A maximum of 20 parameters can be modified in a single
|
13779
|
+
# request.
|
13618
13780
|
#
|
13619
13781
|
# Valid Values (for the application method): `immediate |
|
13620
13782
|
# pending-reboot`
|
13621
13783
|
#
|
13622
|
-
# <note markdown="1"> You can use the immediate value with dynamic parameters only. You
|
13623
|
-
# use the pending-reboot value for both dynamic and static
|
13624
|
-
#
|
13625
|
-
#
|
13784
|
+
# <note markdown="1"> You can use the `immediate` value with dynamic parameters only. You
|
13785
|
+
# can use the `pending-reboot` value for both dynamic and static
|
13786
|
+
# parameters.
|
13787
|
+
#
|
13788
|
+
# When the application method is `immediate`, changes to dynamic
|
13789
|
+
# parameters are applied immediately to the DB instances associated with
|
13790
|
+
# the parameter group. When the application method is `pending-reboot`,
|
13791
|
+
# changes to dynamic and static parameters are applied after a reboot
|
13792
|
+
# without failover to the DB instances associated with the parameter
|
13793
|
+
# group.
|
13626
13794
|
#
|
13627
13795
|
# </note>
|
13628
13796
|
#
|
@@ -13719,7 +13887,7 @@ module Aws::RDS
|
|
13719
13887
|
#
|
13720
13888
|
# @option params [String] :role_arn
|
13721
13889
|
# The Amazon Resource Name (ARN) of the IAM role that the proxy uses to
|
13722
|
-
# access secrets in
|
13890
|
+
# access secrets in Amazon Web Services Secrets Manager.
|
13723
13891
|
#
|
13724
13892
|
# @option params [Array<String>] :security_groups
|
13725
13893
|
# The new list of security groups for the `DBProxy`.
|
@@ -14010,28 +14178,28 @@ module Aws::RDS
|
|
14010
14178
|
# Adds an attribute and values to, or removes an attribute and values
|
14011
14179
|
# from, a manual DB snapshot.
|
14012
14180
|
#
|
14013
|
-
# To share a manual DB snapshot with other
|
14014
|
-
# `restore` as the `AttributeName` and use the `ValuesToAdd`
|
14015
|
-
# to add a list of IDs of the
|
14016
|
-
# restore the manual DB snapshot. Uses the value
|
14017
|
-
# manual DB snapshot public, which means it can be
|
14018
|
-
# all
|
14181
|
+
# To share a manual DB snapshot with other Amazon Web Services accounts,
|
14182
|
+
# specify `restore` as the `AttributeName` and use the `ValuesToAdd`
|
14183
|
+
# parameter to add a list of IDs of the Amazon Web Services accounts
|
14184
|
+
# that are authorized to restore the manual DB snapshot. Uses the value
|
14185
|
+
# `all` to make the manual DB snapshot public, which means it can be
|
14186
|
+
# copied or restored by all Amazon Web Services accounts.
|
14019
14187
|
#
|
14020
14188
|
# <note markdown="1"> Don't add the `all` value for any manual DB snapshots that contain
|
14021
|
-
# private information that you don't want available to all
|
14022
|
-
# accounts.
|
14189
|
+
# private information that you don't want available to all Amazon Web
|
14190
|
+
# Services accounts.
|
14023
14191
|
#
|
14024
14192
|
# </note>
|
14025
14193
|
#
|
14026
14194
|
# If the manual DB snapshot is encrypted, it can be shared, but only by
|
14027
|
-
# specifying a list of authorized
|
14028
|
-
# parameter. You can't use `all` as a value for that
|
14029
|
-
# case.
|
14195
|
+
# specifying a list of authorized Amazon Web Services account IDs for
|
14196
|
+
# the `ValuesToAdd` parameter. You can't use `all` as a value for that
|
14197
|
+
# parameter in this case.
|
14030
14198
|
#
|
14031
|
-
# To view which
|
14032
|
-
# snapshot, or whether a manual DB snapshot public
|
14033
|
-
# DescribeDBSnapshotAttributes API action. The
|
14034
|
-
# values for the `restore` attribute.
|
14199
|
+
# To view which Amazon Web Services accounts have access to copy or
|
14200
|
+
# restore a manual DB snapshot, or whether a manual DB snapshot public
|
14201
|
+
# or private, use the DescribeDBSnapshotAttributes API action. The
|
14202
|
+
# accounts are returned as values for the `restore` attribute.
|
14035
14203
|
#
|
14036
14204
|
# @option params [required, String] :db_snapshot_identifier
|
14037
14205
|
# The identifier for the DB snapshot to modify the attributes for.
|
@@ -14039,8 +14207,8 @@ module Aws::RDS
|
|
14039
14207
|
# @option params [required, String] :attribute_name
|
14040
14208
|
# The name of the DB snapshot attribute to modify.
|
14041
14209
|
#
|
14042
|
-
# To manage authorization for other
|
14043
|
-
# manual DB snapshot, set this value to `restore`.
|
14210
|
+
# To manage authorization for other Amazon Web Services accounts to copy
|
14211
|
+
# or restore a manual DB snapshot, set this value to `restore`.
|
14044
14212
|
#
|
14045
14213
|
# <note markdown="1"> To view the list of attributes available to modify, use the
|
14046
14214
|
# DescribeDBSnapshotAttributes API action.
|
@@ -14051,20 +14219,22 @@ module Aws::RDS
|
|
14051
14219
|
# A list of DB snapshot attributes to add to the attribute specified by
|
14052
14220
|
# `AttributeName`.
|
14053
14221
|
#
|
14054
|
-
# To authorize other
|
14055
|
-
# set this list to include one or more
|
14056
|
-
#
|
14057
|
-
#
|
14058
|
-
#
|
14222
|
+
# To authorize other Amazon Web Services accounts to copy or restore a
|
14223
|
+
# manual snapshot, set this list to include one or more Amazon Web
|
14224
|
+
# Services account IDs, or `all` to make the manual DB snapshot
|
14225
|
+
# restorable by any Amazon Web Services account. Do not add the `all`
|
14226
|
+
# value for any manual DB snapshots that contain private information
|
14227
|
+
# that you don't want available to all Amazon Web Services accounts.
|
14059
14228
|
#
|
14060
14229
|
# @option params [Array<String>] :values_to_remove
|
14061
14230
|
# A list of DB snapshot attributes to remove from the attribute
|
14062
14231
|
# specified by `AttributeName`.
|
14063
14232
|
#
|
14064
|
-
# To remove authorization for other
|
14065
|
-
# manual snapshot, set this list to include one or more
|
14066
|
-
# identifiers, or `all` to remove
|
14067
|
-
#
|
14233
|
+
# To remove authorization for other Amazon Web Services accounts to copy
|
14234
|
+
# or restore a manual snapshot, set this list to include one or more
|
14235
|
+
# Amazon Web Services account identifiers, or `all` to remove
|
14236
|
+
# authorization for any Amazon Web Services account to copy or restore
|
14237
|
+
# the DB snapshot. If you specify `all`, an Amazon Web Services account
|
14068
14238
|
# whose account ID is explicitly added to the `restore` attribute can
|
14069
14239
|
# still copy or restore the manual DB snapshot.
|
14070
14240
|
#
|
@@ -14118,7 +14288,8 @@ module Aws::RDS
|
|
14118
14288
|
end
|
14119
14289
|
|
14120
14290
|
# Modifies an existing DB subnet group. DB subnet groups must contain at
|
14121
|
-
# least one subnet in at least two AZs in the
|
14291
|
+
# least one subnet in at least two AZs in the Amazon Web Services
|
14292
|
+
# Region.
|
14122
14293
|
#
|
14123
14294
|
# @option params [required, String] :db_subnet_group_name
|
14124
14295
|
# The name for the DB subnet group. This value is stored as a lowercase
|
@@ -14584,9 +14755,9 @@ module Aws::RDS
|
|
14584
14755
|
# parameter.
|
14585
14756
|
#
|
14586
14757
|
# The default is a 30-minute window selected at random from an 8-hour
|
14587
|
-
# block of time for each
|
14588
|
-
# see [ Adjusting the Preferred Maintenance Window][1]
|
14589
|
-
# RDS User Guide.*
|
14758
|
+
# block of time for each Amazon Web Services Region. To see the time
|
14759
|
+
# blocks available, see [ Adjusting the Preferred Maintenance Window][1]
|
14760
|
+
# in the *Amazon RDS User Guide.*
|
14590
14761
|
#
|
14591
14762
|
# Constraints:
|
14592
14763
|
#
|
@@ -14757,6 +14928,11 @@ module Aws::RDS
|
|
14757
14928
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
14758
14929
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
14759
14930
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
14931
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
14932
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
14933
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
14934
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
14935
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
14760
14936
|
#
|
14761
14937
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplica AWS API Documentation
|
14762
14938
|
#
|
@@ -15170,6 +15346,11 @@ module Aws::RDS
|
|
15170
15346
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
15171
15347
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
15172
15348
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
15349
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
15350
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
15351
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
15352
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
15353
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
15173
15354
|
#
|
15174
15355
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstance AWS API Documentation
|
15175
15356
|
#
|
@@ -15290,10 +15471,10 @@ module Aws::RDS
|
|
15290
15471
|
req.send_request(options)
|
15291
15472
|
end
|
15292
15473
|
|
15293
|
-
# Disassociates an
|
15294
|
-
# Amazon Aurora DB cluster. For more information, see
|
15295
|
-
# Amazon Aurora MySQL to Access Other
|
15296
|
-
# in the *Amazon Aurora User Guide*.
|
15474
|
+
# Disassociates an Amazon Web Services Identity and Access Management
|
15475
|
+
# (IAM) role from an Amazon Aurora DB cluster. For more information, see
|
15476
|
+
# [Authorizing Amazon Aurora MySQL to Access Other Amazon Web Services
|
15477
|
+
# Services on Your Behalf ][1] in the *Amazon Aurora User Guide*.
|
15297
15478
|
#
|
15298
15479
|
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
15299
15480
|
#
|
@@ -15335,8 +15516,8 @@ module Aws::RDS
|
|
15335
15516
|
req.send_request(options)
|
15336
15517
|
end
|
15337
15518
|
|
15338
|
-
# Disassociates an
|
15339
|
-
# DB instance.
|
15519
|
+
# Disassociates an Amazon Web Services Identity and Access Management
|
15520
|
+
# (IAM) role from a DB instance.
|
15340
15521
|
#
|
15341
15522
|
# @option params [required, String] :db_instance_identifier
|
15342
15523
|
# The name of the DB instance to disassociate the IAM role from.
|
@@ -15841,8 +16022,9 @@ module Aws::RDS
|
|
15841
16022
|
# parameter.
|
15842
16023
|
#
|
15843
16024
|
# The default is a 30-minute window selected at random from an 8-hour
|
15844
|
-
# block of time for each
|
15845
|
-
# see [ Backup window][1] in the *Amazon Aurora User
|
16025
|
+
# block of time for each Amazon Web Services Region. To view the time
|
16026
|
+
# blocks available, see [ Backup window][1] in the *Amazon Aurora User
|
16027
|
+
# Guide.*
|
15846
16028
|
#
|
15847
16029
|
# Constraints:
|
15848
16030
|
#
|
@@ -15865,9 +16047,10 @@ module Aws::RDS
|
|
15865
16047
|
# Format: `ddd:hh24:mi-ddd:hh24:mi`
|
15866
16048
|
#
|
15867
16049
|
# The default is a 30-minute window selected at random from an 8-hour
|
15868
|
-
# block of time for each
|
15869
|
-
# week. To see the time blocks available, see [
|
15870
|
-
# Maintenance Window][1] in the *Amazon Aurora
|
16050
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
16051
|
+
# random day of the week. To see the time blocks available, see [
|
16052
|
+
# Adjusting the Preferred Maintenance Window][1] in the *Amazon Aurora
|
16053
|
+
# User Guide.*
|
15871
16054
|
#
|
15872
16055
|
# Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
|
15873
16056
|
#
|
@@ -15889,21 +16072,24 @@ module Aws::RDS
|
|
15889
16072
|
# A value that indicates whether the restored DB cluster is encrypted.
|
15890
16073
|
#
|
15891
16074
|
# @option params [String] :kms_key_id
|
15892
|
-
# The
|
16075
|
+
# The Amazon Web Services KMS key identifier for an encrypted DB
|
16076
|
+
# cluster.
|
15893
16077
|
#
|
15894
|
-
# The
|
15895
|
-
#
|
15896
|
-
#
|
16078
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
16079
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
16080
|
+
# master key (CMK). To use a CMK in a different Amazon Web Services
|
16081
|
+
# account, specify the key ARN or alias ARN.
|
15897
16082
|
#
|
15898
16083
|
# If the StorageEncrypted parameter is enabled, and you do not specify a
|
15899
16084
|
# value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
15900
|
-
# default CMK. There is a default CMK for your
|
15901
|
-
# account has a different default CMK
|
16085
|
+
# default CMK. There is a default CMK for your Amazon Web Services
|
16086
|
+
# account. Your Amazon Web Services account has a different default CMK
|
16087
|
+
# for each Amazon Web Services Region.
|
15902
16088
|
#
|
15903
16089
|
# @option params [Boolean] :enable_iam_database_authentication
|
15904
|
-
# A value that indicates whether to enable mapping of
|
15905
|
-
# Access Management (IAM) accounts to database
|
15906
|
-
# mapping is disabled.
|
16090
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
16091
|
+
# Services Identity and Access Management (IAM) accounts to database
|
16092
|
+
# accounts. By default, mapping is disabled.
|
15907
16093
|
#
|
15908
16094
|
# For more information, see [ IAM Database Authentication][1] in the
|
15909
16095
|
# *Amazon Aurora User Guide.*
|
@@ -15936,9 +16122,9 @@ module Aws::RDS
|
|
15936
16122
|
# by using all of the files in the Amazon S3 bucket.
|
15937
16123
|
#
|
15938
16124
|
# @option params [required, String] :s3_ingestion_role_arn
|
15939
|
-
# The Amazon Resource Name (ARN) of the
|
15940
|
-
# Management (IAM) role that authorizes Amazon RDS to access the
|
15941
|
-
# S3 bucket on your behalf.
|
16125
|
+
# The Amazon Resource Name (ARN) of the Amazon Web Services Identity and
|
16126
|
+
# Access Management (IAM) role that authorizes Amazon RDS to access the
|
16127
|
+
# Amazon S3 bucket on your behalf.
|
15942
16128
|
#
|
15943
16129
|
# @option params [Integer] :backtrack_window
|
15944
16130
|
# The target backtrack window, in seconds. To disable backtracking, set
|
@@ -16268,28 +16454,29 @@ module Aws::RDS
|
|
16268
16454
|
# The tags to be assigned to the restored DB cluster.
|
16269
16455
|
#
|
16270
16456
|
# @option params [String] :kms_key_id
|
16271
|
-
# The
|
16272
|
-
# cluster from a DB snapshot or DB cluster snapshot.
|
16457
|
+
# The Amazon Web Services KMS key identifier to use when restoring an
|
16458
|
+
# encrypted DB cluster from a DB snapshot or DB cluster snapshot.
|
16273
16459
|
#
|
16274
|
-
# The
|
16275
|
-
#
|
16276
|
-
#
|
16460
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
16461
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
16462
|
+
# master key (CMK). To use a CMK in a different Amazon Web Services
|
16463
|
+
# account, specify the key ARN or alias ARN.
|
16277
16464
|
#
|
16278
16465
|
# When you don't specify a value for the `KmsKeyId` parameter, then the
|
16279
16466
|
# following occurs:
|
16280
16467
|
#
|
16281
16468
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is
|
16282
|
-
# encrypted, then the restored DB cluster is encrypted using the
|
16283
|
-
# KMS CMK that was used to encrypt the DB snapshot
|
16284
|
-
# snapshot.
|
16469
|
+
# encrypted, then the restored DB cluster is encrypted using the
|
16470
|
+
# Amazon Web Services KMS CMK that was used to encrypt the DB snapshot
|
16471
|
+
# or DB cluster snapshot.
|
16285
16472
|
#
|
16286
16473
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
16287
16474
|
# isn't encrypted, then the restored DB cluster isn't encrypted.
|
16288
16475
|
#
|
16289
16476
|
# @option params [Boolean] :enable_iam_database_authentication
|
16290
|
-
# A value that indicates whether to enable mapping of
|
16291
|
-
# Access Management (IAM) accounts to database
|
16292
|
-
# mapping is disabled.
|
16477
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
16478
|
+
# Services Identity and Access Management (IAM) accounts to database
|
16479
|
+
# accounts. By default, mapping is disabled.
|
16293
16480
|
#
|
16294
16481
|
# For more information, see [ IAM Database Authentication][1] in the
|
16295
16482
|
# *Amazon Aurora User Guide.*
|
@@ -16663,24 +16850,26 @@ module Aws::RDS
|
|
16663
16850
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
16664
16851
|
#
|
16665
16852
|
# @option params [String] :kms_key_id
|
16666
|
-
# The
|
16667
|
-
# cluster from an encrypted DB cluster.
|
16853
|
+
# The Amazon Web Services KMS key identifier to use when restoring an
|
16854
|
+
# encrypted DB cluster from an encrypted DB cluster.
|
16668
16855
|
#
|
16669
|
-
# The
|
16670
|
-
#
|
16671
|
-
#
|
16856
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
16857
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
16858
|
+
# master key (CMK). To use a CMK in a different Amazon Web Services
|
16859
|
+
# account, specify the key ARN or alias ARN.
|
16672
16860
|
#
|
16673
16861
|
# You can restore to a new DB cluster and encrypt the new DB cluster
|
16674
|
-
# with a
|
16675
|
-
# encrypt the source DB cluster. The new DB
|
16676
|
-
# the
|
16862
|
+
# with a Amazon Web Services KMS CMK that is different than the Amazon
|
16863
|
+
# Web Services KMS key used to encrypt the source DB cluster. The new DB
|
16864
|
+
# cluster is encrypted with the Amazon Web Services KMS CMK identified
|
16865
|
+
# by the `KmsKeyId` parameter.
|
16677
16866
|
#
|
16678
16867
|
# If you don't specify a value for the `KmsKeyId` parameter, then the
|
16679
16868
|
# following occurs:
|
16680
16869
|
#
|
16681
16870
|
# * If the DB cluster is encrypted, then the restored DB cluster is
|
16682
|
-
# encrypted using the
|
16683
|
-
# DB cluster.
|
16871
|
+
# encrypted using the Amazon Web Services KMS CMK that was used to
|
16872
|
+
# encrypt the source DB cluster.
|
16684
16873
|
#
|
16685
16874
|
# * If the DB cluster isn't encrypted, then the restored DB cluster
|
16686
16875
|
# isn't encrypted.
|
@@ -16689,9 +16878,9 @@ module Aws::RDS
|
|
16689
16878
|
# then the restore request is rejected.
|
16690
16879
|
#
|
16691
16880
|
# @option params [Boolean] :enable_iam_database_authentication
|
16692
|
-
# A value that indicates whether to enable mapping of
|
16693
|
-
# Access Management (IAM) accounts to database
|
16694
|
-
# mapping is disabled.
|
16881
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
16882
|
+
# Services Identity and Access Management (IAM) accounts to database
|
16883
|
+
# accounts. By default, mapping is disabled.
|
16695
16884
|
#
|
16696
16885
|
# For more information, see [ IAM Database Authentication][1] in the
|
16697
16886
|
# *Amazon Aurora User Guide.*
|
@@ -16994,9 +17183,9 @@ module Aws::RDS
|
|
16994
17183
|
# @option params [String] :db_instance_class
|
16995
17184
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
16996
17185
|
# example, `db.m4.large`. Not all DB instance classes are available in
|
16997
|
-
# all
|
16998
|
-
# instance classes, and availability for your engine,
|
16999
|
-
# Class][1] in the *Amazon RDS User Guide.*
|
17186
|
+
# all Amazon Web Services Regions, or for all database engines. For the
|
17187
|
+
# full list of DB instance classes, and availability for your engine,
|
17188
|
+
# see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
17000
17189
|
#
|
17001
17190
|
# Default: The same DBInstanceClass as the original DB instance.
|
17002
17191
|
#
|
@@ -17088,11 +17277,11 @@ module Aws::RDS
|
|
17088
17277
|
#
|
17089
17278
|
# * `oracle-ee`
|
17090
17279
|
#
|
17091
|
-
# * `oracle-
|
17280
|
+
# * `oracle-ee-cdb`
|
17092
17281
|
#
|
17093
|
-
# * `oracle-
|
17282
|
+
# * `oracle-se2`
|
17094
17283
|
#
|
17095
|
-
# * `oracle-
|
17284
|
+
# * `oracle-se2-cdb`
|
17096
17285
|
#
|
17097
17286
|
# * `postgres`
|
17098
17287
|
#
|
@@ -17186,9 +17375,9 @@ module Aws::RDS
|
|
17186
17375
|
# the Directory Service.
|
17187
17376
|
#
|
17188
17377
|
# @option params [Boolean] :enable_iam_database_authentication
|
17189
|
-
# A value that indicates whether to enable mapping of
|
17190
|
-
# Access Management (IAM) accounts to database
|
17191
|
-
# mapping is disabled.
|
17378
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
17379
|
+
# Services Identity and Access Management (IAM) accounts to database
|
17380
|
+
# accounts. By default, mapping is disabled.
|
17192
17381
|
#
|
17193
17382
|
# For more information about IAM database authentication, see [ IAM
|
17194
17383
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -17252,10 +17441,11 @@ module Aws::RDS
|
|
17252
17441
|
# from outside of its virtual private cloud (VPC) on your local network.
|
17253
17442
|
#
|
17254
17443
|
# For more information about RDS on Outposts, see [Working with Amazon
|
17255
|
-
# RDS on
|
17444
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
17445
|
+
# Guide*.
|
17256
17446
|
#
|
17257
17447
|
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
17258
|
-
# in the *
|
17448
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
17259
17449
|
#
|
17260
17450
|
#
|
17261
17451
|
#
|
@@ -17531,6 +17721,11 @@ module Aws::RDS
|
|
17531
17721
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
17532
17722
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
17533
17723
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
17724
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
17725
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
17726
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
17727
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
17728
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
17534
17729
|
#
|
17535
17730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot AWS API Documentation
|
17536
17731
|
#
|
@@ -17582,10 +17777,10 @@ module Aws::RDS
|
|
17582
17777
|
#
|
17583
17778
|
# @option params [required, String] :db_instance_class
|
17584
17779
|
# The compute and memory capacity of the DB instance, for example,
|
17585
|
-
# `db.m4.large`. Not all DB instance classes are available in all
|
17586
|
-
# Regions, or for all database engines. For the full list
|
17587
|
-
# classes, and availability for your engine, see [DB
|
17588
|
-
# in the *Amazon RDS User Guide.*
|
17780
|
+
# `db.m4.large`. Not all DB instance classes are available in all Amazon
|
17781
|
+
# Web Services Regions, or for all database engines. For the full list
|
17782
|
+
# of DB instance classes, and availability for your engine, see [DB
|
17783
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
17589
17784
|
#
|
17590
17785
|
# Importing from Amazon S3 isn't supported on the db.t2.micro DB
|
17591
17786
|
# instance class.
|
@@ -17626,17 +17821,19 @@ module Aws::RDS
|
|
17626
17821
|
#
|
17627
17822
|
# @option params [String] :availability_zone
|
17628
17823
|
# The Availability Zone that the DB instance is created in. For
|
17629
|
-
# information about
|
17630
|
-
# Availability Zones][1] in the *Amazon RDS User
|
17824
|
+
# information about Amazon Web Services Regions and Availability Zones,
|
17825
|
+
# see [Regions and Availability Zones][1] in the *Amazon RDS User
|
17826
|
+
# Guide.*
|
17631
17827
|
#
|
17632
17828
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
17633
|
-
#
|
17829
|
+
# Amazon Web Services Region.
|
17634
17830
|
#
|
17635
17831
|
# Example: `us-east-1d`
|
17636
17832
|
#
|
17637
17833
|
# Constraint: The `AvailabilityZone` parameter can't be specified if
|
17638
17834
|
# the DB instance is a Multi-AZ deployment. The specified Availability
|
17639
|
-
# Zone must be in the same
|
17835
|
+
# Zone must be in the same Amazon Web Services Region as the current
|
17836
|
+
# endpoint.
|
17640
17837
|
#
|
17641
17838
|
#
|
17642
17839
|
#
|
@@ -17777,16 +17974,19 @@ module Aws::RDS
|
|
17777
17974
|
# not.
|
17778
17975
|
#
|
17779
17976
|
# @option params [String] :kms_key_id
|
17780
|
-
# The
|
17977
|
+
# The Amazon Web Services KMS key identifier for an encrypted DB
|
17978
|
+
# instance.
|
17781
17979
|
#
|
17782
|
-
# The
|
17783
|
-
#
|
17784
|
-
#
|
17980
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
17981
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
17982
|
+
# master key (CMK). To use a CMK in a different Amazon Web Services
|
17983
|
+
# account, specify the key ARN or alias ARN.
|
17785
17984
|
#
|
17786
17985
|
# If the `StorageEncrypted` parameter is enabled, and you do not specify
|
17787
17986
|
# a value for the `KmsKeyId` parameter, then Amazon RDS will use your
|
17788
|
-
# default CMK. There is a default CMK for your
|
17789
|
-
# account has a different default CMK
|
17987
|
+
# default CMK. There is a default CMK for your Amazon Web Services
|
17988
|
+
# account. Your Amazon Web Services account has a different default CMK
|
17989
|
+
# for each Amazon Web Services Region.
|
17790
17990
|
#
|
17791
17991
|
# @option params [Boolean] :copy_tags_to_snapshot
|
17792
17992
|
# A value that indicates whether to copy all tags from the DB instance
|
@@ -17819,9 +18019,9 @@ module Aws::RDS
|
|
17819
18019
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
17820
18020
|
#
|
17821
18021
|
# @option params [Boolean] :enable_iam_database_authentication
|
17822
|
-
# A value that indicates whether to enable mapping of
|
17823
|
-
# Access Management (IAM) accounts to database
|
17824
|
-
# mapping is disabled.
|
18022
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
18023
|
+
# Services Identity and Access Management (IAM) accounts to database
|
18024
|
+
# accounts. By default, mapping is disabled.
|
17825
18025
|
#
|
17826
18026
|
# For more information about IAM database authentication, see [ IAM
|
17827
18027
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -17851,8 +18051,8 @@ module Aws::RDS
|
|
17851
18051
|
# The prefix of your Amazon S3 bucket.
|
17852
18052
|
#
|
17853
18053
|
# @option params [required, String] :s3_ingestion_role_arn
|
17854
|
-
# An
|
17855
|
-
# to access your Amazon S3 bucket.
|
18054
|
+
# An Amazon Web Services Identity and Access Management (IAM) role to
|
18055
|
+
# allow Amazon RDS to access your Amazon S3 bucket.
|
17856
18056
|
#
|
17857
18057
|
# @option params [Boolean] :enable_performance_insights
|
17858
18058
|
# A value that indicates whether to enable Performance Insights for the
|
@@ -17866,16 +18066,17 @@ module Aws::RDS
|
|
17866
18066
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
17867
18067
|
#
|
17868
18068
|
# @option params [String] :performance_insights_kms_key_id
|
17869
|
-
# The
|
17870
|
-
# data.
|
18069
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
18070
|
+
# Performance Insights data.
|
17871
18071
|
#
|
17872
|
-
# The
|
17873
|
-
# name for the
|
18072
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
18073
|
+
# alias ARN, or alias name for the Amazon Web Services KMS customer
|
18074
|
+
# master key (CMK).
|
17874
18075
|
#
|
17875
18076
|
# If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
|
17876
|
-
# Amazon RDS uses your default CMK. There is a default CMK for your
|
17877
|
-
# account. Your
|
17878
|
-
# Region.
|
18077
|
+
# Amazon RDS uses your default CMK. There is a default CMK for your
|
18078
|
+
# Amazon Web Services account. Your Amazon Web Services account has a
|
18079
|
+
# different default CMK for each Amazon Web Services Region.
|
17879
18080
|
#
|
17880
18081
|
# @option params [Integer] :performance_insights_retention_period
|
17881
18082
|
# The amount of time, in days, to retain Performance Insights data.
|
@@ -18110,6 +18311,11 @@ module Aws::RDS
|
|
18110
18311
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
18111
18312
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
18112
18313
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
18314
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
18315
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
18316
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
18317
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
18318
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
18113
18319
|
#
|
18114
18320
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3 AWS API Documentation
|
18115
18321
|
#
|
@@ -18185,9 +18391,9 @@ module Aws::RDS
|
|
18185
18391
|
# @option params [String] :db_instance_class
|
18186
18392
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
18187
18393
|
# example, `db.m4.large`. Not all DB instance classes are available in
|
18188
|
-
# all
|
18189
|
-
# instance classes, and availability for your engine,
|
18190
|
-
# Class][1] in the *Amazon RDS User Guide.*
|
18394
|
+
# all Amazon Web Services Regions, or for all database engines. For the
|
18395
|
+
# full list of DB instance classes, and availability for your engine,
|
18396
|
+
# see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
18191
18397
|
#
|
18192
18398
|
# Default: The same DBInstanceClass as the original DB instance.
|
18193
18399
|
#
|
@@ -18276,11 +18482,11 @@ module Aws::RDS
|
|
18276
18482
|
#
|
18277
18483
|
# * `oracle-ee`
|
18278
18484
|
#
|
18279
|
-
# * `oracle-
|
18485
|
+
# * `oracle-ee-cdb`
|
18280
18486
|
#
|
18281
|
-
# * `oracle-
|
18487
|
+
# * `oracle-se2`
|
18282
18488
|
#
|
18283
|
-
# * `oracle-
|
18489
|
+
# * `oracle-se2-cdb`
|
18284
18490
|
#
|
18285
18491
|
# * `postgres`
|
18286
18492
|
#
|
@@ -18366,9 +18572,9 @@ module Aws::RDS
|
|
18366
18572
|
# the Directory Service.
|
18367
18573
|
#
|
18368
18574
|
# @option params [Boolean] :enable_iam_database_authentication
|
18369
|
-
# A value that indicates whether to enable mapping of
|
18370
|
-
# Access Management (IAM) accounts to database
|
18371
|
-
# mapping is disabled.
|
18575
|
+
# A value that indicates whether to enable mapping of Amazon Web
|
18576
|
+
# Services Identity and Access Management (IAM) accounts to database
|
18577
|
+
# accounts. By default, mapping is disabled.
|
18372
18578
|
#
|
18373
18579
|
# For more information about IAM database authentication, see [ IAM
|
18374
18580
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -18452,10 +18658,11 @@ module Aws::RDS
|
|
18452
18658
|
# from outside of its virtual private cloud (VPC) on your local network.
|
18453
18659
|
#
|
18454
18660
|
# For more information about RDS on Outposts, see [Working with Amazon
|
18455
|
-
# RDS on
|
18661
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
18662
|
+
# Guide*.
|
18456
18663
|
#
|
18457
18664
|
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
18458
|
-
# in the *
|
18665
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
18459
18666
|
#
|
18460
18667
|
#
|
18461
18668
|
#
|
@@ -18737,6 +18944,11 @@ module Aws::RDS
|
|
18737
18944
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
18738
18945
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
18739
18946
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
18947
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
18948
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
18949
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
18950
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
18951
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
18740
18952
|
#
|
18741
18953
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTime AWS API Documentation
|
18742
18954
|
#
|
@@ -18774,10 +18986,10 @@ module Aws::RDS
|
|
18774
18986
|
# `EC2SecurityGroupId` must be provided.
|
18775
18987
|
#
|
18776
18988
|
# @option params [String] :ec2_security_group_owner_id
|
18777
|
-
# The
|
18778
|
-
# specified in the `EC2SecurityGroupName` parameter. The
|
18779
|
-
# ID isn't an acceptable value. For VPC
|
18780
|
-
# `EC2SecurityGroupId` must be provided. Otherwise,
|
18989
|
+
# The Amazon Web Services account number of the owner of the EC2
|
18990
|
+
# security group specified in the `EC2SecurityGroupName` parameter. The
|
18991
|
+
# Amazon Web Services access key ID isn't an acceptable value. For VPC
|
18992
|
+
# DB security groups, `EC2SecurityGroupId` must be provided. Otherwise,
|
18781
18993
|
# EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or
|
18782
18994
|
# `EC2SecurityGroupId` must be provided.
|
18783
18995
|
#
|
@@ -18855,15 +19067,21 @@ module Aws::RDS
|
|
18855
19067
|
# asynchronously.
|
18856
19068
|
#
|
18857
19069
|
# @option params [required, String] :kms_key_id
|
18858
|
-
# The
|
18859
|
-
# activity stream. The
|
18860
|
-
# alias ARN, or alias name for the
|
19070
|
+
# The Amazon Web Services KMS key identifier for encrypting messages in
|
19071
|
+
# the database activity stream. The Amazon Web Services KMS key
|
19072
|
+
# identifier is the key ARN, key ID, alias ARN, or alias name for the
|
19073
|
+
# Amazon Web Services KMS customer master key (CMK).
|
18861
19074
|
#
|
18862
19075
|
# @option params [Boolean] :apply_immediately
|
18863
19076
|
# Specifies whether or not the database activity stream is to start as
|
18864
19077
|
# soon as possible, regardless of the maintenance window for the
|
18865
19078
|
# database.
|
18866
19079
|
#
|
19080
|
+
# @option params [Boolean] :engine_native_audit_fields_included
|
19081
|
+
# Specifies whether the database activity stream includes engine-native
|
19082
|
+
# audit fields. This option only applies to an Oracle DB instance. By
|
19083
|
+
# default, no engine-native audit fields are included.
|
19084
|
+
#
|
18867
19085
|
# @return [Types::StartActivityStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
18868
19086
|
#
|
18869
19087
|
# * {Types::StartActivityStreamResponse#kms_key_id #kms_key_id} => String
|
@@ -18871,6 +19089,7 @@ module Aws::RDS
|
|
18871
19089
|
# * {Types::StartActivityStreamResponse#status #status} => String
|
18872
19090
|
# * {Types::StartActivityStreamResponse#mode #mode} => String
|
18873
19091
|
# * {Types::StartActivityStreamResponse#apply_immediately #apply_immediately} => Boolean
|
19092
|
+
# * {Types::StartActivityStreamResponse#engine_native_audit_fields_included #engine_native_audit_fields_included} => Boolean
|
18874
19093
|
#
|
18875
19094
|
# @example Request syntax with placeholder values
|
18876
19095
|
#
|
@@ -18879,6 +19098,7 @@ module Aws::RDS
|
|
18879
19098
|
# mode: "sync", # required, accepts sync, async
|
18880
19099
|
# kms_key_id: "String", # required
|
18881
19100
|
# apply_immediately: false,
|
19101
|
+
# engine_native_audit_fields_included: false,
|
18882
19102
|
# })
|
18883
19103
|
#
|
18884
19104
|
# @example Response structure
|
@@ -18888,6 +19108,7 @@ module Aws::RDS
|
|
18888
19108
|
# resp.status #=> String, one of "stopped", "starting", "started", "stopping"
|
18889
19109
|
# resp.mode #=> String, one of "sync", "async"
|
18890
19110
|
# resp.apply_immediately #=> Boolean
|
19111
|
+
# resp.engine_native_audit_fields_included #=> Boolean
|
18891
19112
|
#
|
18892
19113
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartActivityStream AWS API Documentation
|
18893
19114
|
#
|
@@ -18898,9 +19119,9 @@ module Aws::RDS
|
|
18898
19119
|
req.send_request(options)
|
18899
19120
|
end
|
18900
19121
|
|
18901
|
-
# Starts an Amazon Aurora DB cluster that was stopped using the
|
18902
|
-
# console, the stop-db-cluster
|
18903
|
-
# action.
|
19122
|
+
# Starts an Amazon Aurora DB cluster that was stopped using the Amazon
|
19123
|
+
# Web Services console, the stop-db-cluster CLI command, or the
|
19124
|
+
# StopDBCluster action.
|
18904
19125
|
#
|
18905
19126
|
# For more information, see [ Stopping and Starting an Aurora
|
18906
19127
|
# Cluster][1] in the *Amazon Aurora User Guide.*
|
@@ -19027,9 +19248,9 @@ module Aws::RDS
|
|
19027
19248
|
req.send_request(options)
|
19028
19249
|
end
|
19029
19250
|
|
19030
|
-
# Starts an Amazon RDS DB instance that was stopped using the
|
19031
|
-
# console, the stop-db-instance
|
19032
|
-
# action.
|
19251
|
+
# Starts an Amazon RDS DB instance that was stopped using the Amazon Web
|
19252
|
+
# Services console, the stop-db-instance CLI command, or the
|
19253
|
+
# StopDBInstance action.
|
19033
19254
|
#
|
19034
19255
|
# For more information, see [ Starting an Amazon RDS DB instance That
|
19035
19256
|
# Was Previously Stopped][1] in the *Amazon RDS User Guide.*
|
@@ -19182,6 +19403,11 @@ module Aws::RDS
|
|
19182
19403
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
19183
19404
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
19184
19405
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
19406
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
19407
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
19408
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
19409
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
19410
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
19185
19411
|
#
|
19186
19412
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstance AWS API Documentation
|
19187
19413
|
#
|
@@ -19192,10 +19418,11 @@ module Aws::RDS
|
|
19192
19418
|
req.send_request(options)
|
19193
19419
|
end
|
19194
19420
|
|
19195
|
-
# Enables replication of automated backups to a different
|
19421
|
+
# Enables replication of automated backups to a different Amazon Web
|
19422
|
+
# Services Region.
|
19196
19423
|
#
|
19197
19424
|
# For more information, see [ Replicating Automated Backups to Another
|
19198
|
-
#
|
19425
|
+
# Amazon Web Services Region][1] in the *Amazon RDS User Guide.*
|
19199
19426
|
#
|
19200
19427
|
#
|
19201
19428
|
#
|
@@ -19210,18 +19437,20 @@ module Aws::RDS
|
|
19210
19437
|
# The retention period for the replicated automated backups.
|
19211
19438
|
#
|
19212
19439
|
# @option params [String] :kms_key_id
|
19213
|
-
# The
|
19214
|
-
# backups. The KMS key ID is the Amazon Resource
|
19215
|
-
# encryption key in the destination
|
19440
|
+
# The Amazon Web Services KMS key identifier for encryption of the
|
19441
|
+
# replicated automated backups. The KMS key ID is the Amazon Resource
|
19442
|
+
# Name (ARN) for the KMS encryption key in the destination Amazon Web
|
19443
|
+
# Services Region, for example,
|
19216
19444
|
# `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`.
|
19217
19445
|
#
|
19218
19446
|
# @option params [String] :pre_signed_url
|
19219
19447
|
# A URL that contains a Signature Version 4 signed request for the
|
19220
19448
|
# StartDBInstanceAutomatedBackupsReplication action to be called in the
|
19221
|
-
#
|
19222
|
-
# valid request for the
|
19223
|
-
# action that can be
|
19224
|
-
# DB
|
19449
|
+
# Amazon Web Services Region of the source DB instance. The presigned
|
19450
|
+
# URL must be a valid request for the
|
19451
|
+
# StartDBInstanceAutomatedBackupsReplication API action that can be
|
19452
|
+
# executed in the Amazon Web Services Region that contains the source DB
|
19453
|
+
# instance.
|
19225
19454
|
#
|
19226
19455
|
# @option params [String] :source_region
|
19227
19456
|
# The source region of the snapshot. This is only needed when the
|
@@ -19300,11 +19529,13 @@ module Aws::RDS
|
|
19300
19529
|
# when exporting a snapshot.
|
19301
19530
|
#
|
19302
19531
|
# @option params [required, String] :kms_key_id
|
19303
|
-
# The ID of the
|
19304
|
-
# snapshot exported to Amazon S3. The
|
19305
|
-
# ARN, key ID, alias ARN, or alias name
|
19306
|
-
#
|
19307
|
-
#
|
19532
|
+
# The ID of the Amazon Web Services KMS customer master key (CMK) to use
|
19533
|
+
# to encrypt the snapshot exported to Amazon S3. The Amazon Web Services
|
19534
|
+
# KMS key identifier is the key ARN, key ID, alias ARN, or alias name
|
19535
|
+
# for the Amazon Web Services KMS customer master key (CMK). The caller
|
19536
|
+
# of this operation must be authorized to execute the following
|
19537
|
+
# operations. These can be set in the Amazon Web Services KMS key
|
19538
|
+
# policy:
|
19308
19539
|
#
|
19309
19540
|
# * GrantOperation.Encrypt
|
19310
19541
|
#
|
@@ -19405,8 +19636,8 @@ module Aws::RDS
|
|
19405
19636
|
req.send_request(options)
|
19406
19637
|
end
|
19407
19638
|
|
19408
|
-
# Stops a database activity stream that was started using the
|
19409
|
-
# console, the `start-activity-stream`
|
19639
|
+
# Stops a database activity stream that was started using the Amazon Web
|
19640
|
+
# Services console, the `start-activity-stream` CLI command, or the
|
19410
19641
|
# `StartActivityStream` action.
|
19411
19642
|
#
|
19412
19643
|
# For more information, see [Database Activity Streams][1] in the
|
@@ -19746,6 +19977,11 @@ module Aws::RDS
|
|
19746
19977
|
# resp.db_instance.db_instance_automated_backups_replications[0].db_instance_automated_backups_arn #=> String
|
19747
19978
|
# resp.db_instance.customer_owned_ip_enabled #=> Boolean
|
19748
19979
|
# resp.db_instance.aws_backup_recovery_point_arn #=> String
|
19980
|
+
# resp.db_instance.activity_stream_status #=> String, one of "stopped", "starting", "started", "stopping"
|
19981
|
+
# resp.db_instance.activity_stream_kms_key_id #=> String
|
19982
|
+
# resp.db_instance.activity_stream_kinesis_stream_name #=> String
|
19983
|
+
# resp.db_instance.activity_stream_mode #=> String, one of "sync", "async"
|
19984
|
+
# resp.db_instance.activity_stream_engine_native_audit_fields_included #=> Boolean
|
19749
19985
|
#
|
19750
19986
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstance AWS API Documentation
|
19751
19987
|
#
|
@@ -19759,7 +19995,7 @@ module Aws::RDS
|
|
19759
19995
|
# Stops automated backup replication for a DB instance.
|
19760
19996
|
#
|
19761
19997
|
# For more information, see [ Replicating Automated Backups to Another
|
19762
|
-
#
|
19998
|
+
# Amazon Web Services Region][1] in the *Amazon RDS User Guide.*
|
19763
19999
|
#
|
19764
20000
|
#
|
19765
20001
|
#
|
@@ -19833,7 +20069,7 @@ module Aws::RDS
|
|
19833
20069
|
params: params,
|
19834
20070
|
config: config)
|
19835
20071
|
context[:gem_name] = 'aws-sdk-rds'
|
19836
|
-
context[:gem_version] = '1.
|
20072
|
+
context[:gem_version] = '1.121.0'
|
19837
20073
|
Seahorse::Client::Request.new(handlers, context)
|
19838
20074
|
end
|
19839
20075
|
|