aws-sdk-docdb 1.12.0 → 1.17.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 +5 -5
- data/lib/aws-sdk-docdb.rb +7 -4
- data/lib/aws-sdk-docdb/client.rb +456 -397
- data/lib/aws-sdk-docdb/client_api.rb +88 -0
- data/lib/aws-sdk-docdb/errors.rb +506 -0
- data/lib/aws-sdk-docdb/resource.rb +1 -0
- data/lib/aws-sdk-docdb/types.rb +716 -445
- data/lib/aws-sdk-docdb/waiters.rb +62 -0
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 9237f122da5761584067196772152326b8375b79cfe0b7b8cb8a682f6cdfcc80
|
4
|
+
data.tar.gz: 654777f391483057f4ad083b1d631a2130af58c3d72428ecb8110c04cabe739e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5b6a314f2c7a43405a2a9c3d17dc952eb3ab3f69547c97d9a08bd8f24cd9e22f7afccccaf15ccff9242495d18f80f385e461fd06149311392d4f941d3d9df7e6
|
7
|
+
data.tar.gz: b315688394c5b50dd40133987e35c1eeafb1e3e033647d1e982770eeb9048e1ba79d076447dd069b84997d2d962326c94c94979f1821df21f1144e9303c0d731
|
data/lib/aws-sdk-docdb.rb
CHANGED
@@ -25,17 +25,20 @@ require_relative 'aws-sdk-docdb/customizations'
|
|
25
25
|
# methods each accept a hash of request parameters and return a response
|
26
26
|
# structure.
|
27
27
|
#
|
28
|
+
# doc_db = Aws::DocDB::Client.new
|
29
|
+
# resp = doc_db.add_tags_to_resource(params)
|
30
|
+
#
|
28
31
|
# See {Client} for more information.
|
29
32
|
#
|
30
33
|
# # Errors
|
31
34
|
#
|
32
|
-
# Errors returned from Amazon DocumentDB with MongoDB compatibility
|
33
|
-
# extend {Errors::ServiceError}.
|
35
|
+
# Errors returned from Amazon DocumentDB with MongoDB compatibility are defined in the
|
36
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
34
37
|
#
|
35
38
|
# begin
|
36
39
|
# # do stuff
|
37
40
|
# rescue Aws::DocDB::Errors::ServiceError
|
38
|
-
# # rescues all
|
41
|
+
# # rescues all Amazon DocumentDB with MongoDB compatibility API errors
|
39
42
|
# end
|
40
43
|
#
|
41
44
|
# See {Errors} for more information.
|
@@ -43,6 +46,6 @@ require_relative 'aws-sdk-docdb/customizations'
|
|
43
46
|
# @service
|
44
47
|
module Aws::DocDB
|
45
48
|
|
46
|
-
GEM_VERSION = '1.
|
49
|
+
GEM_VERSION = '1.17.0'
|
47
50
|
|
48
51
|
end
|
data/lib/aws-sdk-docdb/client.rb
CHANGED
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/query.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:docdb)
|
31
31
|
|
32
32
|
module Aws::DocDB
|
33
|
+
# An API client for DocDB. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::DocDB::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::DocDB
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::DocDB
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::DocDB
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::DocDB
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::DocDB
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::DocDB
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::DocDB
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -209,16 +264,15 @@ module Aws::DocDB
|
|
209
264
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
265
|
#
|
211
266
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
268
|
# `Timeout::Error`.
|
214
269
|
#
|
215
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
271
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
219
273
|
#
|
220
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
222
276
|
# considered stale. Stale connections are closed and removed
|
223
277
|
# from the pool before making a request.
|
224
278
|
#
|
@@ -227,7 +281,7 @@ module Aws::DocDB
|
|
227
281
|
# request body. This option has no effect unless the request has
|
228
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
283
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
284
|
+
# request on the session.
|
231
285
|
#
|
232
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -347,27 +401,26 @@ module Aws::DocDB
|
|
347
401
|
req.send_request(options)
|
348
402
|
end
|
349
403
|
|
350
|
-
# Copies the specified
|
404
|
+
# Copies the specified cluster parameter group.
|
351
405
|
#
|
352
406
|
# @option params [required, String] :source_db_cluster_parameter_group_identifier
|
353
|
-
# The identifier or Amazon Resource Name (ARN) for the source
|
407
|
+
# The identifier or Amazon Resource Name (ARN) for the source cluster
|
354
408
|
# parameter group.
|
355
409
|
#
|
356
410
|
# Constraints:
|
357
411
|
#
|
358
|
-
# * Must specify a valid
|
412
|
+
# * Must specify a valid cluster parameter group.
|
359
413
|
#
|
360
|
-
# * If the source
|
361
|
-
#
|
362
|
-
#
|
414
|
+
# * If the source cluster parameter group is in the same AWS Region as
|
415
|
+
# the copy, specify a valid parameter group identifier; for example,
|
416
|
+
# `my-db-cluster-param-group`, or a valid ARN.
|
363
417
|
#
|
364
|
-
# * If the source
|
365
|
-
#
|
366
|
-
# example,
|
418
|
+
# * If the source parameter group is in a different AWS Region than the
|
419
|
+
# copy, specify a valid cluster parameter group ARN; for example,
|
367
420
|
# `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
|
368
421
|
#
|
369
422
|
# @option params [required, String] :target_db_cluster_parameter_group_identifier
|
370
|
-
# The identifier for the copied
|
423
|
+
# The identifier for the copied cluster parameter group.
|
371
424
|
#
|
372
425
|
# Constraints:
|
373
426
|
#
|
@@ -382,7 +435,7 @@ module Aws::DocDB
|
|
382
435
|
# Example: `my-cluster-param-group1`
|
383
436
|
#
|
384
437
|
# @option params [required, String] :target_db_cluster_parameter_group_description
|
385
|
-
# A description for the copied
|
438
|
+
# A description for the copied cluster parameter group.
|
386
439
|
#
|
387
440
|
# @option params [Array<Types::Tag>] :tags
|
388
441
|
# The tags that are to be assigned to the parameter group.
|
@@ -421,22 +474,22 @@ module Aws::DocDB
|
|
421
474
|
req.send_request(options)
|
422
475
|
end
|
423
476
|
|
424
|
-
# Copies a snapshot of a
|
477
|
+
# Copies a snapshot of a cluster.
|
425
478
|
#
|
426
|
-
# To copy a
|
427
|
-
#
|
428
|
-
#
|
479
|
+
# To copy a cluster snapshot from a shared manual cluster snapshot,
|
480
|
+
# `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name
|
481
|
+
# (ARN) of the shared cluster snapshot.
|
429
482
|
#
|
430
483
|
# To cancel the copy operation after it is in progress, delete the
|
431
|
-
# target
|
484
|
+
# target cluster snapshot identified by
|
432
485
|
# `TargetDBClusterSnapshotIdentifier` while that DB cluster snapshot is
|
433
486
|
# in the *copying* status.
|
434
487
|
#
|
435
488
|
# @option params [required, String] :source_db_cluster_snapshot_identifier
|
436
|
-
# The identifier of the
|
437
|
-
#
|
489
|
+
# The identifier of the cluster snapshot to copy. This parameter is not
|
490
|
+
# case sensitive.
|
438
491
|
#
|
439
|
-
# You can't copy an encrypted, shared
|
492
|
+
# You can't copy an encrypted, shared cluster snapshot from one AWS
|
440
493
|
# Region to another.
|
441
494
|
#
|
442
495
|
# Constraints:
|
@@ -444,16 +497,16 @@ module Aws::DocDB
|
|
444
497
|
# * Must specify a valid system snapshot in the "available" state.
|
445
498
|
#
|
446
499
|
# * If the source snapshot is in the same AWS Region as the copy,
|
447
|
-
# specify a valid
|
500
|
+
# specify a valid snapshot identifier.
|
448
501
|
#
|
449
502
|
# * If the source snapshot is in a different AWS Region than the copy,
|
450
|
-
# specify a valid
|
503
|
+
# specify a valid cluster snapshot ARN.
|
451
504
|
#
|
452
505
|
# Example: `my-cluster-snapshot1`
|
453
506
|
#
|
454
507
|
# @option params [required, String] :target_db_cluster_snapshot_identifier
|
455
|
-
# The identifier of the new
|
456
|
-
#
|
508
|
+
# The identifier of the new cluster snapshot to create from the source
|
509
|
+
# cluster snapshot. This parameter is not case sensitive.
|
457
510
|
#
|
458
511
|
# Constraints:
|
459
512
|
#
|
@@ -466,35 +519,35 @@ module Aws::DocDB
|
|
466
519
|
# Example: `my-cluster-snapshot2`
|
467
520
|
#
|
468
521
|
# @option params [String] :kms_key_id
|
469
|
-
# The AWS KMS key ID for an encrypted
|
470
|
-
#
|
471
|
-
#
|
522
|
+
# The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key
|
523
|
+
# ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the
|
524
|
+
# AWS KMS key alias for the AWS KMS encryption key.
|
472
525
|
#
|
473
|
-
# If you copy an encrypted
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
477
|
-
#
|
526
|
+
# If you copy an encrypted cluster snapshot from your AWS account, you
|
527
|
+
# can specify a value for `KmsKeyId` to encrypt the copy with a new AWS
|
528
|
+
# KMS encryption key. If you don't specify a value for `KmsKeyId`, then
|
529
|
+
# the copy of the cluster snapshot is encrypted with the same AWS KMS
|
530
|
+
# key as the source cluster snapshot.
|
478
531
|
#
|
479
|
-
# If you copy an encrypted
|
480
|
-
#
|
532
|
+
# If you copy an encrypted cluster snapshot that is shared from another
|
533
|
+
# AWS account, then you must specify a value for `KmsKeyId`.
|
481
534
|
#
|
482
|
-
# To copy an encrypted
|
535
|
+
# To copy an encrypted cluster snapshot to another AWS Region, set
|
483
536
|
# `KmsKeyId` to the AWS KMS key ID that you want to use to encrypt the
|
484
|
-
# copy of the
|
537
|
+
# copy of the cluster snapshot in the destination Region. AWS KMS
|
485
538
|
# encryption keys are specific to the AWS Region that they are created
|
486
539
|
# in, and you can't use encryption keys from one Region in another
|
487
540
|
# Region.
|
488
541
|
#
|
489
|
-
# If you copy an unencrypted
|
542
|
+
# If you copy an unencrypted cluster snapshot and specify a value for
|
490
543
|
# the `KmsKeyId` parameter, an error is returned.
|
491
544
|
#
|
492
545
|
# @option params [String] :pre_signed_url
|
493
546
|
# The URL that contains a Signature Version 4 signed request for the
|
494
547
|
# `CopyDBClusterSnapshot` API action in the AWS Region that contains the
|
495
|
-
# source
|
496
|
-
# parameter when copying an encrypted
|
497
|
-
#
|
548
|
+
# source cluster snapshot to copy. You must use the `PreSignedUrl`
|
549
|
+
# parameter when copying an encrypted cluster snapshot from another AWS
|
550
|
+
# Region.
|
498
551
|
#
|
499
552
|
# The presigned URL must be a valid request for the
|
500
553
|
# `CopyDBSClusterSnapshot` API action that can be executed in the source
|
@@ -503,7 +556,7 @@ module Aws::DocDB
|
|
503
556
|
# values:
|
504
557
|
#
|
505
558
|
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
506
|
-
# encrypt the copy of the
|
559
|
+
# encrypt the copy of the cluster snapshot in the destination AWS
|
507
560
|
# Region. This is the same identifier for both the
|
508
561
|
# `CopyDBClusterSnapshot` action that is called in the destination AWS
|
509
562
|
# Region, and the action contained in the presigned URL.
|
@@ -511,22 +564,22 @@ module Aws::DocDB
|
|
511
564
|
# * `DestinationRegion` - The name of the AWS Region that the DB cluster
|
512
565
|
# snapshot will be created in.
|
513
566
|
#
|
514
|
-
# * `SourceDBClusterSnapshotIdentifier` - The
|
515
|
-
# identifier for the encrypted
|
567
|
+
# * `SourceDBClusterSnapshotIdentifier` - The cluster snapshot
|
568
|
+
# identifier for the encrypted cluster snapshot to be copied. This
|
516
569
|
# identifier must be in the Amazon Resource Name (ARN) format for the
|
517
|
-
# source AWS Region. For example, if you are copying an encrypted
|
570
|
+
# source AWS Region. For example, if you are copying an encrypted
|
518
571
|
# cluster snapshot from the us-west-2 AWS Region, then your
|
519
572
|
# `SourceDBClusterSnapshotIdentifier` looks like the following
|
520
573
|
# example:
|
521
574
|
# `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115`.
|
522
575
|
#
|
523
576
|
# @option params [Boolean] :copy_tags
|
524
|
-
# Set to `true` to copy all tags from the source
|
525
|
-
#
|
577
|
+
# Set to `true` to copy all tags from the source cluster snapshot to the
|
578
|
+
# target cluster snapshot, and otherwise `false`. The default is
|
526
579
|
# `false`.
|
527
580
|
#
|
528
581
|
# @option params [Array<Types::Tag>] :tags
|
529
|
-
# The tags to be assigned to the
|
582
|
+
# The tags to be assigned to the cluster snapshot.
|
530
583
|
#
|
531
584
|
# @return [Types::CopyDBClusterSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
532
585
|
#
|
@@ -578,11 +631,11 @@ module Aws::DocDB
|
|
578
631
|
req.send_request(options)
|
579
632
|
end
|
580
633
|
|
581
|
-
# Creates a new Amazon DocumentDB
|
634
|
+
# Creates a new Amazon DocumentDB cluster.
|
582
635
|
#
|
583
636
|
# @option params [Array<String>] :availability_zones
|
584
|
-
# A list of Amazon EC2 Availability Zones that instances in the
|
585
|
-
#
|
637
|
+
# A list of Amazon EC2 Availability Zones that instances in the cluster
|
638
|
+
# can be created in.
|
586
639
|
#
|
587
640
|
# @option params [Integer] :backup_retention_period
|
588
641
|
# The number of days for which automated backups are retained. You must
|
@@ -597,7 +650,7 @@ module Aws::DocDB
|
|
597
650
|
# ^
|
598
651
|
#
|
599
652
|
# @option params [required, String] :db_cluster_identifier
|
600
|
-
# The
|
653
|
+
# The cluster identifier. This parameter is stored as a lowercase
|
601
654
|
# string.
|
602
655
|
#
|
603
656
|
# Constraints:
|
@@ -611,14 +664,14 @@ module Aws::DocDB
|
|
611
664
|
# Example: `my-cluster`
|
612
665
|
#
|
613
666
|
# @option params [String] :db_cluster_parameter_group_name
|
614
|
-
# The name of the
|
667
|
+
# The name of the cluster parameter group to associate with this
|
615
668
|
# cluster.
|
616
669
|
#
|
617
670
|
# @option params [Array<String>] :vpc_security_group_ids
|
618
|
-
# A list of EC2 VPC security groups to associate with this
|
671
|
+
# A list of EC2 VPC security groups to associate with this cluster.
|
619
672
|
#
|
620
673
|
# @option params [String] :db_subnet_group_name
|
621
|
-
# A
|
674
|
+
# A subnet group to associate with this cluster.
|
622
675
|
#
|
623
676
|
# Constraints: Must match the name of an existing `DBSubnetGroup`. Must
|
624
677
|
# not be default.
|
@@ -626,7 +679,7 @@ module Aws::DocDB
|
|
626
679
|
# Example: `mySubnetgroup`
|
627
680
|
#
|
628
681
|
# @option params [required, String] :engine
|
629
|
-
# The name of the database engine to be used for this
|
682
|
+
# The name of the database engine to be used for this cluster.
|
630
683
|
#
|
631
684
|
# Valid values: `docdb`
|
632
685
|
#
|
@@ -634,11 +687,11 @@ module Aws::DocDB
|
|
634
687
|
# The version number of the database engine to use.
|
635
688
|
#
|
636
689
|
# @option params [Integer] :port
|
637
|
-
# The port number on which the instances in the
|
690
|
+
# The port number on which the instances in the cluster accept
|
638
691
|
# connections.
|
639
692
|
#
|
640
693
|
# @option params [required, String] :master_username
|
641
|
-
# The name of the master user for the
|
694
|
+
# The name of the master user for the cluster.
|
642
695
|
#
|
643
696
|
# Constraints:
|
644
697
|
#
|
@@ -688,19 +741,19 @@ module Aws::DocDB
|
|
688
741
|
# Constraints: Minimum 30-minute window.
|
689
742
|
#
|
690
743
|
# @option params [Array<Types::Tag>] :tags
|
691
|
-
# The tags to be assigned to the
|
744
|
+
# The tags to be assigned to the cluster.
|
692
745
|
#
|
693
746
|
# @option params [Boolean] :storage_encrypted
|
694
|
-
# Specifies whether the
|
747
|
+
# Specifies whether the cluster is encrypted.
|
695
748
|
#
|
696
749
|
# @option params [String] :kms_key_id
|
697
|
-
# The AWS KMS key identifier for an encrypted
|
750
|
+
# The AWS KMS key identifier for an encrypted cluster.
|
698
751
|
#
|
699
752
|
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
700
|
-
# AWS KMS encryption key. If you are creating a
|
701
|
-
#
|
702
|
-
# encrypt the new
|
703
|
-
#
|
753
|
+
# AWS KMS encryption key. If you are creating a cluster using the same
|
754
|
+
# AWS account that owns the AWS KMS encryption key that is used to
|
755
|
+
# encrypt the new cluster, you can use the AWS KMS key alias instead of
|
756
|
+
# the ARN for the AWS KMS encryption key.
|
704
757
|
#
|
705
758
|
# If an encryption key is not specified in `KmsKeyId`\:
|
706
759
|
#
|
@@ -717,8 +770,8 @@ module Aws::DocDB
|
|
717
770
|
# AWS account has a different default encryption key for each AWS
|
718
771
|
# Region.
|
719
772
|
#
|
720
|
-
# If you create a replica of an encrypted
|
721
|
-
#
|
773
|
+
# If you create a replica of an encrypted cluster in another AWS Region,
|
774
|
+
# you must set `KmsKeyId` to a KMS key ID that is valid in the
|
722
775
|
# destination AWS Region. This key is used to encrypt the replica in
|
723
776
|
# that AWS Region.
|
724
777
|
#
|
@@ -815,36 +868,34 @@ module Aws::DocDB
|
|
815
868
|
req.send_request(options)
|
816
869
|
end
|
817
870
|
|
818
|
-
# Creates a new
|
819
|
-
#
|
820
|
-
# Parameters in a
|
821
|
-
#
|
822
|
-
#
|
823
|
-
# A
|
824
|
-
# parameters for the database engine used by instances in the
|
825
|
-
#
|
826
|
-
#
|
827
|
-
#
|
828
|
-
#
|
829
|
-
#
|
830
|
-
#
|
831
|
-
#
|
832
|
-
#
|
833
|
-
#
|
834
|
-
#
|
835
|
-
#
|
836
|
-
#
|
837
|
-
#
|
838
|
-
#
|
839
|
-
# character set for the default database defined by the
|
840
|
-
# `character_set_database` parameter.
|
871
|
+
# Creates a new cluster parameter group.
|
872
|
+
#
|
873
|
+
# Parameters in a cluster parameter group apply to all of the instances
|
874
|
+
# in a DB cluster.
|
875
|
+
#
|
876
|
+
# A cluster parameter group is initially created with the default
|
877
|
+
# parameters for the database engine used by instances in the cluster.
|
878
|
+
# To provide custom values for any of the parameters, you must modify
|
879
|
+
# the group after you create it. After you create a DB cluster parameter
|
880
|
+
# group, you must associate it with your cluster. For the new DB cluster
|
881
|
+
# parameter group and associated settings to take effect, you must then
|
882
|
+
# reboot the instances in the cluster without failover.
|
883
|
+
#
|
884
|
+
# After you create a cluster parameter group, you should wait at least 5
|
885
|
+
# minutes before creating your first cluster that uses that cluster
|
886
|
+
# parameter group as the default parameter group. This allows Amazon
|
887
|
+
# DocumentDB to fully complete the create action before the cluster
|
888
|
+
# parameter group is used as the default for a new cluster. This step is
|
889
|
+
# especially important for parameters that are critical when creating
|
890
|
+
# the default database for a cluster, such as the character set for the
|
891
|
+
# default database defined by the `character_set_database` parameter.
|
841
892
|
#
|
842
893
|
# @option params [required, String] :db_cluster_parameter_group_name
|
843
|
-
# The name of the
|
894
|
+
# The name of the cluster parameter group.
|
844
895
|
#
|
845
896
|
# Constraints:
|
846
897
|
#
|
847
|
-
# * Must match the name of an existing `DBClusterParameterGroup`.
|
898
|
+
# * Must not match the name of an existing `DBClusterParameterGroup`.
|
848
899
|
#
|
849
900
|
# ^
|
850
901
|
#
|
@@ -853,13 +904,13 @@ module Aws::DocDB
|
|
853
904
|
# </note>
|
854
905
|
#
|
855
906
|
# @option params [required, String] :db_parameter_group_family
|
856
|
-
# The
|
907
|
+
# The cluster parameter group family name.
|
857
908
|
#
|
858
909
|
# @option params [required, String] :description
|
859
|
-
# The description for the
|
910
|
+
# The description for the cluster parameter group.
|
860
911
|
#
|
861
912
|
# @option params [Array<Types::Tag>] :tags
|
862
|
-
# The tags to be assigned to the
|
913
|
+
# The tags to be assigned to the cluster parameter group.
|
863
914
|
#
|
864
915
|
# @return [Types::CreateDBClusterParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
865
916
|
#
|
@@ -895,11 +946,11 @@ module Aws::DocDB
|
|
895
946
|
req.send_request(options)
|
896
947
|
end
|
897
948
|
|
898
|
-
# Creates a snapshot of a
|
949
|
+
# Creates a snapshot of a cluster.
|
899
950
|
#
|
900
951
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
901
|
-
# The identifier of the
|
902
|
-
#
|
952
|
+
# The identifier of the cluster snapshot. This parameter is stored as a
|
953
|
+
# lowercase string.
|
903
954
|
#
|
904
955
|
# Constraints:
|
905
956
|
#
|
@@ -912,8 +963,8 @@ module Aws::DocDB
|
|
912
963
|
# Example: `my-cluster-snapshot1`
|
913
964
|
#
|
914
965
|
# @option params [required, String] :db_cluster_identifier
|
915
|
-
# The identifier of the
|
916
|
-
#
|
966
|
+
# The identifier of the cluster to create a snapshot for. This parameter
|
967
|
+
# is not case sensitive.
|
917
968
|
#
|
918
969
|
# Constraints:
|
919
970
|
#
|
@@ -924,7 +975,7 @@ module Aws::DocDB
|
|
924
975
|
# Example: `my-cluster`
|
925
976
|
#
|
926
977
|
# @option params [Array<Types::Tag>] :tags
|
927
|
-
# The tags to be assigned to the
|
978
|
+
# The tags to be assigned to the cluster snapshot.
|
928
979
|
#
|
929
980
|
# @return [Types::CreateDBClusterSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
930
981
|
#
|
@@ -973,10 +1024,10 @@ module Aws::DocDB
|
|
973
1024
|
req.send_request(options)
|
974
1025
|
end
|
975
1026
|
|
976
|
-
# Creates a new
|
1027
|
+
# Creates a new instance.
|
977
1028
|
#
|
978
1029
|
# @option params [required, String] :db_instance_identifier
|
979
|
-
# The
|
1030
|
+
# The instance identifier. This parameter is stored as a lowercase
|
980
1031
|
# string.
|
981
1032
|
#
|
982
1033
|
# Constraints:
|
@@ -990,7 +1041,7 @@ module Aws::DocDB
|
|
990
1041
|
# Example: `mydbinstance`
|
991
1042
|
#
|
992
1043
|
# @option params [required, String] :db_instance_class
|
993
|
-
# The compute and memory capacity of the
|
1044
|
+
# The compute and memory capacity of the instance; for example,
|
994
1045
|
# `db.r5.large`.
|
995
1046
|
#
|
996
1047
|
# @option params [required, String] :engine
|
@@ -999,7 +1050,7 @@ module Aws::DocDB
|
|
999
1050
|
# Valid value: `docdb`
|
1000
1051
|
#
|
1001
1052
|
# @option params [String] :availability_zone
|
1002
|
-
# The Amazon EC2 Availability Zone that the
|
1053
|
+
# The Amazon EC2 Availability Zone that the instance is created in.
|
1003
1054
|
#
|
1004
1055
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
1005
1056
|
# AWS Region.
|
@@ -1026,16 +1077,16 @@ module Aws::DocDB
|
|
1026
1077
|
#
|
1027
1078
|
# @option params [Boolean] :auto_minor_version_upgrade
|
1028
1079
|
# Indicates that minor engine upgrades are applied automatically to the
|
1029
|
-
#
|
1080
|
+
# instance during the maintenance window.
|
1030
1081
|
#
|
1031
1082
|
# Default: `true`
|
1032
1083
|
#
|
1033
1084
|
# @option params [Array<Types::Tag>] :tags
|
1034
|
-
# The tags to be assigned to the
|
1035
|
-
#
|
1085
|
+
# The tags to be assigned to the instance. You can assign up to 10 tags
|
1086
|
+
# to an instance.
|
1036
1087
|
#
|
1037
1088
|
# @option params [required, String] :db_cluster_identifier
|
1038
|
-
# The identifier of the
|
1089
|
+
# The identifier of the cluster that the instance will belong to.
|
1039
1090
|
#
|
1040
1091
|
# @option params [Integer] :promotion_tier
|
1041
1092
|
# A value that specifies the order in which an Amazon DocumentDB replica
|
@@ -1140,11 +1191,11 @@ module Aws::DocDB
|
|
1140
1191
|
req.send_request(options)
|
1141
1192
|
end
|
1142
1193
|
|
1143
|
-
# Creates a new
|
1144
|
-
#
|
1194
|
+
# Creates a new subnet group. subnet groups must contain at least one
|
1195
|
+
# subnet in at least two Availability Zones in the AWS Region.
|
1145
1196
|
#
|
1146
1197
|
# @option params [required, String] :db_subnet_group_name
|
1147
|
-
# The name for the
|
1198
|
+
# The name for the subnet group. This value is stored as a lowercase
|
1148
1199
|
# string.
|
1149
1200
|
#
|
1150
1201
|
# Constraints: Must contain no more than 255 letters, numbers, periods,
|
@@ -1153,13 +1204,13 @@ module Aws::DocDB
|
|
1153
1204
|
# Example: `mySubnetgroup`
|
1154
1205
|
#
|
1155
1206
|
# @option params [required, String] :db_subnet_group_description
|
1156
|
-
# The description for the
|
1207
|
+
# The description for the subnet group.
|
1157
1208
|
#
|
1158
1209
|
# @option params [required, Array<String>] :subnet_ids
|
1159
|
-
# The Amazon EC2 subnet IDs for the
|
1210
|
+
# The Amazon EC2 subnet IDs for the subnet group.
|
1160
1211
|
#
|
1161
1212
|
# @option params [Array<Types::Tag>] :tags
|
1162
|
-
# The tags to be assigned to the
|
1213
|
+
# The tags to be assigned to the subnet group.
|
1163
1214
|
#
|
1164
1215
|
# @return [Types::CreateDBSubnetGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1165
1216
|
#
|
@@ -1200,14 +1251,14 @@ module Aws::DocDB
|
|
1200
1251
|
req.send_request(options)
|
1201
1252
|
end
|
1202
1253
|
|
1203
|
-
# Deletes a previously provisioned
|
1204
|
-
#
|
1205
|
-
#
|
1206
|
-
#
|
1254
|
+
# Deletes a previously provisioned cluster. When you delete a cluster,
|
1255
|
+
# all automated backups for that cluster are deleted and can't be
|
1256
|
+
# recovered. Manual DB cluster snapshots of the specified cluster are
|
1257
|
+
# not deleted.
|
1207
1258
|
#
|
1208
1259
|
# @option params [required, String] :db_cluster_identifier
|
1209
|
-
# The
|
1210
|
-
#
|
1260
|
+
# The cluster identifier for the cluster to be deleted. This parameter
|
1261
|
+
# isn't case sensitive.
|
1211
1262
|
#
|
1212
1263
|
# Constraints:
|
1213
1264
|
#
|
@@ -1216,10 +1267,10 @@ module Aws::DocDB
|
|
1216
1267
|
# ^
|
1217
1268
|
#
|
1218
1269
|
# @option params [Boolean] :skip_final_snapshot
|
1219
|
-
# Determines whether a final
|
1220
|
-
#
|
1221
|
-
#
|
1222
|
-
#
|
1270
|
+
# Determines whether a final cluster snapshot is created before the
|
1271
|
+
# cluster is deleted. If `true` is specified, no cluster snapshot is
|
1272
|
+
# created. If `false` is specified, a cluster snapshot is created before
|
1273
|
+
# the DB cluster is deleted.
|
1223
1274
|
#
|
1224
1275
|
# <note markdown="1"> If `SkipFinalSnapshot` is `false`, you must specify a
|
1225
1276
|
# `FinalDBSnapshotIdentifier` parameter.
|
@@ -1229,8 +1280,8 @@ module Aws::DocDB
|
|
1229
1280
|
# Default: `false`
|
1230
1281
|
#
|
1231
1282
|
# @option params [String] :final_db_snapshot_identifier
|
1232
|
-
# The
|
1233
|
-
#
|
1283
|
+
# The cluster snapshot identifier of the new cluster snapshot created
|
1284
|
+
# when `SkipFinalSnapshot` is set to `false`.
|
1234
1285
|
#
|
1235
1286
|
# <note markdown="1"> Specifying this parameter and also setting the `SkipFinalShapshot`
|
1236
1287
|
# parameter to `true` results in an error.
|
@@ -1308,20 +1359,19 @@ module Aws::DocDB
|
|
1308
1359
|
req.send_request(options)
|
1309
1360
|
end
|
1310
1361
|
|
1311
|
-
# Deletes a specified
|
1312
|
-
#
|
1313
|
-
# clusters.
|
1362
|
+
# Deletes a specified cluster parameter group. The cluster parameter
|
1363
|
+
# group to be deleted can't be associated with any clusters.
|
1314
1364
|
#
|
1315
1365
|
# @option params [required, String] :db_cluster_parameter_group_name
|
1316
|
-
# The name of the
|
1366
|
+
# The name of the cluster parameter group.
|
1317
1367
|
#
|
1318
1368
|
# Constraints:
|
1319
1369
|
#
|
1320
|
-
# * Must be the name of an existing
|
1370
|
+
# * Must be the name of an existing cluster parameter group.
|
1321
1371
|
#
|
1322
|
-
# * You can't delete a default
|
1372
|
+
# * You can't delete a default cluster parameter group.
|
1323
1373
|
#
|
1324
|
-
# * Cannot be associated with any
|
1374
|
+
# * Cannot be associated with any clusters.
|
1325
1375
|
#
|
1326
1376
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1327
1377
|
#
|
@@ -1340,19 +1390,18 @@ module Aws::DocDB
|
|
1340
1390
|
req.send_request(options)
|
1341
1391
|
end
|
1342
1392
|
|
1343
|
-
# Deletes a
|
1344
|
-
#
|
1393
|
+
# Deletes a cluster snapshot. If the snapshot is being copied, the copy
|
1394
|
+
# operation is terminated.
|
1345
1395
|
#
|
1346
|
-
# <note markdown="1"> The
|
1347
|
-
# deleted.
|
1396
|
+
# <note markdown="1"> The cluster snapshot must be in the `available` state to be deleted.
|
1348
1397
|
#
|
1349
1398
|
# </note>
|
1350
1399
|
#
|
1351
1400
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
1352
|
-
# The identifier of the
|
1401
|
+
# The identifier of the cluster snapshot to delete.
|
1353
1402
|
#
|
1354
|
-
# Constraints: Must be the name of an existing
|
1355
|
-
#
|
1403
|
+
# Constraints: Must be the name of an existing cluster snapshot in the
|
1404
|
+
# `available` state.
|
1356
1405
|
#
|
1357
1406
|
# @return [Types::DeleteDBClusterSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1358
1407
|
#
|
@@ -1394,15 +1443,15 @@ module Aws::DocDB
|
|
1394
1443
|
req.send_request(options)
|
1395
1444
|
end
|
1396
1445
|
|
1397
|
-
# Deletes a previously provisioned
|
1446
|
+
# Deletes a previously provisioned instance.
|
1398
1447
|
#
|
1399
1448
|
# @option params [required, String] :db_instance_identifier
|
1400
|
-
# The
|
1401
|
-
#
|
1449
|
+
# The instance identifier for the instance to be deleted. This parameter
|
1450
|
+
# isn't case sensitive.
|
1402
1451
|
#
|
1403
1452
|
# Constraints:
|
1404
1453
|
#
|
1405
|
-
# * Must match the name of an existing
|
1454
|
+
# * Must match the name of an existing instance.
|
1406
1455
|
#
|
1407
1456
|
# ^
|
1408
1457
|
#
|
@@ -1487,7 +1536,7 @@ module Aws::DocDB
|
|
1487
1536
|
req.send_request(options)
|
1488
1537
|
end
|
1489
1538
|
|
1490
|
-
# Deletes a
|
1539
|
+
# Deletes a subnet group.
|
1491
1540
|
#
|
1492
1541
|
# <note markdown="1"> The specified database subnet group must not be associated with any DB
|
1493
1542
|
# instances.
|
@@ -1526,7 +1575,7 @@ module Aws::DocDB
|
|
1526
1575
|
end
|
1527
1576
|
|
1528
1577
|
# Returns a list of certificate authority (CA) certificates provided by
|
1529
|
-
# Amazon
|
1578
|
+
# Amazon DocumentDB for this AWS account.
|
1530
1579
|
#
|
1531
1580
|
# @option params [String] :certificate_identifier
|
1532
1581
|
# The user-supplied certificate identifier. If this parameter is
|
@@ -1604,12 +1653,11 @@ module Aws::DocDB
|
|
1604
1653
|
|
1605
1654
|
# Returns a list of `DBClusterParameterGroup` descriptions. If a
|
1606
1655
|
# `DBClusterParameterGroupName` parameter is specified, the list
|
1607
|
-
# contains only the description of the specified
|
1656
|
+
# contains only the description of the specified cluster parameter
|
1608
1657
|
# group.
|
1609
1658
|
#
|
1610
1659
|
# @option params [String] :db_cluster_parameter_group_name
|
1611
|
-
# The name of a specific
|
1612
|
-
# for.
|
1660
|
+
# The name of a specific cluster parameter group to return details for.
|
1613
1661
|
#
|
1614
1662
|
# Constraints:
|
1615
1663
|
#
|
@@ -1673,11 +1721,11 @@ module Aws::DocDB
|
|
1673
1721
|
req.send_request(options)
|
1674
1722
|
end
|
1675
1723
|
|
1676
|
-
# Returns the detailed parameter list for a particular
|
1677
|
-
#
|
1724
|
+
# Returns the detailed parameter list for a particular cluster parameter
|
1725
|
+
# group.
|
1678
1726
|
#
|
1679
1727
|
# @option params [required, String] :db_cluster_parameter_group_name
|
1680
|
-
# The name of a specific
|
1728
|
+
# The name of a specific cluster parameter group to return parameter
|
1681
1729
|
# details for.
|
1682
1730
|
#
|
1683
1731
|
# Constraints:
|
@@ -1753,18 +1801,18 @@ module Aws::DocDB
|
|
1753
1801
|
req.send_request(options)
|
1754
1802
|
end
|
1755
1803
|
|
1756
|
-
# Returns a list of
|
1804
|
+
# Returns a list of cluster snapshot attribute names and values for a
|
1757
1805
|
# manual DB cluster snapshot.
|
1758
1806
|
#
|
1759
1807
|
# When you share snapshots with other AWS accounts,
|
1760
1808
|
# `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute
|
1761
1809
|
# and a list of IDs for the AWS accounts that are authorized to copy or
|
1762
|
-
# restore the manual
|
1763
|
-
#
|
1810
|
+
# restore the manual cluster snapshot. If `all` is included in the list
|
1811
|
+
# of values for the `restore` attribute, then the manual cluster
|
1764
1812
|
# snapshot is public and can be copied or restored by all AWS accounts.
|
1765
1813
|
#
|
1766
1814
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
1767
|
-
# The identifier for the
|
1815
|
+
# The identifier for the cluster snapshot to describe the attributes
|
1768
1816
|
# for.
|
1769
1817
|
#
|
1770
1818
|
# @return [Types::DescribeDBClusterSnapshotAttributesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -1794,14 +1842,13 @@ module Aws::DocDB
|
|
1794
1842
|
req.send_request(options)
|
1795
1843
|
end
|
1796
1844
|
|
1797
|
-
# Returns information about
|
1845
|
+
# Returns information about cluster snapshots. This API operation
|
1798
1846
|
# supports pagination.
|
1799
1847
|
#
|
1800
1848
|
# @option params [String] :db_cluster_identifier
|
1801
|
-
# The ID of the
|
1802
|
-
#
|
1803
|
-
#
|
1804
|
-
# sensitive.
|
1849
|
+
# The ID of the cluster to retrieve the list of cluster snapshots for.
|
1850
|
+
# This parameter can't be used with the `DBClusterSnapshotIdentifier`
|
1851
|
+
# parameter. This parameter is not case sensitive.
|
1805
1852
|
#
|
1806
1853
|
# Constraints:
|
1807
1854
|
#
|
@@ -1810,7 +1857,7 @@ module Aws::DocDB
|
|
1810
1857
|
# ^
|
1811
1858
|
#
|
1812
1859
|
# @option params [String] :db_cluster_snapshot_identifier
|
1813
|
-
# A specific
|
1860
|
+
# A specific cluster snapshot identifier to describe. This parameter
|
1814
1861
|
# can't be used with the `DBClusterIdentifier` parameter. This value is
|
1815
1862
|
# stored as a lowercase string.
|
1816
1863
|
#
|
@@ -1823,26 +1870,26 @@ module Aws::DocDB
|
|
1823
1870
|
# parameter must also be specified.
|
1824
1871
|
#
|
1825
1872
|
# @option params [String] :snapshot_type
|
1826
|
-
# The type of
|
1827
|
-
#
|
1873
|
+
# The type of cluster snapshots to be returned. You can specify one of
|
1874
|
+
# the following values:
|
1828
1875
|
#
|
1829
|
-
# * `automated` - Return all
|
1876
|
+
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
1830
1877
|
# has automatically created for your AWS account.
|
1831
1878
|
#
|
1832
|
-
# * `manual` - Return all
|
1879
|
+
# * `manual` - Return all cluster snapshots that you have manually
|
1833
1880
|
# created for your AWS account.
|
1834
1881
|
#
|
1835
|
-
# * `shared` - Return all manual
|
1836
|
-
#
|
1882
|
+
# * `shared` - Return all manual cluster snapshots that have been shared
|
1883
|
+
# to your AWS account.
|
1837
1884
|
#
|
1838
|
-
# * `public` - Return all
|
1885
|
+
# * `public` - Return all cluster snapshots that have been marked as
|
1839
1886
|
# public.
|
1840
1887
|
#
|
1841
1888
|
# If you don't specify a `SnapshotType` value, then both automated and
|
1842
|
-
# manual
|
1843
|
-
#
|
1844
|
-
#
|
1845
|
-
#
|
1889
|
+
# manual cluster snapshots are returned. You can include shared cluster
|
1890
|
+
# snapshots with these results by setting the `IncludeShared` parameter
|
1891
|
+
# to `true`. You can include public cluster snapshots with these results
|
1892
|
+
# by setting the `IncludePublic` parameter to `true`.
|
1846
1893
|
#
|
1847
1894
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
1848
1895
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
@@ -1869,14 +1916,14 @@ module Aws::DocDB
|
|
1869
1916
|
# marker, up to the value specified by `MaxRecords`.
|
1870
1917
|
#
|
1871
1918
|
# @option params [Boolean] :include_shared
|
1872
|
-
# Set to `true` to include shared manual
|
1919
|
+
# Set to `true` to include shared manual cluster snapshots from other
|
1873
1920
|
# AWS accounts that this AWS account has been given permission to copy
|
1874
1921
|
# or restore, and otherwise `false`. The default is `false`.
|
1875
1922
|
#
|
1876
1923
|
# @option params [Boolean] :include_public
|
1877
|
-
# Set to `true` to include manual
|
1878
|
-
#
|
1879
|
-
#
|
1924
|
+
# Set to `true` to include manual cluster snapshots that are public and
|
1925
|
+
# can be copied or restored by any AWS account, and otherwise `false`.
|
1926
|
+
# The default is `false`.
|
1880
1927
|
#
|
1881
1928
|
# @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1882
1929
|
#
|
@@ -1933,13 +1980,17 @@ module Aws::DocDB
|
|
1933
1980
|
req.send_request(options)
|
1934
1981
|
end
|
1935
1982
|
|
1936
|
-
# Returns information about provisioned Amazon DocumentDB
|
1937
|
-
#
|
1983
|
+
# Returns information about provisioned Amazon DocumentDB clusters. This
|
1984
|
+
# API operation supports pagination. For certain management features
|
1985
|
+
# such as cluster and instance lifecycle management, Amazon DocumentDB
|
1986
|
+
# leverages operational technology that is shared with Amazon RDS and
|
1987
|
+
# Amazon Neptune. Use the `filterName=engine,Values=docdb` filter
|
1988
|
+
# parameter to return only Amazon DocumentDB clusters.
|
1938
1989
|
#
|
1939
1990
|
# @option params [String] :db_cluster_identifier
|
1940
|
-
# The user-provided
|
1941
|
-
#
|
1942
|
-
#
|
1991
|
+
# The user-provided cluster identifier. If this parameter is specified,
|
1992
|
+
# information from only the specific cluster is returned. This parameter
|
1993
|
+
# isn't case sensitive.
|
1943
1994
|
#
|
1944
1995
|
# Constraints:
|
1945
1996
|
#
|
@@ -1948,13 +1999,13 @@ module Aws::DocDB
|
|
1948
1999
|
# ^
|
1949
2000
|
#
|
1950
2001
|
# @option params [Array<Types::Filter>] :filters
|
1951
|
-
# A filter that specifies one or more
|
2002
|
+
# A filter that specifies one or more clusters to describe.
|
1952
2003
|
#
|
1953
2004
|
# Supported filters:
|
1954
2005
|
#
|
1955
|
-
# * `db-cluster-id` - Accepts
|
1956
|
-
#
|
1957
|
-
#
|
2006
|
+
# * `db-cluster-id` - Accepts cluster identifiers and cluster Amazon
|
2007
|
+
# Resource Names (ARNs). The results list only includes information
|
2008
|
+
# about the clusters identified by these ARNs.
|
1958
2009
|
#
|
1959
2010
|
# ^
|
1960
2011
|
#
|
@@ -1978,6 +2029,8 @@ module Aws::DocDB
|
|
1978
2029
|
# * {Types::DBClusterMessage#marker #marker} => String
|
1979
2030
|
# * {Types::DBClusterMessage#db_clusters #db_clusters} => Array<Types::DBCluster>
|
1980
2031
|
#
|
2032
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2033
|
+
#
|
1981
2034
|
# @example Request syntax with placeholder values
|
1982
2035
|
#
|
1983
2036
|
# resp = client.describe_db_clusters({
|
@@ -2045,7 +2098,7 @@ module Aws::DocDB
|
|
2045
2098
|
req.send_request(options)
|
2046
2099
|
end
|
2047
2100
|
|
2048
|
-
# Returns a list of the available
|
2101
|
+
# Returns a list of the available engines.
|
2049
2102
|
#
|
2050
2103
|
# @option params [String] :engine
|
2051
2104
|
# The database engine to return.
|
@@ -2056,8 +2109,7 @@ module Aws::DocDB
|
|
2056
2109
|
# Example: `5.1.49`
|
2057
2110
|
#
|
2058
2111
|
# @option params [String] :db_parameter_group_family
|
2059
|
-
# The name of a specific
|
2060
|
-
# for.
|
2112
|
+
# The name of a specific parameter group family to return details for.
|
2061
2113
|
#
|
2062
2114
|
# Constraints:
|
2063
2115
|
#
|
@@ -2102,6 +2154,8 @@ module Aws::DocDB
|
|
2102
2154
|
# * {Types::DBEngineVersionMessage#marker #marker} => String
|
2103
2155
|
# * {Types::DBEngineVersionMessage#db_engine_versions #db_engine_versions} => Array<Types::DBEngineVersion>
|
2104
2156
|
#
|
2157
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2158
|
+
#
|
2105
2159
|
# @example Request syntax with placeholder values
|
2106
2160
|
#
|
2107
2161
|
# resp = client.describe_db_engine_versions({
|
@@ -2154,7 +2208,7 @@ module Aws::DocDB
|
|
2154
2208
|
#
|
2155
2209
|
# @option params [String] :db_instance_identifier
|
2156
2210
|
# The user-provided instance identifier. If this parameter is specified,
|
2157
|
-
# information from only the specific
|
2211
|
+
# information from only the specific instance is returned. This
|
2158
2212
|
# parameter isn't case sensitive.
|
2159
2213
|
#
|
2160
2214
|
# Constraints:
|
@@ -2164,18 +2218,18 @@ module Aws::DocDB
|
|
2164
2218
|
# ^
|
2165
2219
|
#
|
2166
2220
|
# @option params [Array<Types::Filter>] :filters
|
2167
|
-
# A filter that specifies one or more
|
2221
|
+
# A filter that specifies one or more instances to describe.
|
2168
2222
|
#
|
2169
2223
|
# Supported filters:
|
2170
2224
|
#
|
2171
|
-
# * `db-cluster-id` - Accepts
|
2172
|
-
#
|
2173
|
-
# information about the
|
2225
|
+
# * `db-cluster-id` - Accepts cluster identifiers and cluster Amazon
|
2226
|
+
# Resource Names (ARNs). The results list includes only the
|
2227
|
+
# information about the instances that are associated with the
|
2174
2228
|
# clusters that are identified by these ARNs.
|
2175
2229
|
#
|
2176
|
-
# * `db-instance-id` - Accepts
|
2177
|
-
#
|
2178
|
-
#
|
2230
|
+
# * `db-instance-id` - Accepts instance identifiers and instance ARNs.
|
2231
|
+
# The results list includes only the information about the instances
|
2232
|
+
# that are identified by these ARNs.
|
2179
2233
|
#
|
2180
2234
|
# @option params [Integer] :max_records
|
2181
2235
|
# The maximum number of records to include in the response. If more
|
@@ -2197,6 +2251,8 @@ module Aws::DocDB
|
|
2197
2251
|
# * {Types::DBInstanceMessage#marker #marker} => String
|
2198
2252
|
# * {Types::DBInstanceMessage#db_instances #db_instances} => Array<Types::DBInstance>
|
2199
2253
|
#
|
2254
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2255
|
+
#
|
2200
2256
|
# @example Request syntax with placeholder values
|
2201
2257
|
#
|
2202
2258
|
# resp = client.describe_db_instances({
|
@@ -2275,6 +2331,12 @@ module Aws::DocDB
|
|
2275
2331
|
# resp.db_instances[0].enabled_cloudwatch_logs_exports #=> Array
|
2276
2332
|
# resp.db_instances[0].enabled_cloudwatch_logs_exports[0] #=> String
|
2277
2333
|
#
|
2334
|
+
#
|
2335
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
2336
|
+
#
|
2337
|
+
# * db_instance_available
|
2338
|
+
# * db_instance_deleted
|
2339
|
+
#
|
2278
2340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBInstances AWS API Documentation
|
2279
2341
|
#
|
2280
2342
|
# @overload describe_db_instances(params = {})
|
@@ -2289,7 +2351,7 @@ module Aws::DocDB
|
|
2289
2351
|
# descriptions of the specified `DBSubnetGroup`.
|
2290
2352
|
#
|
2291
2353
|
# @option params [String] :db_subnet_group_name
|
2292
|
-
# The name of the
|
2354
|
+
# The name of the subnet group to return details for.
|
2293
2355
|
#
|
2294
2356
|
# @option params [Array<Types::Filter>] :filters
|
2295
2357
|
# This parameter is not currently supported.
|
@@ -2314,6 +2376,8 @@ module Aws::DocDB
|
|
2314
2376
|
# * {Types::DBSubnetGroupMessage#marker #marker} => String
|
2315
2377
|
# * {Types::DBSubnetGroupMessage#db_subnet_groups #db_subnet_groups} => Array<Types::DBSubnetGroup>
|
2316
2378
|
#
|
2379
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2380
|
+
#
|
2317
2381
|
# @example Request syntax with placeholder values
|
2318
2382
|
#
|
2319
2383
|
# resp = client.describe_db_subnet_groups({
|
@@ -2355,7 +2419,7 @@ module Aws::DocDB
|
|
2355
2419
|
# cluster database engine.
|
2356
2420
|
#
|
2357
2421
|
# @option params [required, String] :db_parameter_group_family
|
2358
|
-
# The name of the
|
2422
|
+
# The name of the cluster parameter group family to return the engine
|
2359
2423
|
# parameter information for.
|
2360
2424
|
#
|
2361
2425
|
# @option params [Array<Types::Filter>] :filters
|
@@ -2463,11 +2527,11 @@ module Aws::DocDB
|
|
2463
2527
|
req.send_request(options)
|
2464
2528
|
end
|
2465
2529
|
|
2466
|
-
# Returns events related to
|
2467
|
-
#
|
2468
|
-
#
|
2469
|
-
#
|
2470
|
-
#
|
2530
|
+
# Returns events related to instances, security groups, snapshots, and
|
2531
|
+
# DB parameter groups for the past 14 days. You can obtain events
|
2532
|
+
# specific to a particular DB instance, security group, snapshot, or
|
2533
|
+
# parameter group by providing the name as a parameter. By default, the
|
2534
|
+
# events of the past hour are returned.
|
2471
2535
|
#
|
2472
2536
|
# @option params [String] :source_identifier
|
2473
2537
|
# The identifier of the event source for which events are returned. If
|
@@ -2540,6 +2604,8 @@ module Aws::DocDB
|
|
2540
2604
|
# * {Types::EventsMessage#marker #marker} => String
|
2541
2605
|
# * {Types::EventsMessage#events #events} => Array<Types::Event>
|
2542
2606
|
#
|
2607
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2608
|
+
#
|
2543
2609
|
# @example Request syntax with placeholder values
|
2544
2610
|
#
|
2545
2611
|
# resp = client.describe_events({
|
@@ -2580,20 +2646,18 @@ module Aws::DocDB
|
|
2580
2646
|
req.send_request(options)
|
2581
2647
|
end
|
2582
2648
|
|
2583
|
-
# Returns a list of orderable
|
2584
|
-
# engine.
|
2649
|
+
# Returns a list of orderable instance options for the specified engine.
|
2585
2650
|
#
|
2586
2651
|
# @option params [required, String] :engine
|
2587
|
-
# The name of the engine to retrieve
|
2652
|
+
# The name of the engine to retrieve instance options for.
|
2588
2653
|
#
|
2589
2654
|
# @option params [String] :engine_version
|
2590
2655
|
# The engine version filter value. Specify this parameter to show only
|
2591
2656
|
# the available offerings that match the specified engine version.
|
2592
2657
|
#
|
2593
2658
|
# @option params [String] :db_instance_class
|
2594
|
-
# The
|
2595
|
-
#
|
2596
|
-
# class.
|
2659
|
+
# The instance class filter value. Specify this parameter to show only
|
2660
|
+
# the available offerings that match the specified instance class.
|
2597
2661
|
#
|
2598
2662
|
# @option params [String] :license_model
|
2599
2663
|
# The license model filter value. Specify this parameter to show only
|
@@ -2626,6 +2690,8 @@ module Aws::DocDB
|
|
2626
2690
|
# * {Types::OrderableDBInstanceOptionsMessage#orderable_db_instance_options #orderable_db_instance_options} => Array<Types::OrderableDBInstanceOption>
|
2627
2691
|
# * {Types::OrderableDBInstanceOptionsMessage#marker #marker} => String
|
2628
2692
|
#
|
2693
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2694
|
+
#
|
2629
2695
|
# @example Request syntax with placeholder values
|
2630
2696
|
#
|
2631
2697
|
# resp = client.describe_orderable_db_instance_options({
|
@@ -2665,7 +2731,7 @@ module Aws::DocDB
|
|
2665
2731
|
req.send_request(options)
|
2666
2732
|
end
|
2667
2733
|
|
2668
|
-
# Returns a list of resources (for example,
|
2734
|
+
# Returns a list of resources (for example, instances) that have at
|
2669
2735
|
# least one pending maintenance action.
|
2670
2736
|
#
|
2671
2737
|
# @option params [String] :resource_identifier
|
@@ -2677,13 +2743,13 @@ module Aws::DocDB
|
|
2677
2743
|
#
|
2678
2744
|
# Supported filters:
|
2679
2745
|
#
|
2680
|
-
# * `db-cluster-id` - Accepts
|
2681
|
-
#
|
2682
|
-
# maintenance actions for the
|
2746
|
+
# * `db-cluster-id` - Accepts cluster identifiers and cluster Amazon
|
2747
|
+
# Resource Names (ARNs). The results list includes only pending
|
2748
|
+
# maintenance actions for the clusters identified by these ARNs.
|
2683
2749
|
#
|
2684
|
-
# * `db-instance-id` - Accepts
|
2685
|
-
#
|
2686
|
-
#
|
2750
|
+
# * `db-instance-id` - Accepts instance identifiers and instance ARNs.
|
2751
|
+
# The results list includes only pending maintenance actions for the
|
2752
|
+
# DB instances identified by these ARNs.
|
2687
2753
|
#
|
2688
2754
|
# @option params [String] :marker
|
2689
2755
|
# An optional pagination token provided by a previous request. If this
|
@@ -2741,10 +2807,10 @@ module Aws::DocDB
|
|
2741
2807
|
req.send_request(options)
|
2742
2808
|
end
|
2743
2809
|
|
2744
|
-
# Forces a failover for a
|
2810
|
+
# Forces a failover for a cluster.
|
2745
2811
|
#
|
2746
|
-
# A failover for a
|
2747
|
-
# replicas (read-only instances) in the
|
2812
|
+
# A failover for a cluster promotes one of the Amazon DocumentDB
|
2813
|
+
# replicas (read-only instances) in the cluster to be the primary
|
2748
2814
|
# instance (the cluster writer).
|
2749
2815
|
#
|
2750
2816
|
# If the primary instance fails, Amazon DocumentDB automatically fails
|
@@ -2753,7 +2819,7 @@ module Aws::DocDB
|
|
2753
2819
|
# testing.
|
2754
2820
|
#
|
2755
2821
|
# @option params [String] :db_cluster_identifier
|
2756
|
-
# A
|
2822
|
+
# A cluster identifier to force a failover for. This parameter is not
|
2757
2823
|
# case sensitive.
|
2758
2824
|
#
|
2759
2825
|
# Constraints:
|
@@ -2766,7 +2832,7 @@ module Aws::DocDB
|
|
2766
2832
|
# The name of the instance to promote to the primary instance.
|
2767
2833
|
#
|
2768
2834
|
# You must specify the instance identifier for an Amazon DocumentDB
|
2769
|
-
# replica in the
|
2835
|
+
# replica in the cluster. For example, `mydbcluster-replica1`.
|
2770
2836
|
#
|
2771
2837
|
# @return [Types::FailoverDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2772
2838
|
#
|
@@ -2870,12 +2936,12 @@ module Aws::DocDB
|
|
2870
2936
|
req.send_request(options)
|
2871
2937
|
end
|
2872
2938
|
|
2873
|
-
# Modifies a setting for an Amazon DocumentDB
|
2939
|
+
# Modifies a setting for an Amazon DocumentDB cluster. You can change
|
2874
2940
|
# one or more database configuration parameters by specifying these
|
2875
2941
|
# parameters and the new values in the request.
|
2876
2942
|
#
|
2877
2943
|
# @option params [required, String] :db_cluster_identifier
|
2878
|
-
# The
|
2944
|
+
# The cluster identifier for the cluster that is being modified. This
|
2879
2945
|
# parameter is not case sensitive.
|
2880
2946
|
#
|
2881
2947
|
# Constraints:
|
@@ -2885,8 +2951,8 @@ module Aws::DocDB
|
|
2885
2951
|
# ^
|
2886
2952
|
#
|
2887
2953
|
# @option params [String] :new_db_cluster_identifier
|
2888
|
-
# The new
|
2889
|
-
#
|
2954
|
+
# The new cluster identifier for the cluster when renaming a cluster.
|
2955
|
+
# This value is stored as a lowercase string.
|
2890
2956
|
#
|
2891
2957
|
# Constraints:
|
2892
2958
|
#
|
@@ -2901,9 +2967,9 @@ module Aws::DocDB
|
|
2901
2967
|
# @option params [Boolean] :apply_immediately
|
2902
2968
|
# A value that specifies whether the changes in this request and any
|
2903
2969
|
# pending changes are asynchronously applied as soon as possible,
|
2904
|
-
# regardless of the `PreferredMaintenanceWindow` setting for the
|
2905
|
-
# cluster. If this parameter is set to `false`, changes to the
|
2906
|
-
#
|
2970
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the
|
2971
|
+
# cluster. If this parameter is set to `false`, changes to the cluster
|
2972
|
+
# are applied during the next maintenance window.
|
2907
2973
|
#
|
2908
2974
|
# The `ApplyImmediately` parameter affects only the
|
2909
2975
|
# `NewDBClusterIdentifier` and `MasterUserPassword` values. If you set
|
@@ -2928,18 +2994,18 @@ module Aws::DocDB
|
|
2928
2994
|
# ^
|
2929
2995
|
#
|
2930
2996
|
# @option params [String] :db_cluster_parameter_group_name
|
2931
|
-
# The name of the
|
2997
|
+
# The name of the cluster parameter group to use for the cluster.
|
2932
2998
|
#
|
2933
2999
|
# @option params [Array<String>] :vpc_security_group_ids
|
2934
|
-
# A list of virtual private cloud (VPC) security groups that the
|
2935
|
-
#
|
3000
|
+
# A list of virtual private cloud (VPC) security groups that the cluster
|
3001
|
+
# will belong to.
|
2936
3002
|
#
|
2937
3003
|
# @option params [Integer] :port
|
2938
|
-
# The port number on which the
|
3004
|
+
# The port number on which the cluster accepts connections.
|
2939
3005
|
#
|
2940
3006
|
# Constraints: Must be a value from `1150` to `65535`.
|
2941
3007
|
#
|
2942
|
-
# Default: The same port as the original
|
3008
|
+
# Default: The same port as the original cluster.
|
2943
3009
|
#
|
2944
3010
|
# @option params [String] :master_user_password
|
2945
3011
|
# The password for the master database user. This password can contain
|
@@ -2982,9 +3048,9 @@ module Aws::DocDB
|
|
2982
3048
|
#
|
2983
3049
|
# @option params [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
2984
3050
|
# The configuration setting for the log types to be enabled for export
|
2985
|
-
# to Amazon CloudWatch Logs for a specific
|
2986
|
-
#
|
2987
|
-
#
|
3051
|
+
# to Amazon CloudWatch Logs for a specific instance or cluster. The
|
3052
|
+
# `EnableLogTypes` and `DisableLogTypes` arrays determine which logs are
|
3053
|
+
# exported (or not exported) to CloudWatch Logs.
|
2988
3054
|
#
|
2989
3055
|
# @option params [String] :engine_version
|
2990
3056
|
# The version number of the database engine to which you want to
|
@@ -3074,10 +3140,10 @@ module Aws::DocDB
|
|
3074
3140
|
req.send_request(options)
|
3075
3141
|
end
|
3076
3142
|
|
3077
|
-
# Modifies the parameters of a
|
3078
|
-
#
|
3079
|
-
# `
|
3080
|
-
#
|
3143
|
+
# Modifies the parameters of a cluster parameter group. To modify more
|
3144
|
+
# than one parameter, submit a list of the following: `ParameterName`,
|
3145
|
+
# `ParameterValue`, and `ApplyMethod`. A maximum of 20 parameters can be
|
3146
|
+
# modified in a single request.
|
3081
3147
|
#
|
3082
3148
|
# <note markdown="1"> Changes to dynamic parameters are applied immediately. Changes to
|
3083
3149
|
# static parameters require a reboot or maintenance window before the
|
@@ -3085,21 +3151,20 @@ module Aws::DocDB
|
|
3085
3151
|
#
|
3086
3152
|
# </note>
|
3087
3153
|
#
|
3088
|
-
# After you create a
|
3089
|
-
#
|
3090
|
-
#
|
3091
|
-
#
|
3092
|
-
#
|
3093
|
-
#
|
3094
|
-
# the default database for a
|
3095
|
-
#
|
3096
|
-
# parameter.
|
3154
|
+
# After you create a cluster parameter group, you should wait at least 5
|
3155
|
+
# minutes before creating your first cluster that uses that cluster
|
3156
|
+
# parameter group as the default parameter group. This allows Amazon
|
3157
|
+
# DocumentDB to fully complete the create action before the parameter
|
3158
|
+
# group is used as the default for a new cluster. This step is
|
3159
|
+
# especially important for parameters that are critical when creating
|
3160
|
+
# the default database for a cluster, such as the character set for the
|
3161
|
+
# default database defined by the `character_set_database` parameter.
|
3097
3162
|
#
|
3098
3163
|
# @option params [required, String] :db_cluster_parameter_group_name
|
3099
|
-
# The name of the
|
3164
|
+
# The name of the cluster parameter group to modify.
|
3100
3165
|
#
|
3101
3166
|
# @option params [required, Array<Types::Parameter>] :parameters
|
3102
|
-
# A list of parameters in the
|
3167
|
+
# A list of parameters in the cluster parameter group to modify.
|
3103
3168
|
#
|
3104
3169
|
# @return [Types::DBClusterParameterGroupNameMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3105
3170
|
#
|
@@ -3141,49 +3206,48 @@ module Aws::DocDB
|
|
3141
3206
|
# Adds an attribute and values to, or removes an attribute and values
|
3142
3207
|
# from, a manual DB cluster snapshot.
|
3143
3208
|
#
|
3144
|
-
# To share a manual
|
3209
|
+
# To share a manual cluster snapshot with other AWS accounts, specify
|
3145
3210
|
# `restore` as the `AttributeName`, and use the `ValuesToAdd` parameter
|
3146
3211
|
# to add a list of IDs of the AWS accounts that are authorized to
|
3147
|
-
# restore the manual
|
3148
|
-
#
|
3149
|
-
#
|
3150
|
-
#
|
3151
|
-
#
|
3212
|
+
# restore the manual cluster snapshot. Use the value `all` to make the
|
3213
|
+
# manual cluster snapshot public, which means that it can be copied or
|
3214
|
+
# restored by all AWS accounts. Do not add the `all` value for any
|
3215
|
+
# manual DB cluster snapshots that contain private information that you
|
3216
|
+
# don't want available to all AWS accounts. If a manual cluster
|
3152
3217
|
# snapshot is encrypted, it can be shared, but only by specifying a list
|
3153
3218
|
# of authorized AWS account IDs for the `ValuesToAdd` parameter. You
|
3154
3219
|
# can't use `all` as a value for that parameter in this case.
|
3155
3220
|
#
|
3156
3221
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
3157
|
-
# The identifier for the
|
3158
|
-
# for.
|
3222
|
+
# The identifier for the cluster snapshot to modify the attributes for.
|
3159
3223
|
#
|
3160
3224
|
# @option params [required, String] :attribute_name
|
3161
|
-
# The name of the
|
3225
|
+
# The name of the cluster snapshot attribute to modify.
|
3162
3226
|
#
|
3163
3227
|
# To manage authorization for other AWS accounts to copy or restore a
|
3164
|
-
# manual
|
3228
|
+
# manual cluster snapshot, set this value to `restore`.
|
3165
3229
|
#
|
3166
3230
|
# @option params [Array<String>] :values_to_add
|
3167
|
-
# A list of
|
3231
|
+
# A list of cluster snapshot attributes to add to the attribute
|
3168
3232
|
# specified by `AttributeName`.
|
3169
3233
|
#
|
3170
|
-
# To authorize other AWS accounts to copy or restore a manual
|
3234
|
+
# To authorize other AWS accounts to copy or restore a manual cluster
|
3171
3235
|
# snapshot, set this list to include one or more AWS account IDs. To
|
3172
|
-
# make the manual
|
3173
|
-
#
|
3174
|
-
#
|
3175
|
-
#
|
3236
|
+
# make the manual cluster snapshot restorable by any AWS account, set it
|
3237
|
+
# to `all`. Do not add the `all` value for any manual cluster snapshots
|
3238
|
+
# that contain private information that you don't want to be available
|
3239
|
+
# to all AWS accounts.
|
3176
3240
|
#
|
3177
3241
|
# @option params [Array<String>] :values_to_remove
|
3178
|
-
# A list of
|
3242
|
+
# A list of cluster snapshot attributes to remove from the attribute
|
3179
3243
|
# specified by `AttributeName`.
|
3180
3244
|
#
|
3181
3245
|
# To remove authorization for other AWS accounts to copy or restore a
|
3182
|
-
# manual
|
3246
|
+
# manual cluster snapshot, set this list to include one or more AWS
|
3183
3247
|
# account identifiers. To remove authorization for any AWS account to
|
3184
|
-
# copy or restore the
|
3185
|
-
#
|
3186
|
-
#
|
3248
|
+
# copy or restore the cluster snapshot, set it to `all` . If you specify
|
3249
|
+
# `all`, an AWS account whose account ID is explicitly added to the
|
3250
|
+
# `restore` attribute can still copy or restore a manual cluster
|
3187
3251
|
# snapshot.
|
3188
3252
|
#
|
3189
3253
|
# @return [Types::ModifyDBClusterSnapshotAttributeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3216,13 +3280,12 @@ module Aws::DocDB
|
|
3216
3280
|
req.send_request(options)
|
3217
3281
|
end
|
3218
3282
|
|
3219
|
-
# Modifies settings for
|
3220
|
-
#
|
3221
|
-
#
|
3283
|
+
# Modifies settings for an instance. You can change one or more database
|
3284
|
+
# configuration parameters by specifying these parameters and the new
|
3285
|
+
# values in the request.
|
3222
3286
|
#
|
3223
3287
|
# @option params [required, String] :db_instance_identifier
|
3224
|
-
# The
|
3225
|
-
# string.
|
3288
|
+
# The instance identifier. This value is stored as a lowercase string.
|
3226
3289
|
#
|
3227
3290
|
# Constraints:
|
3228
3291
|
#
|
@@ -3231,23 +3294,23 @@ module Aws::DocDB
|
|
3231
3294
|
# ^
|
3232
3295
|
#
|
3233
3296
|
# @option params [String] :db_instance_class
|
3234
|
-
# The new compute and memory capacity of the
|
3235
|
-
# `db.r5.large`. Not all
|
3297
|
+
# The new compute and memory capacity of the instance; for example,
|
3298
|
+
# `db.r5.large`. Not all instance classes are available in all AWS
|
3236
3299
|
# Regions.
|
3237
3300
|
#
|
3238
|
-
# If you modify the
|
3239
|
-
#
|
3240
|
-
#
|
3301
|
+
# If you modify the instance class, an outage occurs during the change.
|
3302
|
+
# The change is applied during the next maintenance window, unless
|
3303
|
+
# `ApplyImmediately` is specified as `true` for this request.
|
3241
3304
|
#
|
3242
3305
|
# Default: Uses existing setting.
|
3243
3306
|
#
|
3244
3307
|
# @option params [Boolean] :apply_immediately
|
3245
3308
|
# Specifies whether the modifications in this request and any pending
|
3246
3309
|
# modifications are asynchronously applied as soon as possible,
|
3247
|
-
# regardless of the `PreferredMaintenanceWindow` setting for the
|
3310
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the
|
3248
3311
|
# instance.
|
3249
3312
|
#
|
3250
|
-
# If this parameter is set to `false`, changes to the
|
3313
|
+
# If this parameter is set to `false`, changes to the instance are
|
3251
3314
|
# applied during the next maintenance window. Some parameter changes can
|
3252
3315
|
# cause an outage and are applied on the next reboot.
|
3253
3316
|
#
|
@@ -3260,9 +3323,9 @@ module Aws::DocDB
|
|
3260
3323
|
# the change is asynchronously applied as soon as possible. If there are
|
3261
3324
|
# pending actions that cause a reboot, and the maintenance window is
|
3262
3325
|
# changed to include the current time, changing this parameter causes a
|
3263
|
-
# reboot of the
|
3264
|
-
#
|
3265
|
-
#
|
3326
|
+
# reboot of the instance. If you are moving this window to the current
|
3327
|
+
# time, there must be at least 30 minutes between the current time and
|
3328
|
+
# end of the window to ensure that pending changes are applied.
|
3266
3329
|
#
|
3267
3330
|
# Default: Uses existing setting.
|
3268
3331
|
#
|
@@ -3274,7 +3337,7 @@ module Aws::DocDB
|
|
3274
3337
|
#
|
3275
3338
|
# @option params [Boolean] :auto_minor_version_upgrade
|
3276
3339
|
# Indicates that minor version upgrades are applied automatically to the
|
3277
|
-
#
|
3340
|
+
# instance during the maintenance window. Changing this parameter
|
3278
3341
|
# doesn't result in an outage except in the following case, and the
|
3279
3342
|
# change is asynchronously applied as soon as possible. An outage
|
3280
3343
|
# results if this parameter is set to `true` during the maintenance
|
@@ -3282,11 +3345,11 @@ module Aws::DocDB
|
|
3282
3345
|
# has enabled automatic patching for that engine version.
|
3283
3346
|
#
|
3284
3347
|
# @option params [String] :new_db_instance_identifier
|
3285
|
-
# The new
|
3286
|
-
# instance. When you change the
|
3287
|
-
#
|
3288
|
-
#
|
3289
|
-
#
|
3348
|
+
# The new instance identifier for the instance when renaming an
|
3349
|
+
# instance. When you change the instance identifier, an instance reboot
|
3350
|
+
# occurs immediately if you set `Apply Immediately` to `true`. It occurs
|
3351
|
+
# during the next maintenance window if you set `Apply Immediately` to
|
3352
|
+
# `false`. This value is stored as a lowercase string.
|
3290
3353
|
#
|
3291
3354
|
# Constraints:
|
3292
3355
|
#
|
@@ -3399,11 +3462,11 @@ module Aws::DocDB
|
|
3399
3462
|
req.send_request(options)
|
3400
3463
|
end
|
3401
3464
|
|
3402
|
-
# Modifies an existing
|
3403
|
-
#
|
3465
|
+
# Modifies an existing subnet group. subnet groups must contain at least
|
3466
|
+
# one subnet in at least two Availability Zones in the AWS Region.
|
3404
3467
|
#
|
3405
3468
|
# @option params [required, String] :db_subnet_group_name
|
3406
|
-
# The name for the
|
3469
|
+
# The name for the subnet group. This value is stored as a lowercase
|
3407
3470
|
# string. You can't modify the default subnet group.
|
3408
3471
|
#
|
3409
3472
|
# Constraints: Must match the name of an existing `DBSubnetGroup`. Must
|
@@ -3412,10 +3475,10 @@ module Aws::DocDB
|
|
3412
3475
|
# Example: `mySubnetgroup`
|
3413
3476
|
#
|
3414
3477
|
# @option params [String] :db_subnet_group_description
|
3415
|
-
# The description for the
|
3478
|
+
# The description for the subnet group.
|
3416
3479
|
#
|
3417
3480
|
# @option params [required, Array<String>] :subnet_ids
|
3418
|
-
# The Amazon EC2 subnet IDs for the
|
3481
|
+
# The Amazon EC2 subnet IDs for the subnet group.
|
3419
3482
|
#
|
3420
3483
|
# @return [Types::ModifyDBSubnetGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3421
3484
|
#
|
@@ -3450,17 +3513,17 @@ module Aws::DocDB
|
|
3450
3513
|
req.send_request(options)
|
3451
3514
|
end
|
3452
3515
|
|
3453
|
-
# You might need to reboot your
|
3516
|
+
# You might need to reboot your instance, usually for maintenance
|
3454
3517
|
# reasons. For example, if you make certain changes, or if you change
|
3455
|
-
# the
|
3456
|
-
#
|
3518
|
+
# the cluster parameter group that is associated with the instance, you
|
3519
|
+
# must reboot the instance for the changes to take effect.
|
3457
3520
|
#
|
3458
|
-
# Rebooting
|
3459
|
-
#
|
3460
|
-
#
|
3521
|
+
# Rebooting an instance restarts the database engine service. Rebooting
|
3522
|
+
# an instance results in a momentary outage, during which the instance
|
3523
|
+
# status is set to *rebooting*.
|
3461
3524
|
#
|
3462
3525
|
# @option params [required, String] :db_instance_identifier
|
3463
|
-
# The
|
3526
|
+
# The instance identifier. This parameter is stored as a lowercase
|
3464
3527
|
# string.
|
3465
3528
|
#
|
3466
3529
|
# Constraints:
|
@@ -3584,9 +3647,9 @@ module Aws::DocDB
|
|
3584
3647
|
req.send_request(options)
|
3585
3648
|
end
|
3586
3649
|
|
3587
|
-
# Modifies the parameters of a
|
3650
|
+
# Modifies the parameters of a cluster parameter group to the default
|
3588
3651
|
# value. To reset specific parameters, submit a list of the following:
|
3589
|
-
# `ParameterName` and `ApplyMethod`. To reset the entire
|
3652
|
+
# `ParameterName` and `ApplyMethod`. To reset the entire cluster
|
3590
3653
|
# parameter group, specify the `DBClusterParameterGroupName` and
|
3591
3654
|
# `ResetAllParameters` parameters.
|
3592
3655
|
#
|
@@ -3595,17 +3658,17 @@ module Aws::DocDB
|
|
3595
3658
|
# effect on the next DB instance reboot.
|
3596
3659
|
#
|
3597
3660
|
# @option params [required, String] :db_cluster_parameter_group_name
|
3598
|
-
# The name of the
|
3661
|
+
# The name of the cluster parameter group to reset.
|
3599
3662
|
#
|
3600
3663
|
# @option params [Boolean] :reset_all_parameters
|
3601
|
-
# A value that is set to `true` to reset all parameters in the
|
3602
|
-
#
|
3603
|
-
#
|
3604
|
-
#
|
3664
|
+
# A value that is set to `true` to reset all parameters in the cluster
|
3665
|
+
# parameter group to their default values, and `false` otherwise. You
|
3666
|
+
# can't use this parameter if there is a list of parameter names
|
3667
|
+
# specified for the `Parameters` parameter.
|
3605
3668
|
#
|
3606
3669
|
# @option params [Array<Types::Parameter>] :parameters
|
3607
|
-
# A list of parameter names in the
|
3608
|
-
#
|
3670
|
+
# A list of parameter names in the cluster parameter group to reset to
|
3671
|
+
# the default values. You can't use this parameter if the
|
3609
3672
|
# `ResetAllParameters` parameter is set to `true`.
|
3610
3673
|
#
|
3611
3674
|
# @return [Types::DBClusterParameterGroupNameMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -3646,24 +3709,24 @@ module Aws::DocDB
|
|
3646
3709
|
req.send_request(options)
|
3647
3710
|
end
|
3648
3711
|
|
3649
|
-
# Creates a new
|
3712
|
+
# Creates a new cluster from a snapshot or cluster snapshot.
|
3650
3713
|
#
|
3651
|
-
# If a
|
3652
|
-
#
|
3653
|
-
#
|
3714
|
+
# If a snapshot is specified, the target cluster is created from the
|
3715
|
+
# source DB snapshot with a default configuration and default security
|
3716
|
+
# group.
|
3654
3717
|
#
|
3655
|
-
# If a
|
3656
|
-
#
|
3657
|
-
#
|
3658
|
-
#
|
3718
|
+
# If a cluster snapshot is specified, the target cluster is created from
|
3719
|
+
# the source cluster restore point with the same configuration as the
|
3720
|
+
# original source DB cluster, except that the new cluster is created
|
3721
|
+
# with the default security group.
|
3659
3722
|
#
|
3660
3723
|
# @option params [Array<String>] :availability_zones
|
3661
3724
|
# Provides the list of Amazon EC2 Availability Zones that instances in
|
3662
3725
|
# the restored DB cluster can be created in.
|
3663
3726
|
#
|
3664
3727
|
# @option params [required, String] :db_cluster_identifier
|
3665
|
-
# The name of the
|
3666
|
-
#
|
3728
|
+
# The name of the cluster to create from the snapshot or cluster
|
3729
|
+
# snapshot. This parameter isn't case sensitive.
|
3667
3730
|
#
|
3668
3731
|
# Constraints:
|
3669
3732
|
#
|
@@ -3676,12 +3739,11 @@ module Aws::DocDB
|
|
3676
3739
|
# Example: `my-snapshot-id`
|
3677
3740
|
#
|
3678
3741
|
# @option params [required, String] :snapshot_identifier
|
3679
|
-
# The identifier for the
|
3680
|
-
# from.
|
3742
|
+
# The identifier for the snapshot or cluster snapshot to restore from.
|
3681
3743
|
#
|
3682
3744
|
# You can use either the name or the Amazon Resource Name (ARN) to
|
3683
|
-
# specify a
|
3684
|
-
# specify a
|
3745
|
+
# specify a cluster snapshot. However, you can use only the ARN to
|
3746
|
+
# specify a snapshot.
|
3685
3747
|
#
|
3686
3748
|
# Constraints:
|
3687
3749
|
#
|
@@ -3690,24 +3752,24 @@ module Aws::DocDB
|
|
3690
3752
|
# ^
|
3691
3753
|
#
|
3692
3754
|
# @option params [required, String] :engine
|
3693
|
-
# The database engine to use for the new
|
3755
|
+
# The database engine to use for the new cluster.
|
3694
3756
|
#
|
3695
3757
|
# Default: The same as source.
|
3696
3758
|
#
|
3697
3759
|
# Constraint: Must be compatible with the engine of the source.
|
3698
3760
|
#
|
3699
3761
|
# @option params [String] :engine_version
|
3700
|
-
# The version of the database engine to use for the new
|
3762
|
+
# The version of the database engine to use for the new cluster.
|
3701
3763
|
#
|
3702
3764
|
# @option params [Integer] :port
|
3703
|
-
# The port number on which the new
|
3765
|
+
# The port number on which the new cluster accepts connections.
|
3704
3766
|
#
|
3705
3767
|
# Constraints: Must be a value from `1150` to `65535`.
|
3706
3768
|
#
|
3707
|
-
# Default: The same port as the original
|
3769
|
+
# Default: The same port as the original cluster.
|
3708
3770
|
#
|
3709
3771
|
# @option params [String] :db_subnet_group_name
|
3710
|
-
# The name of the
|
3772
|
+
# The name of the subnet group to use for the new cluster.
|
3711
3773
|
#
|
3712
3774
|
# Constraints: If provided, must match the name of an existing
|
3713
3775
|
# `DBSubnetGroup`.
|
@@ -3715,33 +3777,31 @@ module Aws::DocDB
|
|
3715
3777
|
# Example: `mySubnetgroup`
|
3716
3778
|
#
|
3717
3779
|
# @option params [Array<String>] :vpc_security_group_ids
|
3718
|
-
# A list of virtual private cloud (VPC) security groups that the new
|
3780
|
+
# A list of virtual private cloud (VPC) security groups that the new
|
3719
3781
|
# cluster will belong to.
|
3720
3782
|
#
|
3721
3783
|
# @option params [Array<Types::Tag>] :tags
|
3722
|
-
# The tags to be assigned to the restored
|
3784
|
+
# The tags to be assigned to the restored cluster.
|
3723
3785
|
#
|
3724
3786
|
# @option params [String] :kms_key_id
|
3725
|
-
# The AWS KMS key identifier to use when restoring an encrypted
|
3726
|
-
#
|
3787
|
+
# The AWS KMS key identifier to use when restoring an encrypted cluster
|
3788
|
+
# from a DB snapshot or cluster snapshot.
|
3727
3789
|
#
|
3728
3790
|
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
3729
|
-
# AWS KMS encryption key. If you are restoring a
|
3730
|
-
#
|
3731
|
-
#
|
3732
|
-
#
|
3791
|
+
# AWS KMS encryption key. If you are restoring a cluster with the same
|
3792
|
+
# AWS account that owns the AWS KMS encryption key used to encrypt the
|
3793
|
+
# new cluster, then you can use the AWS KMS key alias instead of the ARN
|
3794
|
+
# for the AWS KMS encryption key.
|
3733
3795
|
#
|
3734
3796
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
3735
3797
|
# following occurs:
|
3736
3798
|
#
|
3737
|
-
# * If the
|
3738
|
-
# encrypted, then the restored
|
3739
|
-
#
|
3740
|
-
# snapshot.
|
3799
|
+
# * If the snapshot or cluster snapshot in `SnapshotIdentifier` is
|
3800
|
+
# encrypted, then the restored cluster is encrypted using the AWS KMS
|
3801
|
+
# key that was used to encrypt the snapshot or the cluster snapshot.
|
3741
3802
|
#
|
3742
|
-
# * If the
|
3743
|
-
#
|
3744
|
-
# is not encrypted.
|
3803
|
+
# * If the snapshot or the cluster snapshot in `SnapshotIdentifier` is
|
3804
|
+
# not encrypted, then the restored DB cluster is not encrypted.
|
3745
3805
|
#
|
3746
3806
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
3747
3807
|
# A list of log types that must be enabled for exporting to Amazon
|
@@ -3830,15 +3890,15 @@ module Aws::DocDB
|
|
3830
3890
|
req.send_request(options)
|
3831
3891
|
end
|
3832
3892
|
|
3833
|
-
# Restores a
|
3834
|
-
#
|
3835
|
-
# `BackupRetentionPeriod` days. The target
|
3836
|
-
#
|
3837
|
-
#
|
3838
|
-
#
|
3893
|
+
# Restores a cluster to an arbitrary point in time. Users can restore to
|
3894
|
+
# any point in time before `LatestRestorableTime` for up to
|
3895
|
+
# `BackupRetentionPeriod` days. The target cluster is created from the
|
3896
|
+
# source cluster with the same configuration as the original cluster,
|
3897
|
+
# except that the new cluster is created with the default security
|
3898
|
+
# group.
|
3839
3899
|
#
|
3840
3900
|
# @option params [required, String] :db_cluster_identifier
|
3841
|
-
# The name of the new
|
3901
|
+
# The name of the new cluster to be created.
|
3842
3902
|
#
|
3843
3903
|
# Constraints:
|
3844
3904
|
#
|
@@ -3849,7 +3909,7 @@ module Aws::DocDB
|
|
3849
3909
|
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
3850
3910
|
#
|
3851
3911
|
# @option params [required, String] :source_db_cluster_identifier
|
3852
|
-
# The identifier of the source
|
3912
|
+
# The identifier of the source cluster from which to restore.
|
3853
3913
|
#
|
3854
3914
|
# Constraints:
|
3855
3915
|
#
|
@@ -3858,13 +3918,13 @@ module Aws::DocDB
|
|
3858
3918
|
# ^
|
3859
3919
|
#
|
3860
3920
|
# @option params [Time,DateTime,Date,Integer,String] :restore_to_time
|
3861
|
-
# The date and time to restore the
|
3921
|
+
# The date and time to restore the cluster to.
|
3862
3922
|
#
|
3863
3923
|
# Valid values: A time in Universal Coordinated Time (UTC) format.
|
3864
3924
|
#
|
3865
3925
|
# Constraints:
|
3866
3926
|
#
|
3867
|
-
# * Must be before the latest restorable time for the
|
3927
|
+
# * Must be before the latest restorable time for the instance.
|
3868
3928
|
#
|
3869
3929
|
# * Must be specified if the `UseLatestRestorableTime` parameter is not
|
3870
3930
|
# provided.
|
@@ -3878,7 +3938,7 @@ module Aws::DocDB
|
|
3878
3938
|
# Example: `2015-03-07T23:45:00Z`
|
3879
3939
|
#
|
3880
3940
|
# @option params [Boolean] :use_latest_restorable_time
|
3881
|
-
# A value that is set to `true` to restore the
|
3941
|
+
# A value that is set to `true` to restore the cluster to the latest
|
3882
3942
|
# restorable backup time, and `false` otherwise.
|
3883
3943
|
#
|
3884
3944
|
# Default: `false`
|
@@ -3887,14 +3947,14 @@ module Aws::DocDB
|
|
3887
3947
|
# provided.
|
3888
3948
|
#
|
3889
3949
|
# @option params [Integer] :port
|
3890
|
-
# The port number on which the new
|
3950
|
+
# The port number on which the new cluster accepts connections.
|
3891
3951
|
#
|
3892
3952
|
# Constraints: Must be a value from `1150` to `65535`.
|
3893
3953
|
#
|
3894
3954
|
# Default: The default port for the engine.
|
3895
3955
|
#
|
3896
3956
|
# @option params [String] :db_subnet_group_name
|
3897
|
-
# The
|
3957
|
+
# The subnet group name to use for the new cluster.
|
3898
3958
|
#
|
3899
3959
|
# Constraints: If provided, must match the name of an existing
|
3900
3960
|
# `DBSubnetGroup`.
|
@@ -3902,37 +3962,36 @@ module Aws::DocDB
|
|
3902
3962
|
# Example: `mySubnetgroup`
|
3903
3963
|
#
|
3904
3964
|
# @option params [Array<String>] :vpc_security_group_ids
|
3905
|
-
# A list of VPC security groups that the new
|
3965
|
+
# A list of VPC security groups that the new cluster belongs to.
|
3906
3966
|
#
|
3907
3967
|
# @option params [Array<Types::Tag>] :tags
|
3908
|
-
# The tags to be assigned to the restored
|
3968
|
+
# The tags to be assigned to the restored cluster.
|
3909
3969
|
#
|
3910
3970
|
# @option params [String] :kms_key_id
|
3911
|
-
# The AWS KMS key identifier to use when restoring an encrypted
|
3912
|
-
#
|
3971
|
+
# The AWS KMS key identifier to use when restoring an encrypted cluster
|
3972
|
+
# from an encrypted cluster.
|
3913
3973
|
#
|
3914
3974
|
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
3915
|
-
# AWS KMS encryption key. If you are restoring a
|
3916
|
-
#
|
3917
|
-
#
|
3918
|
-
#
|
3975
|
+
# AWS KMS encryption key. If you are restoring a cluster with the same
|
3976
|
+
# AWS account that owns the AWS KMS encryption key used to encrypt the
|
3977
|
+
# new cluster, then you can use the AWS KMS key alias instead of the ARN
|
3978
|
+
# for the AWS KMS encryption key.
|
3919
3979
|
#
|
3920
|
-
# You can restore to a new
|
3921
|
-
#
|
3922
|
-
#
|
3923
|
-
#
|
3980
|
+
# You can restore to a new cluster and encrypt the new cluster with an
|
3981
|
+
# AWS KMS key that is different from the AWS KMS key used to encrypt the
|
3982
|
+
# source cluster. The new DB cluster is encrypted with the AWS KMS key
|
3983
|
+
# identified by the `KmsKeyId` parameter.
|
3924
3984
|
#
|
3925
3985
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
3926
3986
|
# following occurs:
|
3927
3987
|
#
|
3928
|
-
# * If the
|
3929
|
-
#
|
3930
|
-
# DB cluster.
|
3988
|
+
# * If the cluster is encrypted, then the restored cluster is encrypted
|
3989
|
+
# using the AWS KMS key that was used to encrypt the source cluster.
|
3931
3990
|
#
|
3932
|
-
# * If the
|
3933
|
-
#
|
3991
|
+
# * If the cluster is not encrypted, then the restored cluster is not
|
3992
|
+
# encrypted.
|
3934
3993
|
#
|
3935
|
-
# If `DBClusterIdentifier` refers to a
|
3994
|
+
# If `DBClusterIdentifier` refers to a cluster that is not encrypted,
|
3936
3995
|
# then the restore request is rejected.
|
3937
3996
|
#
|
3938
3997
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
@@ -4180,7 +4239,7 @@ module Aws::DocDB
|
|
4180
4239
|
params: params,
|
4181
4240
|
config: config)
|
4182
4241
|
context[:gem_name] = 'aws-sdk-docdb'
|
4183
|
-
context[:gem_version] = '1.
|
4242
|
+
context[:gem_version] = '1.17.0'
|
4184
4243
|
Seahorse::Client::Request.new(handlers, context)
|
4185
4244
|
end
|
4186
4245
|
|
@@ -4246,10 +4305,10 @@ module Aws::DocDB
|
|
4246
4305
|
# The following table lists the valid waiter names, the operations they call,
|
4247
4306
|
# and the default `:delay` and `:max_attempts` values.
|
4248
4307
|
#
|
4249
|
-
# | waiter_name | params
|
4250
|
-
# | --------------------- |
|
4251
|
-
# | db_instance_available | {#describe_db_instances} | 30 | 60 |
|
4252
|
-
# | db_instance_deleted | {#describe_db_instances} | 30 | 60 |
|
4308
|
+
# | waiter_name | params | :delay | :max_attempts |
|
4309
|
+
# | --------------------- | ------------------------------ | -------- | ------------- |
|
4310
|
+
# | db_instance_available | {Client#describe_db_instances} | 30 | 60 |
|
4311
|
+
# | db_instance_deleted | {Client#describe_db_instances} | 30 | 60 |
|
4253
4312
|
#
|
4254
4313
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
4255
4314
|
# because the waiter has entered a state that it will not transition
|