aws-sdk-rds 1.95.0 → 1.96.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rds.rb +1 -1
- data/lib/aws-sdk-rds/client.rb +219 -141
- data/lib/aws-sdk-rds/client_api.rb +4 -0
- data/lib/aws-sdk-rds/db_cluster.rb +7 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +10 -1
- data/lib/aws-sdk-rds/db_instance.rb +84 -54
- data/lib/aws-sdk-rds/db_snapshot.rb +4 -13
- data/lib/aws-sdk-rds/event_subscription.rb +35 -22
- data/lib/aws-sdk-rds/resource.rb +46 -35
- data/lib/aws-sdk-rds/types.rb +202 -117
- 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: ca81309eba6d6d7895733a8a3598a4b1bd0892ebd91d803a96293fa8881d64ac
|
4
|
+
data.tar.gz: 2449ec61bda3861a90e1d47b09ecd77f8c1026b9c452eec356223a9e76d41fec
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ccc8a9d9a080f3c3e2a88d706cc0195398c6939aa6d53bf47f8888b4c9ddd9679ac393b1c5eae45fbc0efb378fe534d629c8638649dfafe6812502bf363a7e03
|
7
|
+
data.tar.gz: fcf747e0cb3be2f0e9b6fcf05949de13e6e4db04dd59c863b9beba17df6ebc30e0a140bd704034d0609bfc88fb0a614c3ad99ce7d694b0fd803475f5c34a26ef
|
data/lib/aws-sdk-rds.rb
CHANGED
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -410,17 +410,23 @@ module Aws::RDS
|
|
410
410
|
#
|
411
411
|
# Constraints:
|
412
412
|
#
|
413
|
-
# * If the source type is a DB instance,
|
413
|
+
# * If the source type is a DB instance, a `DBInstanceIdentifier` value
|
414
414
|
# must be supplied.
|
415
415
|
#
|
416
|
-
# * If the source type is a DB
|
416
|
+
# * If the source type is a DB cluster, a `DBClusterIdentifier` value
|
417
417
|
# must be supplied.
|
418
418
|
#
|
419
419
|
# * If the source type is a DB parameter group, a `DBParameterGroupName`
|
420
|
+
# value must be supplied.
|
421
|
+
#
|
422
|
+
# * If the source type is a DB security group, a `DBSecurityGroupName`
|
423
|
+
# value must be supplied.
|
424
|
+
#
|
425
|
+
# * If the source type is a DB snapshot, a `DBSnapshotIdentifier` value
|
420
426
|
# must be supplied.
|
421
427
|
#
|
422
|
-
# * If the source type is a DB snapshot, a
|
423
|
-
# be supplied.
|
428
|
+
# * If the source type is a DB cluster snapshot, a
|
429
|
+
# `DBClusterSnapshotIdentifier` value must be supplied.
|
424
430
|
#
|
425
431
|
# @return [Types::AddSourceIdentifierToSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
426
432
|
#
|
@@ -2719,6 +2725,9 @@ module Aws::RDS
|
|
2719
2725
|
#
|
2720
2726
|
# * Must contain 1 to 64 letters or numbers.
|
2721
2727
|
#
|
2728
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
2729
|
+
# underscores, or digits (0-9).
|
2730
|
+
#
|
2722
2731
|
# * Can't be a word reserved by the specified database engine
|
2723
2732
|
#
|
2724
2733
|
# **MariaDB**
|
@@ -2731,6 +2740,9 @@ module Aws::RDS
|
|
2731
2740
|
#
|
2732
2741
|
# * Must contain 1 to 64 letters or numbers.
|
2733
2742
|
#
|
2743
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
2744
|
+
# underscores, or digits (0-9).
|
2745
|
+
#
|
2734
2746
|
# * Can't be a word reserved by the specified database engine
|
2735
2747
|
#
|
2736
2748
|
# **PostgreSQL**
|
@@ -2743,8 +2755,8 @@ module Aws::RDS
|
|
2743
2755
|
#
|
2744
2756
|
# * Must contain 1 to 63 letters, numbers, or underscores.
|
2745
2757
|
#
|
2746
|
-
# * Must begin with a letter
|
2747
|
-
#
|
2758
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
2759
|
+
# underscores, or digits (0-9).
|
2748
2760
|
#
|
2749
2761
|
# * Can't be a word reserved by the specified database engine
|
2750
2762
|
#
|
@@ -3386,24 +3398,15 @@ module Aws::RDS
|
|
3386
3398
|
#
|
3387
3399
|
# @option params [String] :domain
|
3388
3400
|
# The Active Directory directory ID to create the DB instance in.
|
3389
|
-
# Currently, only Microsoft SQL Server and
|
3390
|
-
# created in an Active Directory Domain.
|
3401
|
+
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
3402
|
+
# instances can be created in an Active Directory Domain.
|
3391
3403
|
#
|
3392
|
-
# For
|
3393
|
-
# Authentication to authenticate users that connect to the DB instance.
|
3394
|
-
# For more information, see [ Using Windows Authentication with an
|
3395
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
3404
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
3396
3405
|
# RDS User Guide*.
|
3397
3406
|
#
|
3398
|
-
# For Oracle DB instances, Amazon RDS can use Kerberos Authentication to
|
3399
|
-
# authenticate users that connect to the DB instance. For more
|
3400
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
3401
|
-
# Oracle][2] in the *Amazon RDS User Guide*.
|
3402
3407
|
#
|
3403
3408
|
#
|
3404
|
-
#
|
3405
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
3406
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
3409
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
3407
3410
|
#
|
3408
3411
|
# @option params [Boolean] :copy_tags_to_snapshot
|
3409
3412
|
# A value that indicates whether to copy tags from the DB instance to
|
@@ -3712,6 +3715,7 @@ module Aws::RDS
|
|
3712
3715
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
3713
3716
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
3714
3717
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
3718
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
3715
3719
|
# resp.db_instance.license_model #=> String
|
3716
3720
|
# resp.db_instance.iops #=> Integer
|
3717
3721
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -4162,27 +4166,42 @@ module Aws::RDS
|
|
4162
4166
|
#
|
4163
4167
|
# @option params [String] :domain
|
4164
4168
|
# The Active Directory directory ID to create the DB instance in.
|
4169
|
+
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
4170
|
+
# instances can be created in an Active Directory Domain.
|
4165
4171
|
#
|
4166
|
-
# For
|
4167
|
-
# authenticate users that connect to the DB instance. For more
|
4168
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
4169
|
-
# Oracle][1] in the *Amazon RDS User Guide*.
|
4170
|
-
#
|
4171
|
-
# For Microsoft SQL Server DB instances, Amazon RDS can use Windows
|
4172
|
-
# Authentication to authenticate users that connect to the DB instance.
|
4173
|
-
# For more information, see [ Using Windows Authentication with an
|
4174
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][2] in the *Amazon
|
4172
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
4175
4173
|
# RDS User Guide*.
|
4176
4174
|
#
|
4177
4175
|
#
|
4178
4176
|
#
|
4179
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
4180
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
4177
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
4181
4178
|
#
|
4182
4179
|
# @option params [String] :domain_iam_role_name
|
4183
4180
|
# Specify the name of the IAM role to be used when making API calls to
|
4184
4181
|
# the Directory Service.
|
4185
4182
|
#
|
4183
|
+
# @option params [String] :replica_mode
|
4184
|
+
# The open mode of the replica database: mounted or read-only.
|
4185
|
+
#
|
4186
|
+
# <note markdown="1"> This parameter is only supported for Oracle DB instances.
|
4187
|
+
#
|
4188
|
+
# </note>
|
4189
|
+
#
|
4190
|
+
# Mounted DB replicas are included in Oracle Enterprise Edition. The
|
4191
|
+
# main use case for mounted replicas is cross-Region disaster recovery.
|
4192
|
+
# The primary database doesn't use Active Data Guard to transmit
|
4193
|
+
# information to the mounted replica. Because it doesn't accept user
|
4194
|
+
# connections, a mounted replica can't serve a read-only workload.
|
4195
|
+
#
|
4196
|
+
# You can create a combination of mounted and read-only DB replicas for
|
4197
|
+
# the same primary DB instance. For more information, see [Working with
|
4198
|
+
# Oracle Read Replicas for Amazon RDS][1] in the *Amazon RDS User
|
4199
|
+
# Guide*.
|
4200
|
+
#
|
4201
|
+
#
|
4202
|
+
#
|
4203
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
4204
|
+
#
|
4186
4205
|
# @option params [String] :source_region
|
4187
4206
|
# The source region of the snapshot. This is only needed when the
|
4188
4207
|
# shapshot is encrypted and in a different region.
|
@@ -4261,6 +4280,7 @@ module Aws::RDS
|
|
4261
4280
|
# deletion_protection: false,
|
4262
4281
|
# domain: "String",
|
4263
4282
|
# domain_iam_role_name: "String",
|
4283
|
+
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
4264
4284
|
# source_region: "String",
|
4265
4285
|
# })
|
4266
4286
|
#
|
@@ -4329,6 +4349,7 @@ module Aws::RDS
|
|
4329
4349
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
4330
4350
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
4331
4351
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
4352
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
4332
4353
|
# resp.db_instance.license_model #=> String
|
4333
4354
|
# resp.db_instance.iops #=> Integer
|
4334
4355
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -4908,21 +4929,22 @@ module Aws::RDS
|
|
4908
4929
|
# create a topic in Amazon SNS and subscribe to the topic. The ARN is
|
4909
4930
|
# displayed in the SNS console.
|
4910
4931
|
#
|
4911
|
-
# You can specify the type of source (SourceType) you want to be
|
4912
|
-
# notified of
|
4913
|
-
# the events
|
4914
|
-
# for events you want to be notified of. For
|
4915
|
-
# SourceType = db-instance
|
4916
|
-
# EventCategories =
|
4917
|
-
#
|
4918
|
-
#
|
4919
|
-
#
|
4920
|
-
#
|
4921
|
-
#
|
4922
|
-
#
|
4923
|
-
#
|
4924
|
-
#
|
4925
|
-
#
|
4932
|
+
# You can specify the type of source (`SourceType`) that you want to be
|
4933
|
+
# notified of and provide a list of RDS sources (`SourceIds`) that
|
4934
|
+
# triggers the events. You can also provide a list of event categories
|
4935
|
+
# (`EventCategories`) for events that you want to be notified of. For
|
4936
|
+
# example, you can specify `SourceType` = `db-instance`, `SourceIds` =
|
4937
|
+
# `mydbinstance1`, `mydbinstance2` and `EventCategories` =
|
4938
|
+
# `Availability`, `Backup`.
|
4939
|
+
#
|
4940
|
+
# If you specify both the `SourceType` and `SourceIds`, such as
|
4941
|
+
# `SourceType` = `db-instance` and `SourceIdentifier` = `myDBInstance1`,
|
4942
|
+
# you are notified of all the `db-instance` events for the specified
|
4943
|
+
# source. If you specify a `SourceType` but do not specify a
|
4944
|
+
# `SourceIdentifier`, you receive notice of the events for that source
|
4945
|
+
# type for all your RDS sources. If you don't specify either the
|
4946
|
+
# SourceType or the `SourceIdentifier`, you are notified of events
|
4947
|
+
# generated from all RDS sources belonging to your customer account.
|
4926
4948
|
#
|
4927
4949
|
# <note markdown="1"> RDS event notification is only available for unencrypted SNS topics.
|
4928
4950
|
# If you specify an encrypted SNS topic, event notifications aren't
|
@@ -4942,18 +4964,18 @@ module Aws::RDS
|
|
4942
4964
|
#
|
4943
4965
|
# @option params [String] :source_type
|
4944
4966
|
# The type of source that is generating the events. For example, if you
|
4945
|
-
# want to be notified of events generated by a DB instance, you
|
4946
|
-
#
|
4947
|
-
#
|
4967
|
+
# want to be notified of events generated by a DB instance, you set this
|
4968
|
+
# parameter to `db-instance`. If this value isn't specified, all events
|
4969
|
+
# are returned.
|
4948
4970
|
#
|
4949
4971
|
# Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
4950
4972
|
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
|
4951
4973
|
#
|
4952
4974
|
# @option params [Array<String>] :event_categories
|
4953
|
-
# A list of event categories for a
|
4954
|
-
# to. You can see a list of the categories
|
4955
|
-
# [Events][1]
|
4956
|
-
#
|
4975
|
+
# A list of event categories for a particular source type (`SourceType`)
|
4976
|
+
# that you want to subscribe to. You can see a list of the categories
|
4977
|
+
# for a given source type in [Events][1] in the *Amazon RDS User Guide*
|
4978
|
+
# or by using the `DescribeEventCategories` operation.
|
4957
4979
|
#
|
4958
4980
|
#
|
4959
4981
|
#
|
@@ -4968,19 +4990,26 @@ module Aws::RDS
|
|
4968
4990
|
#
|
4969
4991
|
# Constraints:
|
4970
4992
|
#
|
4971
|
-
# * If SourceIds
|
4993
|
+
# * If a `SourceIds` value is supplied, `SourceType` must also be
|
4994
|
+
# provided.
|
4972
4995
|
#
|
4973
|
-
# * If the source type is a DB instance,
|
4996
|
+
# * If the source type is a DB instance, a `DBInstanceIdentifier` value
|
4974
4997
|
# must be supplied.
|
4975
4998
|
#
|
4976
|
-
# * If the source type is a DB
|
4999
|
+
# * If the source type is a DB cluster, a `DBClusterIdentifier` value
|
4977
5000
|
# must be supplied.
|
4978
5001
|
#
|
4979
5002
|
# * If the source type is a DB parameter group, a `DBParameterGroupName`
|
5003
|
+
# value must be supplied.
|
5004
|
+
#
|
5005
|
+
# * If the source type is a DB security group, a `DBSecurityGroupName`
|
5006
|
+
# value must be supplied.
|
5007
|
+
#
|
5008
|
+
# * If the source type is a DB snapshot, a `DBSnapshotIdentifier` value
|
4980
5009
|
# must be supplied.
|
4981
5010
|
#
|
4982
|
-
# * If the source type is a DB snapshot, a
|
4983
|
-
# be supplied.
|
5011
|
+
# * If the source type is a DB cluster snapshot, a
|
5012
|
+
# `DBClusterSnapshotIdentifier` value must be supplied.
|
4984
5013
|
#
|
4985
5014
|
# @option params [Boolean] :enabled
|
4986
5015
|
# A value that indicates whether to activate the subscription. If the
|
@@ -5845,6 +5874,7 @@ module Aws::RDS
|
|
5845
5874
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
5846
5875
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
5847
5876
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
5877
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
5848
5878
|
# resp.db_instance.license_model #=> String
|
5849
5879
|
# resp.db_instance.iops #=> Integer
|
5850
5880
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -6798,7 +6828,7 @@ module Aws::RDS
|
|
6798
6828
|
# `writer`, `custom`. `Values` for the `db-cluster-endpoint-custom-type`
|
6799
6829
|
# filter can be one or more of: `reader`, `any`. `Values` for the
|
6800
6830
|
# `db-cluster-endpoint-status` filter can be one or more of:
|
6801
|
-
# `available`, `creating`, `deleting`, `modifying`.
|
6831
|
+
# `available`, `creating`, `deleting`, `inactive`, `modifying`.
|
6802
6832
|
#
|
6803
6833
|
# @option params [Integer] :max_records
|
6804
6834
|
# The maximum number of records to include in the response. If more
|
@@ -7942,6 +7972,7 @@ module Aws::RDS
|
|
7942
7972
|
# resp.db_instances[0].read_replica_db_instance_identifiers[0] #=> String
|
7943
7973
|
# resp.db_instances[0].read_replica_db_cluster_identifiers #=> Array
|
7944
7974
|
# resp.db_instances[0].read_replica_db_cluster_identifiers[0] #=> String
|
7975
|
+
# resp.db_instances[0].replica_mode #=> String, one of "open-read-only", "mounted"
|
7945
7976
|
# resp.db_instances[0].license_model #=> String
|
7946
7977
|
# resp.db_instances[0].iops #=> Integer
|
7947
7978
|
# resp.db_instances[0].option_group_memberships #=> Array
|
@@ -9147,8 +9178,8 @@ module Aws::RDS
|
|
9147
9178
|
|
9148
9179
|
# Displays a list of categories for all event source types, or, if
|
9149
9180
|
# specified, for a specified source type. You can see a list of the
|
9150
|
-
# event categories and source types in
|
9151
|
-
#
|
9181
|
+
# event categories and source types in [ Events][1] in the *Amazon RDS
|
9182
|
+
# User Guide.*
|
9152
9183
|
#
|
9153
9184
|
#
|
9154
9185
|
#
|
@@ -9157,8 +9188,8 @@ module Aws::RDS
|
|
9157
9188
|
# @option params [String] :source_type
|
9158
9189
|
# The type of source that is generating the events.
|
9159
9190
|
#
|
9160
|
-
# Valid values: db-instance \| db-
|
9161
|
-
# \| db-snapshot
|
9191
|
+
# Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
9192
|
+
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
|
9162
9193
|
#
|
9163
9194
|
# @option params [Array<Types::Filter>] :filters
|
9164
9195
|
# This parameter isn't currently supported.
|
@@ -9209,10 +9240,11 @@ module Aws::RDS
|
|
9209
9240
|
end
|
9210
9241
|
|
9211
9242
|
# Lists all the subscription descriptions for a customer account. The
|
9212
|
-
# description for a subscription includes SubscriptionName
|
9213
|
-
# CustomerID
|
9243
|
+
# description for a subscription includes `SubscriptionName`,
|
9244
|
+
# `SNSTopicARN`, `CustomerID`, `SourceType`, `SourceID`, `CreationTime`,
|
9245
|
+
# and `Status`.
|
9214
9246
|
#
|
9215
|
-
# If you specify a SubscriptionName
|
9247
|
+
# If you specify a `SubscriptionName`, lists the description for that
|
9216
9248
|
# subscription.
|
9217
9249
|
#
|
9218
9250
|
# @option params [String] :subscription_name
|
@@ -9298,11 +9330,12 @@ module Aws::RDS
|
|
9298
9330
|
req.send_request(options)
|
9299
9331
|
end
|
9300
9332
|
|
9301
|
-
# Returns events related to DB instances, DB
|
9302
|
-
#
|
9303
|
-
# specific to a particular DB
|
9304
|
-
#
|
9305
|
-
#
|
9333
|
+
# Returns events related to DB instances, DB clusters, DB parameter
|
9334
|
+
# groups, DB security groups, DB snapshots, and DB cluster snapshots for
|
9335
|
+
# the past 14 days. Events specific to a particular DB instances, DB
|
9336
|
+
# clusters, DB parameter groups, DB security groups, DB snapshots, and
|
9337
|
+
# DB cluster snapshots group can be obtained by providing the name as a
|
9338
|
+
# parameter. By default, the past hour of events are returned.
|
9306
9339
|
#
|
9307
9340
|
# @option params [String] :source_identifier
|
9308
9341
|
# The identifier of the event source for which events are returned. If
|
@@ -9310,19 +9343,26 @@ module Aws::RDS
|
|
9310
9343
|
#
|
9311
9344
|
# Constraints:
|
9312
9345
|
#
|
9313
|
-
# * If SourceIdentifier is supplied, SourceType must also be
|
9346
|
+
# * If `SourceIdentifier` is supplied, `SourceType` must also be
|
9347
|
+
# provided.
|
9314
9348
|
#
|
9315
|
-
# * If the source type is
|
9349
|
+
# * If the source type is a DB instance, a `DBInstanceIdentifier` value
|
9316
9350
|
# must be supplied.
|
9317
9351
|
#
|
9318
|
-
# * If the source type is
|
9352
|
+
# * If the source type is a DB cluster, a `DBClusterIdentifier` value
|
9319
9353
|
# must be supplied.
|
9320
9354
|
#
|
9321
|
-
# * If the source type is
|
9355
|
+
# * If the source type is a DB parameter group, a `DBParameterGroupName`
|
9356
|
+
# value must be supplied.
|
9357
|
+
#
|
9358
|
+
# * If the source type is a DB security group, a `DBSecurityGroupName`
|
9359
|
+
# value must be supplied.
|
9360
|
+
#
|
9361
|
+
# * If the source type is a DB snapshot, a `DBSnapshotIdentifier` value
|
9322
9362
|
# must be supplied.
|
9323
9363
|
#
|
9324
|
-
# * If the source type is
|
9325
|
-
# supplied.
|
9364
|
+
# * If the source type is a DB cluster snapshot, a
|
9365
|
+
# `DBClusterSnapshotIdentifier` value must be supplied.
|
9326
9366
|
#
|
9327
9367
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
9328
9368
|
#
|
@@ -11447,6 +11487,13 @@ module Aws::RDS
|
|
11447
11487
|
# `none` to remove the cluster from its current domain. The domain must
|
11448
11488
|
# be created prior to this operation.
|
11449
11489
|
#
|
11490
|
+
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
11491
|
+
# Aurora User Guide*.
|
11492
|
+
#
|
11493
|
+
#
|
11494
|
+
#
|
11495
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
11496
|
+
#
|
11450
11497
|
# @option params [String] :domain_iam_role_name
|
11451
11498
|
# Specify the name of the IAM role to be used when making API calls to
|
11452
11499
|
# the Directory Service.
|
@@ -12325,25 +12372,16 @@ module Aws::RDS
|
|
12325
12372
|
# @option params [String] :domain
|
12326
12373
|
# The Active Directory directory ID to move the DB instance to. Specify
|
12327
12374
|
# `none` to remove the instance from its current domain. The domain must
|
12328
|
-
# be created prior to this operation. Currently, only Microsoft
|
12329
|
-
# Server and
|
12330
|
-
# Domain.
|
12331
|
-
#
|
12332
|
-
# For Microsoft SQL Server DB instances, Amazon RDS can use Windows
|
12333
|
-
# Authentication to authenticate users that connect to the DB instance.
|
12334
|
-
# For more information, see [ Using Windows Authentication with an
|
12335
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
12336
|
-
# RDS User Guide*.
|
12375
|
+
# be created prior to this operation. Currently, only MySQL, Microsoft
|
12376
|
+
# SQL Server, Oracle, and PostgreSQL DB instances can be created in an
|
12377
|
+
# Active Directory Domain.
|
12337
12378
|
#
|
12338
|
-
# For
|
12339
|
-
#
|
12340
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
12341
|
-
# Oracle][2] in the *Amazon RDS User Guide*.
|
12379
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
12380
|
+
# RDS User Guide*.
|
12342
12381
|
#
|
12343
12382
|
#
|
12344
12383
|
#
|
12345
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
12346
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
12384
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
12347
12385
|
#
|
12348
12386
|
# @option params [Boolean] :copy_tags_to_snapshot
|
12349
12387
|
# A value that indicates whether to copy all tags from the DB instance
|
@@ -12563,6 +12601,26 @@ module Aws::RDS
|
|
12563
12601
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
12564
12602
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
12565
12603
|
#
|
12604
|
+
# @option params [String] :replica_mode
|
12605
|
+
# A value that sets the open mode of a replica database to either
|
12606
|
+
# mounted or read-only.
|
12607
|
+
#
|
12608
|
+
# <note markdown="1"> Currently, this parameter is only supported for Oracle DB instances.
|
12609
|
+
#
|
12610
|
+
# </note>
|
12611
|
+
#
|
12612
|
+
# Mounted DB replicas are included in Oracle Enterprise Edition. The
|
12613
|
+
# main use case for mounted replicas is cross-Region disaster recovery.
|
12614
|
+
# The primary database doesn't use Active Data Guard to transmit
|
12615
|
+
# information to the mounted replica. Because it doesn't accept user
|
12616
|
+
# connections, a mounted replica can't serve a read-only workload. For
|
12617
|
+
# more information, see [Working with Oracle Read Replicas for Amazon
|
12618
|
+
# RDS][1] in the *Amazon RDS User Guide*.
|
12619
|
+
#
|
12620
|
+
#
|
12621
|
+
#
|
12622
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
12623
|
+
#
|
12566
12624
|
# @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12567
12625
|
#
|
12568
12626
|
# * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance
|
@@ -12642,6 +12700,7 @@ module Aws::RDS
|
|
12642
12700
|
# deletion_protection: false,
|
12643
12701
|
# max_allocated_storage: 1,
|
12644
12702
|
# certificate_rotation_restart: false,
|
12703
|
+
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
12645
12704
|
# })
|
12646
12705
|
#
|
12647
12706
|
# @example Response structure
|
@@ -12709,6 +12768,7 @@ module Aws::RDS
|
|
12709
12768
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
12710
12769
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
12711
12770
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
12771
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
12712
12772
|
# resp.db_instance.license_model #=> String
|
12713
12773
|
# resp.db_instance.iops #=> Integer
|
12714
12774
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -13331,9 +13391,9 @@ module Aws::RDS
|
|
13331
13391
|
# `AddSourceIdentifierToSubscription` and
|
13332
13392
|
# `RemoveSourceIdentifierFromSubscription` calls.
|
13333
13393
|
#
|
13334
|
-
# You can see a list of the event categories for a given
|
13335
|
-
#
|
13336
|
-
#
|
13394
|
+
# You can see a list of the event categories for a given source type
|
13395
|
+
# (`SourceType`) in [Events][1] in the *Amazon RDS User Guide* or by
|
13396
|
+
# using the `DescribeEventCategories` operation.
|
13337
13397
|
#
|
13338
13398
|
#
|
13339
13399
|
#
|
@@ -13353,14 +13413,14 @@ module Aws::RDS
|
|
13353
13413
|
# set this parameter to db-instance. If this value isn't specified, all
|
13354
13414
|
# events are returned.
|
13355
13415
|
#
|
13356
|
-
# Valid values: db-instance \| db-
|
13357
|
-
# \| db-snapshot
|
13416
|
+
# Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
13417
|
+
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
|
13358
13418
|
#
|
13359
13419
|
# @option params [Array<String>] :event_categories
|
13360
|
-
# A list of event categories for a SourceType that you
|
13361
|
-
# to. You can see a list of the categories for a given
|
13362
|
-
# [Events][1]
|
13363
|
-
#
|
13420
|
+
# A list of event categories for a source type (`SourceType`) that you
|
13421
|
+
# want to subscribe to. You can see a list of the categories for a given
|
13422
|
+
# source type in [Events][1] in the *Amazon RDS User Guide* or by using
|
13423
|
+
# the `DescribeEventCategories` operation.
|
13364
13424
|
#
|
13365
13425
|
#
|
13366
13426
|
#
|
@@ -13792,6 +13852,7 @@ module Aws::RDS
|
|
13792
13852
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
13793
13853
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
13794
13854
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
13855
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
13795
13856
|
# resp.db_instance.license_model #=> String
|
13796
13857
|
# resp.db_instance.iops #=> Integer
|
13797
13858
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -14184,6 +14245,7 @@ module Aws::RDS
|
|
14184
14245
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
14185
14246
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
14186
14247
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
14248
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
14187
14249
|
# resp.db_instance.license_model #=> String
|
14188
14250
|
# resp.db_instance.iops #=> Integer
|
14189
14251
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -14739,11 +14801,11 @@ module Aws::RDS
|
|
14739
14801
|
req.send_request(options)
|
14740
14802
|
end
|
14741
14803
|
|
14742
|
-
# Creates an Amazon Aurora DB cluster from data stored in an
|
14743
|
-
# bucket. Amazon RDS must be authorized to access the Amazon
|
14744
|
-
# and the data must be created using the Percona XtraBackup
|
14745
|
-
# described in [ Migrating Data
|
14746
|
-
# in the *Amazon Aurora User Guide*.
|
14804
|
+
# Creates an Amazon Aurora DB cluster from MySQL data stored in an
|
14805
|
+
# Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon
|
14806
|
+
# S3 bucket and the data must be created using the Percona XtraBackup
|
14807
|
+
# utility as described in [ Migrating Data from MySQL by Using an Amazon
|
14808
|
+
# S3 Bucket][1] in the *Amazon Aurora User Guide*.
|
14747
14809
|
#
|
14748
14810
|
# <note markdown="1"> This action only restores the DB cluster, not the DB instances for
|
14749
14811
|
# that DB cluster. You must invoke the `CreateDBInstance` action to
|
@@ -14757,13 +14819,14 @@ module Aws::RDS
|
|
14757
14819
|
# For more information on Amazon Aurora, see [ What Is Amazon
|
14758
14820
|
# Aurora?][2] in the *Amazon Aurora User Guide.*
|
14759
14821
|
#
|
14760
|
-
# <note markdown="1"> This action only applies to Aurora DB clusters.
|
14822
|
+
# <note markdown="1"> This action only applies to Aurora DB clusters. The source DB engine
|
14823
|
+
# must be MySQL.
|
14761
14824
|
#
|
14762
14825
|
# </note>
|
14763
14826
|
#
|
14764
14827
|
#
|
14765
14828
|
#
|
14766
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.html
|
14829
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3
|
14767
14830
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
|
14768
14831
|
#
|
14769
14832
|
# @option params [Array<String>] :availability_zones
|
@@ -14828,10 +14891,11 @@ module Aws::RDS
|
|
14828
14891
|
# Example: `mySubnetgroup`
|
14829
14892
|
#
|
14830
14893
|
# @option params [required, String] :engine
|
14831
|
-
# The name of the database engine to be used for
|
14832
|
-
# cluster.
|
14894
|
+
# The name of the database engine to be used for this DB cluster.
|
14833
14895
|
#
|
14834
|
-
# Valid Values: `aurora
|
14896
|
+
# Valid Values: `aurora` (for MySQL 5.6-compatible Aurora),
|
14897
|
+
# `aurora-mysql` (for MySQL 5.7-compatible Aurora), and
|
14898
|
+
# `aurora-postgresql`
|
14835
14899
|
#
|
14836
14900
|
# @option params [String] :engine_version
|
14837
14901
|
# The version number of the database engine to use.
|
@@ -14986,7 +15050,7 @@ module Aws::RDS
|
|
14986
15050
|
#
|
14987
15051
|
# MySQL versions 5.5, 5.6, and 5.7 are supported.
|
14988
15052
|
#
|
14989
|
-
# Example: `5.6.40`
|
15053
|
+
# Example: `5.6.40`, `5.7.28`
|
14990
15054
|
#
|
14991
15055
|
# @option params [required, String] :s3_bucket_name
|
14992
15056
|
# The name of the Amazon S3 bucket that contains the data used to create
|
@@ -15414,7 +15478,16 @@ module Aws::RDS
|
|
15414
15478
|
#
|
15415
15479
|
# @option params [String] :domain
|
15416
15480
|
# Specify the Active Directory directory ID to restore the DB cluster
|
15417
|
-
# in. The domain must be created prior to this operation.
|
15481
|
+
# in. The domain must be created prior to this operation. Currently,
|
15482
|
+
# only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
|
15483
|
+
# can be created in an Active Directory Domain.
|
15484
|
+
#
|
15485
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
15486
|
+
# RDS User Guide*.
|
15487
|
+
#
|
15488
|
+
#
|
15489
|
+
#
|
15490
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
15418
15491
|
#
|
15419
15492
|
# @option params [String] :domain_iam_role_name
|
15420
15493
|
# Specify the name of the IAM role to be used when making API calls to
|
@@ -16164,24 +16237,15 @@ module Aws::RDS
|
|
16164
16237
|
# @option params [String] :domain
|
16165
16238
|
# Specify the Active Directory directory ID to restore the DB instance
|
16166
16239
|
# in. The domain must be created prior to this operation. Currently,
|
16167
|
-
# only Microsoft SQL Server and
|
16168
|
-
# Active Directory Domain.
|
16240
|
+
# only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
|
16241
|
+
# can be created in an Active Directory Domain.
|
16169
16242
|
#
|
16170
|
-
# For
|
16171
|
-
# Authentication to authenticate users that connect to the DB instance.
|
16172
|
-
# For more information, see [ Using Windows Authentication with an
|
16173
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
16243
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
16174
16244
|
# RDS User Guide*.
|
16175
16245
|
#
|
16176
|
-
# For Oracle DB instances, Amazon RDS can use Kerberos authentication to
|
16177
|
-
# authenticate users that connect to the DB instance. For more
|
16178
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
16179
|
-
# Oracle][2] in the *Amazon RDS User Guide*.
|
16180
16246
|
#
|
16181
16247
|
#
|
16182
|
-
#
|
16183
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
16184
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
16248
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
16185
16249
|
#
|
16186
16250
|
# @option params [Boolean] :copy_tags_to_snapshot
|
16187
16251
|
# A value that indicates whether to copy all tags from the restored DB
|
@@ -16457,6 +16521,7 @@ module Aws::RDS
|
|
16457
16521
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
16458
16522
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
16459
16523
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
16524
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
16460
16525
|
# resp.db_instance.license_model #=> String
|
16461
16526
|
# resp.db_instance.iops #=> Integer
|
16462
16527
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -17015,6 +17080,7 @@ module Aws::RDS
|
|
17015
17080
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
17016
17081
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
17017
17082
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
17083
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
17018
17084
|
# resp.db_instance.license_model #=> String
|
17019
17085
|
# resp.db_instance.iops #=> Integer
|
17020
17086
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -17307,24 +17373,15 @@ module Aws::RDS
|
|
17307
17373
|
# @option params [String] :domain
|
17308
17374
|
# Specify the Active Directory directory ID to restore the DB instance
|
17309
17375
|
# in. The domain must be created prior to this operation. Currently,
|
17310
|
-
# only Microsoft SQL Server and
|
17311
|
-
# Active Directory Domain.
|
17376
|
+
# only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
|
17377
|
+
# can be created in an Active Directory Domain.
|
17312
17378
|
#
|
17313
|
-
# For
|
17314
|
-
# Authentication to authenticate users that connect to the DB instance.
|
17315
|
-
# For more information, see [ Using Windows Authentication with an
|
17316
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
17379
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
17317
17380
|
# RDS User Guide*.
|
17318
17381
|
#
|
17319
|
-
# For Oracle DB instances, Amazon RDS can use Kerberos authentication to
|
17320
|
-
# authenticate users that connect to the DB instance. For more
|
17321
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
17322
|
-
# Oracle][2] in the *Amazon RDS User Guide*.
|
17323
17382
|
#
|
17324
17383
|
#
|
17325
|
-
#
|
17326
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
17327
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
17384
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
17328
17385
|
#
|
17329
17386
|
# @option params [String] :domain_iam_role_name
|
17330
17387
|
# Specify the name of the IAM role to be used when making API calls to
|
@@ -17602,6 +17659,7 @@ module Aws::RDS
|
|
17602
17659
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
17603
17660
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
17604
17661
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
17662
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
17605
17663
|
# resp.db_instance.license_model #=> String
|
17606
17664
|
# resp.db_instance.iops #=> Integer
|
17607
17665
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -18026,6 +18084,7 @@ module Aws::RDS
|
|
18026
18084
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
18027
18085
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
18028
18086
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
18087
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
18029
18088
|
# resp.db_instance.license_model #=> String
|
18030
18089
|
# resp.db_instance.iops #=> Integer
|
18031
18090
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -18109,8 +18168,26 @@ module Aws::RDS
|
|
18109
18168
|
# The ID of the AWS KMS key to use to encrypt the snapshot exported to
|
18110
18169
|
# Amazon S3. The KMS key ID is the Amazon Resource Name (ARN), the KMS
|
18111
18170
|
# key identifier, or the KMS key alias for the KMS encryption key. The
|
18112
|
-
#
|
18113
|
-
#
|
18171
|
+
# caller of this operation must be authorized to execute the following
|
18172
|
+
# operations. These can be set in the KMS key policy:
|
18173
|
+
#
|
18174
|
+
# * GrantOperation.Encrypt
|
18175
|
+
#
|
18176
|
+
# * GrantOperation.Decrypt
|
18177
|
+
#
|
18178
|
+
# * GrantOperation.GenerateDataKey
|
18179
|
+
#
|
18180
|
+
# * GrantOperation.GenerateDataKeyWithoutPlaintext
|
18181
|
+
#
|
18182
|
+
# * GrantOperation.ReEncryptFrom
|
18183
|
+
#
|
18184
|
+
# * GrantOperation.ReEncryptTo
|
18185
|
+
#
|
18186
|
+
# * GrantOperation.CreateGrant
|
18187
|
+
#
|
18188
|
+
# * GrantOperation.DescribeKey
|
18189
|
+
#
|
18190
|
+
# * GrantOperation.RetireGrant
|
18114
18191
|
#
|
18115
18192
|
# @option params [String] :s3_prefix
|
18116
18193
|
# The Amazon S3 bucket prefix to use as the file name and path of the
|
@@ -18462,6 +18539,7 @@ module Aws::RDS
|
|
18462
18539
|
# resp.db_instance.read_replica_db_instance_identifiers[0] #=> String
|
18463
18540
|
# resp.db_instance.read_replica_db_cluster_identifiers #=> Array
|
18464
18541
|
# resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String
|
18542
|
+
# resp.db_instance.replica_mode #=> String, one of "open-read-only", "mounted"
|
18465
18543
|
# resp.db_instance.license_model #=> String
|
18466
18544
|
# resp.db_instance.iops #=> Integer
|
18467
18545
|
# resp.db_instance.option_group_memberships #=> Array
|
@@ -18536,7 +18614,7 @@ module Aws::RDS
|
|
18536
18614
|
params: params,
|
18537
18615
|
config: config)
|
18538
18616
|
context[:gem_name] = 'aws-sdk-rds'
|
18539
|
-
context[:gem_version] = '1.
|
18617
|
+
context[:gem_version] = '1.96.0'
|
18540
18618
|
Seahorse::Client::Request.new(handlers, context)
|
18541
18619
|
end
|
18542
18620
|
|