aws-sdk-docdb 1.12.0 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-docdb.rb +1 -1
- data/lib/aws-sdk-docdb/client.rb +366 -379
- data/lib/aws-sdk-docdb/types.rb +428 -444
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3b5229f6fbb1fb78df66a004ef06d3d7d918a2df
|
|
4
|
+
data.tar.gz: 4634d5b5e8f6f13ed1f79c9d00362345934577c6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a16793def2cb24469d5f8658be7090a82f15783597b3e06d26c3bd03f02bfd8909f4d079a6078f062be84833826655637574fedb7549327ccf3ca5c976e8fb5b
|
|
7
|
+
data.tar.gz: fb3ba5d0534e37c2a683f25a5a1a36b9a2984d24831abb032e7d09dc1b504c8ed60a8dc312b856bdc2faf95cd21d05fa602f7f1595e4a605eac7b709ff2c607a
|
data/lib/aws-sdk-docdb.rb
CHANGED
data/lib/aws-sdk-docdb/client.rb
CHANGED
|
@@ -347,27 +347,26 @@ module Aws::DocDB
|
|
|
347
347
|
req.send_request(options)
|
|
348
348
|
end
|
|
349
349
|
|
|
350
|
-
# Copies the specified
|
|
350
|
+
# Copies the specified cluster parameter group.
|
|
351
351
|
#
|
|
352
352
|
# @option params [required, String] :source_db_cluster_parameter_group_identifier
|
|
353
|
-
# The identifier or Amazon Resource Name (ARN) for the source
|
|
353
|
+
# The identifier or Amazon Resource Name (ARN) for the source cluster
|
|
354
354
|
# parameter group.
|
|
355
355
|
#
|
|
356
356
|
# Constraints:
|
|
357
357
|
#
|
|
358
|
-
# * Must specify a valid
|
|
358
|
+
# * Must specify a valid cluster parameter group.
|
|
359
359
|
#
|
|
360
|
-
# * If the source
|
|
361
|
-
#
|
|
362
|
-
#
|
|
360
|
+
# * If the source cluster parameter group is in the same AWS Region as
|
|
361
|
+
# the copy, specify a valid parameter group identifier; for example,
|
|
362
|
+
# `my-db-cluster-param-group`, or a valid ARN.
|
|
363
363
|
#
|
|
364
|
-
# * If the source
|
|
365
|
-
#
|
|
366
|
-
# example,
|
|
364
|
+
# * If the source parameter group is in a different AWS Region than the
|
|
365
|
+
# copy, specify a valid cluster parameter group ARN; for example,
|
|
367
366
|
# `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
|
|
368
367
|
#
|
|
369
368
|
# @option params [required, String] :target_db_cluster_parameter_group_identifier
|
|
370
|
-
# The identifier for the copied
|
|
369
|
+
# The identifier for the copied cluster parameter group.
|
|
371
370
|
#
|
|
372
371
|
# Constraints:
|
|
373
372
|
#
|
|
@@ -382,7 +381,7 @@ module Aws::DocDB
|
|
|
382
381
|
# Example: `my-cluster-param-group1`
|
|
383
382
|
#
|
|
384
383
|
# @option params [required, String] :target_db_cluster_parameter_group_description
|
|
385
|
-
# A description for the copied
|
|
384
|
+
# A description for the copied cluster parameter group.
|
|
386
385
|
#
|
|
387
386
|
# @option params [Array<Types::Tag>] :tags
|
|
388
387
|
# The tags that are to be assigned to the parameter group.
|
|
@@ -421,22 +420,22 @@ module Aws::DocDB
|
|
|
421
420
|
req.send_request(options)
|
|
422
421
|
end
|
|
423
422
|
|
|
424
|
-
# Copies a snapshot of a
|
|
423
|
+
# Copies a snapshot of a cluster.
|
|
425
424
|
#
|
|
426
|
-
# To copy a
|
|
427
|
-
#
|
|
428
|
-
#
|
|
425
|
+
# To copy a cluster snapshot from a shared manual cluster snapshot,
|
|
426
|
+
# `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name
|
|
427
|
+
# (ARN) of the shared cluster snapshot.
|
|
429
428
|
#
|
|
430
429
|
# To cancel the copy operation after it is in progress, delete the
|
|
431
|
-
# target
|
|
430
|
+
# target cluster snapshot identified by
|
|
432
431
|
# `TargetDBClusterSnapshotIdentifier` while that DB cluster snapshot is
|
|
433
432
|
# in the *copying* status.
|
|
434
433
|
#
|
|
435
434
|
# @option params [required, String] :source_db_cluster_snapshot_identifier
|
|
436
|
-
# The identifier of the
|
|
437
|
-
#
|
|
435
|
+
# The identifier of the cluster snapshot to copy. This parameter is not
|
|
436
|
+
# case sensitive.
|
|
438
437
|
#
|
|
439
|
-
# You can't copy an encrypted, shared
|
|
438
|
+
# You can't copy an encrypted, shared cluster snapshot from one AWS
|
|
440
439
|
# Region to another.
|
|
441
440
|
#
|
|
442
441
|
# Constraints:
|
|
@@ -444,16 +443,16 @@ module Aws::DocDB
|
|
|
444
443
|
# * Must specify a valid system snapshot in the "available" state.
|
|
445
444
|
#
|
|
446
445
|
# * If the source snapshot is in the same AWS Region as the copy,
|
|
447
|
-
# specify a valid
|
|
446
|
+
# specify a valid snapshot identifier.
|
|
448
447
|
#
|
|
449
448
|
# * If the source snapshot is in a different AWS Region than the copy,
|
|
450
|
-
# specify a valid
|
|
449
|
+
# specify a valid cluster snapshot ARN.
|
|
451
450
|
#
|
|
452
451
|
# Example: `my-cluster-snapshot1`
|
|
453
452
|
#
|
|
454
453
|
# @option params [required, String] :target_db_cluster_snapshot_identifier
|
|
455
|
-
# The identifier of the new
|
|
456
|
-
#
|
|
454
|
+
# The identifier of the new cluster snapshot to create from the source
|
|
455
|
+
# cluster snapshot. This parameter is not case sensitive.
|
|
457
456
|
#
|
|
458
457
|
# Constraints:
|
|
459
458
|
#
|
|
@@ -466,35 +465,35 @@ module Aws::DocDB
|
|
|
466
465
|
# Example: `my-cluster-snapshot2`
|
|
467
466
|
#
|
|
468
467
|
# @option params [String] :kms_key_id
|
|
469
|
-
# The AWS KMS key ID for an encrypted
|
|
470
|
-
#
|
|
471
|
-
#
|
|
468
|
+
# The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key
|
|
469
|
+
# ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the
|
|
470
|
+
# AWS KMS key alias for the AWS KMS encryption key.
|
|
472
471
|
#
|
|
473
|
-
# If you copy an encrypted
|
|
474
|
-
#
|
|
475
|
-
#
|
|
476
|
-
#
|
|
477
|
-
#
|
|
472
|
+
# If you copy an encrypted cluster snapshot from your AWS account, you
|
|
473
|
+
# can specify a value for `KmsKeyId` to encrypt the copy with a new AWS
|
|
474
|
+
# KMS encryption key. If you don't specify a value for `KmsKeyId`, then
|
|
475
|
+
# the copy of the cluster snapshot is encrypted with the same AWS KMS
|
|
476
|
+
# key as the source cluster snapshot.
|
|
478
477
|
#
|
|
479
|
-
# If you copy an encrypted
|
|
480
|
-
#
|
|
478
|
+
# If you copy an encrypted cluster snapshot that is shared from another
|
|
479
|
+
# AWS account, then you must specify a value for `KmsKeyId`.
|
|
481
480
|
#
|
|
482
|
-
# To copy an encrypted
|
|
481
|
+
# To copy an encrypted cluster snapshot to another AWS Region, set
|
|
483
482
|
# `KmsKeyId` to the AWS KMS key ID that you want to use to encrypt the
|
|
484
|
-
# copy of the
|
|
483
|
+
# copy of the cluster snapshot in the destination Region. AWS KMS
|
|
485
484
|
# encryption keys are specific to the AWS Region that they are created
|
|
486
485
|
# in, and you can't use encryption keys from one Region in another
|
|
487
486
|
# Region.
|
|
488
487
|
#
|
|
489
|
-
# If you copy an unencrypted
|
|
488
|
+
# If you copy an unencrypted cluster snapshot and specify a value for
|
|
490
489
|
# the `KmsKeyId` parameter, an error is returned.
|
|
491
490
|
#
|
|
492
491
|
# @option params [String] :pre_signed_url
|
|
493
492
|
# The URL that contains a Signature Version 4 signed request for the
|
|
494
493
|
# `CopyDBClusterSnapshot` API action in the AWS Region that contains the
|
|
495
|
-
# source
|
|
496
|
-
# parameter when copying an encrypted
|
|
497
|
-
#
|
|
494
|
+
# source cluster snapshot to copy. You must use the `PreSignedUrl`
|
|
495
|
+
# parameter when copying an encrypted cluster snapshot from another AWS
|
|
496
|
+
# Region.
|
|
498
497
|
#
|
|
499
498
|
# The presigned URL must be a valid request for the
|
|
500
499
|
# `CopyDBSClusterSnapshot` API action that can be executed in the source
|
|
@@ -503,7 +502,7 @@ module Aws::DocDB
|
|
|
503
502
|
# values:
|
|
504
503
|
#
|
|
505
504
|
# * `KmsKeyId` - The AWS KMS key identifier for the key to use to
|
|
506
|
-
# encrypt the copy of the
|
|
505
|
+
# encrypt the copy of the cluster snapshot in the destination AWS
|
|
507
506
|
# Region. This is the same identifier for both the
|
|
508
507
|
# `CopyDBClusterSnapshot` action that is called in the destination AWS
|
|
509
508
|
# Region, and the action contained in the presigned URL.
|
|
@@ -511,22 +510,22 @@ module Aws::DocDB
|
|
|
511
510
|
# * `DestinationRegion` - The name of the AWS Region that the DB cluster
|
|
512
511
|
# snapshot will be created in.
|
|
513
512
|
#
|
|
514
|
-
# * `SourceDBClusterSnapshotIdentifier` - The
|
|
515
|
-
# identifier for the encrypted
|
|
513
|
+
# * `SourceDBClusterSnapshotIdentifier` - The cluster snapshot
|
|
514
|
+
# identifier for the encrypted cluster snapshot to be copied. This
|
|
516
515
|
# identifier must be in the Amazon Resource Name (ARN) format for the
|
|
517
|
-
# source AWS Region. For example, if you are copying an encrypted
|
|
516
|
+
# source AWS Region. For example, if you are copying an encrypted
|
|
518
517
|
# cluster snapshot from the us-west-2 AWS Region, then your
|
|
519
518
|
# `SourceDBClusterSnapshotIdentifier` looks like the following
|
|
520
519
|
# example:
|
|
521
520
|
# `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115`.
|
|
522
521
|
#
|
|
523
522
|
# @option params [Boolean] :copy_tags
|
|
524
|
-
# Set to `true` to copy all tags from the source
|
|
525
|
-
#
|
|
523
|
+
# Set to `true` to copy all tags from the source cluster snapshot to the
|
|
524
|
+
# target cluster snapshot, and otherwise `false`. The default is
|
|
526
525
|
# `false`.
|
|
527
526
|
#
|
|
528
527
|
# @option params [Array<Types::Tag>] :tags
|
|
529
|
-
# The tags to be assigned to the
|
|
528
|
+
# The tags to be assigned to the cluster snapshot.
|
|
530
529
|
#
|
|
531
530
|
# @return [Types::CopyDBClusterSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
532
531
|
#
|
|
@@ -578,11 +577,11 @@ module Aws::DocDB
|
|
|
578
577
|
req.send_request(options)
|
|
579
578
|
end
|
|
580
579
|
|
|
581
|
-
# Creates a new Amazon DocumentDB
|
|
580
|
+
# Creates a new Amazon DocumentDB cluster.
|
|
582
581
|
#
|
|
583
582
|
# @option params [Array<String>] :availability_zones
|
|
584
|
-
# A list of Amazon EC2 Availability Zones that instances in the
|
|
585
|
-
#
|
|
583
|
+
# A list of Amazon EC2 Availability Zones that instances in the cluster
|
|
584
|
+
# can be created in.
|
|
586
585
|
#
|
|
587
586
|
# @option params [Integer] :backup_retention_period
|
|
588
587
|
# The number of days for which automated backups are retained. You must
|
|
@@ -597,7 +596,7 @@ module Aws::DocDB
|
|
|
597
596
|
# ^
|
|
598
597
|
#
|
|
599
598
|
# @option params [required, String] :db_cluster_identifier
|
|
600
|
-
# The
|
|
599
|
+
# The cluster identifier. This parameter is stored as a lowercase
|
|
601
600
|
# string.
|
|
602
601
|
#
|
|
603
602
|
# Constraints:
|
|
@@ -611,14 +610,14 @@ module Aws::DocDB
|
|
|
611
610
|
# Example: `my-cluster`
|
|
612
611
|
#
|
|
613
612
|
# @option params [String] :db_cluster_parameter_group_name
|
|
614
|
-
# The name of the
|
|
613
|
+
# The name of the cluster parameter group to associate with this
|
|
615
614
|
# cluster.
|
|
616
615
|
#
|
|
617
616
|
# @option params [Array<String>] :vpc_security_group_ids
|
|
618
|
-
# A list of EC2 VPC security groups to associate with this
|
|
617
|
+
# A list of EC2 VPC security groups to associate with this cluster.
|
|
619
618
|
#
|
|
620
619
|
# @option params [String] :db_subnet_group_name
|
|
621
|
-
# A
|
|
620
|
+
# A subnet group to associate with this cluster.
|
|
622
621
|
#
|
|
623
622
|
# Constraints: Must match the name of an existing `DBSubnetGroup`. Must
|
|
624
623
|
# not be default.
|
|
@@ -626,7 +625,7 @@ module Aws::DocDB
|
|
|
626
625
|
# Example: `mySubnetgroup`
|
|
627
626
|
#
|
|
628
627
|
# @option params [required, String] :engine
|
|
629
|
-
# The name of the database engine to be used for this
|
|
628
|
+
# The name of the database engine to be used for this cluster.
|
|
630
629
|
#
|
|
631
630
|
# Valid values: `docdb`
|
|
632
631
|
#
|
|
@@ -634,11 +633,11 @@ module Aws::DocDB
|
|
|
634
633
|
# The version number of the database engine to use.
|
|
635
634
|
#
|
|
636
635
|
# @option params [Integer] :port
|
|
637
|
-
# The port number on which the instances in the
|
|
636
|
+
# The port number on which the instances in the cluster accept
|
|
638
637
|
# connections.
|
|
639
638
|
#
|
|
640
639
|
# @option params [required, String] :master_username
|
|
641
|
-
# The name of the master user for the
|
|
640
|
+
# The name of the master user for the cluster.
|
|
642
641
|
#
|
|
643
642
|
# Constraints:
|
|
644
643
|
#
|
|
@@ -688,19 +687,19 @@ module Aws::DocDB
|
|
|
688
687
|
# Constraints: Minimum 30-minute window.
|
|
689
688
|
#
|
|
690
689
|
# @option params [Array<Types::Tag>] :tags
|
|
691
|
-
# The tags to be assigned to the
|
|
690
|
+
# The tags to be assigned to the cluster.
|
|
692
691
|
#
|
|
693
692
|
# @option params [Boolean] :storage_encrypted
|
|
694
|
-
# Specifies whether the
|
|
693
|
+
# Specifies whether the cluster is encrypted.
|
|
695
694
|
#
|
|
696
695
|
# @option params [String] :kms_key_id
|
|
697
|
-
# The AWS KMS key identifier for an encrypted
|
|
696
|
+
# The AWS KMS key identifier for an encrypted cluster.
|
|
698
697
|
#
|
|
699
698
|
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
|
700
|
-
# AWS KMS encryption key. If you are creating a
|
|
701
|
-
#
|
|
702
|
-
# encrypt the new
|
|
703
|
-
#
|
|
699
|
+
# AWS KMS encryption key. If you are creating a cluster using the same
|
|
700
|
+
# AWS account that owns the AWS KMS encryption key that is used to
|
|
701
|
+
# encrypt the new cluster, you can use the AWS KMS key alias instead of
|
|
702
|
+
# the ARN for the AWS KMS encryption key.
|
|
704
703
|
#
|
|
705
704
|
# If an encryption key is not specified in `KmsKeyId`\:
|
|
706
705
|
#
|
|
@@ -717,8 +716,8 @@ module Aws::DocDB
|
|
|
717
716
|
# AWS account has a different default encryption key for each AWS
|
|
718
717
|
# Region.
|
|
719
718
|
#
|
|
720
|
-
# If you create a replica of an encrypted
|
|
721
|
-
#
|
|
719
|
+
# If you create a replica of an encrypted cluster in another AWS Region,
|
|
720
|
+
# you must set `KmsKeyId` to a KMS key ID that is valid in the
|
|
722
721
|
# destination AWS Region. This key is used to encrypt the replica in
|
|
723
722
|
# that AWS Region.
|
|
724
723
|
#
|
|
@@ -815,32 +814,30 @@ module Aws::DocDB
|
|
|
815
814
|
req.send_request(options)
|
|
816
815
|
end
|
|
817
816
|
|
|
818
|
-
# Creates a new
|
|
819
|
-
#
|
|
820
|
-
# Parameters in a
|
|
821
|
-
#
|
|
822
|
-
#
|
|
823
|
-
# A
|
|
824
|
-
# parameters for the database engine used by instances in the
|
|
825
|
-
#
|
|
826
|
-
#
|
|
827
|
-
#
|
|
828
|
-
#
|
|
829
|
-
#
|
|
830
|
-
#
|
|
831
|
-
#
|
|
832
|
-
#
|
|
833
|
-
#
|
|
834
|
-
#
|
|
835
|
-
#
|
|
836
|
-
#
|
|
837
|
-
#
|
|
838
|
-
#
|
|
839
|
-
# character set for the default database defined by the
|
|
840
|
-
# `character_set_database` parameter.
|
|
817
|
+
# Creates a new cluster parameter group.
|
|
818
|
+
#
|
|
819
|
+
# Parameters in a cluster parameter group apply to all of the instances
|
|
820
|
+
# in a DB cluster.
|
|
821
|
+
#
|
|
822
|
+
# A cluster parameter group is initially created with the default
|
|
823
|
+
# parameters for the database engine used by instances in the cluster.
|
|
824
|
+
# To provide custom values for any of the parameters, you must modify
|
|
825
|
+
# the group after you create it. After you create a DB cluster parameter
|
|
826
|
+
# group, you must associate it with your cluster. For the new DB cluster
|
|
827
|
+
# parameter group and associated settings to take effect, you must then
|
|
828
|
+
# reboot the instances in the cluster without failover.
|
|
829
|
+
#
|
|
830
|
+
# After you create a cluster parameter group, you should wait at least 5
|
|
831
|
+
# minutes before creating your first cluster that uses that cluster
|
|
832
|
+
# parameter group as the default parameter group. This allows Amazon
|
|
833
|
+
# DocumentDB to fully complete the create action before the cluster
|
|
834
|
+
# parameter group is used as the default for a new cluster. This step is
|
|
835
|
+
# especially important for parameters that are critical when creating
|
|
836
|
+
# the default database for a cluster, such as the character set for the
|
|
837
|
+
# default database defined by the `character_set_database` parameter.
|
|
841
838
|
#
|
|
842
839
|
# @option params [required, String] :db_cluster_parameter_group_name
|
|
843
|
-
# The name of the
|
|
840
|
+
# The name of the cluster parameter group.
|
|
844
841
|
#
|
|
845
842
|
# Constraints:
|
|
846
843
|
#
|
|
@@ -853,13 +850,13 @@ module Aws::DocDB
|
|
|
853
850
|
# </note>
|
|
854
851
|
#
|
|
855
852
|
# @option params [required, String] :db_parameter_group_family
|
|
856
|
-
# The
|
|
853
|
+
# The cluster parameter group family name.
|
|
857
854
|
#
|
|
858
855
|
# @option params [required, String] :description
|
|
859
|
-
# The description for the
|
|
856
|
+
# The description for the cluster parameter group.
|
|
860
857
|
#
|
|
861
858
|
# @option params [Array<Types::Tag>] :tags
|
|
862
|
-
# The tags to be assigned to the
|
|
859
|
+
# The tags to be assigned to the cluster parameter group.
|
|
863
860
|
#
|
|
864
861
|
# @return [Types::CreateDBClusterParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
865
862
|
#
|
|
@@ -895,11 +892,11 @@ module Aws::DocDB
|
|
|
895
892
|
req.send_request(options)
|
|
896
893
|
end
|
|
897
894
|
|
|
898
|
-
# Creates a snapshot of a
|
|
895
|
+
# Creates a snapshot of a cluster.
|
|
899
896
|
#
|
|
900
897
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
|
901
|
-
# The identifier of the
|
|
902
|
-
#
|
|
898
|
+
# The identifier of the cluster snapshot. This parameter is stored as a
|
|
899
|
+
# lowercase string.
|
|
903
900
|
#
|
|
904
901
|
# Constraints:
|
|
905
902
|
#
|
|
@@ -912,8 +909,8 @@ module Aws::DocDB
|
|
|
912
909
|
# Example: `my-cluster-snapshot1`
|
|
913
910
|
#
|
|
914
911
|
# @option params [required, String] :db_cluster_identifier
|
|
915
|
-
# The identifier of the
|
|
916
|
-
#
|
|
912
|
+
# The identifier of the cluster to create a snapshot for. This parameter
|
|
913
|
+
# is not case sensitive.
|
|
917
914
|
#
|
|
918
915
|
# Constraints:
|
|
919
916
|
#
|
|
@@ -924,7 +921,7 @@ module Aws::DocDB
|
|
|
924
921
|
# Example: `my-cluster`
|
|
925
922
|
#
|
|
926
923
|
# @option params [Array<Types::Tag>] :tags
|
|
927
|
-
# The tags to be assigned to the
|
|
924
|
+
# The tags to be assigned to the cluster snapshot.
|
|
928
925
|
#
|
|
929
926
|
# @return [Types::CreateDBClusterSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
930
927
|
#
|
|
@@ -973,10 +970,10 @@ module Aws::DocDB
|
|
|
973
970
|
req.send_request(options)
|
|
974
971
|
end
|
|
975
972
|
|
|
976
|
-
# Creates a new
|
|
973
|
+
# Creates a new instance.
|
|
977
974
|
#
|
|
978
975
|
# @option params [required, String] :db_instance_identifier
|
|
979
|
-
# The
|
|
976
|
+
# The instance identifier. This parameter is stored as a lowercase
|
|
980
977
|
# string.
|
|
981
978
|
#
|
|
982
979
|
# Constraints:
|
|
@@ -990,7 +987,7 @@ module Aws::DocDB
|
|
|
990
987
|
# Example: `mydbinstance`
|
|
991
988
|
#
|
|
992
989
|
# @option params [required, String] :db_instance_class
|
|
993
|
-
# The compute and memory capacity of the
|
|
990
|
+
# The compute and memory capacity of the instance; for example,
|
|
994
991
|
# `db.r5.large`.
|
|
995
992
|
#
|
|
996
993
|
# @option params [required, String] :engine
|
|
@@ -999,7 +996,7 @@ module Aws::DocDB
|
|
|
999
996
|
# Valid value: `docdb`
|
|
1000
997
|
#
|
|
1001
998
|
# @option params [String] :availability_zone
|
|
1002
|
-
# The Amazon EC2 Availability Zone that the
|
|
999
|
+
# The Amazon EC2 Availability Zone that the instance is created in.
|
|
1003
1000
|
#
|
|
1004
1001
|
# Default: A random, system-chosen Availability Zone in the endpoint's
|
|
1005
1002
|
# AWS Region.
|
|
@@ -1026,16 +1023,16 @@ module Aws::DocDB
|
|
|
1026
1023
|
#
|
|
1027
1024
|
# @option params [Boolean] :auto_minor_version_upgrade
|
|
1028
1025
|
# Indicates that minor engine upgrades are applied automatically to the
|
|
1029
|
-
#
|
|
1026
|
+
# instance during the maintenance window.
|
|
1030
1027
|
#
|
|
1031
1028
|
# Default: `true`
|
|
1032
1029
|
#
|
|
1033
1030
|
# @option params [Array<Types::Tag>] :tags
|
|
1034
|
-
# The tags to be assigned to the
|
|
1035
|
-
#
|
|
1031
|
+
# The tags to be assigned to the instance. You can assign up to 10 tags
|
|
1032
|
+
# to an instance.
|
|
1036
1033
|
#
|
|
1037
1034
|
# @option params [required, String] :db_cluster_identifier
|
|
1038
|
-
# The identifier of the
|
|
1035
|
+
# The identifier of the cluster that the instance will belong to.
|
|
1039
1036
|
#
|
|
1040
1037
|
# @option params [Integer] :promotion_tier
|
|
1041
1038
|
# A value that specifies the order in which an Amazon DocumentDB replica
|
|
@@ -1140,11 +1137,11 @@ module Aws::DocDB
|
|
|
1140
1137
|
req.send_request(options)
|
|
1141
1138
|
end
|
|
1142
1139
|
|
|
1143
|
-
# Creates a new
|
|
1144
|
-
#
|
|
1140
|
+
# Creates a new subnet group. subnet groups must contain at least one
|
|
1141
|
+
# subnet in at least two Availability Zones in the AWS Region.
|
|
1145
1142
|
#
|
|
1146
1143
|
# @option params [required, String] :db_subnet_group_name
|
|
1147
|
-
# The name for the
|
|
1144
|
+
# The name for the subnet group. This value is stored as a lowercase
|
|
1148
1145
|
# string.
|
|
1149
1146
|
#
|
|
1150
1147
|
# Constraints: Must contain no more than 255 letters, numbers, periods,
|
|
@@ -1153,13 +1150,13 @@ module Aws::DocDB
|
|
|
1153
1150
|
# Example: `mySubnetgroup`
|
|
1154
1151
|
#
|
|
1155
1152
|
# @option params [required, String] :db_subnet_group_description
|
|
1156
|
-
# The description for the
|
|
1153
|
+
# The description for the subnet group.
|
|
1157
1154
|
#
|
|
1158
1155
|
# @option params [required, Array<String>] :subnet_ids
|
|
1159
|
-
# The Amazon EC2 subnet IDs for the
|
|
1156
|
+
# The Amazon EC2 subnet IDs for the subnet group.
|
|
1160
1157
|
#
|
|
1161
1158
|
# @option params [Array<Types::Tag>] :tags
|
|
1162
|
-
# The tags to be assigned to the
|
|
1159
|
+
# The tags to be assigned to the subnet group.
|
|
1163
1160
|
#
|
|
1164
1161
|
# @return [Types::CreateDBSubnetGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1165
1162
|
#
|
|
@@ -1200,14 +1197,14 @@ module Aws::DocDB
|
|
|
1200
1197
|
req.send_request(options)
|
|
1201
1198
|
end
|
|
1202
1199
|
|
|
1203
|
-
# Deletes a previously provisioned
|
|
1204
|
-
#
|
|
1205
|
-
#
|
|
1206
|
-
#
|
|
1200
|
+
# Deletes a previously provisioned cluster. When you delete a cluster,
|
|
1201
|
+
# all automated backups for that cluster are deleted and can't be
|
|
1202
|
+
# recovered. Manual DB cluster snapshots of the specified cluster are
|
|
1203
|
+
# not deleted.
|
|
1207
1204
|
#
|
|
1208
1205
|
# @option params [required, String] :db_cluster_identifier
|
|
1209
|
-
# The
|
|
1210
|
-
#
|
|
1206
|
+
# The cluster identifier for the cluster to be deleted. This parameter
|
|
1207
|
+
# isn't case sensitive.
|
|
1211
1208
|
#
|
|
1212
1209
|
# Constraints:
|
|
1213
1210
|
#
|
|
@@ -1216,10 +1213,10 @@ module Aws::DocDB
|
|
|
1216
1213
|
# ^
|
|
1217
1214
|
#
|
|
1218
1215
|
# @option params [Boolean] :skip_final_snapshot
|
|
1219
|
-
# Determines whether a final
|
|
1220
|
-
#
|
|
1221
|
-
#
|
|
1222
|
-
#
|
|
1216
|
+
# Determines whether a final cluster snapshot is created before the
|
|
1217
|
+
# cluster is deleted. If `true` is specified, no cluster snapshot is
|
|
1218
|
+
# created. If `false` is specified, a cluster snapshot is created before
|
|
1219
|
+
# the DB cluster is deleted.
|
|
1223
1220
|
#
|
|
1224
1221
|
# <note markdown="1"> If `SkipFinalSnapshot` is `false`, you must specify a
|
|
1225
1222
|
# `FinalDBSnapshotIdentifier` parameter.
|
|
@@ -1229,8 +1226,8 @@ module Aws::DocDB
|
|
|
1229
1226
|
# Default: `false`
|
|
1230
1227
|
#
|
|
1231
1228
|
# @option params [String] :final_db_snapshot_identifier
|
|
1232
|
-
# The
|
|
1233
|
-
#
|
|
1229
|
+
# The cluster snapshot identifier of the new cluster snapshot created
|
|
1230
|
+
# when `SkipFinalSnapshot` is set to `false`.
|
|
1234
1231
|
#
|
|
1235
1232
|
# <note markdown="1"> Specifying this parameter and also setting the `SkipFinalShapshot`
|
|
1236
1233
|
# parameter to `true` results in an error.
|
|
@@ -1308,20 +1305,19 @@ module Aws::DocDB
|
|
|
1308
1305
|
req.send_request(options)
|
|
1309
1306
|
end
|
|
1310
1307
|
|
|
1311
|
-
# Deletes a specified
|
|
1312
|
-
#
|
|
1313
|
-
# clusters.
|
|
1308
|
+
# Deletes a specified cluster parameter group. The cluster parameter
|
|
1309
|
+
# group to be deleted can't be associated with any clusters.
|
|
1314
1310
|
#
|
|
1315
1311
|
# @option params [required, String] :db_cluster_parameter_group_name
|
|
1316
|
-
# The name of the
|
|
1312
|
+
# The name of the cluster parameter group.
|
|
1317
1313
|
#
|
|
1318
1314
|
# Constraints:
|
|
1319
1315
|
#
|
|
1320
|
-
# * Must be the name of an existing
|
|
1316
|
+
# * Must be the name of an existing cluster parameter group.
|
|
1321
1317
|
#
|
|
1322
|
-
# * You can't delete a default
|
|
1318
|
+
# * You can't delete a default cluster parameter group.
|
|
1323
1319
|
#
|
|
1324
|
-
# * Cannot be associated with any
|
|
1320
|
+
# * Cannot be associated with any clusters.
|
|
1325
1321
|
#
|
|
1326
1322
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1327
1323
|
#
|
|
@@ -1340,19 +1336,18 @@ module Aws::DocDB
|
|
|
1340
1336
|
req.send_request(options)
|
|
1341
1337
|
end
|
|
1342
1338
|
|
|
1343
|
-
# Deletes a
|
|
1344
|
-
#
|
|
1339
|
+
# Deletes a cluster snapshot. If the snapshot is being copied, the copy
|
|
1340
|
+
# operation is terminated.
|
|
1345
1341
|
#
|
|
1346
|
-
# <note markdown="1"> The
|
|
1347
|
-
# deleted.
|
|
1342
|
+
# <note markdown="1"> The cluster snapshot must be in the `available` state to be deleted.
|
|
1348
1343
|
#
|
|
1349
1344
|
# </note>
|
|
1350
1345
|
#
|
|
1351
1346
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
|
1352
|
-
# The identifier of the
|
|
1347
|
+
# The identifier of the cluster snapshot to delete.
|
|
1353
1348
|
#
|
|
1354
|
-
# Constraints: Must be the name of an existing
|
|
1355
|
-
#
|
|
1349
|
+
# Constraints: Must be the name of an existing cluster snapshot in the
|
|
1350
|
+
# `available` state.
|
|
1356
1351
|
#
|
|
1357
1352
|
# @return [Types::DeleteDBClusterSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1358
1353
|
#
|
|
@@ -1394,15 +1389,15 @@ module Aws::DocDB
|
|
|
1394
1389
|
req.send_request(options)
|
|
1395
1390
|
end
|
|
1396
1391
|
|
|
1397
|
-
# Deletes a previously provisioned
|
|
1392
|
+
# Deletes a previously provisioned instance.
|
|
1398
1393
|
#
|
|
1399
1394
|
# @option params [required, String] :db_instance_identifier
|
|
1400
|
-
# The
|
|
1401
|
-
#
|
|
1395
|
+
# The instance identifier for the instance to be deleted. This parameter
|
|
1396
|
+
# isn't case sensitive.
|
|
1402
1397
|
#
|
|
1403
1398
|
# Constraints:
|
|
1404
1399
|
#
|
|
1405
|
-
# * Must match the name of an existing
|
|
1400
|
+
# * Must match the name of an existing instance.
|
|
1406
1401
|
#
|
|
1407
1402
|
# ^
|
|
1408
1403
|
#
|
|
@@ -1487,7 +1482,7 @@ module Aws::DocDB
|
|
|
1487
1482
|
req.send_request(options)
|
|
1488
1483
|
end
|
|
1489
1484
|
|
|
1490
|
-
# Deletes a
|
|
1485
|
+
# Deletes a subnet group.
|
|
1491
1486
|
#
|
|
1492
1487
|
# <note markdown="1"> The specified database subnet group must not be associated with any DB
|
|
1493
1488
|
# instances.
|
|
@@ -1526,7 +1521,11 @@ module Aws::DocDB
|
|
|
1526
1521
|
end
|
|
1527
1522
|
|
|
1528
1523
|
# Returns a list of certificate authority (CA) certificates provided by
|
|
1529
|
-
# Amazon
|
|
1524
|
+
# Amazon DocumentDB for this AWS account. For certain management
|
|
1525
|
+
# features such as cluster and instance lifecycle management, Amazon
|
|
1526
|
+
# DocumentDB leverages operational technology that is shared with Amazon
|
|
1527
|
+
# RDS and Amazon Neptune. Use the `filterName=engine,Values=docdb`
|
|
1528
|
+
# filter parameter to return only Amazon DocumentDB clusters.
|
|
1530
1529
|
#
|
|
1531
1530
|
# @option params [String] :certificate_identifier
|
|
1532
1531
|
# The user-supplied certificate identifier. If this parameter is
|
|
@@ -1604,12 +1603,11 @@ module Aws::DocDB
|
|
|
1604
1603
|
|
|
1605
1604
|
# Returns a list of `DBClusterParameterGroup` descriptions. If a
|
|
1606
1605
|
# `DBClusterParameterGroupName` parameter is specified, the list
|
|
1607
|
-
# contains only the description of the specified
|
|
1606
|
+
# contains only the description of the specified cluster parameter
|
|
1608
1607
|
# group.
|
|
1609
1608
|
#
|
|
1610
1609
|
# @option params [String] :db_cluster_parameter_group_name
|
|
1611
|
-
# The name of a specific
|
|
1612
|
-
# for.
|
|
1610
|
+
# The name of a specific cluster parameter group to return details for.
|
|
1613
1611
|
#
|
|
1614
1612
|
# Constraints:
|
|
1615
1613
|
#
|
|
@@ -1673,11 +1671,11 @@ module Aws::DocDB
|
|
|
1673
1671
|
req.send_request(options)
|
|
1674
1672
|
end
|
|
1675
1673
|
|
|
1676
|
-
# Returns the detailed parameter list for a particular
|
|
1677
|
-
#
|
|
1674
|
+
# Returns the detailed parameter list for a particular cluster parameter
|
|
1675
|
+
# group.
|
|
1678
1676
|
#
|
|
1679
1677
|
# @option params [required, String] :db_cluster_parameter_group_name
|
|
1680
|
-
# The name of a specific
|
|
1678
|
+
# The name of a specific cluster parameter group to return parameter
|
|
1681
1679
|
# details for.
|
|
1682
1680
|
#
|
|
1683
1681
|
# Constraints:
|
|
@@ -1753,18 +1751,18 @@ module Aws::DocDB
|
|
|
1753
1751
|
req.send_request(options)
|
|
1754
1752
|
end
|
|
1755
1753
|
|
|
1756
|
-
# Returns a list of
|
|
1754
|
+
# Returns a list of cluster snapshot attribute names and values for a
|
|
1757
1755
|
# manual DB cluster snapshot.
|
|
1758
1756
|
#
|
|
1759
1757
|
# When you share snapshots with other AWS accounts,
|
|
1760
1758
|
# `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute
|
|
1761
1759
|
# and a list of IDs for the AWS accounts that are authorized to copy or
|
|
1762
|
-
# restore the manual
|
|
1763
|
-
#
|
|
1760
|
+
# restore the manual cluster snapshot. If `all` is included in the list
|
|
1761
|
+
# of values for the `restore` attribute, then the manual cluster
|
|
1764
1762
|
# snapshot is public and can be copied or restored by all AWS accounts.
|
|
1765
1763
|
#
|
|
1766
1764
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
|
1767
|
-
# The identifier for the
|
|
1765
|
+
# The identifier for the cluster snapshot to describe the attributes
|
|
1768
1766
|
# for.
|
|
1769
1767
|
#
|
|
1770
1768
|
# @return [Types::DescribeDBClusterSnapshotAttributesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -1794,14 +1792,13 @@ module Aws::DocDB
|
|
|
1794
1792
|
req.send_request(options)
|
|
1795
1793
|
end
|
|
1796
1794
|
|
|
1797
|
-
# Returns information about
|
|
1795
|
+
# Returns information about cluster snapshots. This API operation
|
|
1798
1796
|
# supports pagination.
|
|
1799
1797
|
#
|
|
1800
1798
|
# @option params [String] :db_cluster_identifier
|
|
1801
|
-
# The ID of the
|
|
1802
|
-
#
|
|
1803
|
-
#
|
|
1804
|
-
# sensitive.
|
|
1799
|
+
# The ID of the cluster to retrieve the list of cluster snapshots for.
|
|
1800
|
+
# This parameter can't be used with the `DBClusterSnapshotIdentifier`
|
|
1801
|
+
# parameter. This parameter is not case sensitive.
|
|
1805
1802
|
#
|
|
1806
1803
|
# Constraints:
|
|
1807
1804
|
#
|
|
@@ -1810,7 +1807,7 @@ module Aws::DocDB
|
|
|
1810
1807
|
# ^
|
|
1811
1808
|
#
|
|
1812
1809
|
# @option params [String] :db_cluster_snapshot_identifier
|
|
1813
|
-
# A specific
|
|
1810
|
+
# A specific cluster snapshot identifier to describe. This parameter
|
|
1814
1811
|
# can't be used with the `DBClusterIdentifier` parameter. This value is
|
|
1815
1812
|
# stored as a lowercase string.
|
|
1816
1813
|
#
|
|
@@ -1823,26 +1820,26 @@ module Aws::DocDB
|
|
|
1823
1820
|
# parameter must also be specified.
|
|
1824
1821
|
#
|
|
1825
1822
|
# @option params [String] :snapshot_type
|
|
1826
|
-
# The type of
|
|
1827
|
-
#
|
|
1823
|
+
# The type of cluster snapshots to be returned. You can specify one of
|
|
1824
|
+
# the following values:
|
|
1828
1825
|
#
|
|
1829
|
-
# * `automated` - Return all
|
|
1826
|
+
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
|
1830
1827
|
# has automatically created for your AWS account.
|
|
1831
1828
|
#
|
|
1832
|
-
# * `manual` - Return all
|
|
1829
|
+
# * `manual` - Return all cluster snapshots that you have manually
|
|
1833
1830
|
# created for your AWS account.
|
|
1834
1831
|
#
|
|
1835
|
-
# * `shared` - Return all manual
|
|
1836
|
-
#
|
|
1832
|
+
# * `shared` - Return all manual cluster snapshots that have been shared
|
|
1833
|
+
# to your AWS account.
|
|
1837
1834
|
#
|
|
1838
|
-
# * `public` - Return all
|
|
1835
|
+
# * `public` - Return all cluster snapshots that have been marked as
|
|
1839
1836
|
# public.
|
|
1840
1837
|
#
|
|
1841
1838
|
# If you don't specify a `SnapshotType` value, then both automated and
|
|
1842
|
-
# manual
|
|
1843
|
-
#
|
|
1844
|
-
#
|
|
1845
|
-
#
|
|
1839
|
+
# manual cluster snapshots are returned. You can include shared cluster
|
|
1840
|
+
# snapshots with these results by setting the `IncludeShared` parameter
|
|
1841
|
+
# to `true`. You can include public cluster snapshots with these results
|
|
1842
|
+
# by setting the `IncludePublic` parameter to `true`.
|
|
1846
1843
|
#
|
|
1847
1844
|
# The `IncludeShared` and `IncludePublic` parameters don't apply for
|
|
1848
1845
|
# `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
|
|
@@ -1869,14 +1866,14 @@ module Aws::DocDB
|
|
|
1869
1866
|
# marker, up to the value specified by `MaxRecords`.
|
|
1870
1867
|
#
|
|
1871
1868
|
# @option params [Boolean] :include_shared
|
|
1872
|
-
# Set to `true` to include shared manual
|
|
1869
|
+
# Set to `true` to include shared manual cluster snapshots from other
|
|
1873
1870
|
# AWS accounts that this AWS account has been given permission to copy
|
|
1874
1871
|
# or restore, and otherwise `false`. The default is `false`.
|
|
1875
1872
|
#
|
|
1876
1873
|
# @option params [Boolean] :include_public
|
|
1877
|
-
# Set to `true` to include manual
|
|
1878
|
-
#
|
|
1879
|
-
#
|
|
1874
|
+
# Set to `true` to include manual cluster snapshots that are public and
|
|
1875
|
+
# can be copied or restored by any AWS account, and otherwise `false`.
|
|
1876
|
+
# The default is `false`.
|
|
1880
1877
|
#
|
|
1881
1878
|
# @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1882
1879
|
#
|
|
@@ -1933,13 +1930,13 @@ module Aws::DocDB
|
|
|
1933
1930
|
req.send_request(options)
|
|
1934
1931
|
end
|
|
1935
1932
|
|
|
1936
|
-
# Returns information about provisioned Amazon DocumentDB
|
|
1937
|
-
#
|
|
1933
|
+
# Returns information about provisioned Amazon DocumentDB clusters. This
|
|
1934
|
+
# API operation supports pagination.
|
|
1938
1935
|
#
|
|
1939
1936
|
# @option params [String] :db_cluster_identifier
|
|
1940
|
-
# The user-provided
|
|
1941
|
-
#
|
|
1942
|
-
#
|
|
1937
|
+
# The user-provided cluster identifier. If this parameter is specified,
|
|
1938
|
+
# information from only the specific cluster is returned. This parameter
|
|
1939
|
+
# isn't case sensitive.
|
|
1943
1940
|
#
|
|
1944
1941
|
# Constraints:
|
|
1945
1942
|
#
|
|
@@ -1948,13 +1945,13 @@ module Aws::DocDB
|
|
|
1948
1945
|
# ^
|
|
1949
1946
|
#
|
|
1950
1947
|
# @option params [Array<Types::Filter>] :filters
|
|
1951
|
-
# A filter that specifies one or more
|
|
1948
|
+
# A filter that specifies one or more clusters to describe.
|
|
1952
1949
|
#
|
|
1953
1950
|
# Supported filters:
|
|
1954
1951
|
#
|
|
1955
|
-
# * `db-cluster-id` - Accepts
|
|
1956
|
-
#
|
|
1957
|
-
#
|
|
1952
|
+
# * `db-cluster-id` - Accepts cluster identifiers and cluster Amazon
|
|
1953
|
+
# Resource Names (ARNs). The results list only includes information
|
|
1954
|
+
# about the clusters identified by these ARNs.
|
|
1958
1955
|
#
|
|
1959
1956
|
# ^
|
|
1960
1957
|
#
|
|
@@ -2045,7 +2042,7 @@ module Aws::DocDB
|
|
|
2045
2042
|
req.send_request(options)
|
|
2046
2043
|
end
|
|
2047
2044
|
|
|
2048
|
-
# Returns a list of the available
|
|
2045
|
+
# Returns a list of the available engines.
|
|
2049
2046
|
#
|
|
2050
2047
|
# @option params [String] :engine
|
|
2051
2048
|
# The database engine to return.
|
|
@@ -2056,8 +2053,7 @@ module Aws::DocDB
|
|
|
2056
2053
|
# Example: `5.1.49`
|
|
2057
2054
|
#
|
|
2058
2055
|
# @option params [String] :db_parameter_group_family
|
|
2059
|
-
# The name of a specific
|
|
2060
|
-
# for.
|
|
2056
|
+
# The name of a specific parameter group family to return details for.
|
|
2061
2057
|
#
|
|
2062
2058
|
# Constraints:
|
|
2063
2059
|
#
|
|
@@ -2154,7 +2150,7 @@ module Aws::DocDB
|
|
|
2154
2150
|
#
|
|
2155
2151
|
# @option params [String] :db_instance_identifier
|
|
2156
2152
|
# The user-provided instance identifier. If this parameter is specified,
|
|
2157
|
-
# information from only the specific
|
|
2153
|
+
# information from only the specific instance is returned. This
|
|
2158
2154
|
# parameter isn't case sensitive.
|
|
2159
2155
|
#
|
|
2160
2156
|
# Constraints:
|
|
@@ -2164,18 +2160,18 @@ module Aws::DocDB
|
|
|
2164
2160
|
# ^
|
|
2165
2161
|
#
|
|
2166
2162
|
# @option params [Array<Types::Filter>] :filters
|
|
2167
|
-
# A filter that specifies one or more
|
|
2163
|
+
# A filter that specifies one or more instances to describe.
|
|
2168
2164
|
#
|
|
2169
2165
|
# Supported filters:
|
|
2170
2166
|
#
|
|
2171
|
-
# * `db-cluster-id` - Accepts
|
|
2172
|
-
#
|
|
2173
|
-
# information about the
|
|
2167
|
+
# * `db-cluster-id` - Accepts cluster identifiers and cluster Amazon
|
|
2168
|
+
# Resource Names (ARNs). The results list includes only the
|
|
2169
|
+
# information about the instances that are associated with the
|
|
2174
2170
|
# clusters that are identified by these ARNs.
|
|
2175
2171
|
#
|
|
2176
|
-
# * `db-instance-id` - Accepts
|
|
2177
|
-
#
|
|
2178
|
-
#
|
|
2172
|
+
# * `db-instance-id` - Accepts instance identifiers and instance ARNs.
|
|
2173
|
+
# The results list includes only the information about the instances
|
|
2174
|
+
# that are identified by these ARNs.
|
|
2179
2175
|
#
|
|
2180
2176
|
# @option params [Integer] :max_records
|
|
2181
2177
|
# The maximum number of records to include in the response. If more
|
|
@@ -2289,7 +2285,7 @@ module Aws::DocDB
|
|
|
2289
2285
|
# descriptions of the specified `DBSubnetGroup`.
|
|
2290
2286
|
#
|
|
2291
2287
|
# @option params [String] :db_subnet_group_name
|
|
2292
|
-
# The name of the
|
|
2288
|
+
# The name of the subnet group to return details for.
|
|
2293
2289
|
#
|
|
2294
2290
|
# @option params [Array<Types::Filter>] :filters
|
|
2295
2291
|
# This parameter is not currently supported.
|
|
@@ -2355,7 +2351,7 @@ module Aws::DocDB
|
|
|
2355
2351
|
# cluster database engine.
|
|
2356
2352
|
#
|
|
2357
2353
|
# @option params [required, String] :db_parameter_group_family
|
|
2358
|
-
# The name of the
|
|
2354
|
+
# The name of the cluster parameter group family to return the engine
|
|
2359
2355
|
# parameter information for.
|
|
2360
2356
|
#
|
|
2361
2357
|
# @option params [Array<Types::Filter>] :filters
|
|
@@ -2463,11 +2459,11 @@ module Aws::DocDB
|
|
|
2463
2459
|
req.send_request(options)
|
|
2464
2460
|
end
|
|
2465
2461
|
|
|
2466
|
-
# Returns events related to
|
|
2467
|
-
#
|
|
2468
|
-
#
|
|
2469
|
-
#
|
|
2470
|
-
#
|
|
2462
|
+
# Returns events related to instances, security groups, snapshots, and
|
|
2463
|
+
# DB parameter groups for the past 14 days. You can obtain events
|
|
2464
|
+
# specific to a particular DB instance, security group, snapshot, or
|
|
2465
|
+
# parameter group by providing the name as a parameter. By default, the
|
|
2466
|
+
# events of the past hour are returned.
|
|
2471
2467
|
#
|
|
2472
2468
|
# @option params [String] :source_identifier
|
|
2473
2469
|
# The identifier of the event source for which events are returned. If
|
|
@@ -2580,20 +2576,18 @@ module Aws::DocDB
|
|
|
2580
2576
|
req.send_request(options)
|
|
2581
2577
|
end
|
|
2582
2578
|
|
|
2583
|
-
# Returns a list of orderable
|
|
2584
|
-
# engine.
|
|
2579
|
+
# Returns a list of orderable instance options for the specified engine.
|
|
2585
2580
|
#
|
|
2586
2581
|
# @option params [required, String] :engine
|
|
2587
|
-
# The name of the engine to retrieve
|
|
2582
|
+
# The name of the engine to retrieve instance options for.
|
|
2588
2583
|
#
|
|
2589
2584
|
# @option params [String] :engine_version
|
|
2590
2585
|
# The engine version filter value. Specify this parameter to show only
|
|
2591
2586
|
# the available offerings that match the specified engine version.
|
|
2592
2587
|
#
|
|
2593
2588
|
# @option params [String] :db_instance_class
|
|
2594
|
-
# The
|
|
2595
|
-
#
|
|
2596
|
-
# class.
|
|
2589
|
+
# The instance class filter value. Specify this parameter to show only
|
|
2590
|
+
# the available offerings that match the specified instance class.
|
|
2597
2591
|
#
|
|
2598
2592
|
# @option params [String] :license_model
|
|
2599
2593
|
# The license model filter value. Specify this parameter to show only
|
|
@@ -2665,7 +2659,7 @@ module Aws::DocDB
|
|
|
2665
2659
|
req.send_request(options)
|
|
2666
2660
|
end
|
|
2667
2661
|
|
|
2668
|
-
# Returns a list of resources (for example,
|
|
2662
|
+
# Returns a list of resources (for example, instances) that have at
|
|
2669
2663
|
# least one pending maintenance action.
|
|
2670
2664
|
#
|
|
2671
2665
|
# @option params [String] :resource_identifier
|
|
@@ -2677,13 +2671,13 @@ module Aws::DocDB
|
|
|
2677
2671
|
#
|
|
2678
2672
|
# Supported filters:
|
|
2679
2673
|
#
|
|
2680
|
-
# * `db-cluster-id` - Accepts
|
|
2681
|
-
#
|
|
2682
|
-
# maintenance actions for the
|
|
2674
|
+
# * `db-cluster-id` - Accepts cluster identifiers and cluster Amazon
|
|
2675
|
+
# Resource Names (ARNs). The results list includes only pending
|
|
2676
|
+
# maintenance actions for the clusters identified by these ARNs.
|
|
2683
2677
|
#
|
|
2684
|
-
# * `db-instance-id` - Accepts
|
|
2685
|
-
#
|
|
2686
|
-
#
|
|
2678
|
+
# * `db-instance-id` - Accepts instance identifiers and instance ARNs.
|
|
2679
|
+
# The results list includes only pending maintenance actions for the
|
|
2680
|
+
# DB instances identified by these ARNs.
|
|
2687
2681
|
#
|
|
2688
2682
|
# @option params [String] :marker
|
|
2689
2683
|
# An optional pagination token provided by a previous request. If this
|
|
@@ -2741,10 +2735,10 @@ module Aws::DocDB
|
|
|
2741
2735
|
req.send_request(options)
|
|
2742
2736
|
end
|
|
2743
2737
|
|
|
2744
|
-
# Forces a failover for a
|
|
2738
|
+
# Forces a failover for a cluster.
|
|
2745
2739
|
#
|
|
2746
|
-
# A failover for a
|
|
2747
|
-
# replicas (read-only instances) in the
|
|
2740
|
+
# A failover for a cluster promotes one of the Amazon DocumentDB
|
|
2741
|
+
# replicas (read-only instances) in the cluster to be the primary
|
|
2748
2742
|
# instance (the cluster writer).
|
|
2749
2743
|
#
|
|
2750
2744
|
# If the primary instance fails, Amazon DocumentDB automatically fails
|
|
@@ -2753,7 +2747,7 @@ module Aws::DocDB
|
|
|
2753
2747
|
# testing.
|
|
2754
2748
|
#
|
|
2755
2749
|
# @option params [String] :db_cluster_identifier
|
|
2756
|
-
# A
|
|
2750
|
+
# A cluster identifier to force a failover for. This parameter is not
|
|
2757
2751
|
# case sensitive.
|
|
2758
2752
|
#
|
|
2759
2753
|
# Constraints:
|
|
@@ -2766,7 +2760,7 @@ module Aws::DocDB
|
|
|
2766
2760
|
# The name of the instance to promote to the primary instance.
|
|
2767
2761
|
#
|
|
2768
2762
|
# You must specify the instance identifier for an Amazon DocumentDB
|
|
2769
|
-
# replica in the
|
|
2763
|
+
# replica in the cluster. For example, `mydbcluster-replica1`.
|
|
2770
2764
|
#
|
|
2771
2765
|
# @return [Types::FailoverDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2772
2766
|
#
|
|
@@ -2870,12 +2864,12 @@ module Aws::DocDB
|
|
|
2870
2864
|
req.send_request(options)
|
|
2871
2865
|
end
|
|
2872
2866
|
|
|
2873
|
-
# Modifies a setting for an Amazon DocumentDB
|
|
2867
|
+
# Modifies a setting for an Amazon DocumentDB cluster. You can change
|
|
2874
2868
|
# one or more database configuration parameters by specifying these
|
|
2875
2869
|
# parameters and the new values in the request.
|
|
2876
2870
|
#
|
|
2877
2871
|
# @option params [required, String] :db_cluster_identifier
|
|
2878
|
-
# The
|
|
2872
|
+
# The cluster identifier for the cluster that is being modified. This
|
|
2879
2873
|
# parameter is not case sensitive.
|
|
2880
2874
|
#
|
|
2881
2875
|
# Constraints:
|
|
@@ -2885,8 +2879,8 @@ module Aws::DocDB
|
|
|
2885
2879
|
# ^
|
|
2886
2880
|
#
|
|
2887
2881
|
# @option params [String] :new_db_cluster_identifier
|
|
2888
|
-
# The new
|
|
2889
|
-
#
|
|
2882
|
+
# The new cluster identifier for the cluster when renaming a cluster.
|
|
2883
|
+
# This value is stored as a lowercase string.
|
|
2890
2884
|
#
|
|
2891
2885
|
# Constraints:
|
|
2892
2886
|
#
|
|
@@ -2901,9 +2895,9 @@ module Aws::DocDB
|
|
|
2901
2895
|
# @option params [Boolean] :apply_immediately
|
|
2902
2896
|
# A value that specifies whether the changes in this request and any
|
|
2903
2897
|
# pending changes are asynchronously applied as soon as possible,
|
|
2904
|
-
# regardless of the `PreferredMaintenanceWindow` setting for the
|
|
2905
|
-
# cluster. If this parameter is set to `false`, changes to the
|
|
2906
|
-
#
|
|
2898
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the
|
|
2899
|
+
# cluster. If this parameter is set to `false`, changes to the cluster
|
|
2900
|
+
# are applied during the next maintenance window.
|
|
2907
2901
|
#
|
|
2908
2902
|
# The `ApplyImmediately` parameter affects only the
|
|
2909
2903
|
# `NewDBClusterIdentifier` and `MasterUserPassword` values. If you set
|
|
@@ -2928,18 +2922,18 @@ module Aws::DocDB
|
|
|
2928
2922
|
# ^
|
|
2929
2923
|
#
|
|
2930
2924
|
# @option params [String] :db_cluster_parameter_group_name
|
|
2931
|
-
# The name of the
|
|
2925
|
+
# The name of the cluster parameter group to use for the cluster.
|
|
2932
2926
|
#
|
|
2933
2927
|
# @option params [Array<String>] :vpc_security_group_ids
|
|
2934
|
-
# A list of virtual private cloud (VPC) security groups that the
|
|
2935
|
-
#
|
|
2928
|
+
# A list of virtual private cloud (VPC) security groups that the cluster
|
|
2929
|
+
# will belong to.
|
|
2936
2930
|
#
|
|
2937
2931
|
# @option params [Integer] :port
|
|
2938
|
-
# The port number on which the
|
|
2932
|
+
# The port number on which the cluster accepts connections.
|
|
2939
2933
|
#
|
|
2940
2934
|
# Constraints: Must be a value from `1150` to `65535`.
|
|
2941
2935
|
#
|
|
2942
|
-
# Default: The same port as the original
|
|
2936
|
+
# Default: The same port as the original cluster.
|
|
2943
2937
|
#
|
|
2944
2938
|
# @option params [String] :master_user_password
|
|
2945
2939
|
# The password for the master database user. This password can contain
|
|
@@ -2982,9 +2976,9 @@ module Aws::DocDB
|
|
|
2982
2976
|
#
|
|
2983
2977
|
# @option params [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
|
2984
2978
|
# The configuration setting for the log types to be enabled for export
|
|
2985
|
-
# to Amazon CloudWatch Logs for a specific
|
|
2986
|
-
#
|
|
2987
|
-
#
|
|
2979
|
+
# to Amazon CloudWatch Logs for a specific instance or cluster. The
|
|
2980
|
+
# `EnableLogTypes` and `DisableLogTypes` arrays determine which logs are
|
|
2981
|
+
# exported (or not exported) to CloudWatch Logs.
|
|
2988
2982
|
#
|
|
2989
2983
|
# @option params [String] :engine_version
|
|
2990
2984
|
# The version number of the database engine to which you want to
|
|
@@ -3074,10 +3068,10 @@ module Aws::DocDB
|
|
|
3074
3068
|
req.send_request(options)
|
|
3075
3069
|
end
|
|
3076
3070
|
|
|
3077
|
-
# Modifies the parameters of a
|
|
3078
|
-
#
|
|
3079
|
-
# `
|
|
3080
|
-
#
|
|
3071
|
+
# Modifies the parameters of a cluster parameter group. To modify more
|
|
3072
|
+
# than one parameter, submit a list of the following: `ParameterName`,
|
|
3073
|
+
# `ParameterValue`, and `ApplyMethod`. A maximum of 20 parameters can be
|
|
3074
|
+
# modified in a single request.
|
|
3081
3075
|
#
|
|
3082
3076
|
# <note markdown="1"> Changes to dynamic parameters are applied immediately. Changes to
|
|
3083
3077
|
# static parameters require a reboot or maintenance window before the
|
|
@@ -3085,21 +3079,20 @@ module Aws::DocDB
|
|
|
3085
3079
|
#
|
|
3086
3080
|
# </note>
|
|
3087
3081
|
#
|
|
3088
|
-
# After you create a
|
|
3089
|
-
#
|
|
3090
|
-
#
|
|
3091
|
-
#
|
|
3092
|
-
#
|
|
3093
|
-
#
|
|
3094
|
-
# the default database for a
|
|
3095
|
-
#
|
|
3096
|
-
# parameter.
|
|
3082
|
+
# After you create a cluster parameter group, you should wait at least 5
|
|
3083
|
+
# minutes before creating your first cluster that uses that cluster
|
|
3084
|
+
# parameter group as the default parameter group. This allows Amazon
|
|
3085
|
+
# DocumentDB to fully complete the create action before the parameter
|
|
3086
|
+
# group is used as the default for a new cluster. This step is
|
|
3087
|
+
# especially important for parameters that are critical when creating
|
|
3088
|
+
# the default database for a cluster, such as the character set for the
|
|
3089
|
+
# default database defined by the `character_set_database` parameter.
|
|
3097
3090
|
#
|
|
3098
3091
|
# @option params [required, String] :db_cluster_parameter_group_name
|
|
3099
|
-
# The name of the
|
|
3092
|
+
# The name of the cluster parameter group to modify.
|
|
3100
3093
|
#
|
|
3101
3094
|
# @option params [required, Array<Types::Parameter>] :parameters
|
|
3102
|
-
# A list of parameters in the
|
|
3095
|
+
# A list of parameters in the cluster parameter group to modify.
|
|
3103
3096
|
#
|
|
3104
3097
|
# @return [Types::DBClusterParameterGroupNameMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3105
3098
|
#
|
|
@@ -3141,49 +3134,48 @@ module Aws::DocDB
|
|
|
3141
3134
|
# Adds an attribute and values to, or removes an attribute and values
|
|
3142
3135
|
# from, a manual DB cluster snapshot.
|
|
3143
3136
|
#
|
|
3144
|
-
# To share a manual
|
|
3137
|
+
# To share a manual cluster snapshot with other AWS accounts, specify
|
|
3145
3138
|
# `restore` as the `AttributeName`, and use the `ValuesToAdd` parameter
|
|
3146
3139
|
# to add a list of IDs of the AWS accounts that are authorized to
|
|
3147
|
-
# restore the manual
|
|
3148
|
-
#
|
|
3149
|
-
#
|
|
3150
|
-
#
|
|
3151
|
-
#
|
|
3140
|
+
# restore the manual cluster snapshot. Use the value `all` to make the
|
|
3141
|
+
# manual cluster snapshot public, which means that it can be copied or
|
|
3142
|
+
# restored by all AWS accounts. Do not add the `all` value for any
|
|
3143
|
+
# manual DB cluster snapshots that contain private information that you
|
|
3144
|
+
# don't want available to all AWS accounts. If a manual cluster
|
|
3152
3145
|
# snapshot is encrypted, it can be shared, but only by specifying a list
|
|
3153
3146
|
# of authorized AWS account IDs for the `ValuesToAdd` parameter. You
|
|
3154
3147
|
# can't use `all` as a value for that parameter in this case.
|
|
3155
3148
|
#
|
|
3156
3149
|
# @option params [required, String] :db_cluster_snapshot_identifier
|
|
3157
|
-
# The identifier for the
|
|
3158
|
-
# for.
|
|
3150
|
+
# The identifier for the cluster snapshot to modify the attributes for.
|
|
3159
3151
|
#
|
|
3160
3152
|
# @option params [required, String] :attribute_name
|
|
3161
|
-
# The name of the
|
|
3153
|
+
# The name of the cluster snapshot attribute to modify.
|
|
3162
3154
|
#
|
|
3163
3155
|
# To manage authorization for other AWS accounts to copy or restore a
|
|
3164
|
-
# manual
|
|
3156
|
+
# manual cluster snapshot, set this value to `restore`.
|
|
3165
3157
|
#
|
|
3166
3158
|
# @option params [Array<String>] :values_to_add
|
|
3167
|
-
# A list of
|
|
3159
|
+
# A list of cluster snapshot attributes to add to the attribute
|
|
3168
3160
|
# specified by `AttributeName`.
|
|
3169
3161
|
#
|
|
3170
|
-
# To authorize other AWS accounts to copy or restore a manual
|
|
3162
|
+
# To authorize other AWS accounts to copy or restore a manual cluster
|
|
3171
3163
|
# snapshot, set this list to include one or more AWS account IDs. To
|
|
3172
|
-
# make the manual
|
|
3173
|
-
#
|
|
3174
|
-
#
|
|
3175
|
-
#
|
|
3164
|
+
# make the manual cluster snapshot restorable by any AWS account, set it
|
|
3165
|
+
# to `all`. Do not add the `all` value for any manual cluster snapshots
|
|
3166
|
+
# that contain private information that you don't want to be available
|
|
3167
|
+
# to all AWS accounts.
|
|
3176
3168
|
#
|
|
3177
3169
|
# @option params [Array<String>] :values_to_remove
|
|
3178
|
-
# A list of
|
|
3170
|
+
# A list of cluster snapshot attributes to remove from the attribute
|
|
3179
3171
|
# specified by `AttributeName`.
|
|
3180
3172
|
#
|
|
3181
3173
|
# To remove authorization for other AWS accounts to copy or restore a
|
|
3182
|
-
# manual
|
|
3174
|
+
# manual cluster snapshot, set this list to include one or more AWS
|
|
3183
3175
|
# account identifiers. To remove authorization for any AWS account to
|
|
3184
|
-
# copy or restore the
|
|
3185
|
-
#
|
|
3186
|
-
#
|
|
3176
|
+
# copy or restore the cluster snapshot, set it to `all` . If you specify
|
|
3177
|
+
# `all`, an AWS account whose account ID is explicitly added to the
|
|
3178
|
+
# `restore` attribute can still copy or restore a manual cluster
|
|
3187
3179
|
# snapshot.
|
|
3188
3180
|
#
|
|
3189
3181
|
# @return [Types::ModifyDBClusterSnapshotAttributeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -3216,13 +3208,12 @@ module Aws::DocDB
|
|
|
3216
3208
|
req.send_request(options)
|
|
3217
3209
|
end
|
|
3218
3210
|
|
|
3219
|
-
# Modifies settings for
|
|
3220
|
-
#
|
|
3221
|
-
#
|
|
3211
|
+
# Modifies settings for an instance. You can change one or more database
|
|
3212
|
+
# configuration parameters by specifying these parameters and the new
|
|
3213
|
+
# values in the request.
|
|
3222
3214
|
#
|
|
3223
3215
|
# @option params [required, String] :db_instance_identifier
|
|
3224
|
-
# The
|
|
3225
|
-
# string.
|
|
3216
|
+
# The instance identifier. This value is stored as a lowercase string.
|
|
3226
3217
|
#
|
|
3227
3218
|
# Constraints:
|
|
3228
3219
|
#
|
|
@@ -3231,23 +3222,23 @@ module Aws::DocDB
|
|
|
3231
3222
|
# ^
|
|
3232
3223
|
#
|
|
3233
3224
|
# @option params [String] :db_instance_class
|
|
3234
|
-
# The new compute and memory capacity of the
|
|
3235
|
-
# `db.r5.large`. Not all
|
|
3225
|
+
# The new compute and memory capacity of the instance; for example,
|
|
3226
|
+
# `db.r5.large`. Not all instance classes are available in all AWS
|
|
3236
3227
|
# Regions.
|
|
3237
3228
|
#
|
|
3238
|
-
# If you modify the
|
|
3239
|
-
#
|
|
3240
|
-
#
|
|
3229
|
+
# If you modify the instance class, an outage occurs during the change.
|
|
3230
|
+
# The change is applied during the next maintenance window, unless
|
|
3231
|
+
# `ApplyImmediately` is specified as `true` for this request.
|
|
3241
3232
|
#
|
|
3242
3233
|
# Default: Uses existing setting.
|
|
3243
3234
|
#
|
|
3244
3235
|
# @option params [Boolean] :apply_immediately
|
|
3245
3236
|
# Specifies whether the modifications in this request and any pending
|
|
3246
3237
|
# modifications are asynchronously applied as soon as possible,
|
|
3247
|
-
# regardless of the `PreferredMaintenanceWindow` setting for the
|
|
3238
|
+
# regardless of the `PreferredMaintenanceWindow` setting for the
|
|
3248
3239
|
# instance.
|
|
3249
3240
|
#
|
|
3250
|
-
# If this parameter is set to `false`, changes to the
|
|
3241
|
+
# If this parameter is set to `false`, changes to the instance are
|
|
3251
3242
|
# applied during the next maintenance window. Some parameter changes can
|
|
3252
3243
|
# cause an outage and are applied on the next reboot.
|
|
3253
3244
|
#
|
|
@@ -3260,9 +3251,9 @@ module Aws::DocDB
|
|
|
3260
3251
|
# the change is asynchronously applied as soon as possible. If there are
|
|
3261
3252
|
# pending actions that cause a reboot, and the maintenance window is
|
|
3262
3253
|
# changed to include the current time, changing this parameter causes a
|
|
3263
|
-
# reboot of the
|
|
3264
|
-
#
|
|
3265
|
-
#
|
|
3254
|
+
# reboot of the instance. If you are moving this window to the current
|
|
3255
|
+
# time, there must be at least 30 minutes between the current time and
|
|
3256
|
+
# end of the window to ensure that pending changes are applied.
|
|
3266
3257
|
#
|
|
3267
3258
|
# Default: Uses existing setting.
|
|
3268
3259
|
#
|
|
@@ -3274,7 +3265,7 @@ module Aws::DocDB
|
|
|
3274
3265
|
#
|
|
3275
3266
|
# @option params [Boolean] :auto_minor_version_upgrade
|
|
3276
3267
|
# Indicates that minor version upgrades are applied automatically to the
|
|
3277
|
-
#
|
|
3268
|
+
# instance during the maintenance window. Changing this parameter
|
|
3278
3269
|
# doesn't result in an outage except in the following case, and the
|
|
3279
3270
|
# change is asynchronously applied as soon as possible. An outage
|
|
3280
3271
|
# results if this parameter is set to `true` during the maintenance
|
|
@@ -3282,11 +3273,11 @@ module Aws::DocDB
|
|
|
3282
3273
|
# has enabled automatic patching for that engine version.
|
|
3283
3274
|
#
|
|
3284
3275
|
# @option params [String] :new_db_instance_identifier
|
|
3285
|
-
# The new
|
|
3286
|
-
# instance. When you change the
|
|
3287
|
-
#
|
|
3288
|
-
#
|
|
3289
|
-
#
|
|
3276
|
+
# The new instance identifier for the instance when renaming an
|
|
3277
|
+
# instance. When you change the instance identifier, an instance reboot
|
|
3278
|
+
# occurs immediately if you set `Apply Immediately` to `true`. It occurs
|
|
3279
|
+
# during the next maintenance window if you set `Apply Immediately` to
|
|
3280
|
+
# `false`. This value is stored as a lowercase string.
|
|
3290
3281
|
#
|
|
3291
3282
|
# Constraints:
|
|
3292
3283
|
#
|
|
@@ -3399,11 +3390,11 @@ module Aws::DocDB
|
|
|
3399
3390
|
req.send_request(options)
|
|
3400
3391
|
end
|
|
3401
3392
|
|
|
3402
|
-
# Modifies an existing
|
|
3403
|
-
#
|
|
3393
|
+
# Modifies an existing subnet group. subnet groups must contain at least
|
|
3394
|
+
# one subnet in at least two Availability Zones in the AWS Region.
|
|
3404
3395
|
#
|
|
3405
3396
|
# @option params [required, String] :db_subnet_group_name
|
|
3406
|
-
# The name for the
|
|
3397
|
+
# The name for the subnet group. This value is stored as a lowercase
|
|
3407
3398
|
# string. You can't modify the default subnet group.
|
|
3408
3399
|
#
|
|
3409
3400
|
# Constraints: Must match the name of an existing `DBSubnetGroup`. Must
|
|
@@ -3412,10 +3403,10 @@ module Aws::DocDB
|
|
|
3412
3403
|
# Example: `mySubnetgroup`
|
|
3413
3404
|
#
|
|
3414
3405
|
# @option params [String] :db_subnet_group_description
|
|
3415
|
-
# The description for the
|
|
3406
|
+
# The description for the subnet group.
|
|
3416
3407
|
#
|
|
3417
3408
|
# @option params [required, Array<String>] :subnet_ids
|
|
3418
|
-
# The Amazon EC2 subnet IDs for the
|
|
3409
|
+
# The Amazon EC2 subnet IDs for the subnet group.
|
|
3419
3410
|
#
|
|
3420
3411
|
# @return [Types::ModifyDBSubnetGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3421
3412
|
#
|
|
@@ -3450,17 +3441,17 @@ module Aws::DocDB
|
|
|
3450
3441
|
req.send_request(options)
|
|
3451
3442
|
end
|
|
3452
3443
|
|
|
3453
|
-
# You might need to reboot your
|
|
3444
|
+
# You might need to reboot your instance, usually for maintenance
|
|
3454
3445
|
# reasons. For example, if you make certain changes, or if you change
|
|
3455
|
-
# the
|
|
3456
|
-
#
|
|
3446
|
+
# the cluster parameter group that is associated with the instance, you
|
|
3447
|
+
# must reboot the instance for the changes to take effect.
|
|
3457
3448
|
#
|
|
3458
|
-
# Rebooting
|
|
3459
|
-
#
|
|
3460
|
-
#
|
|
3449
|
+
# Rebooting an instance restarts the database engine service. Rebooting
|
|
3450
|
+
# an instance results in a momentary outage, during which the instance
|
|
3451
|
+
# status is set to *rebooting*.
|
|
3461
3452
|
#
|
|
3462
3453
|
# @option params [required, String] :db_instance_identifier
|
|
3463
|
-
# The
|
|
3454
|
+
# The instance identifier. This parameter is stored as a lowercase
|
|
3464
3455
|
# string.
|
|
3465
3456
|
#
|
|
3466
3457
|
# Constraints:
|
|
@@ -3584,9 +3575,9 @@ module Aws::DocDB
|
|
|
3584
3575
|
req.send_request(options)
|
|
3585
3576
|
end
|
|
3586
3577
|
|
|
3587
|
-
# Modifies the parameters of a
|
|
3578
|
+
# Modifies the parameters of a cluster parameter group to the default
|
|
3588
3579
|
# value. To reset specific parameters, submit a list of the following:
|
|
3589
|
-
# `ParameterName` and `ApplyMethod`. To reset the entire
|
|
3580
|
+
# `ParameterName` and `ApplyMethod`. To reset the entire cluster
|
|
3590
3581
|
# parameter group, specify the `DBClusterParameterGroupName` and
|
|
3591
3582
|
# `ResetAllParameters` parameters.
|
|
3592
3583
|
#
|
|
@@ -3595,17 +3586,17 @@ module Aws::DocDB
|
|
|
3595
3586
|
# effect on the next DB instance reboot.
|
|
3596
3587
|
#
|
|
3597
3588
|
# @option params [required, String] :db_cluster_parameter_group_name
|
|
3598
|
-
# The name of the
|
|
3589
|
+
# The name of the cluster parameter group to reset.
|
|
3599
3590
|
#
|
|
3600
3591
|
# @option params [Boolean] :reset_all_parameters
|
|
3601
|
-
# A value that is set to `true` to reset all parameters in the
|
|
3602
|
-
#
|
|
3603
|
-
#
|
|
3604
|
-
#
|
|
3592
|
+
# A value that is set to `true` to reset all parameters in the cluster
|
|
3593
|
+
# parameter group to their default values, and `false` otherwise. You
|
|
3594
|
+
# can't use this parameter if there is a list of parameter names
|
|
3595
|
+
# specified for the `Parameters` parameter.
|
|
3605
3596
|
#
|
|
3606
3597
|
# @option params [Array<Types::Parameter>] :parameters
|
|
3607
|
-
# A list of parameter names in the
|
|
3608
|
-
#
|
|
3598
|
+
# A list of parameter names in the cluster parameter group to reset to
|
|
3599
|
+
# the default values. You can't use this parameter if the
|
|
3609
3600
|
# `ResetAllParameters` parameter is set to `true`.
|
|
3610
3601
|
#
|
|
3611
3602
|
# @return [Types::DBClusterParameterGroupNameMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
@@ -3646,24 +3637,24 @@ module Aws::DocDB
|
|
|
3646
3637
|
req.send_request(options)
|
|
3647
3638
|
end
|
|
3648
3639
|
|
|
3649
|
-
# Creates a new
|
|
3640
|
+
# Creates a new cluster from a snapshot or cluster snapshot.
|
|
3650
3641
|
#
|
|
3651
|
-
# If a
|
|
3652
|
-
#
|
|
3653
|
-
#
|
|
3642
|
+
# If a snapshot is specified, the target cluster is created from the
|
|
3643
|
+
# source DB snapshot with a default configuration and default security
|
|
3644
|
+
# group.
|
|
3654
3645
|
#
|
|
3655
|
-
# If a
|
|
3656
|
-
#
|
|
3657
|
-
#
|
|
3658
|
-
#
|
|
3646
|
+
# If a cluster snapshot is specified, the target cluster is created from
|
|
3647
|
+
# the source cluster restore point with the same configuration as the
|
|
3648
|
+
# original source DB cluster, except that the new cluster is created
|
|
3649
|
+
# with the default security group.
|
|
3659
3650
|
#
|
|
3660
3651
|
# @option params [Array<String>] :availability_zones
|
|
3661
3652
|
# Provides the list of Amazon EC2 Availability Zones that instances in
|
|
3662
3653
|
# the restored DB cluster can be created in.
|
|
3663
3654
|
#
|
|
3664
3655
|
# @option params [required, String] :db_cluster_identifier
|
|
3665
|
-
# The name of the
|
|
3666
|
-
#
|
|
3656
|
+
# The name of the cluster to create from the snapshot or cluster
|
|
3657
|
+
# snapshot. This parameter isn't case sensitive.
|
|
3667
3658
|
#
|
|
3668
3659
|
# Constraints:
|
|
3669
3660
|
#
|
|
@@ -3676,12 +3667,11 @@ module Aws::DocDB
|
|
|
3676
3667
|
# Example: `my-snapshot-id`
|
|
3677
3668
|
#
|
|
3678
3669
|
# @option params [required, String] :snapshot_identifier
|
|
3679
|
-
# The identifier for the
|
|
3680
|
-
# from.
|
|
3670
|
+
# The identifier for the snapshot or cluster snapshot to restore from.
|
|
3681
3671
|
#
|
|
3682
3672
|
# You can use either the name or the Amazon Resource Name (ARN) to
|
|
3683
|
-
# specify a
|
|
3684
|
-
# specify a
|
|
3673
|
+
# specify a cluster snapshot. However, you can use only the ARN to
|
|
3674
|
+
# specify a snapshot.
|
|
3685
3675
|
#
|
|
3686
3676
|
# Constraints:
|
|
3687
3677
|
#
|
|
@@ -3690,24 +3680,24 @@ module Aws::DocDB
|
|
|
3690
3680
|
# ^
|
|
3691
3681
|
#
|
|
3692
3682
|
# @option params [required, String] :engine
|
|
3693
|
-
# The database engine to use for the new
|
|
3683
|
+
# The database engine to use for the new cluster.
|
|
3694
3684
|
#
|
|
3695
3685
|
# Default: The same as source.
|
|
3696
3686
|
#
|
|
3697
3687
|
# Constraint: Must be compatible with the engine of the source.
|
|
3698
3688
|
#
|
|
3699
3689
|
# @option params [String] :engine_version
|
|
3700
|
-
# The version of the database engine to use for the new
|
|
3690
|
+
# The version of the database engine to use for the new cluster.
|
|
3701
3691
|
#
|
|
3702
3692
|
# @option params [Integer] :port
|
|
3703
|
-
# The port number on which the new
|
|
3693
|
+
# The port number on which the new cluster accepts connections.
|
|
3704
3694
|
#
|
|
3705
3695
|
# Constraints: Must be a value from `1150` to `65535`.
|
|
3706
3696
|
#
|
|
3707
|
-
# Default: The same port as the original
|
|
3697
|
+
# Default: The same port as the original cluster.
|
|
3708
3698
|
#
|
|
3709
3699
|
# @option params [String] :db_subnet_group_name
|
|
3710
|
-
# The name of the
|
|
3700
|
+
# The name of the subnet group to use for the new cluster.
|
|
3711
3701
|
#
|
|
3712
3702
|
# Constraints: If provided, must match the name of an existing
|
|
3713
3703
|
# `DBSubnetGroup`.
|
|
@@ -3715,33 +3705,31 @@ module Aws::DocDB
|
|
|
3715
3705
|
# Example: `mySubnetgroup`
|
|
3716
3706
|
#
|
|
3717
3707
|
# @option params [Array<String>] :vpc_security_group_ids
|
|
3718
|
-
# A list of virtual private cloud (VPC) security groups that the new
|
|
3708
|
+
# A list of virtual private cloud (VPC) security groups that the new
|
|
3719
3709
|
# cluster will belong to.
|
|
3720
3710
|
#
|
|
3721
3711
|
# @option params [Array<Types::Tag>] :tags
|
|
3722
|
-
# The tags to be assigned to the restored
|
|
3712
|
+
# The tags to be assigned to the restored cluster.
|
|
3723
3713
|
#
|
|
3724
3714
|
# @option params [String] :kms_key_id
|
|
3725
|
-
# The AWS KMS key identifier to use when restoring an encrypted
|
|
3726
|
-
#
|
|
3715
|
+
# The AWS KMS key identifier to use when restoring an encrypted cluster
|
|
3716
|
+
# from a DB snapshot or cluster snapshot.
|
|
3727
3717
|
#
|
|
3728
3718
|
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
|
3729
|
-
# AWS KMS encryption key. If you are restoring a
|
|
3730
|
-
#
|
|
3731
|
-
#
|
|
3732
|
-
#
|
|
3719
|
+
# AWS KMS encryption key. If you are restoring a cluster with the same
|
|
3720
|
+
# AWS account that owns the AWS KMS encryption key used to encrypt the
|
|
3721
|
+
# new cluster, then you can use the AWS KMS key alias instead of the ARN
|
|
3722
|
+
# for the AWS KMS encryption key.
|
|
3733
3723
|
#
|
|
3734
3724
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
|
3735
3725
|
# following occurs:
|
|
3736
3726
|
#
|
|
3737
|
-
# * If the
|
|
3738
|
-
# encrypted, then the restored
|
|
3739
|
-
#
|
|
3740
|
-
# snapshot.
|
|
3727
|
+
# * If the snapshot or cluster snapshot in `SnapshotIdentifier` is
|
|
3728
|
+
# encrypted, then the restored cluster is encrypted using the AWS KMS
|
|
3729
|
+
# key that was used to encrypt the snapshot or the cluster snapshot.
|
|
3741
3730
|
#
|
|
3742
|
-
# * If the
|
|
3743
|
-
#
|
|
3744
|
-
# is not encrypted.
|
|
3731
|
+
# * If the snapshot or the cluster snapshot in `SnapshotIdentifier` is
|
|
3732
|
+
# not encrypted, then the restored DB cluster is not encrypted.
|
|
3745
3733
|
#
|
|
3746
3734
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
|
3747
3735
|
# A list of log types that must be enabled for exporting to Amazon
|
|
@@ -3830,15 +3818,15 @@ module Aws::DocDB
|
|
|
3830
3818
|
req.send_request(options)
|
|
3831
3819
|
end
|
|
3832
3820
|
|
|
3833
|
-
# Restores a
|
|
3834
|
-
#
|
|
3835
|
-
# `BackupRetentionPeriod` days. The target
|
|
3836
|
-
#
|
|
3837
|
-
#
|
|
3838
|
-
#
|
|
3821
|
+
# Restores a cluster to an arbitrary point in time. Users can restore to
|
|
3822
|
+
# any point in time before `LatestRestorableTime` for up to
|
|
3823
|
+
# `BackupRetentionPeriod` days. The target cluster is created from the
|
|
3824
|
+
# source cluster with the same configuration as the original cluster,
|
|
3825
|
+
# except that the new cluster is created with the default security
|
|
3826
|
+
# group.
|
|
3839
3827
|
#
|
|
3840
3828
|
# @option params [required, String] :db_cluster_identifier
|
|
3841
|
-
# The name of the new
|
|
3829
|
+
# The name of the new cluster to be created.
|
|
3842
3830
|
#
|
|
3843
3831
|
# Constraints:
|
|
3844
3832
|
#
|
|
@@ -3849,7 +3837,7 @@ module Aws::DocDB
|
|
|
3849
3837
|
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
|
3850
3838
|
#
|
|
3851
3839
|
# @option params [required, String] :source_db_cluster_identifier
|
|
3852
|
-
# The identifier of the source
|
|
3840
|
+
# The identifier of the source cluster from which to restore.
|
|
3853
3841
|
#
|
|
3854
3842
|
# Constraints:
|
|
3855
3843
|
#
|
|
@@ -3858,13 +3846,13 @@ module Aws::DocDB
|
|
|
3858
3846
|
# ^
|
|
3859
3847
|
#
|
|
3860
3848
|
# @option params [Time,DateTime,Date,Integer,String] :restore_to_time
|
|
3861
|
-
# The date and time to restore the
|
|
3849
|
+
# The date and time to restore the cluster to.
|
|
3862
3850
|
#
|
|
3863
3851
|
# Valid values: A time in Universal Coordinated Time (UTC) format.
|
|
3864
3852
|
#
|
|
3865
3853
|
# Constraints:
|
|
3866
3854
|
#
|
|
3867
|
-
# * Must be before the latest restorable time for the
|
|
3855
|
+
# * Must be before the latest restorable time for the instance.
|
|
3868
3856
|
#
|
|
3869
3857
|
# * Must be specified if the `UseLatestRestorableTime` parameter is not
|
|
3870
3858
|
# provided.
|
|
@@ -3878,7 +3866,7 @@ module Aws::DocDB
|
|
|
3878
3866
|
# Example: `2015-03-07T23:45:00Z`
|
|
3879
3867
|
#
|
|
3880
3868
|
# @option params [Boolean] :use_latest_restorable_time
|
|
3881
|
-
# A value that is set to `true` to restore the
|
|
3869
|
+
# A value that is set to `true` to restore the cluster to the latest
|
|
3882
3870
|
# restorable backup time, and `false` otherwise.
|
|
3883
3871
|
#
|
|
3884
3872
|
# Default: `false`
|
|
@@ -3887,14 +3875,14 @@ module Aws::DocDB
|
|
|
3887
3875
|
# provided.
|
|
3888
3876
|
#
|
|
3889
3877
|
# @option params [Integer] :port
|
|
3890
|
-
# The port number on which the new
|
|
3878
|
+
# The port number on which the new cluster accepts connections.
|
|
3891
3879
|
#
|
|
3892
3880
|
# Constraints: Must be a value from `1150` to `65535`.
|
|
3893
3881
|
#
|
|
3894
3882
|
# Default: The default port for the engine.
|
|
3895
3883
|
#
|
|
3896
3884
|
# @option params [String] :db_subnet_group_name
|
|
3897
|
-
# The
|
|
3885
|
+
# The subnet group name to use for the new cluster.
|
|
3898
3886
|
#
|
|
3899
3887
|
# Constraints: If provided, must match the name of an existing
|
|
3900
3888
|
# `DBSubnetGroup`.
|
|
@@ -3902,37 +3890,36 @@ module Aws::DocDB
|
|
|
3902
3890
|
# Example: `mySubnetgroup`
|
|
3903
3891
|
#
|
|
3904
3892
|
# @option params [Array<String>] :vpc_security_group_ids
|
|
3905
|
-
# A list of VPC security groups that the new
|
|
3893
|
+
# A list of VPC security groups that the new cluster belongs to.
|
|
3906
3894
|
#
|
|
3907
3895
|
# @option params [Array<Types::Tag>] :tags
|
|
3908
|
-
# The tags to be assigned to the restored
|
|
3896
|
+
# The tags to be assigned to the restored cluster.
|
|
3909
3897
|
#
|
|
3910
3898
|
# @option params [String] :kms_key_id
|
|
3911
|
-
# The AWS KMS key identifier to use when restoring an encrypted
|
|
3912
|
-
#
|
|
3899
|
+
# The AWS KMS key identifier to use when restoring an encrypted cluster
|
|
3900
|
+
# from an encrypted cluster.
|
|
3913
3901
|
#
|
|
3914
3902
|
# The AWS KMS key identifier is the Amazon Resource Name (ARN) for the
|
|
3915
|
-
# AWS KMS encryption key. If you are restoring a
|
|
3916
|
-
#
|
|
3917
|
-
#
|
|
3918
|
-
#
|
|
3903
|
+
# AWS KMS encryption key. If you are restoring a cluster with the same
|
|
3904
|
+
# AWS account that owns the AWS KMS encryption key used to encrypt the
|
|
3905
|
+
# new cluster, then you can use the AWS KMS key alias instead of the ARN
|
|
3906
|
+
# for the AWS KMS encryption key.
|
|
3919
3907
|
#
|
|
3920
|
-
# You can restore to a new
|
|
3921
|
-
#
|
|
3922
|
-
#
|
|
3923
|
-
#
|
|
3908
|
+
# You can restore to a new cluster and encrypt the new cluster with an
|
|
3909
|
+
# AWS KMS key that is different from the AWS KMS key used to encrypt the
|
|
3910
|
+
# source cluster. The new DB cluster is encrypted with the AWS KMS key
|
|
3911
|
+
# identified by the `KmsKeyId` parameter.
|
|
3924
3912
|
#
|
|
3925
3913
|
# If you do not specify a value for the `KmsKeyId` parameter, then the
|
|
3926
3914
|
# following occurs:
|
|
3927
3915
|
#
|
|
3928
|
-
# * If the
|
|
3929
|
-
#
|
|
3930
|
-
# DB cluster.
|
|
3916
|
+
# * If the cluster is encrypted, then the restored cluster is encrypted
|
|
3917
|
+
# using the AWS KMS key that was used to encrypt the source cluster.
|
|
3931
3918
|
#
|
|
3932
|
-
# * If the
|
|
3933
|
-
#
|
|
3919
|
+
# * If the cluster is not encrypted, then the restored cluster is not
|
|
3920
|
+
# encrypted.
|
|
3934
3921
|
#
|
|
3935
|
-
# If `DBClusterIdentifier` refers to a
|
|
3922
|
+
# If `DBClusterIdentifier` refers to a cluster that is not encrypted,
|
|
3936
3923
|
# then the restore request is rejected.
|
|
3937
3924
|
#
|
|
3938
3925
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
|
@@ -4180,7 +4167,7 @@ module Aws::DocDB
|
|
|
4180
4167
|
params: params,
|
|
4181
4168
|
config: config)
|
|
4182
4169
|
context[:gem_name] = 'aws-sdk-docdb'
|
|
4183
|
-
context[:gem_version] = '1.
|
|
4170
|
+
context[:gem_version] = '1.13.0'
|
|
4184
4171
|
Seahorse::Client::Request.new(handlers, context)
|
|
4185
4172
|
end
|
|
4186
4173
|
|