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
data/lib/aws-sdk-docdb/types.rb
CHANGED
@@ -98,6 +98,16 @@ module Aws::DocDB
|
|
98
98
|
include Aws::Structure
|
99
99
|
end
|
100
100
|
|
101
|
+
# The specified CIDR IP or Amazon EC2 security group isn't authorized
|
102
|
+
# for the specified security group.
|
103
|
+
#
|
104
|
+
# Amazon DocumentDB also might not be authorized to perform necessary
|
105
|
+
# actions on your behalf using IAM.
|
106
|
+
#
|
107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AuthorizationNotFoundFault AWS API Documentation
|
108
|
+
#
|
109
|
+
class AuthorizationNotFoundFault < Aws::EmptyStructure; end
|
110
|
+
|
101
111
|
# Information about an Availability Zone.
|
102
112
|
#
|
103
113
|
# @!attribute [rw] name
|
@@ -179,12 +189,18 @@ module Aws::DocDB
|
|
179
189
|
include Aws::Structure
|
180
190
|
end
|
181
191
|
|
192
|
+
# `CertificateIdentifier` doesn't refer to an existing certificate.
|
193
|
+
#
|
194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CertificateNotFoundFault AWS API Documentation
|
195
|
+
#
|
196
|
+
class CertificateNotFoundFault < Aws::EmptyStructure; end
|
197
|
+
|
182
198
|
# The configuration setting for the log types to be enabled for export
|
183
|
-
# to Amazon CloudWatch Logs for a specific
|
199
|
+
# to Amazon CloudWatch Logs for a specific instance or cluster.
|
184
200
|
#
|
185
201
|
# The `EnableLogTypes` and `DisableLogTypes` arrays determine which logs
|
186
202
|
# are exported (or not exported) to CloudWatch Logs. The values within
|
187
|
-
# these arrays depend on the
|
203
|
+
# these arrays depend on the engine that is being used.
|
188
204
|
#
|
189
205
|
# @note When making an API call, you may pass CloudwatchLogsExportConfiguration
|
190
206
|
# data as a hash:
|
@@ -228,25 +244,25 @@ module Aws::DocDB
|
|
228
244
|
# }
|
229
245
|
#
|
230
246
|
# @!attribute [rw] source_db_cluster_parameter_group_identifier
|
231
|
-
# The identifier or Amazon Resource Name (ARN) for the source
|
232
|
-
#
|
247
|
+
# The identifier or Amazon Resource Name (ARN) for the source cluster
|
248
|
+
# parameter group.
|
233
249
|
#
|
234
250
|
# Constraints:
|
235
251
|
#
|
236
|
-
# * Must specify a valid
|
252
|
+
# * Must specify a valid cluster parameter group.
|
237
253
|
#
|
238
|
-
# * If the source
|
239
|
-
#
|
240
|
-
#
|
254
|
+
# * If the source cluster parameter group is in the same AWS Region as
|
255
|
+
# the copy, specify a valid parameter group identifier; for example,
|
256
|
+
# `my-db-cluster-param-group`, or a valid ARN.
|
241
257
|
#
|
242
|
-
# * If the source
|
243
|
-
# the copy, specify a valid
|
258
|
+
# * If the source parameter group is in a different AWS Region than
|
259
|
+
# the copy, specify a valid cluster parameter group ARN; for
|
244
260
|
# example,
|
245
261
|
# `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
|
246
262
|
# @return [String]
|
247
263
|
#
|
248
264
|
# @!attribute [rw] target_db_cluster_parameter_group_identifier
|
249
|
-
# The identifier for the copied
|
265
|
+
# The identifier for the copied cluster parameter group.
|
250
266
|
#
|
251
267
|
# Constraints:
|
252
268
|
#
|
@@ -262,7 +278,7 @@ module Aws::DocDB
|
|
262
278
|
# @return [String]
|
263
279
|
#
|
264
280
|
# @!attribute [rw] target_db_cluster_parameter_group_description
|
265
|
-
# A description for the copied
|
281
|
+
# A description for the copied cluster parameter group.
|
266
282
|
# @return [String]
|
267
283
|
#
|
268
284
|
# @!attribute [rw] tags
|
@@ -280,7 +296,7 @@ module Aws::DocDB
|
|
280
296
|
end
|
281
297
|
|
282
298
|
# @!attribute [rw] db_cluster_parameter_group
|
283
|
-
# Detailed information about a
|
299
|
+
# Detailed information about a cluster parameter group.
|
284
300
|
# @return [Types::DBClusterParameterGroup]
|
285
301
|
#
|
286
302
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterParameterGroupResult AWS API Documentation
|
@@ -310,28 +326,28 @@ module Aws::DocDB
|
|
310
326
|
# }
|
311
327
|
#
|
312
328
|
# @!attribute [rw] source_db_cluster_snapshot_identifier
|
313
|
-
# The identifier of the
|
329
|
+
# The identifier of the cluster snapshot to copy. This parameter is
|
314
330
|
# not case sensitive.
|
315
331
|
#
|
316
|
-
# You can't copy an encrypted, shared
|
317
|
-
#
|
332
|
+
# You can't copy an encrypted, shared cluster snapshot from one AWS
|
333
|
+
# Region to another.
|
318
334
|
#
|
319
335
|
# Constraints:
|
320
336
|
#
|
321
337
|
# * Must specify a valid system snapshot in the "available" state.
|
322
338
|
#
|
323
339
|
# * If the source snapshot is in the same AWS Region as the copy,
|
324
|
-
# specify a valid
|
340
|
+
# specify a valid snapshot identifier.
|
325
341
|
#
|
326
342
|
# * If the source snapshot is in a different AWS Region than the copy,
|
327
|
-
# specify a valid
|
343
|
+
# specify a valid cluster snapshot ARN.
|
328
344
|
#
|
329
345
|
# Example: `my-cluster-snapshot1`
|
330
346
|
# @return [String]
|
331
347
|
#
|
332
348
|
# @!attribute [rw] target_db_cluster_snapshot_identifier
|
333
|
-
# The identifier of the new
|
334
|
-
#
|
349
|
+
# The identifier of the new cluster snapshot to create from the source
|
350
|
+
# cluster snapshot. This parameter is not case sensitive.
|
335
351
|
#
|
336
352
|
# Constraints:
|
337
353
|
#
|
@@ -345,36 +361,36 @@ module Aws::DocDB
|
|
345
361
|
# @return [String]
|
346
362
|
#
|
347
363
|
# @!attribute [rw] kms_key_id
|
348
|
-
# The AWS KMS key ID for an encrypted
|
364
|
+
# The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS
|
349
365
|
# key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or
|
350
366
|
# the AWS KMS key alias for the AWS KMS encryption key.
|
351
367
|
#
|
352
|
-
# If you copy an encrypted
|
353
|
-
#
|
354
|
-
#
|
355
|
-
# `KmsKeyId`, then the copy of the
|
356
|
-
#
|
368
|
+
# If you copy an encrypted cluster snapshot from your AWS account, you
|
369
|
+
# can specify a value for `KmsKeyId` to encrypt the copy with a new
|
370
|
+
# AWS KMS encryption key. If you don't specify a value for
|
371
|
+
# `KmsKeyId`, then the copy of the cluster snapshot is encrypted with
|
372
|
+
# the same AWS KMS key as the source cluster snapshot.
|
357
373
|
#
|
358
|
-
# If you copy an encrypted
|
374
|
+
# If you copy an encrypted cluster snapshot that is shared from
|
359
375
|
# another AWS account, then you must specify a value for `KmsKeyId`.
|
360
376
|
#
|
361
|
-
# To copy an encrypted
|
377
|
+
# To copy an encrypted cluster snapshot to another AWS Region, set
|
362
378
|
# `KmsKeyId` to the AWS KMS key ID that you want to use to encrypt the
|
363
|
-
# copy of the
|
379
|
+
# copy of the cluster snapshot in the destination Region. AWS KMS
|
364
380
|
# encryption keys are specific to the AWS Region that they are created
|
365
381
|
# in, and you can't use encryption keys from one Region in another
|
366
382
|
# Region.
|
367
383
|
#
|
368
|
-
# If you copy an unencrypted
|
369
|
-
#
|
384
|
+
# If you copy an unencrypted cluster snapshot and specify a value for
|
385
|
+
# the `KmsKeyId` parameter, an error is returned.
|
370
386
|
# @return [String]
|
371
387
|
#
|
372
388
|
# @!attribute [rw] pre_signed_url
|
373
389
|
# The URL that contains a Signature Version 4 signed request for the
|
374
390
|
# `CopyDBClusterSnapshot` API action in the AWS Region that contains
|
375
|
-
# the source
|
376
|
-
#
|
377
|
-
#
|
391
|
+
# the source cluster snapshot to copy. You must use the `PreSignedUrl`
|
392
|
+
# parameter when copying an encrypted cluster snapshot from another
|
393
|
+
# AWS Region.
|
378
394
|
#
|
379
395
|
# The presigned URL must be a valid request for the
|
380
396
|
# `CopyDBSClusterSnapshot` API action that can be executed in the
|
@@ -383,7 +399,7 @@ module Aws::DocDB
|
|
383
399
|
# parameter values:
|
384
400
|
#
|
385
401
|
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
386
|
-
# encrypt the copy of the
|
402
|
+
# encrypt the copy of the cluster snapshot in the destination AWS
|
387
403
|
# Region. This is the same identifier for both the
|
388
404
|
# `CopyDBClusterSnapshot` action that is called in the destination
|
389
405
|
# AWS Region, and the action contained in the presigned URL.
|
@@ -391,24 +407,24 @@ module Aws::DocDB
|
|
391
407
|
# * `DestinationRegion` - The name of the AWS Region that the DB
|
392
408
|
# cluster snapshot will be created in.
|
393
409
|
#
|
394
|
-
# * `SourceDBClusterSnapshotIdentifier` - The
|
395
|
-
# identifier for the encrypted
|
396
|
-
#
|
397
|
-
#
|
398
|
-
# encrypted
|
410
|
+
# * `SourceDBClusterSnapshotIdentifier` - The cluster snapshot
|
411
|
+
# identifier for the encrypted cluster snapshot to be copied. This
|
412
|
+
# identifier must be in the Amazon Resource Name (ARN) format for
|
413
|
+
# the source AWS Region. For example, if you are copying an
|
414
|
+
# encrypted cluster snapshot from the us-west-2 AWS Region, then
|
399
415
|
# your `SourceDBClusterSnapshotIdentifier` looks like the following
|
400
416
|
# example:
|
401
417
|
# `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115`.
|
402
418
|
# @return [String]
|
403
419
|
#
|
404
420
|
# @!attribute [rw] copy_tags
|
405
|
-
# Set to `true` to copy all tags from the source
|
406
|
-
#
|
407
|
-
#
|
421
|
+
# Set to `true` to copy all tags from the source cluster snapshot to
|
422
|
+
# the target cluster snapshot, and otherwise `false`. The default is
|
423
|
+
# `false`.
|
408
424
|
# @return [Boolean]
|
409
425
|
#
|
410
426
|
# @!attribute [rw] tags
|
411
|
-
# The tags to be assigned to the
|
427
|
+
# The tags to be assigned to the cluster snapshot.
|
412
428
|
# @return [Array<Types::Tag>]
|
413
429
|
#
|
414
430
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshotMessage AWS API Documentation
|
@@ -424,7 +440,7 @@ module Aws::DocDB
|
|
424
440
|
end
|
425
441
|
|
426
442
|
# @!attribute [rw] db_cluster_snapshot
|
427
|
-
# Detailed information about a
|
443
|
+
# Detailed information about a cluster snapshot.
|
428
444
|
# @return [Types::DBClusterSnapshot]
|
429
445
|
#
|
430
446
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshotResult AWS API Documentation
|
@@ -466,7 +482,7 @@ module Aws::DocDB
|
|
466
482
|
# }
|
467
483
|
#
|
468
484
|
# @!attribute [rw] availability_zones
|
469
|
-
# A list of Amazon EC2 Availability Zones that instances in the
|
485
|
+
# A list of Amazon EC2 Availability Zones that instances in the
|
470
486
|
# cluster can be created in.
|
471
487
|
# @return [Array<String>]
|
472
488
|
#
|
@@ -484,7 +500,7 @@ module Aws::DocDB
|
|
484
500
|
# @return [Integer]
|
485
501
|
#
|
486
502
|
# @!attribute [rw] db_cluster_identifier
|
487
|
-
# The
|
503
|
+
# The cluster identifier. This parameter is stored as a lowercase
|
488
504
|
# string.
|
489
505
|
#
|
490
506
|
# Constraints:
|
@@ -499,16 +515,16 @@ module Aws::DocDB
|
|
499
515
|
# @return [String]
|
500
516
|
#
|
501
517
|
# @!attribute [rw] db_cluster_parameter_group_name
|
502
|
-
# The name of the
|
518
|
+
# The name of the cluster parameter group to associate with this
|
503
519
|
# cluster.
|
504
520
|
# @return [String]
|
505
521
|
#
|
506
522
|
# @!attribute [rw] vpc_security_group_ids
|
507
|
-
# A list of EC2 VPC security groups to associate with this
|
523
|
+
# A list of EC2 VPC security groups to associate with this cluster.
|
508
524
|
# @return [Array<String>]
|
509
525
|
#
|
510
526
|
# @!attribute [rw] db_subnet_group_name
|
511
|
-
# A
|
527
|
+
# A subnet group to associate with this cluster.
|
512
528
|
#
|
513
529
|
# Constraints: Must match the name of an existing `DBSubnetGroup`.
|
514
530
|
# Must not be default.
|
@@ -517,7 +533,7 @@ module Aws::DocDB
|
|
517
533
|
# @return [String]
|
518
534
|
#
|
519
535
|
# @!attribute [rw] engine
|
520
|
-
# The name of the database engine to be used for this
|
536
|
+
# The name of the database engine to be used for this cluster.
|
521
537
|
#
|
522
538
|
# Valid values: `docdb`
|
523
539
|
# @return [String]
|
@@ -527,12 +543,12 @@ module Aws::DocDB
|
|
527
543
|
# @return [String]
|
528
544
|
#
|
529
545
|
# @!attribute [rw] port
|
530
|
-
# The port number on which the instances in the
|
546
|
+
# The port number on which the instances in the cluster accept
|
531
547
|
# connections.
|
532
548
|
# @return [Integer]
|
533
549
|
#
|
534
550
|
# @!attribute [rw] master_username
|
535
|
-
# The name of the master user for the
|
551
|
+
# The name of the master user for the cluster.
|
536
552
|
#
|
537
553
|
# Constraints:
|
538
554
|
#
|
@@ -586,21 +602,21 @@ module Aws::DocDB
|
|
586
602
|
# @return [String]
|
587
603
|
#
|
588
604
|
# @!attribute [rw] tags
|
589
|
-
# The tags to be assigned to the
|
605
|
+
# The tags to be assigned to the cluster.
|
590
606
|
# @return [Array<Types::Tag>]
|
591
607
|
#
|
592
608
|
# @!attribute [rw] storage_encrypted
|
593
|
-
# Specifies whether the
|
609
|
+
# Specifies whether the cluster is encrypted.
|
594
610
|
# @return [Boolean]
|
595
611
|
#
|
596
612
|
# @!attribute [rw] kms_key_id
|
597
|
-
# The AWS KMS key identifier for an encrypted
|
613
|
+
# The AWS KMS key identifier for an encrypted cluster.
|
598
614
|
#
|
599
615
|
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
600
|
-
# AWS KMS encryption key. If you are creating a
|
601
|
-
#
|
602
|
-
#
|
603
|
-
#
|
616
|
+
# AWS KMS encryption key. If you are creating a cluster using the same
|
617
|
+
# AWS account that owns the AWS KMS encryption key that is used to
|
618
|
+
# encrypt the new cluster, you can use the AWS KMS key alias instead
|
619
|
+
# of the ARN for the AWS KMS encryption key.
|
604
620
|
#
|
605
621
|
# If an encryption key is not specified in `KmsKeyId`\:
|
606
622
|
#
|
@@ -617,7 +633,7 @@ module Aws::DocDB
|
|
617
633
|
# Your AWS account has a different default encryption key for each AWS
|
618
634
|
# Region.
|
619
635
|
#
|
620
|
-
# If you create a replica of an encrypted
|
636
|
+
# If you create a replica of an encrypted cluster in another AWS
|
621
637
|
# Region, you must set `KmsKeyId` to a KMS key ID that is valid in the
|
622
638
|
# destination AWS Region. This key is used to encrypt the replica in
|
623
639
|
# that AWS Region.
|
@@ -678,11 +694,11 @@ module Aws::DocDB
|
|
678
694
|
# }
|
679
695
|
#
|
680
696
|
# @!attribute [rw] db_cluster_parameter_group_name
|
681
|
-
# The name of the
|
697
|
+
# The name of the cluster parameter group.
|
682
698
|
#
|
683
699
|
# Constraints:
|
684
700
|
#
|
685
|
-
# * Must match the name of an existing `DBClusterParameterGroup`.
|
701
|
+
# * Must not match the name of an existing `DBClusterParameterGroup`.
|
686
702
|
#
|
687
703
|
# ^
|
688
704
|
#
|
@@ -692,15 +708,15 @@ module Aws::DocDB
|
|
692
708
|
# @return [String]
|
693
709
|
#
|
694
710
|
# @!attribute [rw] db_parameter_group_family
|
695
|
-
# The
|
711
|
+
# The cluster parameter group family name.
|
696
712
|
# @return [String]
|
697
713
|
#
|
698
714
|
# @!attribute [rw] description
|
699
|
-
# The description for the
|
715
|
+
# The description for the cluster parameter group.
|
700
716
|
# @return [String]
|
701
717
|
#
|
702
718
|
# @!attribute [rw] tags
|
703
|
-
# The tags to be assigned to the
|
719
|
+
# The tags to be assigned to the cluster parameter group.
|
704
720
|
# @return [Array<Types::Tag>]
|
705
721
|
#
|
706
722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterParameterGroupMessage AWS API Documentation
|
@@ -714,7 +730,7 @@ module Aws::DocDB
|
|
714
730
|
end
|
715
731
|
|
716
732
|
# @!attribute [rw] db_cluster_parameter_group
|
717
|
-
# Detailed information about a
|
733
|
+
# Detailed information about a cluster parameter group.
|
718
734
|
# @return [Types::DBClusterParameterGroup]
|
719
735
|
#
|
720
736
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterParameterGroupResult AWS API Documentation
|
@@ -725,7 +741,7 @@ module Aws::DocDB
|
|
725
741
|
end
|
726
742
|
|
727
743
|
# @!attribute [rw] db_cluster
|
728
|
-
# Detailed information about a
|
744
|
+
# Detailed information about a cluster.
|
729
745
|
# @return [Types::DBCluster]
|
730
746
|
#
|
731
747
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterResult AWS API Documentation
|
@@ -752,8 +768,8 @@ module Aws::DocDB
|
|
752
768
|
# }
|
753
769
|
#
|
754
770
|
# @!attribute [rw] db_cluster_snapshot_identifier
|
755
|
-
# The identifier of the
|
756
|
-
#
|
771
|
+
# The identifier of the cluster snapshot. This parameter is stored as
|
772
|
+
# a lowercase string.
|
757
773
|
#
|
758
774
|
# Constraints:
|
759
775
|
#
|
@@ -767,7 +783,7 @@ module Aws::DocDB
|
|
767
783
|
# @return [String]
|
768
784
|
#
|
769
785
|
# @!attribute [rw] db_cluster_identifier
|
770
|
-
# The identifier of the
|
786
|
+
# The identifier of the cluster to create a snapshot for. This
|
771
787
|
# parameter is not case sensitive.
|
772
788
|
#
|
773
789
|
# Constraints:
|
@@ -780,7 +796,7 @@ module Aws::DocDB
|
|
780
796
|
# @return [String]
|
781
797
|
#
|
782
798
|
# @!attribute [rw] tags
|
783
|
-
# The tags to be assigned to the
|
799
|
+
# The tags to be assigned to the cluster snapshot.
|
784
800
|
# @return [Array<Types::Tag>]
|
785
801
|
#
|
786
802
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterSnapshotMessage AWS API Documentation
|
@@ -793,7 +809,7 @@ module Aws::DocDB
|
|
793
809
|
end
|
794
810
|
|
795
811
|
# @!attribute [rw] db_cluster_snapshot
|
796
|
-
# Detailed information about a
|
812
|
+
# Detailed information about a cluster snapshot.
|
797
813
|
# @return [Types::DBClusterSnapshot]
|
798
814
|
#
|
799
815
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterSnapshotResult AWS API Documentation
|
@@ -826,7 +842,7 @@ module Aws::DocDB
|
|
826
842
|
# }
|
827
843
|
#
|
828
844
|
# @!attribute [rw] db_instance_identifier
|
829
|
-
# The
|
845
|
+
# The instance identifier. This parameter is stored as a lowercase
|
830
846
|
# string.
|
831
847
|
#
|
832
848
|
# Constraints:
|
@@ -841,7 +857,7 @@ module Aws::DocDB
|
|
841
857
|
# @return [String]
|
842
858
|
#
|
843
859
|
# @!attribute [rw] db_instance_class
|
844
|
-
# The compute and memory capacity of the
|
860
|
+
# The compute and memory capacity of the instance; for example,
|
845
861
|
# `db.r5.large`.
|
846
862
|
# @return [String]
|
847
863
|
#
|
@@ -852,7 +868,7 @@ module Aws::DocDB
|
|
852
868
|
# @return [String]
|
853
869
|
#
|
854
870
|
# @!attribute [rw] availability_zone
|
855
|
-
# The Amazon EC2 Availability Zone that the
|
871
|
+
# The Amazon EC2 Availability Zone that the instance is created in.
|
856
872
|
#
|
857
873
|
# Default: A random, system-chosen Availability Zone in the
|
858
874
|
# endpoint's AWS Region.
|
@@ -881,18 +897,18 @@ module Aws::DocDB
|
|
881
897
|
#
|
882
898
|
# @!attribute [rw] auto_minor_version_upgrade
|
883
899
|
# Indicates that minor engine upgrades are applied automatically to
|
884
|
-
# the
|
900
|
+
# the instance during the maintenance window.
|
885
901
|
#
|
886
902
|
# Default: `true`
|
887
903
|
# @return [Boolean]
|
888
904
|
#
|
889
905
|
# @!attribute [rw] tags
|
890
|
-
# The tags to be assigned to the
|
906
|
+
# The tags to be assigned to the instance. You can assign up to 10
|
891
907
|
# tags to an instance.
|
892
908
|
# @return [Array<Types::Tag>]
|
893
909
|
#
|
894
910
|
# @!attribute [rw] db_cluster_identifier
|
895
|
-
# The identifier of the
|
911
|
+
# The identifier of the cluster that the instance will belong to.
|
896
912
|
# @return [String]
|
897
913
|
#
|
898
914
|
# @!attribute [rw] promotion_tier
|
@@ -921,7 +937,7 @@ module Aws::DocDB
|
|
921
937
|
end
|
922
938
|
|
923
939
|
# @!attribute [rw] db_instance
|
924
|
-
# Detailed information about
|
940
|
+
# Detailed information about an instance.
|
925
941
|
# @return [Types::DBInstance]
|
926
942
|
#
|
927
943
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstanceResult AWS API Documentation
|
@@ -949,8 +965,8 @@ module Aws::DocDB
|
|
949
965
|
# }
|
950
966
|
#
|
951
967
|
# @!attribute [rw] db_subnet_group_name
|
952
|
-
# The name for the
|
953
|
-
#
|
968
|
+
# The name for the subnet group. This value is stored as a lowercase
|
969
|
+
# string.
|
954
970
|
#
|
955
971
|
# Constraints: Must contain no more than 255 letters, numbers,
|
956
972
|
# periods, underscores, spaces, or hyphens. Must not be default.
|
@@ -959,15 +975,15 @@ module Aws::DocDB
|
|
959
975
|
# @return [String]
|
960
976
|
#
|
961
977
|
# @!attribute [rw] db_subnet_group_description
|
962
|
-
# The description for the
|
978
|
+
# The description for the subnet group.
|
963
979
|
# @return [String]
|
964
980
|
#
|
965
981
|
# @!attribute [rw] subnet_ids
|
966
|
-
# The Amazon EC2 subnet IDs for the
|
982
|
+
# The Amazon EC2 subnet IDs for the subnet group.
|
967
983
|
# @return [Array<String>]
|
968
984
|
#
|
969
985
|
# @!attribute [rw] tags
|
970
|
-
# The tags to be assigned to the
|
986
|
+
# The tags to be assigned to the subnet group.
|
971
987
|
# @return [Array<Types::Tag>]
|
972
988
|
#
|
973
989
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBSubnetGroupMessage AWS API Documentation
|
@@ -981,7 +997,7 @@ module Aws::DocDB
|
|
981
997
|
end
|
982
998
|
|
983
999
|
# @!attribute [rw] db_subnet_group
|
984
|
-
# Detailed information about a
|
1000
|
+
# Detailed information about a subnet group.
|
985
1001
|
# @return [Types::DBSubnetGroup]
|
986
1002
|
#
|
987
1003
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBSubnetGroupResult AWS API Documentation
|
@@ -991,36 +1007,35 @@ module Aws::DocDB
|
|
991
1007
|
include Aws::Structure
|
992
1008
|
end
|
993
1009
|
|
994
|
-
# Detailed information about a
|
1010
|
+
# Detailed information about a cluster.
|
995
1011
|
#
|
996
1012
|
# @!attribute [rw] availability_zones
|
997
1013
|
# Provides the list of Amazon EC2 Availability Zones that instances in
|
998
|
-
# the
|
1014
|
+
# the cluster can be created in.
|
999
1015
|
# @return [Array<String>]
|
1000
1016
|
#
|
1001
1017
|
# @!attribute [rw] backup_retention_period
|
1002
|
-
# Specifies the number of days for which automatic
|
1018
|
+
# Specifies the number of days for which automatic snapshots are
|
1003
1019
|
# retained.
|
1004
1020
|
# @return [Integer]
|
1005
1021
|
#
|
1006
1022
|
# @!attribute [rw] db_cluster_identifier
|
1007
|
-
# Contains a user-supplied
|
1008
|
-
#
|
1023
|
+
# Contains a user-supplied cluster identifier. This identifier is the
|
1024
|
+
# unique key that identifies a cluster.
|
1009
1025
|
# @return [String]
|
1010
1026
|
#
|
1011
1027
|
# @!attribute [rw] db_cluster_parameter_group
|
1012
|
-
# Specifies the name of the
|
1013
|
-
# cluster.
|
1028
|
+
# Specifies the name of the cluster parameter group for the cluster.
|
1014
1029
|
# @return [String]
|
1015
1030
|
#
|
1016
1031
|
# @!attribute [rw] db_subnet_group
|
1017
1032
|
# Specifies information on the subnet group that is associated with
|
1018
|
-
# the
|
1033
|
+
# the cluster, including the name, description, and subnets in the
|
1019
1034
|
# subnet group.
|
1020
1035
|
# @return [String]
|
1021
1036
|
#
|
1022
1037
|
# @!attribute [rw] status
|
1023
|
-
# Specifies the current state of this
|
1038
|
+
# Specifies the current state of this cluster.
|
1024
1039
|
# @return [String]
|
1025
1040
|
#
|
1026
1041
|
# @!attribute [rw] percent_progress
|
@@ -1033,18 +1048,18 @@ module Aws::DocDB
|
|
1033
1048
|
# @return [Time]
|
1034
1049
|
#
|
1035
1050
|
# @!attribute [rw] endpoint
|
1036
|
-
# Specifies the connection endpoint for the primary instance of the
|
1051
|
+
# Specifies the connection endpoint for the primary instance of the
|
1037
1052
|
# cluster.
|
1038
1053
|
# @return [String]
|
1039
1054
|
#
|
1040
1055
|
# @!attribute [rw] reader_endpoint
|
1041
|
-
# The reader endpoint for the
|
1056
|
+
# The reader endpoint for the cluster. The reader endpoint for a
|
1042
1057
|
# cluster load balances connections across the Amazon DocumentDB
|
1043
|
-
# replicas that are available in a
|
1058
|
+
# replicas that are available in a cluster. As clients request new
|
1044
1059
|
# connections to the reader endpoint, Amazon DocumentDB distributes
|
1045
1060
|
# the connection requests among the Amazon DocumentDB replicas in the
|
1046
|
-
#
|
1047
|
-
# across multiple Amazon DocumentDB replicas in your
|
1061
|
+
# cluster. This functionality can help balance your read workload
|
1062
|
+
# across multiple Amazon DocumentDB replicas in your cluster.
|
1048
1063
|
#
|
1049
1064
|
# If a failover occurs, and the Amazon DocumentDB replica that you are
|
1050
1065
|
# connected to is promoted to be the primary instance, your connection
|
@@ -1054,12 +1069,12 @@ module Aws::DocDB
|
|
1054
1069
|
# @return [String]
|
1055
1070
|
#
|
1056
1071
|
# @!attribute [rw] multi_az
|
1057
|
-
# Specifies whether the
|
1058
|
-
#
|
1072
|
+
# Specifies whether the cluster has instances in multiple Availability
|
1073
|
+
# Zones.
|
1059
1074
|
# @return [Boolean]
|
1060
1075
|
#
|
1061
1076
|
# @!attribute [rw] engine
|
1062
|
-
# Provides the name of the database engine to be used for this
|
1077
|
+
# Provides the name of the database engine to be used for this
|
1063
1078
|
# cluster.
|
1064
1079
|
# @return [String]
|
1065
1080
|
#
|
@@ -1077,7 +1092,7 @@ module Aws::DocDB
|
|
1077
1092
|
# @return [Integer]
|
1078
1093
|
#
|
1079
1094
|
# @!attribute [rw] master_username
|
1080
|
-
# Contains the master user name for the
|
1095
|
+
# Contains the master user name for the cluster.
|
1081
1096
|
# @return [String]
|
1082
1097
|
#
|
1083
1098
|
# @!attribute [rw] preferred_backup_window
|
@@ -1092,12 +1107,12 @@ module Aws::DocDB
|
|
1092
1107
|
# @return [String]
|
1093
1108
|
#
|
1094
1109
|
# @!attribute [rw] db_cluster_members
|
1095
|
-
# Provides the list of instances that make up the
|
1110
|
+
# Provides the list of instances that make up the cluster.
|
1096
1111
|
# @return [Array<Types::DBClusterMember>]
|
1097
1112
|
#
|
1098
1113
|
# @!attribute [rw] vpc_security_groups
|
1099
1114
|
# Provides a list of virtual private cloud (VPC) security groups that
|
1100
|
-
# the
|
1115
|
+
# the cluster belongs to.
|
1101
1116
|
# @return [Array<Types::VpcSecurityGroupMembership>]
|
1102
1117
|
#
|
1103
1118
|
# @!attribute [rw] hosted_zone_id
|
@@ -1106,38 +1121,38 @@ module Aws::DocDB
|
|
1106
1121
|
# @return [String]
|
1107
1122
|
#
|
1108
1123
|
# @!attribute [rw] storage_encrypted
|
1109
|
-
# Specifies whether the
|
1124
|
+
# Specifies whether the cluster is encrypted.
|
1110
1125
|
# @return [Boolean]
|
1111
1126
|
#
|
1112
1127
|
# @!attribute [rw] kms_key_id
|
1113
1128
|
# If `StorageEncrypted` is `true`, the AWS KMS key identifier for the
|
1114
|
-
# encrypted
|
1129
|
+
# encrypted cluster.
|
1115
1130
|
# @return [String]
|
1116
1131
|
#
|
1117
1132
|
# @!attribute [rw] db_cluster_resource_id
|
1118
|
-
# The AWS Region-unique, immutable identifier for the
|
1133
|
+
# The AWS Region-unique, immutable identifier for the cluster. This
|
1119
1134
|
# identifier is found in AWS CloudTrail log entries whenever the AWS
|
1120
|
-
# KMS key for the
|
1135
|
+
# KMS key for the cluster is accessed.
|
1121
1136
|
# @return [String]
|
1122
1137
|
#
|
1123
1138
|
# @!attribute [rw] db_cluster_arn
|
1124
|
-
# The Amazon Resource Name (ARN) for the
|
1139
|
+
# The Amazon Resource Name (ARN) for the cluster.
|
1125
1140
|
# @return [String]
|
1126
1141
|
#
|
1127
1142
|
# @!attribute [rw] associated_roles
|
1128
1143
|
# Provides a list of the AWS Identity and Access Management (IAM)
|
1129
|
-
# roles that are associated with the
|
1130
|
-
# associated with a
|
1131
|
-
#
|
1144
|
+
# roles that are associated with the cluster. IAM roles that are
|
1145
|
+
# associated with a cluster grant permission for the cluster to access
|
1146
|
+
# other AWS services on your behalf.
|
1132
1147
|
# @return [Array<Types::DBClusterRole>]
|
1133
1148
|
#
|
1134
1149
|
# @!attribute [rw] cluster_create_time
|
1135
|
-
# Specifies the time when the
|
1150
|
+
# Specifies the time when the cluster was created, in Universal
|
1136
1151
|
# Coordinated Time (UTC).
|
1137
1152
|
# @return [Time]
|
1138
1153
|
#
|
1139
1154
|
# @!attribute [rw] enabled_cloudwatch_logs_exports
|
1140
|
-
# A list of log types that this
|
1155
|
+
# A list of log types that this cluster is configured to export to
|
1141
1156
|
# Amazon CloudWatch Logs.
|
1142
1157
|
# @return [Array<String>]
|
1143
1158
|
#
|
@@ -1184,20 +1199,26 @@ module Aws::DocDB
|
|
1184
1199
|
include Aws::Structure
|
1185
1200
|
end
|
1186
1201
|
|
1187
|
-
#
|
1202
|
+
# You already have a cluster with the given identifier.
|
1203
|
+
#
|
1204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterAlreadyExistsFault AWS API Documentation
|
1205
|
+
#
|
1206
|
+
class DBClusterAlreadyExistsFault < Aws::EmptyStructure; end
|
1207
|
+
|
1208
|
+
# Contains information about an instance that is part of a cluster.
|
1188
1209
|
#
|
1189
1210
|
# @!attribute [rw] db_instance_identifier
|
1190
|
-
# Specifies the instance identifier for this member of the
|
1211
|
+
# Specifies the instance identifier for this member of the cluster.
|
1191
1212
|
# @return [String]
|
1192
1213
|
#
|
1193
1214
|
# @!attribute [rw] is_cluster_writer
|
1194
1215
|
# A value that is `true` if the cluster member is the primary instance
|
1195
|
-
# for the
|
1216
|
+
# for the cluster and `false` otherwise.
|
1196
1217
|
# @return [Boolean]
|
1197
1218
|
#
|
1198
1219
|
# @!attribute [rw] db_cluster_parameter_group_status
|
1199
|
-
# Specifies the status of the
|
1200
|
-
#
|
1220
|
+
# Specifies the status of the cluster parameter group for this member
|
1221
|
+
# of the DB cluster.
|
1201
1222
|
# @return [String]
|
1202
1223
|
#
|
1203
1224
|
# @!attribute [rw] promotion_tier
|
@@ -1225,7 +1246,7 @@ module Aws::DocDB
|
|
1225
1246
|
# @return [String]
|
1226
1247
|
#
|
1227
1248
|
# @!attribute [rw] db_clusters
|
1228
|
-
# A list of
|
1249
|
+
# A list of clusters.
|
1229
1250
|
# @return [Array<Types::DBCluster>]
|
1230
1251
|
#
|
1231
1252
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterMessage AWS API Documentation
|
@@ -1236,24 +1257,30 @@ module Aws::DocDB
|
|
1236
1257
|
include Aws::Structure
|
1237
1258
|
end
|
1238
1259
|
|
1239
|
-
#
|
1260
|
+
# `DBClusterIdentifier` doesn't refer to an existing cluster.
|
1261
|
+
#
|
1262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterNotFoundFault AWS API Documentation
|
1263
|
+
#
|
1264
|
+
class DBClusterNotFoundFault < Aws::EmptyStructure; end
|
1265
|
+
|
1266
|
+
# Detailed information about a cluster parameter group.
|
1240
1267
|
#
|
1241
1268
|
# @!attribute [rw] db_cluster_parameter_group_name
|
1242
|
-
# Provides the name of the
|
1269
|
+
# Provides the name of the cluster parameter group.
|
1243
1270
|
# @return [String]
|
1244
1271
|
#
|
1245
1272
|
# @!attribute [rw] db_parameter_group_family
|
1246
|
-
# Provides the name of the
|
1247
|
-
#
|
1273
|
+
# Provides the name of the parameter group family that this cluster
|
1274
|
+
# parameter group is compatible with.
|
1248
1275
|
# @return [String]
|
1249
1276
|
#
|
1250
1277
|
# @!attribute [rw] description
|
1251
|
-
# Provides the customer-specified description for this
|
1278
|
+
# Provides the customer-specified description for this cluster
|
1252
1279
|
# parameter group.
|
1253
1280
|
# @return [String]
|
1254
1281
|
#
|
1255
1282
|
# @!attribute [rw] db_cluster_parameter_group_arn
|
1256
|
-
# The Amazon Resource Name (ARN) for the
|
1283
|
+
# The Amazon Resource Name (ARN) for the cluster parameter group.
|
1257
1284
|
# @return [String]
|
1258
1285
|
#
|
1259
1286
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroup AWS API Documentation
|
@@ -1269,7 +1296,7 @@ module Aws::DocDB
|
|
1269
1296
|
# Represents the output of DBClusterParameterGroup.
|
1270
1297
|
#
|
1271
1298
|
# @!attribute [rw] parameters
|
1272
|
-
# Provides a list of parameters for the
|
1299
|
+
# Provides a list of parameters for the cluster parameter group.
|
1273
1300
|
# @return [Array<Types::Parameter>]
|
1274
1301
|
#
|
1275
1302
|
# @!attribute [rw] marker
|
@@ -1286,10 +1313,10 @@ module Aws::DocDB
|
|
1286
1313
|
include Aws::Structure
|
1287
1314
|
end
|
1288
1315
|
|
1289
|
-
# Contains the name of a
|
1316
|
+
# Contains the name of a cluster parameter group.
|
1290
1317
|
#
|
1291
1318
|
# @!attribute [rw] db_cluster_parameter_group_name
|
1292
|
-
# The name of a
|
1319
|
+
# The name of a cluster parameter group.
|
1293
1320
|
#
|
1294
1321
|
# Constraints:
|
1295
1322
|
#
|
@@ -1311,6 +1338,13 @@ module Aws::DocDB
|
|
1311
1338
|
include Aws::Structure
|
1312
1339
|
end
|
1313
1340
|
|
1341
|
+
# `DBClusterParameterGroupName` doesn't refer to an existing cluster
|
1342
|
+
# parameter group.
|
1343
|
+
#
|
1344
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroupNotFoundFault AWS API Documentation
|
1345
|
+
#
|
1346
|
+
class DBClusterParameterGroupNotFoundFault < Aws::EmptyStructure; end
|
1347
|
+
|
1314
1348
|
# Represents the output of DBClusterParameterGroups.
|
1315
1349
|
#
|
1316
1350
|
# @!attribute [rw] marker
|
@@ -1320,7 +1354,7 @@ module Aws::DocDB
|
|
1320
1354
|
# @return [String]
|
1321
1355
|
#
|
1322
1356
|
# @!attribute [rw] db_cluster_parameter_groups
|
1323
|
-
# A list of
|
1357
|
+
# A list of cluster parameter groups.
|
1324
1358
|
# @return [Array<Types::DBClusterParameterGroup>]
|
1325
1359
|
#
|
1326
1360
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroupsMessage AWS API Documentation
|
@@ -1331,8 +1365,15 @@ module Aws::DocDB
|
|
1331
1365
|
include Aws::Structure
|
1332
1366
|
end
|
1333
1367
|
|
1368
|
+
# The cluster can't be created because you have reached the maximum
|
1369
|
+
# allowed quota of clusters.
|
1370
|
+
#
|
1371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterQuotaExceededFault AWS API Documentation
|
1372
|
+
#
|
1373
|
+
class DBClusterQuotaExceededFault < Aws::EmptyStructure; end
|
1374
|
+
|
1334
1375
|
# Describes an AWS Identity and Access Management (IAM) role that is
|
1335
|
-
# associated with a
|
1376
|
+
# associated with a cluster.
|
1336
1377
|
#
|
1337
1378
|
# @!attribute [rw] role_arn
|
1338
1379
|
# The Amazon Resource Name (ARN) of the IAM role that is associated
|
@@ -1340,17 +1381,17 @@ module Aws::DocDB
|
|
1340
1381
|
# @return [String]
|
1341
1382
|
#
|
1342
1383
|
# @!attribute [rw] status
|
1343
|
-
# Describes the state of association between the IAM role and the
|
1384
|
+
# Describes the state of association between the IAM role and the
|
1344
1385
|
# cluster. The `Status` property returns one of the following values:
|
1345
1386
|
#
|
1346
|
-
# * `ACTIVE` - The IAM role ARN is associated with the
|
1347
|
-
#
|
1387
|
+
# * `ACTIVE` - The IAM role ARN is associated with the cluster and can
|
1388
|
+
# be used to access other AWS services on your behalf.
|
1348
1389
|
#
|
1349
1390
|
# * `PENDING` - The IAM role ARN is being associated with the DB
|
1350
1391
|
# cluster.
|
1351
1392
|
#
|
1352
|
-
# * `INVALID` - The IAM role ARN is associated with the
|
1353
|
-
#
|
1393
|
+
# * `INVALID` - The IAM role ARN is associated with the cluster, but
|
1394
|
+
# the cluster cannot assume the IAM role to access other AWS
|
1354
1395
|
# services on your behalf.
|
1355
1396
|
# @return [String]
|
1356
1397
|
#
|
@@ -1362,20 +1403,20 @@ module Aws::DocDB
|
|
1362
1403
|
include Aws::Structure
|
1363
1404
|
end
|
1364
1405
|
|
1365
|
-
# Detailed information about a
|
1406
|
+
# Detailed information about a cluster snapshot.
|
1366
1407
|
#
|
1367
1408
|
# @!attribute [rw] availability_zones
|
1368
1409
|
# Provides the list of Amazon EC2 Availability Zones that instances in
|
1369
|
-
# the
|
1410
|
+
# the cluster snapshot can be restored in.
|
1370
1411
|
# @return [Array<String>]
|
1371
1412
|
#
|
1372
1413
|
# @!attribute [rw] db_cluster_snapshot_identifier
|
1373
|
-
# Specifies the identifier for the
|
1414
|
+
# Specifies the identifier for the cluster snapshot.
|
1374
1415
|
# @return [String]
|
1375
1416
|
#
|
1376
1417
|
# @!attribute [rw] db_cluster_identifier
|
1377
|
-
# Specifies the
|
1378
|
-
#
|
1418
|
+
# Specifies the cluster identifier of the cluster that this cluster
|
1419
|
+
# snapshot was created from.
|
1379
1420
|
# @return [String]
|
1380
1421
|
#
|
1381
1422
|
# @!attribute [rw] snapshot_create_time
|
@@ -1387,35 +1428,35 @@ module Aws::DocDB
|
|
1387
1428
|
# @return [String]
|
1388
1429
|
#
|
1389
1430
|
# @!attribute [rw] status
|
1390
|
-
# Specifies the status of this
|
1431
|
+
# Specifies the status of this cluster snapshot.
|
1391
1432
|
# @return [String]
|
1392
1433
|
#
|
1393
1434
|
# @!attribute [rw] port
|
1394
|
-
# Specifies the port that the
|
1395
|
-
#
|
1435
|
+
# Specifies the port that the cluster was listening on at the time of
|
1436
|
+
# the snapshot.
|
1396
1437
|
# @return [Integer]
|
1397
1438
|
#
|
1398
1439
|
# @!attribute [rw] vpc_id
|
1399
1440
|
# Provides the virtual private cloud (VPC) ID that is associated with
|
1400
|
-
# the
|
1441
|
+
# the cluster snapshot.
|
1401
1442
|
# @return [String]
|
1402
1443
|
#
|
1403
1444
|
# @!attribute [rw] cluster_create_time
|
1404
|
-
# Specifies the time when the
|
1445
|
+
# Specifies the time when the cluster was created, in Universal
|
1405
1446
|
# Coordinated Time (UTC).
|
1406
1447
|
# @return [Time]
|
1407
1448
|
#
|
1408
1449
|
# @!attribute [rw] master_username
|
1409
|
-
# Provides the master user name for the
|
1450
|
+
# Provides the master user name for the cluster snapshot.
|
1410
1451
|
# @return [String]
|
1411
1452
|
#
|
1412
1453
|
# @!attribute [rw] engine_version
|
1413
|
-
# Provides the version of the database engine for this
|
1454
|
+
# Provides the version of the database engine for this cluster
|
1414
1455
|
# snapshot.
|
1415
1456
|
# @return [String]
|
1416
1457
|
#
|
1417
1458
|
# @!attribute [rw] snapshot_type
|
1418
|
-
# Provides the type of the
|
1459
|
+
# Provides the type of the cluster snapshot.
|
1419
1460
|
# @return [String]
|
1420
1461
|
#
|
1421
1462
|
# @!attribute [rw] percent_progress
|
@@ -1424,22 +1465,21 @@ module Aws::DocDB
|
|
1424
1465
|
# @return [Integer]
|
1425
1466
|
#
|
1426
1467
|
# @!attribute [rw] storage_encrypted
|
1427
|
-
# Specifies whether the
|
1468
|
+
# Specifies whether the cluster snapshot is encrypted.
|
1428
1469
|
# @return [Boolean]
|
1429
1470
|
#
|
1430
1471
|
# @!attribute [rw] kms_key_id
|
1431
1472
|
# If `StorageEncrypted` is `true`, the AWS KMS key identifier for the
|
1432
|
-
# encrypted
|
1473
|
+
# encrypted cluster snapshot.
|
1433
1474
|
# @return [String]
|
1434
1475
|
#
|
1435
1476
|
# @!attribute [rw] db_cluster_snapshot_arn
|
1436
|
-
# The Amazon Resource Name (ARN) for the
|
1477
|
+
# The Amazon Resource Name (ARN) for the cluster snapshot.
|
1437
1478
|
# @return [String]
|
1438
1479
|
#
|
1439
1480
|
# @!attribute [rw] source_db_cluster_snapshot_arn
|
1440
|
-
# If the
|
1441
|
-
#
|
1442
|
-
# null value.
|
1481
|
+
# If the cluster snapshot was copied from a source cluster snapshot,
|
1482
|
+
# the ARN for the source cluster snapshot; otherwise, a null value.
|
1443
1483
|
# @return [String]
|
1444
1484
|
#
|
1445
1485
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshot AWS API Documentation
|
@@ -1465,27 +1505,31 @@ module Aws::DocDB
|
|
1465
1505
|
include Aws::Structure
|
1466
1506
|
end
|
1467
1507
|
|
1468
|
-
#
|
1469
|
-
#
|
1508
|
+
# You already have a cluster snapshot with the given identifier.
|
1509
|
+
#
|
1510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotAlreadyExistsFault AWS API Documentation
|
1511
|
+
#
|
1512
|
+
class DBClusterSnapshotAlreadyExistsFault < Aws::EmptyStructure; end
|
1513
|
+
|
1514
|
+
# Contains the name and values of a manual cluster snapshot attribute.
|
1470
1515
|
#
|
1471
|
-
# Manual
|
1472
|
-
# accounts to restore a manual
|
1516
|
+
# Manual cluster snapshot attributes are used to authorize other AWS
|
1517
|
+
# accounts to restore a manual cluster snapshot.
|
1473
1518
|
#
|
1474
1519
|
# @!attribute [rw] attribute_name
|
1475
|
-
# The name of the manual
|
1520
|
+
# The name of the manual cluster snapshot attribute.
|
1476
1521
|
#
|
1477
1522
|
# The attribute named `restore` refers to the list of AWS accounts
|
1478
|
-
# that have permission to copy or restore the manual
|
1479
|
-
# snapshot.
|
1523
|
+
# that have permission to copy or restore the manual cluster snapshot.
|
1480
1524
|
# @return [String]
|
1481
1525
|
#
|
1482
1526
|
# @!attribute [rw] attribute_values
|
1483
|
-
# The values for the manual
|
1527
|
+
# The values for the manual cluster snapshot attribute.
|
1484
1528
|
#
|
1485
1529
|
# If the `AttributeName` field is set to `restore`, then this element
|
1486
1530
|
# returns a list of IDs of the AWS accounts that are authorized to
|
1487
|
-
# copy or restore the manual
|
1488
|
-
#
|
1531
|
+
# copy or restore the manual cluster snapshot. If a value of `all` is
|
1532
|
+
# in the list, then the manual cluster snapshot is public and
|
1489
1533
|
# available for any AWS account to copy or restore.
|
1490
1534
|
# @return [Array<String>]
|
1491
1535
|
#
|
@@ -1498,15 +1542,14 @@ module Aws::DocDB
|
|
1498
1542
|
end
|
1499
1543
|
|
1500
1544
|
# Detailed information about the attributes that are associated with a
|
1501
|
-
#
|
1545
|
+
# cluster snapshot.
|
1502
1546
|
#
|
1503
1547
|
# @!attribute [rw] db_cluster_snapshot_identifier
|
1504
|
-
# The identifier of the
|
1505
|
-
# to.
|
1548
|
+
# The identifier of the cluster snapshot that the attributes apply to.
|
1506
1549
|
# @return [String]
|
1507
1550
|
#
|
1508
1551
|
# @!attribute [rw] db_cluster_snapshot_attributes
|
1509
|
-
# The list of attributes and values for the
|
1552
|
+
# The list of attributes and values for the cluster snapshot.
|
1510
1553
|
# @return [Array<Types::DBClusterSnapshotAttribute>]
|
1511
1554
|
#
|
1512
1555
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotAttributesResult AWS API Documentation
|
@@ -1526,7 +1569,7 @@ module Aws::DocDB
|
|
1526
1569
|
# @return [String]
|
1527
1570
|
#
|
1528
1571
|
# @!attribute [rw] db_cluster_snapshots
|
1529
|
-
# Provides a list of
|
1572
|
+
# Provides a list of cluster snapshots.
|
1530
1573
|
# @return [Array<Types::DBClusterSnapshot>]
|
1531
1574
|
#
|
1532
1575
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotMessage AWS API Documentation
|
@@ -1537,7 +1580,14 @@ module Aws::DocDB
|
|
1537
1580
|
include Aws::Structure
|
1538
1581
|
end
|
1539
1582
|
|
1540
|
-
#
|
1583
|
+
# `DBClusterSnapshotIdentifier` doesn't refer to an existing cluster
|
1584
|
+
# snapshot.
|
1585
|
+
#
|
1586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotNotFoundFault AWS API Documentation
|
1587
|
+
#
|
1588
|
+
class DBClusterSnapshotNotFoundFault < Aws::EmptyStructure; end
|
1589
|
+
|
1590
|
+
# Detailed information about an engine version.
|
1541
1591
|
#
|
1542
1592
|
# @!attribute [rw] engine
|
1543
1593
|
# The name of the database engine.
|
@@ -1548,7 +1598,7 @@ module Aws::DocDB
|
|
1548
1598
|
# @return [String]
|
1549
1599
|
#
|
1550
1600
|
# @!attribute [rw] db_parameter_group_family
|
1551
|
-
# The name of the
|
1601
|
+
# The name of the parameter group family for the database engine.
|
1552
1602
|
# @return [String]
|
1553
1603
|
#
|
1554
1604
|
# @!attribute [rw] db_engine_description
|
@@ -1597,7 +1647,7 @@ module Aws::DocDB
|
|
1597
1647
|
# @return [String]
|
1598
1648
|
#
|
1599
1649
|
# @!attribute [rw] db_engine_versions
|
1600
|
-
# Detailed information about one or more
|
1650
|
+
# Detailed information about one or more engine versions.
|
1601
1651
|
# @return [Array<Types::DBEngineVersion>]
|
1602
1652
|
#
|
1603
1653
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBEngineVersionMessage AWS API Documentation
|
@@ -1608,20 +1658,20 @@ module Aws::DocDB
|
|
1608
1658
|
include Aws::Structure
|
1609
1659
|
end
|
1610
1660
|
|
1611
|
-
# Detailed information about
|
1661
|
+
# Detailed information about an instance.
|
1612
1662
|
#
|
1613
1663
|
# @!attribute [rw] db_instance_identifier
|
1614
1664
|
# Contains a user-provided database identifier. This identifier is the
|
1615
|
-
# unique key that identifies
|
1665
|
+
# unique key that identifies an instance.
|
1616
1666
|
# @return [String]
|
1617
1667
|
#
|
1618
1668
|
# @!attribute [rw] db_instance_class
|
1619
|
-
# Contains the name of the compute and memory capacity class of the
|
1669
|
+
# Contains the name of the compute and memory capacity class of the
|
1620
1670
|
# instance.
|
1621
1671
|
# @return [String]
|
1622
1672
|
#
|
1623
1673
|
# @!attribute [rw] engine
|
1624
|
-
# Provides the name of the database engine to be used for this
|
1674
|
+
# Provides the name of the database engine to be used for this
|
1625
1675
|
# instance.
|
1626
1676
|
# @return [String]
|
1627
1677
|
#
|
@@ -1634,7 +1684,7 @@ module Aws::DocDB
|
|
1634
1684
|
# @return [Types::Endpoint]
|
1635
1685
|
#
|
1636
1686
|
# @!attribute [rw] instance_create_time
|
1637
|
-
# Provides the date and time that the
|
1687
|
+
# Provides the date and time that the instance was created.
|
1638
1688
|
# @return [Time]
|
1639
1689
|
#
|
1640
1690
|
# @!attribute [rw] preferred_backup_window
|
@@ -1644,23 +1694,23 @@ module Aws::DocDB
|
|
1644
1694
|
# @return [String]
|
1645
1695
|
#
|
1646
1696
|
# @!attribute [rw] backup_retention_period
|
1647
|
-
# Specifies the number of days for which automatic
|
1697
|
+
# Specifies the number of days for which automatic snapshots are
|
1648
1698
|
# retained.
|
1649
1699
|
# @return [Integer]
|
1650
1700
|
#
|
1651
1701
|
# @!attribute [rw] vpc_security_groups
|
1652
|
-
# Provides a list of VPC security group elements that the
|
1702
|
+
# Provides a list of VPC security group elements that the instance
|
1653
1703
|
# belongs to.
|
1654
1704
|
# @return [Array<Types::VpcSecurityGroupMembership>]
|
1655
1705
|
#
|
1656
1706
|
# @!attribute [rw] availability_zone
|
1657
|
-
# Specifies the name of the Availability Zone that the
|
1707
|
+
# Specifies the name of the Availability Zone that the instance is
|
1658
1708
|
# located in.
|
1659
1709
|
# @return [String]
|
1660
1710
|
#
|
1661
1711
|
# @!attribute [rw] db_subnet_group
|
1662
1712
|
# Specifies information on the subnet group that is associated with
|
1663
|
-
# the
|
1713
|
+
# the instance, including the name, description, and subnets in the
|
1664
1714
|
# subnet group.
|
1665
1715
|
# @return [Types::DBSubnetGroup]
|
1666
1716
|
#
|
@@ -1670,8 +1720,8 @@ module Aws::DocDB
|
|
1670
1720
|
# @return [String]
|
1671
1721
|
#
|
1672
1722
|
# @!attribute [rw] pending_modified_values
|
1673
|
-
# Specifies that changes to the
|
1674
|
-
#
|
1723
|
+
# Specifies that changes to the instance are pending. This element is
|
1724
|
+
# included only when changes are pending. Specific changes are
|
1675
1725
|
# identified by subelements.
|
1676
1726
|
# @return [Types::PendingModifiedValues]
|
1677
1727
|
#
|
@@ -1699,23 +1749,23 @@ module Aws::DocDB
|
|
1699
1749
|
# @return [Array<Types::DBInstanceStatusInfo>]
|
1700
1750
|
#
|
1701
1751
|
# @!attribute [rw] db_cluster_identifier
|
1702
|
-
# Contains the name of the
|
1703
|
-
#
|
1752
|
+
# Contains the name of the cluster that the instance is a member of if
|
1753
|
+
# the instance is a member of a cluster.
|
1704
1754
|
# @return [String]
|
1705
1755
|
#
|
1706
1756
|
# @!attribute [rw] storage_encrypted
|
1707
|
-
# Specifies whether or not the
|
1757
|
+
# Specifies whether or not the instance is encrypted.
|
1708
1758
|
# @return [Boolean]
|
1709
1759
|
#
|
1710
1760
|
# @!attribute [rw] kms_key_id
|
1711
1761
|
# If `StorageEncrypted` is `true`, the AWS KMS key identifier for the
|
1712
|
-
# encrypted
|
1762
|
+
# encrypted instance.
|
1713
1763
|
# @return [String]
|
1714
1764
|
#
|
1715
1765
|
# @!attribute [rw] dbi_resource_id
|
1716
|
-
# The AWS Region-unique, immutable identifier for the
|
1717
|
-
#
|
1718
|
-
#
|
1766
|
+
# The AWS Region-unique, immutable identifier for the instance. This
|
1767
|
+
# identifier is found in AWS CloudTrail log entries whenever the AWS
|
1768
|
+
# KMS key for the instance is accessed.
|
1719
1769
|
# @return [String]
|
1720
1770
|
#
|
1721
1771
|
# @!attribute [rw] ca_certificate_identifier
|
@@ -1729,11 +1779,11 @@ module Aws::DocDB
|
|
1729
1779
|
# @return [Integer]
|
1730
1780
|
#
|
1731
1781
|
# @!attribute [rw] db_instance_arn
|
1732
|
-
# The Amazon Resource Name (ARN) for the
|
1782
|
+
# The Amazon Resource Name (ARN) for the instance.
|
1733
1783
|
# @return [String]
|
1734
1784
|
#
|
1735
1785
|
# @!attribute [rw] enabled_cloudwatch_logs_exports
|
1736
|
-
# A list of log types that this
|
1786
|
+
# A list of log types that this instance is configured to export to
|
1737
1787
|
# Amazon CloudWatch Logs.
|
1738
1788
|
# @return [Array<String>]
|
1739
1789
|
#
|
@@ -1769,6 +1819,12 @@ module Aws::DocDB
|
|
1769
1819
|
include Aws::Structure
|
1770
1820
|
end
|
1771
1821
|
|
1822
|
+
# You already have a instance with the given identifier.
|
1823
|
+
#
|
1824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstanceAlreadyExistsFault AWS API Documentation
|
1825
|
+
#
|
1826
|
+
class DBInstanceAlreadyExistsFault < Aws::EmptyStructure; end
|
1827
|
+
|
1772
1828
|
# Represents the output of DescribeDBInstances.
|
1773
1829
|
#
|
1774
1830
|
# @!attribute [rw] marker
|
@@ -1778,7 +1834,7 @@ module Aws::DocDB
|
|
1778
1834
|
# @return [String]
|
1779
1835
|
#
|
1780
1836
|
# @!attribute [rw] db_instances
|
1781
|
-
# Detailed information about one or more
|
1837
|
+
# Detailed information about one or more instances.
|
1782
1838
|
# @return [Array<Types::DBInstance>]
|
1783
1839
|
#
|
1784
1840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstanceMessage AWS API Documentation
|
@@ -1789,7 +1845,13 @@ module Aws::DocDB
|
|
1789
1845
|
include Aws::Structure
|
1790
1846
|
end
|
1791
1847
|
|
1792
|
-
#
|
1848
|
+
# `DBInstanceIdentifier` doesn't refer to an existing instance.
|
1849
|
+
#
|
1850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstanceNotFoundFault AWS API Documentation
|
1851
|
+
#
|
1852
|
+
class DBInstanceNotFoundFault < Aws::EmptyStructure; end
|
1853
|
+
|
1854
|
+
# Provides a list of status information for an instance.
|
1793
1855
|
#
|
1794
1856
|
# @!attribute [rw] status_type
|
1795
1857
|
# This value is currently "`read replication`."
|
@@ -1801,7 +1863,7 @@ module Aws::DocDB
|
|
1801
1863
|
# @return [Boolean]
|
1802
1864
|
#
|
1803
1865
|
# @!attribute [rw] status
|
1804
|
-
# Status of the
|
1866
|
+
# Status of the instance. For a `StatusType` of read replica, the
|
1805
1867
|
# values can be `replicating`, error, `stopped`, or `terminated`.
|
1806
1868
|
# @return [String]
|
1807
1869
|
#
|
@@ -1820,26 +1882,63 @@ module Aws::DocDB
|
|
1820
1882
|
include Aws::Structure
|
1821
1883
|
end
|
1822
1884
|
|
1823
|
-
#
|
1885
|
+
# A parameter group with the same name already exists.
|
1886
|
+
#
|
1887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBParameterGroupAlreadyExistsFault AWS API Documentation
|
1888
|
+
#
|
1889
|
+
class DBParameterGroupAlreadyExistsFault < Aws::EmptyStructure; end
|
1890
|
+
|
1891
|
+
# `DBParameterGroupName` doesn't refer to an existing parameter group.
|
1892
|
+
#
|
1893
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBParameterGroupNotFoundFault AWS API Documentation
|
1894
|
+
#
|
1895
|
+
class DBParameterGroupNotFoundFault < Aws::EmptyStructure; end
|
1896
|
+
|
1897
|
+
# This request would cause you to exceed the allowed number of parameter
|
1898
|
+
# groups.
|
1899
|
+
#
|
1900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBParameterGroupQuotaExceededFault AWS API Documentation
|
1901
|
+
#
|
1902
|
+
class DBParameterGroupQuotaExceededFault < Aws::EmptyStructure; end
|
1903
|
+
|
1904
|
+
# `DBSecurityGroupName` doesn't refer to an existing security group.
|
1905
|
+
#
|
1906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSecurityGroupNotFoundFault AWS API Documentation
|
1907
|
+
#
|
1908
|
+
class DBSecurityGroupNotFoundFault < Aws::EmptyStructure; end
|
1909
|
+
|
1910
|
+
# `DBSnapshotIdentifier` is already being used by an existing snapshot.
|
1911
|
+
#
|
1912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSnapshotAlreadyExistsFault AWS API Documentation
|
1913
|
+
#
|
1914
|
+
class DBSnapshotAlreadyExistsFault < Aws::EmptyStructure; end
|
1915
|
+
|
1916
|
+
# `DBSnapshotIdentifier` doesn't refer to an existing snapshot.
|
1917
|
+
#
|
1918
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSnapshotNotFoundFault AWS API Documentation
|
1919
|
+
#
|
1920
|
+
class DBSnapshotNotFoundFault < Aws::EmptyStructure; end
|
1921
|
+
|
1922
|
+
# Detailed information about a subnet group.
|
1824
1923
|
#
|
1825
1924
|
# @!attribute [rw] db_subnet_group_name
|
1826
|
-
# The name of the
|
1925
|
+
# The name of the subnet group.
|
1827
1926
|
# @return [String]
|
1828
1927
|
#
|
1829
1928
|
# @!attribute [rw] db_subnet_group_description
|
1830
|
-
# Provides the description of the
|
1929
|
+
# Provides the description of the subnet group.
|
1831
1930
|
# @return [String]
|
1832
1931
|
#
|
1833
1932
|
# @!attribute [rw] vpc_id
|
1834
|
-
# Provides the virtual private cloud (VPC) ID of the
|
1933
|
+
# Provides the virtual private cloud (VPC) ID of the subnet group.
|
1835
1934
|
# @return [String]
|
1836
1935
|
#
|
1837
1936
|
# @!attribute [rw] subnet_group_status
|
1838
|
-
# Provides the status of the
|
1937
|
+
# Provides the status of the subnet group.
|
1839
1938
|
# @return [String]
|
1840
1939
|
#
|
1841
1940
|
# @!attribute [rw] subnets
|
1842
|
-
# Detailed information about one or more subnets within a
|
1941
|
+
# Detailed information about one or more subnets within a subnet
|
1843
1942
|
# group.
|
1844
1943
|
# @return [Array<Types::Subnet>]
|
1845
1944
|
#
|
@@ -1859,6 +1958,19 @@ module Aws::DocDB
|
|
1859
1958
|
include Aws::Structure
|
1860
1959
|
end
|
1861
1960
|
|
1961
|
+
# `DBSubnetGroupName` is already being used by an existing subnet group.
|
1962
|
+
#
|
1963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSubnetGroupAlreadyExistsFault AWS API Documentation
|
1964
|
+
#
|
1965
|
+
class DBSubnetGroupAlreadyExistsFault < Aws::EmptyStructure; end
|
1966
|
+
|
1967
|
+
# Subnets in the subnet group should cover at least two Availability
|
1968
|
+
# Zones unless there is only one Availability Zone.
|
1969
|
+
#
|
1970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSubnetGroupDoesNotCoverEnoughAZs AWS API Documentation
|
1971
|
+
#
|
1972
|
+
class DBSubnetGroupDoesNotCoverEnoughAZs < Aws::EmptyStructure; end
|
1973
|
+
|
1862
1974
|
# Represents the output of DescribeDBSubnetGroups.
|
1863
1975
|
#
|
1864
1976
|
# @!attribute [rw] marker
|
@@ -1868,7 +1980,7 @@ module Aws::DocDB
|
|
1868
1980
|
# @return [String]
|
1869
1981
|
#
|
1870
1982
|
# @!attribute [rw] db_subnet_groups
|
1871
|
-
# Detailed information about one or more
|
1983
|
+
# Detailed information about one or more subnet groups.
|
1872
1984
|
# @return [Array<Types::DBSubnetGroup>]
|
1873
1985
|
#
|
1874
1986
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSubnetGroupMessage AWS API Documentation
|
@@ -1879,6 +1991,33 @@ module Aws::DocDB
|
|
1879
1991
|
include Aws::Structure
|
1880
1992
|
end
|
1881
1993
|
|
1994
|
+
# `DBSubnetGroupName` doesn't refer to an existing subnet group.
|
1995
|
+
#
|
1996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSubnetGroupNotFoundFault AWS API Documentation
|
1997
|
+
#
|
1998
|
+
class DBSubnetGroupNotFoundFault < Aws::EmptyStructure; end
|
1999
|
+
|
2000
|
+
# The request would cause you to exceed the allowed number of subnet
|
2001
|
+
# groups.
|
2002
|
+
#
|
2003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSubnetGroupQuotaExceededFault AWS API Documentation
|
2004
|
+
#
|
2005
|
+
class DBSubnetGroupQuotaExceededFault < Aws::EmptyStructure; end
|
2006
|
+
|
2007
|
+
# The request would cause you to exceed the allowed number of subnets in
|
2008
|
+
# a subnet group.
|
2009
|
+
#
|
2010
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSubnetQuotaExceededFault AWS API Documentation
|
2011
|
+
#
|
2012
|
+
class DBSubnetQuotaExceededFault < Aws::EmptyStructure; end
|
2013
|
+
|
2014
|
+
# The upgrade failed because a resource that the depends on can't be
|
2015
|
+
# modified.
|
2016
|
+
#
|
2017
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBUpgradeDependencyFailureFault AWS API Documentation
|
2018
|
+
#
|
2019
|
+
class DBUpgradeDependencyFailureFault < Aws::EmptyStructure; end
|
2020
|
+
|
1882
2021
|
# Represents the input to DeleteDBCluster.
|
1883
2022
|
#
|
1884
2023
|
# @note When making an API call, you may pass DeleteDBClusterMessage
|
@@ -1891,8 +2030,8 @@ module Aws::DocDB
|
|
1891
2030
|
# }
|
1892
2031
|
#
|
1893
2032
|
# @!attribute [rw] db_cluster_identifier
|
1894
|
-
# The
|
1895
|
-
#
|
2033
|
+
# The cluster identifier for the cluster to be deleted. This parameter
|
2034
|
+
# isn't case sensitive.
|
1896
2035
|
#
|
1897
2036
|
# Constraints:
|
1898
2037
|
#
|
@@ -1902,10 +2041,10 @@ module Aws::DocDB
|
|
1902
2041
|
# @return [String]
|
1903
2042
|
#
|
1904
2043
|
# @!attribute [rw] skip_final_snapshot
|
1905
|
-
# Determines whether a final
|
1906
|
-
#
|
1907
|
-
#
|
1908
|
-
#
|
2044
|
+
# Determines whether a final cluster snapshot is created before the
|
2045
|
+
# cluster is deleted. If `true` is specified, no cluster snapshot is
|
2046
|
+
# created. If `false` is specified, a cluster snapshot is created
|
2047
|
+
# before the DB cluster is deleted.
|
1909
2048
|
#
|
1910
2049
|
# <note markdown="1"> If `SkipFinalSnapshot` is `false`, you must specify a
|
1911
2050
|
# `FinalDBSnapshotIdentifier` parameter.
|
@@ -1916,8 +2055,8 @@ module Aws::DocDB
|
|
1916
2055
|
# @return [Boolean]
|
1917
2056
|
#
|
1918
2057
|
# @!attribute [rw] final_db_snapshot_identifier
|
1919
|
-
# The
|
1920
|
-
#
|
2058
|
+
# The cluster snapshot identifier of the new cluster snapshot created
|
2059
|
+
# when `SkipFinalSnapshot` is set to `false`.
|
1921
2060
|
#
|
1922
2061
|
# <note markdown="1"> Specifying this parameter and also setting the `SkipFinalShapshot`
|
1923
2062
|
# parameter to `true` results in an error.
|
@@ -1952,15 +2091,15 @@ module Aws::DocDB
|
|
1952
2091
|
# }
|
1953
2092
|
#
|
1954
2093
|
# @!attribute [rw] db_cluster_parameter_group_name
|
1955
|
-
# The name of the
|
2094
|
+
# The name of the cluster parameter group.
|
1956
2095
|
#
|
1957
2096
|
# Constraints:
|
1958
2097
|
#
|
1959
|
-
# * Must be the name of an existing
|
2098
|
+
# * Must be the name of an existing cluster parameter group.
|
1960
2099
|
#
|
1961
|
-
# * You can't delete a default
|
2100
|
+
# * You can't delete a default cluster parameter group.
|
1962
2101
|
#
|
1963
|
-
# * Cannot be associated with any
|
2102
|
+
# * Cannot be associated with any clusters.
|
1964
2103
|
# @return [String]
|
1965
2104
|
#
|
1966
2105
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterParameterGroupMessage AWS API Documentation
|
@@ -1971,7 +2110,7 @@ module Aws::DocDB
|
|
1971
2110
|
end
|
1972
2111
|
|
1973
2112
|
# @!attribute [rw] db_cluster
|
1974
|
-
# Detailed information about a
|
2113
|
+
# Detailed information about a cluster.
|
1975
2114
|
# @return [Types::DBCluster]
|
1976
2115
|
#
|
1977
2116
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterResult AWS API Documentation
|
@@ -1991,10 +2130,10 @@ module Aws::DocDB
|
|
1991
2130
|
# }
|
1992
2131
|
#
|
1993
2132
|
# @!attribute [rw] db_cluster_snapshot_identifier
|
1994
|
-
# The identifier of the
|
2133
|
+
# The identifier of the cluster snapshot to delete.
|
1995
2134
|
#
|
1996
|
-
# Constraints: Must be the name of an existing
|
1997
|
-
#
|
2135
|
+
# Constraints: Must be the name of an existing cluster snapshot in the
|
2136
|
+
# `available` state.
|
1998
2137
|
# @return [String]
|
1999
2138
|
#
|
2000
2139
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterSnapshotMessage AWS API Documentation
|
@@ -2005,7 +2144,7 @@ module Aws::DocDB
|
|
2005
2144
|
end
|
2006
2145
|
|
2007
2146
|
# @!attribute [rw] db_cluster_snapshot
|
2008
|
-
# Detailed information about a
|
2147
|
+
# Detailed information about a cluster snapshot.
|
2009
2148
|
# @return [Types::DBClusterSnapshot]
|
2010
2149
|
#
|
2011
2150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterSnapshotResult AWS API Documentation
|
@@ -2025,12 +2164,12 @@ module Aws::DocDB
|
|
2025
2164
|
# }
|
2026
2165
|
#
|
2027
2166
|
# @!attribute [rw] db_instance_identifier
|
2028
|
-
# The
|
2167
|
+
# The instance identifier for the instance to be deleted. This
|
2029
2168
|
# parameter isn't case sensitive.
|
2030
2169
|
#
|
2031
2170
|
# Constraints:
|
2032
2171
|
#
|
2033
|
-
# * Must match the name of an existing
|
2172
|
+
# * Must match the name of an existing instance.
|
2034
2173
|
#
|
2035
2174
|
# ^
|
2036
2175
|
# @return [String]
|
@@ -2043,7 +2182,7 @@ module Aws::DocDB
|
|
2043
2182
|
end
|
2044
2183
|
|
2045
2184
|
# @!attribute [rw] db_instance
|
2046
|
-
# Detailed information about
|
2185
|
+
# Detailed information about an instance.
|
2047
2186
|
# @return [Types::DBInstance]
|
2048
2187
|
#
|
2049
2188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBInstanceResult AWS API Documentation
|
@@ -2166,7 +2305,7 @@ module Aws::DocDB
|
|
2166
2305
|
# }
|
2167
2306
|
#
|
2168
2307
|
# @!attribute [rw] db_cluster_parameter_group_name
|
2169
|
-
# The name of a specific
|
2308
|
+
# The name of a specific cluster parameter group to return details
|
2170
2309
|
# for.
|
2171
2310
|
#
|
2172
2311
|
# Constraints:
|
@@ -2227,8 +2366,8 @@ module Aws::DocDB
|
|
2227
2366
|
# }
|
2228
2367
|
#
|
2229
2368
|
# @!attribute [rw] db_cluster_parameter_group_name
|
2230
|
-
# The name of a specific
|
2231
|
-
#
|
2369
|
+
# The name of a specific cluster parameter group to return parameter
|
2370
|
+
# details for.
|
2232
2371
|
#
|
2233
2372
|
# Constraints:
|
2234
2373
|
#
|
@@ -2285,8 +2424,8 @@ module Aws::DocDB
|
|
2285
2424
|
# }
|
2286
2425
|
#
|
2287
2426
|
# @!attribute [rw] db_cluster_snapshot_identifier
|
2288
|
-
# The identifier for the
|
2289
|
-
#
|
2427
|
+
# The identifier for the cluster snapshot to describe the attributes
|
2428
|
+
# for.
|
2290
2429
|
# @return [String]
|
2291
2430
|
#
|
2292
2431
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotAttributesMessage AWS API Documentation
|
@@ -2298,7 +2437,7 @@ module Aws::DocDB
|
|
2298
2437
|
|
2299
2438
|
# @!attribute [rw] db_cluster_snapshot_attributes_result
|
2300
2439
|
# Detailed information about the attributes that are associated with a
|
2301
|
-
#
|
2440
|
+
# cluster snapshot.
|
2302
2441
|
# @return [Types::DBClusterSnapshotAttributesResult]
|
2303
2442
|
#
|
2304
2443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotAttributesResult AWS API Documentation
|
@@ -2330,10 +2469,9 @@ module Aws::DocDB
|
|
2330
2469
|
# }
|
2331
2470
|
#
|
2332
2471
|
# @!attribute [rw] db_cluster_identifier
|
2333
|
-
# The ID of the
|
2334
|
-
#
|
2335
|
-
#
|
2336
|
-
# sensitive.
|
2472
|
+
# The ID of the cluster to retrieve the list of cluster snapshots for.
|
2473
|
+
# This parameter can't be used with the `DBClusterSnapshotIdentifier`
|
2474
|
+
# parameter. This parameter is not case sensitive.
|
2337
2475
|
#
|
2338
2476
|
# Constraints:
|
2339
2477
|
#
|
@@ -2343,9 +2481,9 @@ module Aws::DocDB
|
|
2343
2481
|
# @return [String]
|
2344
2482
|
#
|
2345
2483
|
# @!attribute [rw] db_cluster_snapshot_identifier
|
2346
|
-
# A specific
|
2347
|
-
#
|
2348
|
-
#
|
2484
|
+
# A specific cluster snapshot identifier to describe. This parameter
|
2485
|
+
# can't be used with the `DBClusterIdentifier` parameter. This value
|
2486
|
+
# is stored as a lowercase string.
|
2349
2487
|
#
|
2350
2488
|
# Constraints:
|
2351
2489
|
#
|
@@ -2357,27 +2495,26 @@ module Aws::DocDB
|
|
2357
2495
|
# @return [String]
|
2358
2496
|
#
|
2359
2497
|
# @!attribute [rw] snapshot_type
|
2360
|
-
# The type of
|
2361
|
-
#
|
2498
|
+
# The type of cluster snapshots to be returned. You can specify one of
|
2499
|
+
# the following values:
|
2362
2500
|
#
|
2363
|
-
# * `automated` - Return all
|
2364
|
-
#
|
2501
|
+
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
2502
|
+
# has automatically created for your AWS account.
|
2365
2503
|
#
|
2366
|
-
# * `manual` - Return all
|
2504
|
+
# * `manual` - Return all cluster snapshots that you have manually
|
2367
2505
|
# created for your AWS account.
|
2368
2506
|
#
|
2369
|
-
# * `shared` - Return all manual
|
2507
|
+
# * `shared` - Return all manual cluster snapshots that have been
|
2370
2508
|
# shared to your AWS account.
|
2371
2509
|
#
|
2372
|
-
# * `public` - Return all
|
2373
|
-
#
|
2510
|
+
# * `public` - Return all cluster snapshots that have been marked as
|
2511
|
+
# public.
|
2374
2512
|
#
|
2375
2513
|
# If you don't specify a `SnapshotType` value, then both automated
|
2376
|
-
# and manual
|
2377
|
-
#
|
2378
|
-
#
|
2379
|
-
#
|
2380
|
-
# parameter to `true`.
|
2514
|
+
# and manual cluster snapshots are returned. You can include shared
|
2515
|
+
# cluster snapshots with these results by setting the `IncludeShared`
|
2516
|
+
# parameter to `true`. You can include public cluster snapshots with
|
2517
|
+
# these results by setting the `IncludePublic` parameter to `true`.
|
2381
2518
|
#
|
2382
2519
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
2383
2520
|
# `SnapshotType` values of `manual` or `automated`. The
|
@@ -2408,13 +2545,13 @@ module Aws::DocDB
|
|
2408
2545
|
# @return [String]
|
2409
2546
|
#
|
2410
2547
|
# @!attribute [rw] include_shared
|
2411
|
-
# Set to `true` to include shared manual
|
2412
|
-
#
|
2413
|
-
#
|
2548
|
+
# Set to `true` to include shared manual cluster snapshots from other
|
2549
|
+
# AWS accounts that this AWS account has been given permission to copy
|
2550
|
+
# or restore, and otherwise `false`. The default is `false`.
|
2414
2551
|
# @return [Boolean]
|
2415
2552
|
#
|
2416
2553
|
# @!attribute [rw] include_public
|
2417
|
-
# Set to `true` to include manual
|
2554
|
+
# Set to `true` to include manual cluster snapshots that are public
|
2418
2555
|
# and can be copied or restored by any AWS account, and otherwise
|
2419
2556
|
# `false`. The default is `false`.
|
2420
2557
|
# @return [Boolean]
|
@@ -2451,9 +2588,9 @@ module Aws::DocDB
|
|
2451
2588
|
# }
|
2452
2589
|
#
|
2453
2590
|
# @!attribute [rw] db_cluster_identifier
|
2454
|
-
# The user-provided
|
2455
|
-
# specified, information from only the specific
|
2456
|
-
#
|
2591
|
+
# The user-provided cluster identifier. If this parameter is
|
2592
|
+
# specified, information from only the specific cluster is returned.
|
2593
|
+
# This parameter isn't case sensitive.
|
2457
2594
|
#
|
2458
2595
|
# Constraints:
|
2459
2596
|
#
|
@@ -2463,13 +2600,13 @@ module Aws::DocDB
|
|
2463
2600
|
# @return [String]
|
2464
2601
|
#
|
2465
2602
|
# @!attribute [rw] filters
|
2466
|
-
# A filter that specifies one or more
|
2603
|
+
# A filter that specifies one or more clusters to describe.
|
2467
2604
|
#
|
2468
2605
|
# Supported filters:
|
2469
2606
|
#
|
2470
|
-
# * `db-cluster-id` - Accepts
|
2471
|
-
#
|
2472
|
-
#
|
2607
|
+
# * `db-cluster-id` - Accepts cluster identifiers and cluster Amazon
|
2608
|
+
# Resource Names (ARNs). The results list only includes information
|
2609
|
+
# about the clusters identified by these ARNs.
|
2473
2610
|
#
|
2474
2611
|
# ^
|
2475
2612
|
# @return [Array<Types::Filter>]
|
@@ -2534,8 +2671,7 @@ module Aws::DocDB
|
|
2534
2671
|
# @return [String]
|
2535
2672
|
#
|
2536
2673
|
# @!attribute [rw] db_parameter_group_family
|
2537
|
-
# The name of a specific
|
2538
|
-
# for.
|
2674
|
+
# The name of a specific parameter group family to return details for.
|
2539
2675
|
#
|
2540
2676
|
# Constraints:
|
2541
2677
|
#
|
@@ -2616,8 +2752,8 @@ module Aws::DocDB
|
|
2616
2752
|
#
|
2617
2753
|
# @!attribute [rw] db_instance_identifier
|
2618
2754
|
# The user-provided instance identifier. If this parameter is
|
2619
|
-
# specified, information from only the specific
|
2620
|
-
#
|
2755
|
+
# specified, information from only the specific instance is returned.
|
2756
|
+
# This parameter isn't case sensitive.
|
2621
2757
|
#
|
2622
2758
|
# Constraints:
|
2623
2759
|
#
|
@@ -2628,18 +2764,18 @@ module Aws::DocDB
|
|
2628
2764
|
# @return [String]
|
2629
2765
|
#
|
2630
2766
|
# @!attribute [rw] filters
|
2631
|
-
# A filter that specifies one or more
|
2767
|
+
# A filter that specifies one or more instances to describe.
|
2632
2768
|
#
|
2633
2769
|
# Supported filters:
|
2634
2770
|
#
|
2635
|
-
# * `db-cluster-id` - Accepts
|
2636
|
-
#
|
2637
|
-
# information about the
|
2771
|
+
# * `db-cluster-id` - Accepts cluster identifiers and cluster Amazon
|
2772
|
+
# Resource Names (ARNs). The results list includes only the
|
2773
|
+
# information about the instances that are associated with the
|
2638
2774
|
# clusters that are identified by these ARNs.
|
2639
2775
|
#
|
2640
|
-
# * `db-instance-id` - Accepts
|
2641
|
-
#
|
2642
|
-
#
|
2776
|
+
# * `db-instance-id` - Accepts instance identifiers and instance ARNs.
|
2777
|
+
# The results list includes only the information about the instances
|
2778
|
+
# that are identified by these ARNs.
|
2643
2779
|
# @return [Array<Types::Filter>]
|
2644
2780
|
#
|
2645
2781
|
# @!attribute [rw] max_records
|
@@ -2687,7 +2823,7 @@ module Aws::DocDB
|
|
2687
2823
|
# }
|
2688
2824
|
#
|
2689
2825
|
# @!attribute [rw] db_subnet_group_name
|
2690
|
-
# The name of the
|
2826
|
+
# The name of the subnet group to return details for.
|
2691
2827
|
# @return [String]
|
2692
2828
|
#
|
2693
2829
|
# @!attribute [rw] filters
|
@@ -2739,8 +2875,8 @@ module Aws::DocDB
|
|
2739
2875
|
# }
|
2740
2876
|
#
|
2741
2877
|
# @!attribute [rw] db_parameter_group_family
|
2742
|
-
# The name of the
|
2743
|
-
#
|
2878
|
+
# The name of the cluster parameter group family to return the engine
|
2879
|
+
# parameter information for.
|
2744
2880
|
# @return [String]
|
2745
2881
|
#
|
2746
2882
|
# @!attribute [rw] filters
|
@@ -2954,7 +3090,7 @@ module Aws::DocDB
|
|
2954
3090
|
# }
|
2955
3091
|
#
|
2956
3092
|
# @!attribute [rw] engine
|
2957
|
-
# The name of the engine to retrieve
|
3093
|
+
# The name of the engine to retrieve instance options for.
|
2958
3094
|
# @return [String]
|
2959
3095
|
#
|
2960
3096
|
# @!attribute [rw] engine_version
|
@@ -2963,9 +3099,8 @@ module Aws::DocDB
|
|
2963
3099
|
# @return [String]
|
2964
3100
|
#
|
2965
3101
|
# @!attribute [rw] db_instance_class
|
2966
|
-
# The
|
2967
|
-
#
|
2968
|
-
# class.
|
3102
|
+
# The instance class filter value. Specify this parameter to show only
|
3103
|
+
# the available offerings that match the specified instance class.
|
2969
3104
|
# @return [String]
|
2970
3105
|
#
|
2971
3106
|
# @!attribute [rw] license_model
|
@@ -3040,14 +3175,13 @@ module Aws::DocDB
|
|
3040
3175
|
#
|
3041
3176
|
# Supported filters:
|
3042
3177
|
#
|
3043
|
-
# * `db-cluster-id` - Accepts
|
3044
|
-
#
|
3045
|
-
#
|
3046
|
-
# these ARNs.
|
3178
|
+
# * `db-cluster-id` - Accepts cluster identifiers and cluster Amazon
|
3179
|
+
# Resource Names (ARNs). The results list includes only pending
|
3180
|
+
# maintenance actions for the clusters identified by these ARNs.
|
3047
3181
|
#
|
3048
|
-
# * `db-instance-id` - Accepts
|
3049
|
-
#
|
3050
|
-
#
|
3182
|
+
# * `db-instance-id` - Accepts instance identifiers and instance ARNs.
|
3183
|
+
# The results list includes only pending maintenance actions for the
|
3184
|
+
# DB instances identified by these ARNs.
|
3051
3185
|
# @return [Array<Types::Filter>]
|
3052
3186
|
#
|
3053
3187
|
# @!attribute [rw] marker
|
@@ -3077,12 +3211,12 @@ module Aws::DocDB
|
|
3077
3211
|
include Aws::Structure
|
3078
3212
|
end
|
3079
3213
|
|
3080
|
-
# Network information for accessing a
|
3214
|
+
# Network information for accessing a cluster or instance. Client
|
3081
3215
|
# programs must specify a valid endpoint to access these Amazon
|
3082
3216
|
# DocumentDB resources.
|
3083
3217
|
#
|
3084
3218
|
# @!attribute [rw] address
|
3085
|
-
# Specifies the DNS address of the
|
3219
|
+
# Specifies the DNS address of the instance.
|
3086
3220
|
# @return [String]
|
3087
3221
|
#
|
3088
3222
|
# @!attribute [rw] port
|
@@ -3107,8 +3241,8 @@ module Aws::DocDB
|
|
3107
3241
|
# `DescribeEngineDefaultClusterParameters` operation.
|
3108
3242
|
#
|
3109
3243
|
# @!attribute [rw] db_parameter_group_family
|
3110
|
-
# The name of the
|
3111
|
-
#
|
3244
|
+
# The name of the cluster parameter group family to return the engine
|
3245
|
+
# parameter information for.
|
3112
3246
|
# @return [String]
|
3113
3247
|
#
|
3114
3248
|
# @!attribute [rw] marker
|
@@ -3118,7 +3252,7 @@ module Aws::DocDB
|
|
3118
3252
|
# @return [String]
|
3119
3253
|
#
|
3120
3254
|
# @!attribute [rw] parameters
|
3121
|
-
# The parameters of a particular
|
3255
|
+
# The parameters of a particular cluster parameter group family.
|
3122
3256
|
# @return [Array<Types::Parameter>]
|
3123
3257
|
#
|
3124
3258
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EngineDefaults AWS API Documentation
|
@@ -3230,8 +3364,8 @@ module Aws::DocDB
|
|
3230
3364
|
# }
|
3231
3365
|
#
|
3232
3366
|
# @!attribute [rw] db_cluster_identifier
|
3233
|
-
# A
|
3234
|
-
#
|
3367
|
+
# A cluster identifier to force a failover for. This parameter is not
|
3368
|
+
# case sensitive.
|
3235
3369
|
#
|
3236
3370
|
# Constraints:
|
3237
3371
|
#
|
@@ -3244,7 +3378,7 @@ module Aws::DocDB
|
|
3244
3378
|
# The name of the instance to promote to the primary instance.
|
3245
3379
|
#
|
3246
3380
|
# You must specify the instance identifier for an Amazon DocumentDB
|
3247
|
-
# replica in the
|
3381
|
+
# replica in the cluster. For example, `mydbcluster-replica1`.
|
3248
3382
|
# @return [String]
|
3249
3383
|
#
|
3250
3384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBClusterMessage AWS API Documentation
|
@@ -3256,7 +3390,7 @@ module Aws::DocDB
|
|
3256
3390
|
end
|
3257
3391
|
|
3258
3392
|
# @!attribute [rw] db_cluster
|
3259
|
-
# Detailed information about a
|
3393
|
+
# Detailed information about a cluster.
|
3260
3394
|
# @return [Types::DBCluster]
|
3261
3395
|
#
|
3262
3396
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBClusterResult AWS API Documentation
|
@@ -3296,6 +3430,110 @@ module Aws::DocDB
|
|
3296
3430
|
include Aws::Structure
|
3297
3431
|
end
|
3298
3432
|
|
3433
|
+
# The request would cause you to exceed the allowed number of instances.
|
3434
|
+
#
|
3435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InstanceQuotaExceededFault AWS API Documentation
|
3436
|
+
#
|
3437
|
+
class InstanceQuotaExceededFault < Aws::EmptyStructure; end
|
3438
|
+
|
3439
|
+
# The cluster doesn't have enough capacity for the current operation.
|
3440
|
+
#
|
3441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InsufficientDBClusterCapacityFault AWS API Documentation
|
3442
|
+
#
|
3443
|
+
class InsufficientDBClusterCapacityFault < Aws::EmptyStructure; end
|
3444
|
+
|
3445
|
+
# The specified instance class isn't available in the specified
|
3446
|
+
# Availability Zone.
|
3447
|
+
#
|
3448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InsufficientDBInstanceCapacityFault AWS API Documentation
|
3449
|
+
#
|
3450
|
+
class InsufficientDBInstanceCapacityFault < Aws::EmptyStructure; end
|
3451
|
+
|
3452
|
+
# There is not enough storage available for the current action. You
|
3453
|
+
# might be able to resolve this error by updating your subnet group to
|
3454
|
+
# use different Availability Zones that have more storage available.
|
3455
|
+
#
|
3456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InsufficientStorageClusterCapacityFault AWS API Documentation
|
3457
|
+
#
|
3458
|
+
class InsufficientStorageClusterCapacityFault < Aws::EmptyStructure; end
|
3459
|
+
|
3460
|
+
# The provided value isn't a valid cluster snapshot state.
|
3461
|
+
#
|
3462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidDBClusterSnapshotStateFault AWS API Documentation
|
3463
|
+
#
|
3464
|
+
class InvalidDBClusterSnapshotStateFault < Aws::EmptyStructure; end
|
3465
|
+
|
3466
|
+
# The cluster isn't in a valid state.
|
3467
|
+
#
|
3468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidDBClusterStateFault AWS API Documentation
|
3469
|
+
#
|
3470
|
+
class InvalidDBClusterStateFault < Aws::EmptyStructure; end
|
3471
|
+
|
3472
|
+
# The specified instance isn't in the *available* state.
|
3473
|
+
#
|
3474
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidDBInstanceStateFault AWS API Documentation
|
3475
|
+
#
|
3476
|
+
class InvalidDBInstanceStateFault < Aws::EmptyStructure; end
|
3477
|
+
|
3478
|
+
# The parameter group is in use, or it is in a state that is not valid.
|
3479
|
+
# If you are trying to delete the parameter group, you can't delete it
|
3480
|
+
# when the parameter group is in this state.
|
3481
|
+
#
|
3482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidDBParameterGroupStateFault AWS API Documentation
|
3483
|
+
#
|
3484
|
+
class InvalidDBParameterGroupStateFault < Aws::EmptyStructure; end
|
3485
|
+
|
3486
|
+
# The state of the security group doesn't allow deletion.
|
3487
|
+
#
|
3488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidDBSecurityGroupStateFault AWS API Documentation
|
3489
|
+
#
|
3490
|
+
class InvalidDBSecurityGroupStateFault < Aws::EmptyStructure; end
|
3491
|
+
|
3492
|
+
# The state of the snapshot doesn't allow deletion.
|
3493
|
+
#
|
3494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidDBSnapshotStateFault AWS API Documentation
|
3495
|
+
#
|
3496
|
+
class InvalidDBSnapshotStateFault < Aws::EmptyStructure; end
|
3497
|
+
|
3498
|
+
# The subnet group can't be deleted because it's in use.
|
3499
|
+
#
|
3500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidDBSubnetGroupStateFault AWS API Documentation
|
3501
|
+
#
|
3502
|
+
class InvalidDBSubnetGroupStateFault < Aws::EmptyStructure; end
|
3503
|
+
|
3504
|
+
# The subnet isn't in the *available* state.
|
3505
|
+
#
|
3506
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidDBSubnetStateFault AWS API Documentation
|
3507
|
+
#
|
3508
|
+
class InvalidDBSubnetStateFault < Aws::EmptyStructure; end
|
3509
|
+
|
3510
|
+
# You cannot restore from a virtual private cloud (VPC) backup to a
|
3511
|
+
# non-VPC DB instance.
|
3512
|
+
#
|
3513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidRestoreFault AWS API Documentation
|
3514
|
+
#
|
3515
|
+
class InvalidRestoreFault < Aws::EmptyStructure; end
|
3516
|
+
|
3517
|
+
# The requested subnet is not valid, or multiple subnets were requested
|
3518
|
+
# that are not all in a common virtual private cloud (VPC).
|
3519
|
+
#
|
3520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidSubnet AWS API Documentation
|
3521
|
+
#
|
3522
|
+
class InvalidSubnet < Aws::EmptyStructure; end
|
3523
|
+
|
3524
|
+
# The subnet group doesn't cover all Availability Zones after it is
|
3525
|
+
# created because of changes that were made.
|
3526
|
+
#
|
3527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/InvalidVPCNetworkStateFault AWS API Documentation
|
3528
|
+
#
|
3529
|
+
class InvalidVPCNetworkStateFault < Aws::EmptyStructure; end
|
3530
|
+
|
3531
|
+
# An error occurred when accessing an AWS KMS key.
|
3532
|
+
#
|
3533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/KMSKeyNotAccessibleFault AWS API Documentation
|
3534
|
+
#
|
3535
|
+
class KMSKeyNotAccessibleFault < Aws::EmptyStructure; end
|
3536
|
+
|
3299
3537
|
# Represents the input to ListTagsForResource.
|
3300
3538
|
#
|
3301
3539
|
# @note When making an API call, you may pass ListTagsForResourceMessage
|
@@ -3353,8 +3591,8 @@ module Aws::DocDB
|
|
3353
3591
|
# }
|
3354
3592
|
#
|
3355
3593
|
# @!attribute [rw] db_cluster_identifier
|
3356
|
-
# The
|
3357
|
-
#
|
3594
|
+
# The cluster identifier for the cluster that is being modified. This
|
3595
|
+
# parameter is not case sensitive.
|
3358
3596
|
#
|
3359
3597
|
# Constraints:
|
3360
3598
|
#
|
@@ -3364,8 +3602,8 @@ module Aws::DocDB
|
|
3364
3602
|
# @return [String]
|
3365
3603
|
#
|
3366
3604
|
# @!attribute [rw] new_db_cluster_identifier
|
3367
|
-
# The new
|
3368
|
-
#
|
3605
|
+
# The new cluster identifier for the cluster when renaming a cluster.
|
3606
|
+
# This value is stored as a lowercase string.
|
3369
3607
|
#
|
3370
3608
|
# Constraints:
|
3371
3609
|
#
|
@@ -3381,9 +3619,9 @@ module Aws::DocDB
|
|
3381
3619
|
# @!attribute [rw] apply_immediately
|
3382
3620
|
# A value that specifies whether the changes in this request and any
|
3383
3621
|
# pending changes are asynchronously applied as soon as possible,
|
3384
|
-
# regardless of the `PreferredMaintenanceWindow` setting for the
|
3385
|
-
# cluster. If this parameter is set to `false`, changes to the
|
3386
|
-
#
|
3622
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the
|
3623
|
+
# cluster. If this parameter is set to `false`, changes to the cluster
|
3624
|
+
# are applied during the next maintenance window.
|
3387
3625
|
#
|
3388
3626
|
# The `ApplyImmediately` parameter affects only the
|
3389
3627
|
# `NewDBClusterIdentifier` and `MasterUserPassword` values. If you set
|
@@ -3410,21 +3648,20 @@ module Aws::DocDB
|
|
3410
3648
|
# @return [Integer]
|
3411
3649
|
#
|
3412
3650
|
# @!attribute [rw] db_cluster_parameter_group_name
|
3413
|
-
# The name of the
|
3414
|
-
# cluster.
|
3651
|
+
# The name of the cluster parameter group to use for the cluster.
|
3415
3652
|
# @return [String]
|
3416
3653
|
#
|
3417
3654
|
# @!attribute [rw] vpc_security_group_ids
|
3418
|
-
# A list of virtual private cloud (VPC) security groups that the
|
3655
|
+
# A list of virtual private cloud (VPC) security groups that the
|
3419
3656
|
# cluster will belong to.
|
3420
3657
|
# @return [Array<String>]
|
3421
3658
|
#
|
3422
3659
|
# @!attribute [rw] port
|
3423
|
-
# The port number on which the
|
3660
|
+
# The port number on which the cluster accepts connections.
|
3424
3661
|
#
|
3425
3662
|
# Constraints: Must be a value from `1150` to `65535`.
|
3426
3663
|
#
|
3427
|
-
# Default: The same port as the original
|
3664
|
+
# Default: The same port as the original cluster.
|
3428
3665
|
# @return [Integer]
|
3429
3666
|
#
|
3430
3667
|
# @!attribute [rw] master_user_password
|
@@ -3471,9 +3708,9 @@ module Aws::DocDB
|
|
3471
3708
|
#
|
3472
3709
|
# @!attribute [rw] cloudwatch_logs_export_configuration
|
3473
3710
|
# The configuration setting for the log types to be enabled for export
|
3474
|
-
# to Amazon CloudWatch Logs for a specific
|
3475
|
-
#
|
3476
|
-
#
|
3711
|
+
# to Amazon CloudWatch Logs for a specific instance or cluster. The
|
3712
|
+
# `EnableLogTypes` and `DisableLogTypes` arrays determine which logs
|
3713
|
+
# are exported (or not exported) to CloudWatch Logs.
|
3477
3714
|
# @return [Types::CloudwatchLogsExportConfiguration]
|
3478
3715
|
#
|
3479
3716
|
# @!attribute [rw] engine_version
|
@@ -3534,11 +3771,11 @@ module Aws::DocDB
|
|
3534
3771
|
# }
|
3535
3772
|
#
|
3536
3773
|
# @!attribute [rw] db_cluster_parameter_group_name
|
3537
|
-
# The name of the
|
3774
|
+
# The name of the cluster parameter group to modify.
|
3538
3775
|
# @return [String]
|
3539
3776
|
#
|
3540
3777
|
# @!attribute [rw] parameters
|
3541
|
-
# A list of parameters in the
|
3778
|
+
# A list of parameters in the cluster parameter group to modify.
|
3542
3779
|
# @return [Array<Types::Parameter>]
|
3543
3780
|
#
|
3544
3781
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterParameterGroupMessage AWS API Documentation
|
@@ -3550,7 +3787,7 @@ module Aws::DocDB
|
|
3550
3787
|
end
|
3551
3788
|
|
3552
3789
|
# @!attribute [rw] db_cluster
|
3553
|
-
# Detailed information about a
|
3790
|
+
# Detailed information about a cluster.
|
3554
3791
|
# @return [Types::DBCluster]
|
3555
3792
|
#
|
3556
3793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterResult AWS API Documentation
|
@@ -3573,39 +3810,39 @@ module Aws::DocDB
|
|
3573
3810
|
# }
|
3574
3811
|
#
|
3575
3812
|
# @!attribute [rw] db_cluster_snapshot_identifier
|
3576
|
-
# The identifier for the
|
3813
|
+
# The identifier for the cluster snapshot to modify the attributes
|
3577
3814
|
# for.
|
3578
3815
|
# @return [String]
|
3579
3816
|
#
|
3580
3817
|
# @!attribute [rw] attribute_name
|
3581
|
-
# The name of the
|
3818
|
+
# The name of the cluster snapshot attribute to modify.
|
3582
3819
|
#
|
3583
3820
|
# To manage authorization for other AWS accounts to copy or restore a
|
3584
|
-
# manual
|
3821
|
+
# manual cluster snapshot, set this value to `restore`.
|
3585
3822
|
# @return [String]
|
3586
3823
|
#
|
3587
3824
|
# @!attribute [rw] values_to_add
|
3588
|
-
# A list of
|
3825
|
+
# A list of cluster snapshot attributes to add to the attribute
|
3589
3826
|
# specified by `AttributeName`.
|
3590
3827
|
#
|
3591
|
-
# To authorize other AWS accounts to copy or restore a manual
|
3592
|
-
#
|
3593
|
-
#
|
3594
|
-
#
|
3595
|
-
#
|
3596
|
-
#
|
3828
|
+
# To authorize other AWS accounts to copy or restore a manual cluster
|
3829
|
+
# snapshot, set this list to include one or more AWS account IDs. To
|
3830
|
+
# make the manual cluster snapshot restorable by any AWS account, set
|
3831
|
+
# it to `all`. Do not add the `all` value for any manual cluster
|
3832
|
+
# snapshots that contain private information that you don't want to
|
3833
|
+
# be available to all AWS accounts.
|
3597
3834
|
# @return [Array<String>]
|
3598
3835
|
#
|
3599
3836
|
# @!attribute [rw] values_to_remove
|
3600
|
-
# A list of
|
3601
|
-
#
|
3837
|
+
# A list of cluster snapshot attributes to remove from the attribute
|
3838
|
+
# specified by `AttributeName`.
|
3602
3839
|
#
|
3603
3840
|
# To remove authorization for other AWS accounts to copy or restore a
|
3604
|
-
# manual
|
3841
|
+
# manual cluster snapshot, set this list to include one or more AWS
|
3605
3842
|
# account identifiers. To remove authorization for any AWS account to
|
3606
|
-
# copy or restore the
|
3843
|
+
# copy or restore the cluster snapshot, set it to `all` . If you
|
3607
3844
|
# specify `all`, an AWS account whose account ID is explicitly added
|
3608
|
-
# to the `restore` attribute can still copy or restore a manual
|
3845
|
+
# to the `restore` attribute can still copy or restore a manual
|
3609
3846
|
# cluster snapshot.
|
3610
3847
|
# @return [Array<String>]
|
3611
3848
|
#
|
@@ -3621,7 +3858,7 @@ module Aws::DocDB
|
|
3621
3858
|
|
3622
3859
|
# @!attribute [rw] db_cluster_snapshot_attributes_result
|
3623
3860
|
# Detailed information about the attributes that are associated with a
|
3624
|
-
#
|
3861
|
+
# cluster snapshot.
|
3625
3862
|
# @return [Types::DBClusterSnapshotAttributesResult]
|
3626
3863
|
#
|
3627
3864
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttributeResult AWS API Documentation
|
@@ -3648,8 +3885,7 @@ module Aws::DocDB
|
|
3648
3885
|
# }
|
3649
3886
|
#
|
3650
3887
|
# @!attribute [rw] db_instance_identifier
|
3651
|
-
# The
|
3652
|
-
# string.
|
3888
|
+
# The instance identifier. This value is stored as a lowercase string.
|
3653
3889
|
#
|
3654
3890
|
# Constraints:
|
3655
3891
|
#
|
@@ -3659,11 +3895,11 @@ module Aws::DocDB
|
|
3659
3895
|
# @return [String]
|
3660
3896
|
#
|
3661
3897
|
# @!attribute [rw] db_instance_class
|
3662
|
-
# The new compute and memory capacity of the
|
3663
|
-
# `db.r5.large`. Not all
|
3898
|
+
# The new compute and memory capacity of the instance; for example,
|
3899
|
+
# `db.r5.large`. Not all instance classes are available in all AWS
|
3664
3900
|
# Regions.
|
3665
3901
|
#
|
3666
|
-
# If you modify the
|
3902
|
+
# If you modify the instance class, an outage occurs during the
|
3667
3903
|
# change. The change is applied during the next maintenance window,
|
3668
3904
|
# unless `ApplyImmediately` is specified as `true` for this request.
|
3669
3905
|
#
|
@@ -3673,10 +3909,10 @@ module Aws::DocDB
|
|
3673
3909
|
# @!attribute [rw] apply_immediately
|
3674
3910
|
# Specifies whether the modifications in this request and any pending
|
3675
3911
|
# modifications are asynchronously applied as soon as possible,
|
3676
|
-
# regardless of the `PreferredMaintenanceWindow` setting for the
|
3912
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the
|
3677
3913
|
# instance.
|
3678
3914
|
#
|
3679
|
-
# If this parameter is set to `false`, changes to the
|
3915
|
+
# If this parameter is set to `false`, changes to the instance are
|
3680
3916
|
# applied during the next maintenance window. Some parameter changes
|
3681
3917
|
# can cause an outage and are applied on the next reboot.
|
3682
3918
|
#
|
@@ -3690,7 +3926,7 @@ module Aws::DocDB
|
|
3690
3926
|
# the change is asynchronously applied as soon as possible. If there
|
3691
3927
|
# are pending actions that cause a reboot, and the maintenance window
|
3692
3928
|
# is changed to include the current time, changing this parameter
|
3693
|
-
# causes a reboot of the
|
3929
|
+
# causes a reboot of the instance. If you are moving this window to
|
3694
3930
|
# the current time, there must be at least 30 minutes between the
|
3695
3931
|
# current time and end of the window to ensure that pending changes
|
3696
3932
|
# are applied.
|
@@ -3706,18 +3942,17 @@ module Aws::DocDB
|
|
3706
3942
|
#
|
3707
3943
|
# @!attribute [rw] auto_minor_version_upgrade
|
3708
3944
|
# Indicates that minor version upgrades are applied automatically to
|
3709
|
-
# the
|
3710
|
-
#
|
3711
|
-
#
|
3712
|
-
#
|
3713
|
-
#
|
3714
|
-
#
|
3715
|
-
# version.
|
3945
|
+
# the instance during the maintenance window. Changing this parameter
|
3946
|
+
# doesn't result in an outage except in the following case, and the
|
3947
|
+
# change is asynchronously applied as soon as possible. An outage
|
3948
|
+
# results if this parameter is set to `true` during the maintenance
|
3949
|
+
# window, and a newer minor version is available, and Amazon
|
3950
|
+
# DocumentDB has enabled automatic patching for that engine version.
|
3716
3951
|
# @return [Boolean]
|
3717
3952
|
#
|
3718
3953
|
# @!attribute [rw] new_db_instance_identifier
|
3719
|
-
# The new
|
3720
|
-
#
|
3954
|
+
# The new instance identifier for the instance when renaming an
|
3955
|
+
# instance. When you change the instance identifier, an instance
|
3721
3956
|
# reboot occurs immediately if you set `Apply Immediately` to `true`.
|
3722
3957
|
# It occurs during the next maintenance window if you set `Apply
|
3723
3958
|
# Immediately` to `false`. This value is stored as a lowercase string.
|
@@ -3763,7 +3998,7 @@ module Aws::DocDB
|
|
3763
3998
|
end
|
3764
3999
|
|
3765
4000
|
# @!attribute [rw] db_instance
|
3766
|
-
# Detailed information about
|
4001
|
+
# Detailed information about an instance.
|
3767
4002
|
# @return [Types::DBInstance]
|
3768
4003
|
#
|
3769
4004
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstanceResult AWS API Documentation
|
@@ -3785,8 +4020,8 @@ module Aws::DocDB
|
|
3785
4020
|
# }
|
3786
4021
|
#
|
3787
4022
|
# @!attribute [rw] db_subnet_group_name
|
3788
|
-
# The name for the
|
3789
|
-
#
|
4023
|
+
# The name for the subnet group. This value is stored as a lowercase
|
4024
|
+
# string. You can't modify the default subnet group.
|
3790
4025
|
#
|
3791
4026
|
# Constraints: Must match the name of an existing `DBSubnetGroup`.
|
3792
4027
|
# Must not be default.
|
@@ -3795,11 +4030,11 @@ module Aws::DocDB
|
|
3795
4030
|
# @return [String]
|
3796
4031
|
#
|
3797
4032
|
# @!attribute [rw] db_subnet_group_description
|
3798
|
-
# The description for the
|
4033
|
+
# The description for the subnet group.
|
3799
4034
|
# @return [String]
|
3800
4035
|
#
|
3801
4036
|
# @!attribute [rw] subnet_ids
|
3802
|
-
# The Amazon EC2 subnet IDs for the
|
4037
|
+
# The Amazon EC2 subnet IDs for the subnet group.
|
3803
4038
|
# @return [Array<String>]
|
3804
4039
|
#
|
3805
4040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBSubnetGroupMessage AWS API Documentation
|
@@ -3812,7 +4047,7 @@ module Aws::DocDB
|
|
3812
4047
|
end
|
3813
4048
|
|
3814
4049
|
# @!attribute [rw] db_subnet_group
|
3815
|
-
# Detailed information about a
|
4050
|
+
# Detailed information about a subnet group.
|
3816
4051
|
# @return [Types::DBSubnetGroup]
|
3817
4052
|
#
|
3818
4053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBSubnetGroupResult AWS API Documentation
|
@@ -3822,30 +4057,30 @@ module Aws::DocDB
|
|
3822
4057
|
include Aws::Structure
|
3823
4058
|
end
|
3824
4059
|
|
3825
|
-
# The options that are available for
|
4060
|
+
# The options that are available for an instance.
|
3826
4061
|
#
|
3827
4062
|
# @!attribute [rw] engine
|
3828
|
-
# The engine type of
|
4063
|
+
# The engine type of an instance.
|
3829
4064
|
# @return [String]
|
3830
4065
|
#
|
3831
4066
|
# @!attribute [rw] engine_version
|
3832
|
-
# The engine version of
|
4067
|
+
# The engine version of an instance.
|
3833
4068
|
# @return [String]
|
3834
4069
|
#
|
3835
4070
|
# @!attribute [rw] db_instance_class
|
3836
|
-
# The
|
4071
|
+
# The instance class for an instance.
|
3837
4072
|
# @return [String]
|
3838
4073
|
#
|
3839
4074
|
# @!attribute [rw] license_model
|
3840
|
-
# The license model for
|
4075
|
+
# The license model for an instance.
|
3841
4076
|
# @return [String]
|
3842
4077
|
#
|
3843
4078
|
# @!attribute [rw] availability_zones
|
3844
|
-
# A list of Availability Zones for
|
4079
|
+
# A list of Availability Zones for an instance.
|
3845
4080
|
# @return [Array<Types::AvailabilityZone>]
|
3846
4081
|
#
|
3847
4082
|
# @!attribute [rw] vpc
|
3848
|
-
# Indicates whether
|
4083
|
+
# Indicates whether an instance is in a virtual private cloud (VPC).
|
3849
4084
|
# @return [Boolean]
|
3850
4085
|
#
|
3851
4086
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/OrderableDBInstanceOption AWS API Documentation
|
@@ -3863,8 +4098,7 @@ module Aws::DocDB
|
|
3863
4098
|
# Represents the output of DescribeOrderableDBInstanceOptions.
|
3864
4099
|
#
|
3865
4100
|
# @!attribute [rw] orderable_db_instance_options
|
3866
|
-
# The options that are available for a particular orderable
|
3867
|
-
# instance.
|
4101
|
+
# The options that are available for a particular orderable instance.
|
3868
4102
|
# @return [Array<Types::OrderableDBInstanceOption>]
|
3869
4103
|
#
|
3870
4104
|
# @!attribute [rw] marker
|
@@ -4047,26 +4281,26 @@ module Aws::DocDB
|
|
4047
4281
|
include Aws::Structure
|
4048
4282
|
end
|
4049
4283
|
|
4050
|
-
# One or more modified settings for
|
4051
|
-
#
|
4284
|
+
# One or more modified settings for an instance. These modified settings
|
4285
|
+
# have been requested, but haven't been applied yet.
|
4052
4286
|
#
|
4053
4287
|
# @!attribute [rw] db_instance_class
|
4054
|
-
# Contains the new `DBInstanceClass` for the
|
4288
|
+
# Contains the new `DBInstanceClass` for the instance that will be
|
4055
4289
|
# applied or is currently being applied.
|
4056
4290
|
# @return [String]
|
4057
4291
|
#
|
4058
4292
|
# @!attribute [rw] allocated_storage
|
4059
|
-
# Contains the new `AllocatedStorage` size for
|
4060
|
-
#
|
4293
|
+
# Contains the new `AllocatedStorage` size for then instance that will
|
4294
|
+
# be applied or is currently being applied.
|
4061
4295
|
# @return [Integer]
|
4062
4296
|
#
|
4063
4297
|
# @!attribute [rw] master_user_password
|
4064
4298
|
# Contains the pending or currently in-progress change of the master
|
4065
|
-
# credentials for the
|
4299
|
+
# credentials for the instance.
|
4066
4300
|
# @return [String]
|
4067
4301
|
#
|
4068
4302
|
# @!attribute [rw] port
|
4069
|
-
# Specifies the pending port for the
|
4303
|
+
# Specifies the pending port for the instance.
|
4070
4304
|
# @return [Integer]
|
4071
4305
|
#
|
4072
4306
|
# @!attribute [rw] backup_retention_period
|
@@ -4075,7 +4309,7 @@ module Aws::DocDB
|
|
4075
4309
|
# @return [Integer]
|
4076
4310
|
#
|
4077
4311
|
# @!attribute [rw] multi_az
|
4078
|
-
# Indicates that the Single-AZ
|
4312
|
+
# Indicates that the Single-AZ instance is to change to a Multi-AZ
|
4079
4313
|
# deployment.
|
4080
4314
|
# @return [Boolean]
|
4081
4315
|
#
|
@@ -4084,24 +4318,24 @@ module Aws::DocDB
|
|
4084
4318
|
# @return [String]
|
4085
4319
|
#
|
4086
4320
|
# @!attribute [rw] license_model
|
4087
|
-
# The license model for the
|
4321
|
+
# The license model for the instance.
|
4088
4322
|
#
|
4089
4323
|
# Valid values: `license-included`, `bring-your-own-license`,
|
4090
4324
|
# `general-public-license`
|
4091
4325
|
# @return [String]
|
4092
4326
|
#
|
4093
4327
|
# @!attribute [rw] iops
|
4094
|
-
# Specifies the new Provisioned IOPS value for the
|
4095
|
-
#
|
4328
|
+
# Specifies the new Provisioned IOPS value for the instance that will
|
4329
|
+
# be applied or is currently being applied.
|
4096
4330
|
# @return [Integer]
|
4097
4331
|
#
|
4098
4332
|
# @!attribute [rw] db_instance_identifier
|
4099
|
-
# Contains the new `DBInstanceIdentifier` for the
|
4100
|
-
#
|
4333
|
+
# Contains the new `DBInstanceIdentifier` for the instance that will
|
4334
|
+
# be applied or is currently being applied.
|
4101
4335
|
# @return [String]
|
4102
4336
|
#
|
4103
4337
|
# @!attribute [rw] storage_type
|
4104
|
-
# Specifies the storage type to be associated with the
|
4338
|
+
# Specifies the storage type to be associated with the instance.
|
4105
4339
|
# @return [String]
|
4106
4340
|
#
|
4107
4341
|
# @!attribute [rw] ca_certificate_identifier
|
@@ -4110,7 +4344,7 @@ module Aws::DocDB
|
|
4110
4344
|
# @return [String]
|
4111
4345
|
#
|
4112
4346
|
# @!attribute [rw] db_subnet_group_name
|
4113
|
-
# The new
|
4347
|
+
# The new subnet group for the instance.
|
4114
4348
|
# @return [String]
|
4115
4349
|
#
|
4116
4350
|
# @!attribute [rw] pending_cloudwatch_logs_exports
|
@@ -4149,7 +4383,7 @@ module Aws::DocDB
|
|
4149
4383
|
# }
|
4150
4384
|
#
|
4151
4385
|
# @!attribute [rw] db_instance_identifier
|
4152
|
-
# The
|
4386
|
+
# The instance identifier. This parameter is stored as a lowercase
|
4153
4387
|
# string.
|
4154
4388
|
#
|
4155
4389
|
# Constraints:
|
@@ -4175,7 +4409,7 @@ module Aws::DocDB
|
|
4175
4409
|
end
|
4176
4410
|
|
4177
4411
|
# @!attribute [rw] db_instance
|
4178
|
-
# Detailed information about
|
4412
|
+
# Detailed information about an instance.
|
4179
4413
|
# @return [Types::DBInstance]
|
4180
4414
|
#
|
4181
4415
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RebootDBInstanceResult AWS API Documentation
|
@@ -4237,19 +4471,19 @@ module Aws::DocDB
|
|
4237
4471
|
# }
|
4238
4472
|
#
|
4239
4473
|
# @!attribute [rw] db_cluster_parameter_group_name
|
4240
|
-
# The name of the
|
4474
|
+
# The name of the cluster parameter group to reset.
|
4241
4475
|
# @return [String]
|
4242
4476
|
#
|
4243
4477
|
# @!attribute [rw] reset_all_parameters
|
4244
|
-
# A value that is set to `true` to reset all parameters in the
|
4245
|
-
#
|
4246
|
-
#
|
4247
|
-
#
|
4478
|
+
# A value that is set to `true` to reset all parameters in the cluster
|
4479
|
+
# parameter group to their default values, and `false` otherwise. You
|
4480
|
+
# can't use this parameter if there is a list of parameter names
|
4481
|
+
# specified for the `Parameters` parameter.
|
4248
4482
|
# @return [Boolean]
|
4249
4483
|
#
|
4250
4484
|
# @!attribute [rw] parameters
|
4251
|
-
# A list of parameter names in the
|
4252
|
-
#
|
4485
|
+
# A list of parameter names in the cluster parameter group to reset to
|
4486
|
+
# the default values. You can't use this parameter if the
|
4253
4487
|
# `ResetAllParameters` parameter is set to `true`.
|
4254
4488
|
# @return [Array<Types::Parameter>]
|
4255
4489
|
#
|
@@ -4262,6 +4496,12 @@ module Aws::DocDB
|
|
4262
4496
|
include Aws::Structure
|
4263
4497
|
end
|
4264
4498
|
|
4499
|
+
# The specified resource ID was not found.
|
4500
|
+
#
|
4501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ResourceNotFoundFault AWS API Documentation
|
4502
|
+
#
|
4503
|
+
class ResourceNotFoundFault < Aws::EmptyStructure; end
|
4504
|
+
|
4265
4505
|
# Represents the output of ApplyPendingMaintenanceAction.
|
4266
4506
|
#
|
4267
4507
|
# @!attribute [rw] resource_identifier
|
@@ -4313,8 +4553,8 @@ module Aws::DocDB
|
|
4313
4553
|
# @return [Array<String>]
|
4314
4554
|
#
|
4315
4555
|
# @!attribute [rw] db_cluster_identifier
|
4316
|
-
# The name of the
|
4317
|
-
#
|
4556
|
+
# The name of the cluster to create from the snapshot or cluster
|
4557
|
+
# snapshot. This parameter isn't case sensitive.
|
4318
4558
|
#
|
4319
4559
|
# Constraints:
|
4320
4560
|
#
|
@@ -4328,12 +4568,11 @@ module Aws::DocDB
|
|
4328
4568
|
# @return [String]
|
4329
4569
|
#
|
4330
4570
|
# @!attribute [rw] snapshot_identifier
|
4331
|
-
# The identifier for the
|
4332
|
-
# from.
|
4571
|
+
# The identifier for the snapshot or cluster snapshot to restore from.
|
4333
4572
|
#
|
4334
4573
|
# You can use either the name or the Amazon Resource Name (ARN) to
|
4335
|
-
# specify a
|
4336
|
-
# specify a
|
4574
|
+
# specify a cluster snapshot. However, you can use only the ARN to
|
4575
|
+
# specify a snapshot.
|
4337
4576
|
#
|
4338
4577
|
# Constraints:
|
4339
4578
|
#
|
@@ -4343,7 +4582,7 @@ module Aws::DocDB
|
|
4343
4582
|
# @return [String]
|
4344
4583
|
#
|
4345
4584
|
# @!attribute [rw] engine
|
4346
|
-
# The database engine to use for the new
|
4585
|
+
# The database engine to use for the new cluster.
|
4347
4586
|
#
|
4348
4587
|
# Default: The same as source.
|
4349
4588
|
#
|
@@ -4351,19 +4590,19 @@ module Aws::DocDB
|
|
4351
4590
|
# @return [String]
|
4352
4591
|
#
|
4353
4592
|
# @!attribute [rw] engine_version
|
4354
|
-
# The version of the database engine to use for the new
|
4593
|
+
# The version of the database engine to use for the new cluster.
|
4355
4594
|
# @return [String]
|
4356
4595
|
#
|
4357
4596
|
# @!attribute [rw] port
|
4358
|
-
# The port number on which the new
|
4597
|
+
# The port number on which the new cluster accepts connections.
|
4359
4598
|
#
|
4360
4599
|
# Constraints: Must be a value from `1150` to `65535`.
|
4361
4600
|
#
|
4362
|
-
# Default: The same port as the original
|
4601
|
+
# Default: The same port as the original cluster.
|
4363
4602
|
# @return [Integer]
|
4364
4603
|
#
|
4365
4604
|
# @!attribute [rw] db_subnet_group_name
|
4366
|
-
# The name of the
|
4605
|
+
# The name of the subnet group to use for the new cluster.
|
4367
4606
|
#
|
4368
4607
|
# Constraints: If provided, must match the name of an existing
|
4369
4608
|
# `DBSubnetGroup`.
|
@@ -4373,34 +4612,33 @@ module Aws::DocDB
|
|
4373
4612
|
#
|
4374
4613
|
# @!attribute [rw] vpc_security_group_ids
|
4375
4614
|
# A list of virtual private cloud (VPC) security groups that the new
|
4376
|
-
#
|
4615
|
+
# cluster will belong to.
|
4377
4616
|
# @return [Array<String>]
|
4378
4617
|
#
|
4379
4618
|
# @!attribute [rw] tags
|
4380
|
-
# The tags to be assigned to the restored
|
4619
|
+
# The tags to be assigned to the restored cluster.
|
4381
4620
|
# @return [Array<Types::Tag>]
|
4382
4621
|
#
|
4383
4622
|
# @!attribute [rw] kms_key_id
|
4384
|
-
# The AWS KMS key identifier to use when restoring an encrypted
|
4385
|
-
# cluster from a DB snapshot or
|
4623
|
+
# The AWS KMS key identifier to use when restoring an encrypted
|
4624
|
+
# cluster from a DB snapshot or cluster snapshot.
|
4386
4625
|
#
|
4387
4626
|
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
4388
|
-
# AWS KMS encryption key. If you are restoring a
|
4389
|
-
#
|
4390
|
-
#
|
4391
|
-
#
|
4627
|
+
# AWS KMS encryption key. If you are restoring a cluster with the same
|
4628
|
+
# AWS account that owns the AWS KMS encryption key used to encrypt the
|
4629
|
+
# new cluster, then you can use the AWS KMS key alias instead of the
|
4630
|
+
# ARN for the AWS KMS encryption key.
|
4392
4631
|
#
|
4393
4632
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
4394
4633
|
# following occurs:
|
4395
4634
|
#
|
4396
|
-
# * If the
|
4397
|
-
#
|
4398
|
-
#
|
4399
|
-
#
|
4635
|
+
# * If the snapshot or cluster snapshot in `SnapshotIdentifier` is
|
4636
|
+
# encrypted, then the restored cluster is encrypted using the AWS
|
4637
|
+
# KMS key that was used to encrypt the snapshot or the cluster
|
4638
|
+
# snapshot.
|
4400
4639
|
#
|
4401
|
-
# * If the
|
4402
|
-
#
|
4403
|
-
# cluster is not encrypted.
|
4640
|
+
# * If the snapshot or the cluster snapshot in `SnapshotIdentifier` is
|
4641
|
+
# not encrypted, then the restored DB cluster is not encrypted.
|
4404
4642
|
# @return [String]
|
4405
4643
|
#
|
4406
4644
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
@@ -4435,7 +4673,7 @@ module Aws::DocDB
|
|
4435
4673
|
end
|
4436
4674
|
|
4437
4675
|
# @!attribute [rw] db_cluster
|
4438
|
-
# Detailed information about a
|
4676
|
+
# Detailed information about a cluster.
|
4439
4677
|
# @return [Types::DBCluster]
|
4440
4678
|
#
|
4441
4679
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshotResult AWS API Documentation
|
@@ -4470,7 +4708,7 @@ module Aws::DocDB
|
|
4470
4708
|
# }
|
4471
4709
|
#
|
4472
4710
|
# @!attribute [rw] db_cluster_identifier
|
4473
|
-
# The name of the new
|
4711
|
+
# The name of the new cluster to be created.
|
4474
4712
|
#
|
4475
4713
|
# Constraints:
|
4476
4714
|
#
|
@@ -4482,7 +4720,7 @@ module Aws::DocDB
|
|
4482
4720
|
# @return [String]
|
4483
4721
|
#
|
4484
4722
|
# @!attribute [rw] source_db_cluster_identifier
|
4485
|
-
# The identifier of the source
|
4723
|
+
# The identifier of the source cluster from which to restore.
|
4486
4724
|
#
|
4487
4725
|
# Constraints:
|
4488
4726
|
#
|
@@ -4492,13 +4730,13 @@ module Aws::DocDB
|
|
4492
4730
|
# @return [String]
|
4493
4731
|
#
|
4494
4732
|
# @!attribute [rw] restore_to_time
|
4495
|
-
# The date and time to restore the
|
4733
|
+
# The date and time to restore the cluster to.
|
4496
4734
|
#
|
4497
4735
|
# Valid values: A time in Universal Coordinated Time (UTC) format.
|
4498
4736
|
#
|
4499
4737
|
# Constraints:
|
4500
4738
|
#
|
4501
|
-
# * Must be before the latest restorable time for the
|
4739
|
+
# * Must be before the latest restorable time for the instance.
|
4502
4740
|
#
|
4503
4741
|
# * Must be specified if the `UseLatestRestorableTime` parameter is
|
4504
4742
|
# not provided.
|
@@ -4513,8 +4751,8 @@ module Aws::DocDB
|
|
4513
4751
|
# @return [Time]
|
4514
4752
|
#
|
4515
4753
|
# @!attribute [rw] use_latest_restorable_time
|
4516
|
-
# A value that is set to `true` to restore the
|
4517
|
-
#
|
4754
|
+
# A value that is set to `true` to restore the cluster to the latest
|
4755
|
+
# restorable backup time, and `false` otherwise.
|
4518
4756
|
#
|
4519
4757
|
# Default: `false`
|
4520
4758
|
#
|
@@ -4523,7 +4761,7 @@ module Aws::DocDB
|
|
4523
4761
|
# @return [Boolean]
|
4524
4762
|
#
|
4525
4763
|
# @!attribute [rw] port
|
4526
|
-
# The port number on which the new
|
4764
|
+
# The port number on which the new cluster accepts connections.
|
4527
4765
|
#
|
4528
4766
|
# Constraints: Must be a value from `1150` to `65535`.
|
4529
4767
|
#
|
@@ -4531,7 +4769,7 @@ module Aws::DocDB
|
|
4531
4769
|
# @return [Integer]
|
4532
4770
|
#
|
4533
4771
|
# @!attribute [rw] db_subnet_group_name
|
4534
|
-
# The
|
4772
|
+
# The subnet group name to use for the new cluster.
|
4535
4773
|
#
|
4536
4774
|
# Constraints: If provided, must match the name of an existing
|
4537
4775
|
# `DBSubnetGroup`.
|
@@ -4540,40 +4778,40 @@ module Aws::DocDB
|
|
4540
4778
|
# @return [String]
|
4541
4779
|
#
|
4542
4780
|
# @!attribute [rw] vpc_security_group_ids
|
4543
|
-
# A list of VPC security groups that the new
|
4781
|
+
# A list of VPC security groups that the new cluster belongs to.
|
4544
4782
|
# @return [Array<String>]
|
4545
4783
|
#
|
4546
4784
|
# @!attribute [rw] tags
|
4547
|
-
# The tags to be assigned to the restored
|
4785
|
+
# The tags to be assigned to the restored cluster.
|
4548
4786
|
# @return [Array<Types::Tag>]
|
4549
4787
|
#
|
4550
4788
|
# @!attribute [rw] kms_key_id
|
4551
|
-
# The AWS KMS key identifier to use when restoring an encrypted
|
4552
|
-
# cluster from an encrypted
|
4789
|
+
# The AWS KMS key identifier to use when restoring an encrypted
|
4790
|
+
# cluster from an encrypted cluster.
|
4553
4791
|
#
|
4554
4792
|
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
4555
|
-
# AWS KMS encryption key. If you are restoring a
|
4556
|
-
#
|
4557
|
-
#
|
4558
|
-
#
|
4793
|
+
# AWS KMS encryption key. If you are restoring a cluster with the same
|
4794
|
+
# AWS account that owns the AWS KMS encryption key used to encrypt the
|
4795
|
+
# new cluster, then you can use the AWS KMS key alias instead of the
|
4796
|
+
# ARN for the AWS KMS encryption key.
|
4559
4797
|
#
|
4560
|
-
# You can restore to a new
|
4561
|
-
#
|
4562
|
-
#
|
4563
|
-
#
|
4798
|
+
# You can restore to a new cluster and encrypt the new cluster with an
|
4799
|
+
# AWS KMS key that is different from the AWS KMS key used to encrypt
|
4800
|
+
# the source cluster. The new DB cluster is encrypted with the AWS KMS
|
4801
|
+
# key identified by the `KmsKeyId` parameter.
|
4564
4802
|
#
|
4565
4803
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
4566
4804
|
# following occurs:
|
4567
4805
|
#
|
4568
|
-
# * If the
|
4806
|
+
# * If the cluster is encrypted, then the restored cluster is
|
4569
4807
|
# encrypted using the AWS KMS key that was used to encrypt the
|
4570
|
-
# source
|
4808
|
+
# source cluster.
|
4571
4809
|
#
|
4572
|
-
# * If the
|
4573
|
-
#
|
4810
|
+
# * If the cluster is not encrypted, then the restored cluster is not
|
4811
|
+
# encrypted.
|
4574
4812
|
#
|
4575
|
-
# If `DBClusterIdentifier` refers to a
|
4576
|
-
#
|
4813
|
+
# If `DBClusterIdentifier` refers to a cluster that is not encrypted,
|
4814
|
+
# then the restore request is rejected.
|
4577
4815
|
# @return [String]
|
4578
4816
|
#
|
4579
4817
|
# @!attribute [rw] enable_cloudwatch_logs_exports
|
@@ -4607,7 +4845,7 @@ module Aws::DocDB
|
|
4607
4845
|
end
|
4608
4846
|
|
4609
4847
|
# @!attribute [rw] db_cluster
|
4610
|
-
# Detailed information about a
|
4848
|
+
# Detailed information about a cluster.
|
4611
4849
|
# @return [Types::DBCluster]
|
4612
4850
|
#
|
4613
4851
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTimeResult AWS API Documentation
|
@@ -4617,6 +4855,19 @@ module Aws::DocDB
|
|
4617
4855
|
include Aws::Structure
|
4618
4856
|
end
|
4619
4857
|
|
4858
|
+
# You have exceeded the maximum number of accounts that you can share a
|
4859
|
+
# manual DB snapshot with.
|
4860
|
+
#
|
4861
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/SharedSnapshotQuotaExceededFault AWS API Documentation
|
4862
|
+
#
|
4863
|
+
class SharedSnapshotQuotaExceededFault < Aws::EmptyStructure; end
|
4864
|
+
|
4865
|
+
# The request would cause you to exceed the allowed number of snapshots.
|
4866
|
+
#
|
4867
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/SnapshotQuotaExceededFault AWS API Documentation
|
4868
|
+
#
|
4869
|
+
class SnapshotQuotaExceededFault < Aws::EmptyStructure; end
|
4870
|
+
|
4620
4871
|
# @note When making an API call, you may pass StartDBClusterMessage
|
4621
4872
|
# data as a hash:
|
4622
4873
|
#
|
@@ -4637,7 +4888,7 @@ module Aws::DocDB
|
|
4637
4888
|
end
|
4638
4889
|
|
4639
4890
|
# @!attribute [rw] db_cluster
|
4640
|
-
# Detailed information about a
|
4891
|
+
# Detailed information about a cluster.
|
4641
4892
|
# @return [Types::DBCluster]
|
4642
4893
|
#
|
4643
4894
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StartDBClusterResult AWS API Documentation
|
@@ -4667,7 +4918,7 @@ module Aws::DocDB
|
|
4667
4918
|
end
|
4668
4919
|
|
4669
4920
|
# @!attribute [rw] db_cluster
|
4670
|
-
# Detailed information about a
|
4921
|
+
# Detailed information about a cluster.
|
4671
4922
|
# @return [Types::DBCluster]
|
4672
4923
|
#
|
4673
4924
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StopDBClusterResult AWS API Documentation
|
@@ -4677,6 +4928,20 @@ module Aws::DocDB
|
|
4677
4928
|
include Aws::Structure
|
4678
4929
|
end
|
4679
4930
|
|
4931
|
+
# The request would cause you to exceed the allowed amount of storage
|
4932
|
+
# available across all instances.
|
4933
|
+
#
|
4934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StorageQuotaExceededFault AWS API Documentation
|
4935
|
+
#
|
4936
|
+
class StorageQuotaExceededFault < Aws::EmptyStructure; end
|
4937
|
+
|
4938
|
+
# Storage of the specified `StorageType` can't be associated with the
|
4939
|
+
# DB instance.
|
4940
|
+
#
|
4941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StorageTypeNotSupportedFault AWS API Documentation
|
4942
|
+
#
|
4943
|
+
class StorageTypeNotSupportedFault < Aws::EmptyStructure; end
|
4944
|
+
|
4680
4945
|
# Detailed information about a subnet.
|
4681
4946
|
#
|
4682
4947
|
# @!attribute [rw] subnet_identifier
|
@@ -4700,6 +4965,12 @@ module Aws::DocDB
|
|
4700
4965
|
include Aws::Structure
|
4701
4966
|
end
|
4702
4967
|
|
4968
|
+
# The subnet is already in use in the Availability Zone.
|
4969
|
+
#
|
4970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/SubnetAlreadyInUse AWS API Documentation
|
4971
|
+
#
|
4972
|
+
class SubnetAlreadyInUse < Aws::EmptyStructure; end
|
4973
|
+
|
4703
4974
|
# Metadata assigned to an Amazon DocumentDB resource consisting of a
|
4704
4975
|
# key-value pair.
|
4705
4976
|
#
|
@@ -4750,7 +5021,7 @@ module Aws::DocDB
|
|
4750
5021
|
include Aws::Structure
|
4751
5022
|
end
|
4752
5023
|
|
4753
|
-
# The version of the database engine that
|
5024
|
+
# The version of the database engine that an instance can be upgraded
|
4754
5025
|
# to.
|
4755
5026
|
#
|
4756
5027
|
# @!attribute [rw] engine
|
@@ -4762,8 +5033,8 @@ module Aws::DocDB
|
|
4762
5033
|
# @return [String]
|
4763
5034
|
#
|
4764
5035
|
# @!attribute [rw] description
|
4765
|
-
# The version of the database engine that
|
4766
|
-
#
|
5036
|
+
# The version of the database engine that an instance can be upgraded
|
5037
|
+
# to.
|
4767
5038
|
# @return [String]
|
4768
5039
|
#
|
4769
5040
|
# @!attribute [rw] auto_upgrade
|