aws-sdk-docdbelastic 1.11.0 → 1.12.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.
Files changed (13) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/VERSION +1 -1
  4. data/lib/aws-sdk-docdbelastic/client.rb +388 -84
  5. data/lib/aws-sdk-docdbelastic/client_api.rb +95 -0
  6. data/lib/aws-sdk-docdbelastic/endpoint_provider.rb +1 -1
  7. data/lib/aws-sdk-docdbelastic/endpoints.rb +42 -0
  8. data/lib/aws-sdk-docdbelastic/plugins/endpoints.rb +6 -0
  9. data/lib/aws-sdk-docdbelastic/types.rb +396 -118
  10. data/lib/aws-sdk-docdbelastic.rb +2 -2
  11. data/sig/client.rbs +44 -1
  12. data/sig/types.rbs +59 -4
  13. metadata +2 -2
data/lib/aws-sdk-docdbelastic/client.rb CHANGED
@@ -388,11 +388,103 @@ module Aws::DocDBElastic
388
388
 
389
389
  # @!group API Operations
390
390
 
391
- # Creates a new Elastic DocumentDB cluster and returns its Cluster
392
- # structure.
391
+ # Copies a snapshot of an elastic cluster.
392
+ #
393
+ # @option params [Boolean] :copy_tags
394
+ # Set to `true` to copy all tags from the source cluster snapshot to the
395
+ # target elastic cluster snapshot. The default is `false`.
396
+ #
397
+ # @option params [String] :kms_key_id
398
+ # The Amazon Web Services KMS key ID for an encrypted elastic cluster
399
+ # snapshot. The Amazon Web Services KMS key ID is the Amazon Resource
400
+ # Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web
401
+ # Services KMS key alias for the Amazon Web Services KMS encryption key.
402
+ #
403
+ # If you copy an encrypted elastic cluster snapshot from your Amazon Web
404
+ # Services account, you can specify a value for `KmsKeyId` to encrypt
405
+ # the copy with a new Amazon Web ServicesS KMS encryption key. If you
406
+ # don't specify a value for `KmsKeyId`, then the copy of the elastic
407
+ # cluster snapshot is encrypted with the same `AWS` KMS key as the
408
+ # source elastic cluster snapshot.
409
+ #
410
+ # To copy an encrypted elastic cluster snapshot to another Amazon Web
411
+ # Services region, set `KmsKeyId` to the Amazon Web Services KMS key ID
412
+ # that you want to use to encrypt the copy of the elastic cluster
413
+ # snapshot in the destination region. Amazon Web Services KMS encryption
414
+ # keys are specific to the Amazon Web Services region that they are
415
+ # created in, and you can't use encryption keys from one Amazon Web
416
+ # Services region in another Amazon Web Services region.
417
+ #
418
+ # If you copy an unencrypted elastic cluster snapshot and specify a
419
+ # value for the `KmsKeyId` parameter, an error is returned.
420
+ #
421
+ # @option params [required, String] :snapshot_arn
422
+ # The Amazon Resource Name (ARN) identifier of the elastic cluster
423
+ # snapshot.
424
+ #
425
+ # @option params [Hash<String,String>] :tags
426
+ # The tags to be assigned to the elastic cluster snapshot.
427
+ #
428
+ # @option params [required, String] :target_snapshot_name
429
+ # The identifier of the new elastic cluster snapshot to create from the
430
+ # source cluster snapshot. This parameter is not case sensitive.
431
+ #
432
+ # Constraints:
433
+ #
434
+ # * Must contain from 1 to 63 letters, numbers, or hyphens.
435
+ #
436
+ # * The first character must be a letter.
437
+ #
438
+ # * Cannot end with a hyphen or contain two consecutive hyphens.
439
+ #
440
+ # Example: `elastic-cluster-snapshot-5`
441
+ #
442
+ # @return [Types::CopyClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
443
+ #
444
+ # * {Types::CopyClusterSnapshotOutput#snapshot #snapshot} => Types::ClusterSnapshot
445
+ #
446
+ # @example Request syntax with placeholder values
447
+ #
448
+ # resp = client.copy_cluster_snapshot({
449
+ # copy_tags: false,
450
+ # kms_key_id: "String",
451
+ # snapshot_arn: "String", # required
452
+ # tags: {
453
+ # "TagKey" => "TagValue",
454
+ # },
455
+ # target_snapshot_name: "CopyClusterSnapshotInputTargetSnapshotNameString", # required
456
+ # })
457
+ #
458
+ # @example Response structure
459
+ #
460
+ # resp.snapshot.admin_user_name #=> String
461
+ # resp.snapshot.cluster_arn #=> String
462
+ # resp.snapshot.cluster_creation_time #=> String
463
+ # resp.snapshot.kms_key_id #=> String
464
+ # resp.snapshot.snapshot_arn #=> String
465
+ # resp.snapshot.snapshot_creation_time #=> String
466
+ # resp.snapshot.snapshot_name #=> String
467
+ # resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
468
+ # resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
469
+ # resp.snapshot.subnet_ids #=> Array
470
+ # resp.snapshot.subnet_ids[0] #=> String
471
+ # resp.snapshot.vpc_security_group_ids #=> Array
472
+ # resp.snapshot.vpc_security_group_ids[0] #=> String
473
+ #
474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CopyClusterSnapshot AWS API Documentation
475
+ #
476
+ # @overload copy_cluster_snapshot(params = {})
477
+ # @param [Hash] params ({})
478
+ def copy_cluster_snapshot(params = {}, options = {})
479
+ req = build_request(:copy_cluster_snapshot, params)
480
+ req.send_request(options)
481
+ end
482
+
483
+ # Creates a new Amazon DocumentDB elastic cluster and returns its
484
+ # cluster structure.
393
485
  #
394
486
  # @option params [required, String] :admin_user_name
395
- # The name of the Elastic DocumentDB cluster administrator.
487
+ # The name of the Amazon DocumentDB elastic clusters administrator.
396
488
  #
397
489
  # *Constraints*:
398
490
  #
@@ -403,8 +495,8 @@ module Aws::DocDBElastic
403
495
  # * Cannot be a reserved word.
404
496
  #
405
497
  # @option params [required, String] :admin_user_password
406
- # The password for the Elastic DocumentDB cluster administrator and can
407
- # contain any printable ASCII characters.
498
+ # The password for the Amazon DocumentDB elastic clusters administrator.
499
+ # The password can contain any printable ASCII characters.
408
500
  #
409
501
  # *Constraints*:
410
502
  #
@@ -414,17 +506,22 @@ module Aws::DocDBElastic
414
506
  # symbol (@).
415
507
  #
416
508
  # @option params [required, String] :auth_type
417
- # The authentication type for the Elastic DocumentDB cluster.
509
+ # The authentication type used to determine where to fetch the password
510
+ # used for accessing the elastic cluster. Valid types are `PLAIN_TEXT`
511
+ # or `SECRET_ARN`.
512
+ #
513
+ # @option params [Integer] :backup_retention_period
514
+ # The number of days for which automatic snapshots are retained.
418
515
  #
419
516
  # @option params [String] :client_token
420
- # The client token for the Elastic DocumentDB cluster.
517
+ # The client token for the elastic cluster.
421
518
  #
422
519
  # **A suitable default value is auto-generated.** You should normally
423
520
  # not need to pass this option.**
424
521
  #
425
522
  # @option params [required, String] :cluster_name
426
- # The name of the new Elastic DocumentDB cluster. This parameter is
427
- # stored as a lowercase string.
523
+ # The name of the new elastic cluster. This parameter is stored as a
524
+ # lowercase string.
428
525
  #
429
526
  # *Constraints*:
430
527
  #
@@ -437,18 +534,22 @@ module Aws::DocDBElastic
437
534
  # *Example*: `my-cluster`
438
535
  #
439
536
  # @option params [String] :kms_key_id
440
- # The KMS key identifier to use to encrypt the new Elastic DocumentDB
441
- # cluster.
537
+ # The KMS key identifier to use to encrypt the new elastic cluster.
442
538
  #
443
539
  # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
444
540
  # encryption key. If you are creating a cluster using the same Amazon
445
541
  # account that owns this KMS encryption key, you can use the KMS key
446
542
  # alias instead of the ARN as the KMS encryption key.
447
543
  #
448
- # If an encryption key is not specified, Elastic DocumentDB uses the
544
+ # If an encryption key is not specified, Amazon DocumentDB uses the
449
545
  # default encryption key that KMS creates for your account. Your account
450
546
  # has a different default encryption key for each Amazon Region.
451
547
  #
548
+ # @option params [String] :preferred_backup_window
549
+ # The daily time range during which automated backups are created if
550
+ # automated backups are enabled, as determined by the
551
+ # `backupRetentionPeriod`.
552
+ #
452
553
  # @option params [String] :preferred_maintenance_window
453
554
  # The weekly time range during which system maintenance can occur, in
454
555
  # Universal Coordinated Time (UTC).
@@ -464,20 +565,27 @@ module Aws::DocDBElastic
464
565
  # *Constraints*: Minimum 30-minute window.
465
566
  #
466
567
  # @option params [required, Integer] :shard_capacity
467
- # The capacity of each shard in the new Elastic DocumentDB cluster.
568
+ # The number of vCPUs assigned to each elastic cluster shard. Maximum is
569
+ # 64. Allowed values are 2, 4, 8, 16, 32, 64.
468
570
  #
469
571
  # @option params [required, Integer] :shard_count
470
- # The number of shards to create in the new Elastic DocumentDB cluster.
572
+ # The number of shards assigned to the elastic cluster. Maximum is 32.
573
+ #
574
+ # @option params [Integer] :shard_instance_count
575
+ # The number of replica instances applying to all shards in the elastic
576
+ # cluster. A `shardInstanceCount` value of 1 means there is one writer
577
+ # instance, and any additional instances are replicas that can be used
578
+ # for reads and to improve availability.
471
579
  #
472
580
  # @option params [Array<String>] :subnet_ids
473
- # The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
581
+ # The Amazon EC2 subnet IDs for the new elastic cluster.
474
582
  #
475
583
  # @option params [Hash<String,String>] :tags
476
- # The tags to be assigned to the new Elastic DocumentDB cluster.
584
+ # The tags to be assigned to the new elastic cluster.
477
585
  #
478
586
  # @option params [Array<String>] :vpc_security_group_ids
479
- # A list of EC2 VPC security groups to associate with the new Elastic
480
- # DocumentDB cluster.
587
+ # A list of EC2 VPC security groups to associate with the new elastic
588
+ # cluster.
481
589
  #
482
590
  # @return [Types::CreateClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
483
591
  #
@@ -489,12 +597,15 @@ module Aws::DocDBElastic
489
597
  # admin_user_name: "String", # required
490
598
  # admin_user_password: "Password", # required
491
599
  # auth_type: "PLAIN_TEXT", # required, accepts PLAIN_TEXT, SECRET_ARN
600
+ # backup_retention_period: 1,
492
601
  # client_token: "String",
493
602
  # cluster_name: "String", # required
494
603
  # kms_key_id: "String",
604
+ # preferred_backup_window: "String",
495
605
  # preferred_maintenance_window: "String",
496
606
  # shard_capacity: 1, # required
497
607
  # shard_count: 1, # required
608
+ # shard_instance_count: 1,
498
609
  # subnet_ids: ["String"],
499
610
  # tags: {
500
611
  # "TagKey" => "TagValue",
@@ -506,15 +617,22 @@ module Aws::DocDBElastic
506
617
  #
507
618
  # resp.cluster.admin_user_name #=> String
508
619
  # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
620
+ # resp.cluster.backup_retention_period #=> Integer
509
621
  # resp.cluster.cluster_arn #=> String
510
622
  # resp.cluster.cluster_endpoint #=> String
511
623
  # resp.cluster.cluster_name #=> String
512
624
  # resp.cluster.create_time #=> String
513
625
  # resp.cluster.kms_key_id #=> String
626
+ # resp.cluster.preferred_backup_window #=> String
514
627
  # resp.cluster.preferred_maintenance_window #=> String
515
628
  # resp.cluster.shard_capacity #=> Integer
516
629
  # resp.cluster.shard_count #=> Integer
517
- # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS"
630
+ # resp.cluster.shard_instance_count #=> Integer
631
+ # resp.cluster.shards #=> Array
632
+ # resp.cluster.shards[0].create_time #=> String
633
+ # resp.cluster.shards[0].shard_id #=> String
634
+ # resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
635
+ # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
518
636
  # resp.cluster.subnet_ids #=> Array
519
637
  # resp.cluster.subnet_ids[0] #=> String
520
638
  # resp.cluster.vpc_security_group_ids #=> Array
@@ -529,17 +647,17 @@ module Aws::DocDBElastic
529
647
  req.send_request(options)
530
648
  end
531
649
 
532
- # Creates a snapshot of a cluster.
650
+ # Creates a snapshot of an elastic cluster.
533
651
  #
534
652
  # @option params [required, String] :cluster_arn
535
- # The arn of the Elastic DocumentDB cluster that the snapshot will be
536
- # taken from.
653
+ # The ARN identifier of the elastic cluster of which you want to create
654
+ # a snapshot.
537
655
  #
538
656
  # @option params [required, String] :snapshot_name
539
- # The name of the Elastic DocumentDB snapshot.
657
+ # The name of the new elastic cluster snapshot.
540
658
  #
541
659
  # @option params [Hash<String,String>] :tags
542
- # The tags to be assigned to the new Elastic DocumentDB snapshot.
660
+ # The tags to be assigned to the new elastic cluster snapshot.
543
661
  #
544
662
  # @return [Types::CreateClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
545
663
  #
@@ -564,7 +682,8 @@ module Aws::DocDBElastic
564
682
  # resp.snapshot.snapshot_arn #=> String
565
683
  # resp.snapshot.snapshot_creation_time #=> String
566
684
  # resp.snapshot.snapshot_name #=> String
567
- # resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS"
685
+ # resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
686
+ # resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
568
687
  # resp.snapshot.subnet_ids #=> Array
569
688
  # resp.snapshot.subnet_ids[0] #=> String
570
689
  # resp.snapshot.vpc_security_group_ids #=> Array
@@ -579,10 +698,10 @@ module Aws::DocDBElastic
579
698
  req.send_request(options)
580
699
  end
581
700
 
582
- # Delete a Elastic DocumentDB cluster.
701
+ # Delete an elastic cluster.
583
702
  #
584
703
  # @option params [required, String] :cluster_arn
585
- # The arn of the Elastic DocumentDB cluster that is to be deleted.
704
+ # The ARN identifier of the elastic cluster that is to be deleted.
586
705
  #
587
706
  # @return [Types::DeleteClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
588
707
  #
@@ -598,15 +717,22 @@ module Aws::DocDBElastic
598
717
  #
599
718
  # resp.cluster.admin_user_name #=> String
600
719
  # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
720
+ # resp.cluster.backup_retention_period #=> Integer
601
721
  # resp.cluster.cluster_arn #=> String
602
722
  # resp.cluster.cluster_endpoint #=> String
603
723
  # resp.cluster.cluster_name #=> String
604
724
  # resp.cluster.create_time #=> String
605
725
  # resp.cluster.kms_key_id #=> String
726
+ # resp.cluster.preferred_backup_window #=> String
606
727
  # resp.cluster.preferred_maintenance_window #=> String
607
728
  # resp.cluster.shard_capacity #=> Integer
608
729
  # resp.cluster.shard_count #=> Integer
609
- # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS"
730
+ # resp.cluster.shard_instance_count #=> Integer
731
+ # resp.cluster.shards #=> Array
732
+ # resp.cluster.shards[0].create_time #=> String
733
+ # resp.cluster.shards[0].shard_id #=> String
734
+ # resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
735
+ # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
610
736
  # resp.cluster.subnet_ids #=> Array
611
737
  # resp.cluster.subnet_ids[0] #=> String
612
738
  # resp.cluster.vpc_security_group_ids #=> Array
@@ -621,10 +747,11 @@ module Aws::DocDBElastic
621
747
  req.send_request(options)
622
748
  end
623
749
 
624
- # Delete a Elastic DocumentDB snapshot.
750
+ # Delete an elastic cluster snapshot.
625
751
  #
626
752
  # @option params [required, String] :snapshot_arn
627
- # The arn of the Elastic DocumentDB snapshot that is to be deleted.
753
+ # The ARN identifier of the elastic cluster snapshot that is to be
754
+ # deleted.
628
755
  #
629
756
  # @return [Types::DeleteClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
630
757
  #
@@ -645,7 +772,8 @@ module Aws::DocDBElastic
645
772
  # resp.snapshot.snapshot_arn #=> String
646
773
  # resp.snapshot.snapshot_creation_time #=> String
647
774
  # resp.snapshot.snapshot_name #=> String
648
- # resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS"
775
+ # resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
776
+ # resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
649
777
  # resp.snapshot.subnet_ids #=> Array
650
778
  # resp.snapshot.subnet_ids[0] #=> String
651
779
  # resp.snapshot.vpc_security_group_ids #=> Array
@@ -660,10 +788,10 @@ module Aws::DocDBElastic
660
788
  req.send_request(options)
661
789
  end
662
790
 
663
- # Returns information about a specific Elastic DocumentDB cluster.
791
+ # Returns information about a specific elastic cluster.
664
792
  #
665
793
  # @option params [required, String] :cluster_arn
666
- # The arn of the Elastic DocumentDB cluster.
794
+ # The ARN identifier of the elastic cluster.
667
795
  #
668
796
  # @return [Types::GetClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
669
797
  #
@@ -679,15 +807,22 @@ module Aws::DocDBElastic
679
807
  #
680
808
  # resp.cluster.admin_user_name #=> String
681
809
  # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
810
+ # resp.cluster.backup_retention_period #=> Integer
682
811
  # resp.cluster.cluster_arn #=> String
683
812
  # resp.cluster.cluster_endpoint #=> String
684
813
  # resp.cluster.cluster_name #=> String
685
814
  # resp.cluster.create_time #=> String
686
815
  # resp.cluster.kms_key_id #=> String
816
+ # resp.cluster.preferred_backup_window #=> String
687
817
  # resp.cluster.preferred_maintenance_window #=> String
688
818
  # resp.cluster.shard_capacity #=> Integer
689
819
  # resp.cluster.shard_count #=> Integer
690
- # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS"
820
+ # resp.cluster.shard_instance_count #=> Integer
821
+ # resp.cluster.shards #=> Array
822
+ # resp.cluster.shards[0].create_time #=> String
823
+ # resp.cluster.shards[0].shard_id #=> String
824
+ # resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
825
+ # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
691
826
  # resp.cluster.subnet_ids #=> Array
692
827
  # resp.cluster.subnet_ids[0] #=> String
693
828
  # resp.cluster.vpc_security_group_ids #=> Array
@@ -702,10 +837,10 @@ module Aws::DocDBElastic
702
837
  req.send_request(options)
703
838
  end
704
839
 
705
- # Returns information about a specific Elastic DocumentDB snapshot
840
+ # Returns information about a specific elastic cluster snapshot
706
841
  #
707
842
  # @option params [required, String] :snapshot_arn
708
- # The arn of the Elastic DocumentDB snapshot.
843
+ # The ARN identifier of the elastic cluster snapshot.
709
844
  #
710
845
  # @return [Types::GetClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
711
846
  #
@@ -726,7 +861,8 @@ module Aws::DocDBElastic
726
861
  # resp.snapshot.snapshot_arn #=> String
727
862
  # resp.snapshot.snapshot_creation_time #=> String
728
863
  # resp.snapshot.snapshot_name #=> String
729
- # resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS"
864
+ # resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
865
+ # resp.snapshot.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
730
866
  # resp.snapshot.subnet_ids #=> Array
731
867
  # resp.snapshot.subnet_ids[0] #=> String
732
868
  # resp.snapshot.vpc_security_group_ids #=> Array
@@ -741,17 +877,32 @@ module Aws::DocDBElastic
741
877
  req.send_request(options)
742
878
  end
743
879
 
744
- # Returns information about Elastic DocumentDB snapshots for a specified
745
- # cluster.
880
+ # Returns information about snapshots for a specified elastic cluster.
746
881
  #
747
882
  # @option params [String] :cluster_arn
748
- # The arn of the Elastic DocumentDB cluster.
883
+ # The ARN identifier of the elastic cluster.
749
884
  #
750
885
  # @option params [Integer] :max_results
751
- # The maximum number of entries to recieve in the response.
886
+ # The maximum number of elastic cluster snapshot results to receive in
887
+ # the response.
752
888
  #
753
889
  # @option params [String] :next_token
754
- # The nextToken which is used the get the next page of data.
890
+ # A pagination token provided by a previous request. If this parameter
891
+ # is specified, the response includes only records beyond this token, up
892
+ # to the value specified by `max-results`.
893
+ #
894
+ # If there is no more data in the responce, the `nextToken` will not be
895
+ # returned.
896
+ #
897
+ # @option params [String] :snapshot_type
898
+ # The type of cluster snapshots to be returned. You can specify one of
899
+ # the following values:
900
+ #
901
+ # * `automated` - Return all cluster snapshots that Amazon DocumentDB
902
+ # has automatically created for your Amazon Web Services account.
903
+ #
904
+ # * `manual` - Return all cluster snapshots that you have manually
905
+ # created for your Amazon Web Services account.
755
906
  #
756
907
  # @return [Types::ListClusterSnapshotsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
757
908
  #
@@ -766,6 +917,7 @@ module Aws::DocDBElastic
766
917
  # cluster_arn: "String",
767
918
  # max_results: 1,
768
919
  # next_token: "PaginationToken",
920
+ # snapshot_type: "String",
769
921
  # })
770
922
  #
771
923
  # @example Response structure
@@ -776,7 +928,7 @@ module Aws::DocDBElastic
776
928
  # resp.snapshots[0].snapshot_arn #=> String
777
929
  # resp.snapshots[0].snapshot_creation_time #=> String
778
930
  # resp.snapshots[0].snapshot_name #=> String
779
- # resp.snapshots[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS"
931
+ # resp.snapshots[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
780
932
  #
781
933
  # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusterSnapshots AWS API Documentation
782
934
  #
@@ -787,13 +939,20 @@ module Aws::DocDBElastic
787
939
  req.send_request(options)
788
940
  end
789
941
 
790
- # Returns information about provisioned Elastic DocumentDB clusters.
942
+ # Returns information about provisioned Amazon DocumentDB elastic
943
+ # clusters.
791
944
  #
792
945
  # @option params [Integer] :max_results
793
- # The maximum number of entries to recieve in the response.
946
+ # The maximum number of elastic cluster snapshot results to receive in
947
+ # the response.
794
948
  #
795
949
  # @option params [String] :next_token
796
- # The nextToken which is used the get the next page of data.
950
+ # A pagination token provided by a previous request. If this parameter
951
+ # is specified, the response includes only records beyond this token, up
952
+ # to the value specified by `max-results`.
953
+ #
954
+ # If there is no more data in the responce, the `nextToken` will not be
955
+ # returned.
797
956
  #
798
957
  # @return [Types::ListClustersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
799
958
  #
@@ -814,7 +973,7 @@ module Aws::DocDBElastic
814
973
  # resp.clusters #=> Array
815
974
  # resp.clusters[0].cluster_arn #=> String
816
975
  # resp.clusters[0].cluster_name #=> String
817
- # resp.clusters[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS"
976
+ # resp.clusters[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
818
977
  # resp.next_token #=> String
819
978
  #
820
979
  # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusters AWS API Documentation
@@ -826,10 +985,10 @@ module Aws::DocDBElastic
826
985
  req.send_request(options)
827
986
  end
828
987
 
829
- # Lists all tags on a Elastic DocumentDB resource
988
+ # Lists all tags on a elastic cluster resource
830
989
  #
831
990
  # @option params [required, String] :resource_arn
832
- # The arn of the Elastic DocumentDB resource.
991
+ # The ARN identifier of the elastic cluster resource.
833
992
  #
834
993
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
835
994
  #
@@ -855,38 +1014,47 @@ module Aws::DocDBElastic
855
1014
  req.send_request(options)
856
1015
  end
857
1016
 
858
- # Restores a Elastic DocumentDB cluster from a snapshot.
1017
+ # Restores an elastic cluster from a snapshot.
859
1018
  #
860
1019
  # @option params [required, String] :cluster_name
861
- # The name of the Elastic DocumentDB cluster.
1020
+ # The name of the elastic cluster.
862
1021
  #
863
1022
  # @option params [String] :kms_key_id
864
- # The KMS key identifier to use to encrypt the new Elastic DocumentDB
865
- # cluster.
1023
+ # The KMS key identifier to use to encrypt the new Amazon DocumentDB
1024
+ # elastic clusters cluster.
866
1025
  #
867
1026
  # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
868
1027
  # encryption key. If you are creating a cluster using the same Amazon
869
1028
  # account that owns this KMS encryption key, you can use the KMS key
870
1029
  # alias instead of the ARN as the KMS encryption key.
871
1030
  #
872
- # If an encryption key is not specified here, Elastic DocumentDB uses
873
- # the default encryption key that KMS creates for your account. Your
874
- # account has a different default encryption key for each Amazon Region.
1031
+ # If an encryption key is not specified here, Amazon DocumentDB uses the
1032
+ # default encryption key that KMS creates for your account. Your account
1033
+ # has a different default encryption key for each Amazon Region.
1034
+ #
1035
+ # @option params [Integer] :shard_capacity
1036
+ # The capacity of each shard in the new restored elastic cluster.
1037
+ #
1038
+ # @option params [Integer] :shard_instance_count
1039
+ # The number of replica instances applying to all shards in the elastic
1040
+ # cluster. A `shardInstanceCount` value of 1 means there is one writer
1041
+ # instance, and any additional instances are replicas that can be used
1042
+ # for reads and to improve availability.
875
1043
  #
876
1044
  # @option params [required, String] :snapshot_arn
877
- # The arn of the Elastic DocumentDB snapshot.
1045
+ # The ARN identifier of the elastic cluster snapshot.
878
1046
  #
879
1047
  # @option params [Array<String>] :subnet_ids
880
- # The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
1048
+ # The Amazon EC2 subnet IDs for the elastic cluster.
881
1049
  #
882
1050
  # @option params [Hash<String,String>] :tags
883
- # A list of the tag names to be assigned to the restored DB cluster, in
884
- # the form of an array of key-value pairs in which the key is the tag
885
- # name and the value is the key value.
1051
+ # A list of the tag names to be assigned to the restored elastic
1052
+ # cluster, in the form of an array of key-value pairs in which the key
1053
+ # is the tag name and the value is the key value.
886
1054
  #
887
1055
  # @option params [Array<String>] :vpc_security_group_ids
888
- # A list of EC2 VPC security groups to associate with the Elastic
889
- # DocumentDB cluster.
1056
+ # A list of EC2 VPC security groups to associate with the elastic
1057
+ # cluster.
890
1058
  #
891
1059
  # @return [Types::RestoreClusterFromSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
892
1060
  #
@@ -897,6 +1065,8 @@ module Aws::DocDBElastic
897
1065
  # resp = client.restore_cluster_from_snapshot({
898
1066
  # cluster_name: "String", # required
899
1067
  # kms_key_id: "String",
1068
+ # shard_capacity: 1,
1069
+ # shard_instance_count: 1,
900
1070
  # snapshot_arn: "String", # required
901
1071
  # subnet_ids: ["String"],
902
1072
  # tags: {
@@ -909,15 +1079,22 @@ module Aws::DocDBElastic
909
1079
  #
910
1080
  # resp.cluster.admin_user_name #=> String
911
1081
  # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
1082
+ # resp.cluster.backup_retention_period #=> Integer
912
1083
  # resp.cluster.cluster_arn #=> String
913
1084
  # resp.cluster.cluster_endpoint #=> String
914
1085
  # resp.cluster.cluster_name #=> String
915
1086
  # resp.cluster.create_time #=> String
916
1087
  # resp.cluster.kms_key_id #=> String
1088
+ # resp.cluster.preferred_backup_window #=> String
917
1089
  # resp.cluster.preferred_maintenance_window #=> String
918
1090
  # resp.cluster.shard_capacity #=> Integer
919
1091
  # resp.cluster.shard_count #=> Integer
920
- # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS"
1092
+ # resp.cluster.shard_instance_count #=> Integer
1093
+ # resp.cluster.shards #=> Array
1094
+ # resp.cluster.shards[0].create_time #=> String
1095
+ # resp.cluster.shards[0].shard_id #=> String
1096
+ # resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
1097
+ # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
921
1098
  # resp.cluster.subnet_ids #=> Array
922
1099
  # resp.cluster.subnet_ids[0] #=> String
923
1100
  # resp.cluster.vpc_security_group_ids #=> Array
@@ -932,13 +1109,113 @@ module Aws::DocDBElastic
932
1109
  req.send_request(options)
933
1110
  end
934
1111
 
935
- # Adds metadata tags to a Elastic DocumentDB resource
1112
+ # Restarts the stopped elastic cluster that is specified by
1113
+ # `clusterARN`.
1114
+ #
1115
+ # @option params [required, String] :cluster_arn
1116
+ # The ARN identifier of the elastic cluster.
1117
+ #
1118
+ # @return [Types::StartClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1119
+ #
1120
+ # * {Types::StartClusterOutput#cluster #cluster} => Types::Cluster
1121
+ #
1122
+ # @example Request syntax with placeholder values
1123
+ #
1124
+ # resp = client.start_cluster({
1125
+ # cluster_arn: "String", # required
1126
+ # })
1127
+ #
1128
+ # @example Response structure
1129
+ #
1130
+ # resp.cluster.admin_user_name #=> String
1131
+ # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
1132
+ # resp.cluster.backup_retention_period #=> Integer
1133
+ # resp.cluster.cluster_arn #=> String
1134
+ # resp.cluster.cluster_endpoint #=> String
1135
+ # resp.cluster.cluster_name #=> String
1136
+ # resp.cluster.create_time #=> String
1137
+ # resp.cluster.kms_key_id #=> String
1138
+ # resp.cluster.preferred_backup_window #=> String
1139
+ # resp.cluster.preferred_maintenance_window #=> String
1140
+ # resp.cluster.shard_capacity #=> Integer
1141
+ # resp.cluster.shard_count #=> Integer
1142
+ # resp.cluster.shard_instance_count #=> Integer
1143
+ # resp.cluster.shards #=> Array
1144
+ # resp.cluster.shards[0].create_time #=> String
1145
+ # resp.cluster.shards[0].shard_id #=> String
1146
+ # resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
1147
+ # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
1148
+ # resp.cluster.subnet_ids #=> Array
1149
+ # resp.cluster.subnet_ids[0] #=> String
1150
+ # resp.cluster.vpc_security_group_ids #=> Array
1151
+ # resp.cluster.vpc_security_group_ids[0] #=> String
1152
+ #
1153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StartCluster AWS API Documentation
1154
+ #
1155
+ # @overload start_cluster(params = {})
1156
+ # @param [Hash] params ({})
1157
+ def start_cluster(params = {}, options = {})
1158
+ req = build_request(:start_cluster, params)
1159
+ req.send_request(options)
1160
+ end
1161
+
1162
+ # Stops the running elastic cluster that is specified by `clusterArn`.
1163
+ # The elastic cluster must be in the *available* state.
1164
+ #
1165
+ # @option params [required, String] :cluster_arn
1166
+ # The ARN identifier of the elastic cluster.
1167
+ #
1168
+ # @return [Types::StopClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1169
+ #
1170
+ # * {Types::StopClusterOutput#cluster #cluster} => Types::Cluster
1171
+ #
1172
+ # @example Request syntax with placeholder values
1173
+ #
1174
+ # resp = client.stop_cluster({
1175
+ # cluster_arn: "String", # required
1176
+ # })
1177
+ #
1178
+ # @example Response structure
1179
+ #
1180
+ # resp.cluster.admin_user_name #=> String
1181
+ # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
1182
+ # resp.cluster.backup_retention_period #=> Integer
1183
+ # resp.cluster.cluster_arn #=> String
1184
+ # resp.cluster.cluster_endpoint #=> String
1185
+ # resp.cluster.cluster_name #=> String
1186
+ # resp.cluster.create_time #=> String
1187
+ # resp.cluster.kms_key_id #=> String
1188
+ # resp.cluster.preferred_backup_window #=> String
1189
+ # resp.cluster.preferred_maintenance_window #=> String
1190
+ # resp.cluster.shard_capacity #=> Integer
1191
+ # resp.cluster.shard_count #=> Integer
1192
+ # resp.cluster.shard_instance_count #=> Integer
1193
+ # resp.cluster.shards #=> Array
1194
+ # resp.cluster.shards[0].create_time #=> String
1195
+ # resp.cluster.shards[0].shard_id #=> String
1196
+ # resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
1197
+ # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
1198
+ # resp.cluster.subnet_ids #=> Array
1199
+ # resp.cluster.subnet_ids[0] #=> String
1200
+ # resp.cluster.vpc_security_group_ids #=> Array
1201
+ # resp.cluster.vpc_security_group_ids[0] #=> String
1202
+ #
1203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StopCluster AWS API Documentation
1204
+ #
1205
+ # @overload stop_cluster(params = {})
1206
+ # @param [Hash] params ({})
1207
+ def stop_cluster(params = {}, options = {})
1208
+ req = build_request(:stop_cluster, params)
1209
+ req.send_request(options)
1210
+ end
1211
+
1212
+ # Adds metadata tags to an elastic cluster resource
936
1213
  #
937
1214
  # @option params [required, String] :resource_arn
938
- # The arn of the Elastic DocumentDB resource.
1215
+ # The ARN identifier of the elastic cluster resource.
939
1216
  #
940
1217
  # @option params [required, Hash<String,String>] :tags
941
- # The tags to be assigned to the Elastic DocumentDB resource.
1218
+ # The tags that are assigned to the elastic cluster resource.
942
1219
  #
943
1220
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
944
1221
  #
@@ -960,13 +1237,13 @@ module Aws::DocDBElastic
960
1237
  req.send_request(options)
961
1238
  end
962
1239
 
963
- # Removes metadata tags to a Elastic DocumentDB resource
1240
+ # Removes metadata tags from an elastic cluster resource
964
1241
  #
965
1242
  # @option params [required, String] :resource_arn
966
- # The arn of the Elastic DocumentDB resource.
1243
+ # The ARN identifier of the elastic cluster resource.
967
1244
  #
968
1245
  # @option params [required, Array<String>] :tag_keys
969
- # The tag keys to be removed from the Elastic DocumentDB resource.
1246
+ # The tag keys to be removed from the elastic cluster resource.
970
1247
  #
971
1248
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
972
1249
  #
@@ -986,28 +1263,38 @@ module Aws::DocDBElastic
986
1263
  req.send_request(options)
987
1264
  end
988
1265
 
989
- # Modifies a Elastic DocumentDB cluster. This includes updating
990
- # admin-username/password, upgrading API version setting up a backup
991
- # window and maintenance window
1266
+ # Modifies an elastic cluster. This includes updating
1267
+ # admin-username/password, upgrading the API version, and setting up a
1268
+ # backup window and maintenance window
992
1269
  #
993
1270
  # @option params [String] :admin_user_password
994
- # The password for the Elastic DocumentDB cluster administrator. This
1271
+ # The password associated with the elastic cluster administrator. This
995
1272
  # password can contain any printable ASCII character except forward
996
1273
  # slash (/), double quote ("), or the "at" symbol (@).
997
1274
  #
998
1275
  # *Constraints*: Must contain from 8 to 100 characters.
999
1276
  #
1000
1277
  # @option params [String] :auth_type
1001
- # The authentication type for the Elastic DocumentDB cluster.
1278
+ # The authentication type used to determine where to fetch the password
1279
+ # used for accessing the elastic cluster. Valid types are `PLAIN_TEXT`
1280
+ # or `SECRET_ARN`.
1281
+ #
1282
+ # @option params [Integer] :backup_retention_period
1283
+ # The number of days for which automatic snapshots are retained.
1002
1284
  #
1003
1285
  # @option params [String] :client_token
1004
- # The client token for the Elastic DocumentDB cluster.
1286
+ # The client token for the elastic cluster.
1005
1287
  #
1006
1288
  # **A suitable default value is auto-generated.** You should normally
1007
1289
  # not need to pass this option.**
1008
1290
  #
1009
1291
  # @option params [required, String] :cluster_arn
1010
- # The arn of the Elastic DocumentDB cluster.
1292
+ # The ARN identifier of the elastic cluster.
1293
+ #
1294
+ # @option params [String] :preferred_backup_window
1295
+ # The daily time range during which automated backups are created if
1296
+ # automated backups are enabled, as determined by the
1297
+ # `backupRetentionPeriod`.
1011
1298
  #
1012
1299
  # @option params [String] :preferred_maintenance_window
1013
1300
  # The weekly time range during which system maintenance can occur, in
@@ -1024,17 +1311,24 @@ module Aws::DocDBElastic
1024
1311
  # *Constraints*: Minimum 30-minute window.
1025
1312
  #
1026
1313
  # @option params [Integer] :shard_capacity
1027
- # The capacity of each shard in the Elastic DocumentDB cluster.
1314
+ # The number of vCPUs assigned to each elastic cluster shard. Maximum is
1315
+ # 64. Allowed values are 2, 4, 8, 16, 32, 64.
1028
1316
  #
1029
1317
  # @option params [Integer] :shard_count
1030
- # The number of shards to create in the Elastic DocumentDB cluster.
1318
+ # The number of shards assigned to the elastic cluster. Maximum is 32.
1319
+ #
1320
+ # @option params [Integer] :shard_instance_count
1321
+ # The number of replica instances applying to all shards in the elastic
1322
+ # cluster. A `shardInstanceCount` value of 1 means there is one writer
1323
+ # instance, and any additional instances are replicas that can be used
1324
+ # for reads and to improve availability.
1031
1325
  #
1032
1326
  # @option params [Array<String>] :subnet_ids
1033
- # The number of shards to create in the Elastic DocumentDB cluster.
1327
+ # The Amazon EC2 subnet IDs for the elastic cluster.
1034
1328
  #
1035
1329
  # @option params [Array<String>] :vpc_security_group_ids
1036
- # A list of EC2 VPC security groups to associate with the new Elastic
1037
- # DocumentDB cluster.
1330
+ # A list of EC2 VPC security groups to associate with the elastic
1331
+ # cluster.
1038
1332
  #
1039
1333
  # @return [Types::UpdateClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1040
1334
  #
@@ -1045,11 +1339,14 @@ module Aws::DocDBElastic
1045
1339
  # resp = client.update_cluster({
1046
1340
  # admin_user_password: "Password",
1047
1341
  # auth_type: "PLAIN_TEXT", # accepts PLAIN_TEXT, SECRET_ARN
1342
+ # backup_retention_period: 1,
1048
1343
  # client_token: "String",
1049
1344
  # cluster_arn: "String", # required
1345
+ # preferred_backup_window: "String",
1050
1346
  # preferred_maintenance_window: "String",
1051
1347
  # shard_capacity: 1,
1052
1348
  # shard_count: 1,
1349
+ # shard_instance_count: 1,
1053
1350
  # subnet_ids: ["String"],
1054
1351
  # vpc_security_group_ids: ["String"],
1055
1352
  # })
@@ -1058,15 +1355,22 @@ module Aws::DocDBElastic
1058
1355
  #
1059
1356
  # resp.cluster.admin_user_name #=> String
1060
1357
  # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
1358
+ # resp.cluster.backup_retention_period #=> Integer
1061
1359
  # resp.cluster.cluster_arn #=> String
1062
1360
  # resp.cluster.cluster_endpoint #=> String
1063
1361
  # resp.cluster.cluster_name #=> String
1064
1362
  # resp.cluster.create_time #=> String
1065
1363
  # resp.cluster.kms_key_id #=> String
1364
+ # resp.cluster.preferred_backup_window #=> String
1066
1365
  # resp.cluster.preferred_maintenance_window #=> String
1067
1366
  # resp.cluster.shard_capacity #=> Integer
1068
1367
  # resp.cluster.shard_count #=> Integer
1069
- # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS"
1368
+ # resp.cluster.shard_instance_count #=> Integer
1369
+ # resp.cluster.shards #=> Array
1370
+ # resp.cluster.shards[0].create_time #=> String
1371
+ # resp.cluster.shards[0].shard_id #=> String
1372
+ # resp.cluster.shards[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
1373
+ # resp.cluster.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "VPC_ENDPOINT_LIMIT_EXCEEDED", "IP_ADDRESS_LIMIT_EXCEEDED", "INVALID_SECURITY_GROUP_ID", "INVALID_SUBNET_ID", "INACCESSIBLE_ENCRYPTION_CREDS", "INACCESSIBLE_SECRET_ARN", "INACCESSIBLE_VPC_ENDPOINT", "INCOMPATIBLE_NETWORK", "MERGING", "MODIFYING", "SPLITTING", "COPYING", "STARTING", "STOPPING", "STOPPED"
1070
1374
  # resp.cluster.subnet_ids #=> Array
1071
1375
  # resp.cluster.subnet_ids[0] #=> String
1072
1376
  # resp.cluster.vpc_security_group_ids #=> Array
@@ -1094,7 +1398,7 @@ module Aws::DocDBElastic
1094
1398
  params: params,
1095
1399
  config: config)
1096
1400
  context[:gem_name] = 'aws-sdk-docdbelastic'
1097
- context[:gem_version] = '1.11.0'
1401
+ context[:gem_version] = '1.12.0'
1098
1402
  Seahorse::Client::Request.new(handlers, context)
1099
1403
  end
1100
1404