aws-sdk-docdbelastic 1.11.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
22
  require 'aws-sdk-core/plugins/response_paging.rb'
23
23
  require 'aws-sdk-core/plugins/stub_responses.rb'
24
24
  require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/invocation_id.rb'
25
26
  require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
27
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
28
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
@@ -72,6 +73,7 @@ module Aws::DocDBElastic
72
73
  add_plugin(Aws::Plugins::ResponsePaging)
73
74
  add_plugin(Aws::Plugins::StubResponses)
74
75
  add_plugin(Aws::Plugins::IdempotencyToken)
76
+ add_plugin(Aws::Plugins::InvocationId)
75
77
  add_plugin(Aws::Plugins::JsonvalueConverter)
76
78
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
77
79
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
@@ -196,10 +198,17 @@ module Aws::DocDBElastic
196
198
  # When set to 'true' the request body will not be compressed
197
199
  # for supported operations.
198
200
  #
199
- # @option options [String] :endpoint
200
- # The client endpoint is normally constructed from the `:region`
201
- # option. You should only configure an `:endpoint` when connecting
202
- # to test or custom endpoints. This should be a valid HTTP(S) URI.
201
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
202
+ # Normally you should not configure the `:endpoint` option
203
+ # directly. This is normally constructed from the `:region`
204
+ # option. Configuring `:endpoint` is normally reserved for
205
+ # connecting to test or custom endpoints. The endpoint should
206
+ # be a URI formatted like:
207
+ #
208
+ # 'http://example.com'
209
+ # 'https://example.com'
210
+ # 'http://example.com:123'
211
+ #
203
212
  #
204
213
  # @option options [Integer] :endpoint_cache_max_entries (1000)
205
214
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -337,62 +346,169 @@ module Aws::DocDBElastic
337
346
  # @option options [Aws::DocDBElastic::EndpointProvider] :endpoint_provider
338
347
  # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::DocDBElastic::EndpointParameters`
339
348
  #
340
- # @option options [URI::HTTP,String] :http_proxy A proxy to send
341
- # requests through. Formatted like 'http://proxy.com:123'.
349
+ # @option options [Float] :http_continue_timeout (1)
350
+ # The number of seconds to wait for a 100-continue response before sending the
351
+ # request body. This option has no effect unless the request has "Expect"
352
+ # header set to "100-continue". Defaults to `nil` which disables this
353
+ # behaviour. This value can safely be set per request on the session.
354
+ #
355
+ # @option options [Float] :http_idle_timeout (5)
356
+ # The number of seconds a connection is allowed to sit idle before it
357
+ # is considered stale. Stale connections are closed and removed from the
358
+ # pool before making a request.
359
+ #
360
+ # @option options [Float] :http_open_timeout (15)
361
+ # The default number of seconds to wait for response data.
362
+ # This value can safely be set per-request on the session.
363
+ #
364
+ # @option options [URI::HTTP,String] :http_proxy
365
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
366
+ #
367
+ # @option options [Float] :http_read_timeout (60)
368
+ # The default number of seconds to wait for response data.
369
+ # This value can safely be set per-request on the session.
370
+ #
371
+ # @option options [Boolean] :http_wire_trace (false)
372
+ # When `true`, HTTP debug output will be sent to the `:logger`.
373
+ #
374
+ # @option options [Proc] :on_chunk_received
375
+ # When a Proc object is provided, it will be used as callback when each chunk
376
+ # of the response body is received. It provides three arguments: the chunk,
377
+ # the number of bytes received, and the total number of
378
+ # bytes in the response (or nil if the server did not send a `content-length`).
379
+ #
380
+ # @option options [Proc] :on_chunk_sent
381
+ # When a Proc object is provided, it will be used as callback when each chunk
382
+ # of the request body is sent. It provides three arguments: the chunk,
383
+ # the number of bytes read from the body, and the total number of
384
+ # bytes in the body.
385
+ #
386
+ # @option options [Boolean] :raise_response_errors (true)
387
+ # When `true`, response errors are raised.
388
+ #
389
+ # @option options [String] :ssl_ca_bundle
390
+ # Full path to the SSL certificate authority bundle file that should be used when
391
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
392
+ # `:ssl_ca_directory` the the system default will be used if available.
393
+ #
394
+ # @option options [String] :ssl_ca_directory
395
+ # Full path of the directory that contains the unbundled SSL certificate
396
+ # authority files for verifying peer certificates. If you do
397
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
398
+ # default will be used if available.
342
399
  #
343
- # @option options [Float] :http_open_timeout (15) The number of
344
- # seconds to wait when opening a HTTP session before raising a
345
- # `Timeout::Error`.
400
+ # @option options [String] :ssl_ca_store
401
+ # Sets the X509::Store to verify peer certificate.
346
402
  #
347
- # @option options [Float] :http_read_timeout (60) The default
348
- # number of seconds to wait for response data. This value can
349
- # safely be set per-request on the session.
403
+ # @option options [Float] :ssl_timeout
404
+ # Sets the SSL timeout in seconds
350
405
  #
351
- # @option options [Float] :http_idle_timeout (5) The number of
352
- # seconds a connection is allowed to sit idle before it is
353
- # considered stale. Stale connections are closed and removed
354
- # from the pool before making a request.
406
+ # @option options [Boolean] :ssl_verify_peer (true)
407
+ # When `true`, SSL peer certificates are verified when establishing a connection.
408
+ #
409
+ def initialize(*args)
410
+ super
411
+ end
412
+
413
+ # @!group API Operations
414
+
415
+ # Copies a snapshot of an elastic cluster.
355
416
  #
356
- # @option options [Float] :http_continue_timeout (1) The number of
357
- # seconds to wait for a 100-continue response before sending the
358
- # request body. This option has no effect unless the request has
359
- # "Expect" header set to "100-continue". Defaults to `nil` which
360
- # disables this behaviour. This value can safely be set per
361
- # request on the session.
417
+ # @option params [Boolean] :copy_tags
418
+ # Set to `true` to copy all tags from the source cluster snapshot to the
419
+ # target elastic cluster snapshot. The default is `false`.
362
420
  #
363
- # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
364
- # in seconds.
421
+ # @option params [String] :kms_key_id
422
+ # The Amazon Web Services KMS key ID for an encrypted elastic cluster
423
+ # snapshot. The Amazon Web Services KMS key ID is the Amazon Resource
424
+ # Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web
425
+ # Services KMS key alias for the Amazon Web Services KMS encryption key.
426
+ #
427
+ # If you copy an encrypted elastic cluster snapshot from your Amazon Web
428
+ # Services account, you can specify a value for `KmsKeyId` to encrypt
429
+ # the copy with a new Amazon Web ServicesS KMS encryption key. If you
430
+ # don't specify a value for `KmsKeyId`, then the copy of the elastic
431
+ # cluster snapshot is encrypted with the same `AWS` KMS key as the
432
+ # source elastic cluster snapshot.
433
+ #
434
+ # To copy an encrypted elastic cluster snapshot to another Amazon Web
435
+ # Services region, set `KmsKeyId` to the Amazon Web Services KMS key ID
436
+ # that you want to use to encrypt the copy of the elastic cluster
437
+ # snapshot in the destination region. Amazon Web Services KMS encryption
438
+ # keys are specific to the Amazon Web Services region that they are
439
+ # created in, and you can't use encryption keys from one Amazon Web
440
+ # Services region in another Amazon Web Services region.
441
+ #
442
+ # If you copy an unencrypted elastic cluster snapshot and specify a
443
+ # value for the `KmsKeyId` parameter, an error is returned.
365
444
  #
366
- # @option options [Boolean] :http_wire_trace (false) When `true`,
367
- # HTTP debug output will be sent to the `:logger`.
445
+ # @option params [required, String] :snapshot_arn
446
+ # The Amazon Resource Name (ARN) identifier of the elastic cluster
447
+ # snapshot.
368
448
  #
369
- # @option options [Boolean] :ssl_verify_peer (true) When `true`,
370
- # SSL peer certificates are verified when establishing a
371
- # connection.
449
+ # @option params [Hash<String,String>] :tags
450
+ # The tags to be assigned to the elastic cluster snapshot.
372
451
  #
373
- # @option options [String] :ssl_ca_bundle Full path to the SSL
374
- # certificate authority bundle file that should be used when
375
- # verifying peer certificates. If you do not pass
376
- # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
377
- # will be used if available.
452
+ # @option params [required, String] :target_snapshot_name
453
+ # The identifier of the new elastic cluster snapshot to create from the
454
+ # source cluster snapshot. This parameter is not case sensitive.
378
455
  #
379
- # @option options [String] :ssl_ca_directory Full path of the
380
- # directory that contains the unbundled SSL certificate
381
- # authority files for verifying peer certificates. If you do
382
- # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
383
- # system default will be used if available.
456
+ # Constraints:
384
457
  #
385
- def initialize(*args)
386
- super
458
+ # * Must contain from 1 to 63 letters, numbers, or hyphens.
459
+ #
460
+ # * The first character must be a letter.
461
+ #
462
+ # * Cannot end with a hyphen or contain two consecutive hyphens.
463
+ #
464
+ # Example: `elastic-cluster-snapshot-5`
465
+ #
466
+ # @return [Types::CopyClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
467
+ #
468
+ # * {Types::CopyClusterSnapshotOutput#snapshot #snapshot} => Types::ClusterSnapshot
469
+ #
470
+ # @example Request syntax with placeholder values
471
+ #
472
+ # resp = client.copy_cluster_snapshot({
473
+ # copy_tags: false,
474
+ # kms_key_id: "String",
475
+ # snapshot_arn: "String", # required
476
+ # tags: {
477
+ # "TagKey" => "TagValue",
478
+ # },
479
+ # target_snapshot_name: "CopyClusterSnapshotInputTargetSnapshotNameString", # required
480
+ # })
481
+ #
482
+ # @example Response structure
483
+ #
484
+ # resp.snapshot.admin_user_name #=> String
485
+ # resp.snapshot.cluster_arn #=> String
486
+ # resp.snapshot.cluster_creation_time #=> String
487
+ # resp.snapshot.kms_key_id #=> String
488
+ # resp.snapshot.snapshot_arn #=> String
489
+ # resp.snapshot.snapshot_creation_time #=> String
490
+ # resp.snapshot.snapshot_name #=> String
491
+ # resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
492
+ # 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"
493
+ # resp.snapshot.subnet_ids #=> Array
494
+ # resp.snapshot.subnet_ids[0] #=> String
495
+ # resp.snapshot.vpc_security_group_ids #=> Array
496
+ # resp.snapshot.vpc_security_group_ids[0] #=> String
497
+ #
498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CopyClusterSnapshot AWS API Documentation
499
+ #
500
+ # @overload copy_cluster_snapshot(params = {})
501
+ # @param [Hash] params ({})
502
+ def copy_cluster_snapshot(params = {}, options = {})
503
+ req = build_request(:copy_cluster_snapshot, params)
504
+ req.send_request(options)
387
505
  end
388
506
 
389
- # @!group API Operations
390
-
391
- # Creates a new Elastic DocumentDB cluster and returns its Cluster
392
- # structure.
507
+ # Creates a new Amazon DocumentDB elastic cluster and returns its
508
+ # cluster structure.
393
509
  #
394
510
  # @option params [required, String] :admin_user_name
395
- # The name of the Elastic DocumentDB cluster administrator.
511
+ # The name of the Amazon DocumentDB elastic clusters administrator.
396
512
  #
397
513
  # *Constraints*:
398
514
  #
@@ -403,8 +519,8 @@ module Aws::DocDBElastic
403
519
  # * Cannot be a reserved word.
404
520
  #
405
521
  # @option params [required, String] :admin_user_password
406
- # The password for the Elastic DocumentDB cluster administrator and can
407
- # contain any printable ASCII characters.
522
+ # The password for the Amazon DocumentDB elastic clusters administrator.
523
+ # The password can contain any printable ASCII characters.
408
524
  #
409
525
  # *Constraints*:
410
526
  #
@@ -414,17 +530,22 @@ module Aws::DocDBElastic
414
530
  # symbol (@).
415
531
  #
416
532
  # @option params [required, String] :auth_type
417
- # The authentication type for the Elastic DocumentDB cluster.
533
+ # The authentication type used to determine where to fetch the password
534
+ # used for accessing the elastic cluster. Valid types are `PLAIN_TEXT`
535
+ # or `SECRET_ARN`.
536
+ #
537
+ # @option params [Integer] :backup_retention_period
538
+ # The number of days for which automatic snapshots are retained.
418
539
  #
419
540
  # @option params [String] :client_token
420
- # The client token for the Elastic DocumentDB cluster.
541
+ # The client token for the elastic cluster.
421
542
  #
422
543
  # **A suitable default value is auto-generated.** You should normally
423
544
  # not need to pass this option.**
424
545
  #
425
546
  # @option params [required, String] :cluster_name
426
- # The name of the new Elastic DocumentDB cluster. This parameter is
427
- # stored as a lowercase string.
547
+ # The name of the new elastic cluster. This parameter is stored as a
548
+ # lowercase string.
428
549
  #
429
550
  # *Constraints*:
430
551
  #
@@ -437,18 +558,22 @@ module Aws::DocDBElastic
437
558
  # *Example*: `my-cluster`
438
559
  #
439
560
  # @option params [String] :kms_key_id
440
- # The KMS key identifier to use to encrypt the new Elastic DocumentDB
441
- # cluster.
561
+ # The KMS key identifier to use to encrypt the new elastic cluster.
442
562
  #
443
563
  # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
444
564
  # encryption key. If you are creating a cluster using the same Amazon
445
565
  # account that owns this KMS encryption key, you can use the KMS key
446
566
  # alias instead of the ARN as the KMS encryption key.
447
567
  #
448
- # If an encryption key is not specified, Elastic DocumentDB uses the
568
+ # If an encryption key is not specified, Amazon DocumentDB uses the
449
569
  # default encryption key that KMS creates for your account. Your account
450
570
  # has a different default encryption key for each Amazon Region.
451
571
  #
572
+ # @option params [String] :preferred_backup_window
573
+ # The daily time range during which automated backups are created if
574
+ # automated backups are enabled, as determined by the
575
+ # `backupRetentionPeriod`.
576
+ #
452
577
  # @option params [String] :preferred_maintenance_window
453
578
  # The weekly time range during which system maintenance can occur, in
454
579
  # Universal Coordinated Time (UTC).
@@ -464,20 +589,27 @@ module Aws::DocDBElastic
464
589
  # *Constraints*: Minimum 30-minute window.
465
590
  #
466
591
  # @option params [required, Integer] :shard_capacity
467
- # The capacity of each shard in the new Elastic DocumentDB cluster.
592
+ # The number of vCPUs assigned to each elastic cluster shard. Maximum is
593
+ # 64. Allowed values are 2, 4, 8, 16, 32, 64.
468
594
  #
469
595
  # @option params [required, Integer] :shard_count
470
- # The number of shards to create in the new Elastic DocumentDB cluster.
596
+ # The number of shards assigned to the elastic cluster. Maximum is 32.
597
+ #
598
+ # @option params [Integer] :shard_instance_count
599
+ # The number of replica instances applying to all shards in the elastic
600
+ # cluster. A `shardInstanceCount` value of 1 means there is one writer
601
+ # instance, and any additional instances are replicas that can be used
602
+ # for reads and to improve availability.
471
603
  #
472
604
  # @option params [Array<String>] :subnet_ids
473
- # The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
605
+ # The Amazon EC2 subnet IDs for the new elastic cluster.
474
606
  #
475
607
  # @option params [Hash<String,String>] :tags
476
- # The tags to be assigned to the new Elastic DocumentDB cluster.
608
+ # The tags to be assigned to the new elastic cluster.
477
609
  #
478
610
  # @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.
611
+ # A list of EC2 VPC security groups to associate with the new elastic
612
+ # cluster.
481
613
  #
482
614
  # @return [Types::CreateClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
483
615
  #
@@ -489,12 +621,15 @@ module Aws::DocDBElastic
489
621
  # admin_user_name: "String", # required
490
622
  # admin_user_password: "Password", # required
491
623
  # auth_type: "PLAIN_TEXT", # required, accepts PLAIN_TEXT, SECRET_ARN
624
+ # backup_retention_period: 1,
492
625
  # client_token: "String",
493
626
  # cluster_name: "String", # required
494
627
  # kms_key_id: "String",
628
+ # preferred_backup_window: "String",
495
629
  # preferred_maintenance_window: "String",
496
630
  # shard_capacity: 1, # required
497
631
  # shard_count: 1, # required
632
+ # shard_instance_count: 1,
498
633
  # subnet_ids: ["String"],
499
634
  # tags: {
500
635
  # "TagKey" => "TagValue",
@@ -506,15 +641,22 @@ module Aws::DocDBElastic
506
641
  #
507
642
  # resp.cluster.admin_user_name #=> String
508
643
  # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
644
+ # resp.cluster.backup_retention_period #=> Integer
509
645
  # resp.cluster.cluster_arn #=> String
510
646
  # resp.cluster.cluster_endpoint #=> String
511
647
  # resp.cluster.cluster_name #=> String
512
648
  # resp.cluster.create_time #=> String
513
649
  # resp.cluster.kms_key_id #=> String
650
+ # resp.cluster.preferred_backup_window #=> String
514
651
  # resp.cluster.preferred_maintenance_window #=> String
515
652
  # resp.cluster.shard_capacity #=> Integer
516
653
  # 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"
654
+ # resp.cluster.shard_instance_count #=> Integer
655
+ # resp.cluster.shards #=> Array
656
+ # resp.cluster.shards[0].create_time #=> String
657
+ # resp.cluster.shards[0].shard_id #=> String
658
+ # 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"
659
+ # 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
660
  # resp.cluster.subnet_ids #=> Array
519
661
  # resp.cluster.subnet_ids[0] #=> String
520
662
  # resp.cluster.vpc_security_group_ids #=> Array
@@ -529,17 +671,17 @@ module Aws::DocDBElastic
529
671
  req.send_request(options)
530
672
  end
531
673
 
532
- # Creates a snapshot of a cluster.
674
+ # Creates a snapshot of an elastic cluster.
533
675
  #
534
676
  # @option params [required, String] :cluster_arn
535
- # The arn of the Elastic DocumentDB cluster that the snapshot will be
536
- # taken from.
677
+ # The ARN identifier of the elastic cluster of which you want to create
678
+ # a snapshot.
537
679
  #
538
680
  # @option params [required, String] :snapshot_name
539
- # The name of the Elastic DocumentDB snapshot.
681
+ # The name of the new elastic cluster snapshot.
540
682
  #
541
683
  # @option params [Hash<String,String>] :tags
542
- # The tags to be assigned to the new Elastic DocumentDB snapshot.
684
+ # The tags to be assigned to the new elastic cluster snapshot.
543
685
  #
544
686
  # @return [Types::CreateClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
545
687
  #
@@ -564,7 +706,8 @@ module Aws::DocDBElastic
564
706
  # resp.snapshot.snapshot_arn #=> String
565
707
  # resp.snapshot.snapshot_creation_time #=> String
566
708
  # 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"
709
+ # resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
710
+ # 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
711
  # resp.snapshot.subnet_ids #=> Array
569
712
  # resp.snapshot.subnet_ids[0] #=> String
570
713
  # resp.snapshot.vpc_security_group_ids #=> Array
@@ -579,10 +722,10 @@ module Aws::DocDBElastic
579
722
  req.send_request(options)
580
723
  end
581
724
 
582
- # Delete a Elastic DocumentDB cluster.
725
+ # Delete an elastic cluster.
583
726
  #
584
727
  # @option params [required, String] :cluster_arn
585
- # The arn of the Elastic DocumentDB cluster that is to be deleted.
728
+ # The ARN identifier of the elastic cluster that is to be deleted.
586
729
  #
587
730
  # @return [Types::DeleteClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
588
731
  #
@@ -598,15 +741,22 @@ module Aws::DocDBElastic
598
741
  #
599
742
  # resp.cluster.admin_user_name #=> String
600
743
  # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
744
+ # resp.cluster.backup_retention_period #=> Integer
601
745
  # resp.cluster.cluster_arn #=> String
602
746
  # resp.cluster.cluster_endpoint #=> String
603
747
  # resp.cluster.cluster_name #=> String
604
748
  # resp.cluster.create_time #=> String
605
749
  # resp.cluster.kms_key_id #=> String
750
+ # resp.cluster.preferred_backup_window #=> String
606
751
  # resp.cluster.preferred_maintenance_window #=> String
607
752
  # resp.cluster.shard_capacity #=> Integer
608
753
  # 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"
754
+ # resp.cluster.shard_instance_count #=> Integer
755
+ # resp.cluster.shards #=> Array
756
+ # resp.cluster.shards[0].create_time #=> String
757
+ # resp.cluster.shards[0].shard_id #=> String
758
+ # 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"
759
+ # 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
760
  # resp.cluster.subnet_ids #=> Array
611
761
  # resp.cluster.subnet_ids[0] #=> String
612
762
  # resp.cluster.vpc_security_group_ids #=> Array
@@ -621,10 +771,11 @@ module Aws::DocDBElastic
621
771
  req.send_request(options)
622
772
  end
623
773
 
624
- # Delete a Elastic DocumentDB snapshot.
774
+ # Delete an elastic cluster snapshot.
625
775
  #
626
776
  # @option params [required, String] :snapshot_arn
627
- # The arn of the Elastic DocumentDB snapshot that is to be deleted.
777
+ # The ARN identifier of the elastic cluster snapshot that is to be
778
+ # deleted.
628
779
  #
629
780
  # @return [Types::DeleteClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
630
781
  #
@@ -645,7 +796,8 @@ module Aws::DocDBElastic
645
796
  # resp.snapshot.snapshot_arn #=> String
646
797
  # resp.snapshot.snapshot_creation_time #=> String
647
798
  # 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"
799
+ # resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
800
+ # 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
801
  # resp.snapshot.subnet_ids #=> Array
650
802
  # resp.snapshot.subnet_ids[0] #=> String
651
803
  # resp.snapshot.vpc_security_group_ids #=> Array
@@ -660,10 +812,10 @@ module Aws::DocDBElastic
660
812
  req.send_request(options)
661
813
  end
662
814
 
663
- # Returns information about a specific Elastic DocumentDB cluster.
815
+ # Returns information about a specific elastic cluster.
664
816
  #
665
817
  # @option params [required, String] :cluster_arn
666
- # The arn of the Elastic DocumentDB cluster.
818
+ # The ARN identifier of the elastic cluster.
667
819
  #
668
820
  # @return [Types::GetClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
669
821
  #
@@ -679,15 +831,22 @@ module Aws::DocDBElastic
679
831
  #
680
832
  # resp.cluster.admin_user_name #=> String
681
833
  # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
834
+ # resp.cluster.backup_retention_period #=> Integer
682
835
  # resp.cluster.cluster_arn #=> String
683
836
  # resp.cluster.cluster_endpoint #=> String
684
837
  # resp.cluster.cluster_name #=> String
685
838
  # resp.cluster.create_time #=> String
686
839
  # resp.cluster.kms_key_id #=> String
840
+ # resp.cluster.preferred_backup_window #=> String
687
841
  # resp.cluster.preferred_maintenance_window #=> String
688
842
  # resp.cluster.shard_capacity #=> Integer
689
843
  # 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"
844
+ # resp.cluster.shard_instance_count #=> Integer
845
+ # resp.cluster.shards #=> Array
846
+ # resp.cluster.shards[0].create_time #=> String
847
+ # resp.cluster.shards[0].shard_id #=> String
848
+ # 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"
849
+ # 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
850
  # resp.cluster.subnet_ids #=> Array
692
851
  # resp.cluster.subnet_ids[0] #=> String
693
852
  # resp.cluster.vpc_security_group_ids #=> Array
@@ -702,10 +861,10 @@ module Aws::DocDBElastic
702
861
  req.send_request(options)
703
862
  end
704
863
 
705
- # Returns information about a specific Elastic DocumentDB snapshot
864
+ # Returns information about a specific elastic cluster snapshot
706
865
  #
707
866
  # @option params [required, String] :snapshot_arn
708
- # The arn of the Elastic DocumentDB snapshot.
867
+ # The ARN identifier of the elastic cluster snapshot.
709
868
  #
710
869
  # @return [Types::GetClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
711
870
  #
@@ -726,7 +885,8 @@ module Aws::DocDBElastic
726
885
  # resp.snapshot.snapshot_arn #=> String
727
886
  # resp.snapshot.snapshot_creation_time #=> String
728
887
  # 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"
888
+ # resp.snapshot.snapshot_type #=> String, one of "MANUAL", "AUTOMATED"
889
+ # 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
890
  # resp.snapshot.subnet_ids #=> Array
731
891
  # resp.snapshot.subnet_ids[0] #=> String
732
892
  # resp.snapshot.vpc_security_group_ids #=> Array
@@ -741,17 +901,32 @@ module Aws::DocDBElastic
741
901
  req.send_request(options)
742
902
  end
743
903
 
744
- # Returns information about Elastic DocumentDB snapshots for a specified
745
- # cluster.
904
+ # Returns information about snapshots for a specified elastic cluster.
746
905
  #
747
906
  # @option params [String] :cluster_arn
748
- # The arn of the Elastic DocumentDB cluster.
907
+ # The ARN identifier of the elastic cluster.
749
908
  #
750
909
  # @option params [Integer] :max_results
751
- # The maximum number of entries to recieve in the response.
910
+ # The maximum number of elastic cluster snapshot results to receive in
911
+ # the response.
752
912
  #
753
913
  # @option params [String] :next_token
754
- # The nextToken which is used the get the next page of data.
914
+ # A pagination token provided by a previous request. If this parameter
915
+ # is specified, the response includes only records beyond this token, up
916
+ # to the value specified by `max-results`.
917
+ #
918
+ # If there is no more data in the responce, the `nextToken` will not be
919
+ # returned.
920
+ #
921
+ # @option params [String] :snapshot_type
922
+ # The type of cluster snapshots to be returned. You can specify one of
923
+ # the following values:
924
+ #
925
+ # * `automated` - Return all cluster snapshots that Amazon DocumentDB
926
+ # has automatically created for your Amazon Web Services account.
927
+ #
928
+ # * `manual` - Return all cluster snapshots that you have manually
929
+ # created for your Amazon Web Services account.
755
930
  #
756
931
  # @return [Types::ListClusterSnapshotsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
757
932
  #
@@ -766,6 +941,7 @@ module Aws::DocDBElastic
766
941
  # cluster_arn: "String",
767
942
  # max_results: 1,
768
943
  # next_token: "PaginationToken",
944
+ # snapshot_type: "String",
769
945
  # })
770
946
  #
771
947
  # @example Response structure
@@ -776,7 +952,7 @@ module Aws::DocDBElastic
776
952
  # resp.snapshots[0].snapshot_arn #=> String
777
953
  # resp.snapshots[0].snapshot_creation_time #=> String
778
954
  # 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"
955
+ # 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
956
  #
781
957
  # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusterSnapshots AWS API Documentation
782
958
  #
@@ -787,13 +963,20 @@ module Aws::DocDBElastic
787
963
  req.send_request(options)
788
964
  end
789
965
 
790
- # Returns information about provisioned Elastic DocumentDB clusters.
966
+ # Returns information about provisioned Amazon DocumentDB elastic
967
+ # clusters.
791
968
  #
792
969
  # @option params [Integer] :max_results
793
- # The maximum number of entries to recieve in the response.
970
+ # The maximum number of elastic cluster snapshot results to receive in
971
+ # the response.
794
972
  #
795
973
  # @option params [String] :next_token
796
- # The nextToken which is used the get the next page of data.
974
+ # A pagination token provided by a previous request. If this parameter
975
+ # is specified, the response includes only records beyond this token, up
976
+ # to the value specified by `max-results`.
977
+ #
978
+ # If there is no more data in the responce, the `nextToken` will not be
979
+ # returned.
797
980
  #
798
981
  # @return [Types::ListClustersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
799
982
  #
@@ -814,7 +997,7 @@ module Aws::DocDBElastic
814
997
  # resp.clusters #=> Array
815
998
  # resp.clusters[0].cluster_arn #=> String
816
999
  # 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"
1000
+ # 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
1001
  # resp.next_token #=> String
819
1002
  #
820
1003
  # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusters AWS API Documentation
@@ -826,10 +1009,10 @@ module Aws::DocDBElastic
826
1009
  req.send_request(options)
827
1010
  end
828
1011
 
829
- # Lists all tags on a Elastic DocumentDB resource
1012
+ # Lists all tags on a elastic cluster resource
830
1013
  #
831
1014
  # @option params [required, String] :resource_arn
832
- # The arn of the Elastic DocumentDB resource.
1015
+ # The ARN identifier of the elastic cluster resource.
833
1016
  #
834
1017
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
835
1018
  #
@@ -855,38 +1038,47 @@ module Aws::DocDBElastic
855
1038
  req.send_request(options)
856
1039
  end
857
1040
 
858
- # Restores a Elastic DocumentDB cluster from a snapshot.
1041
+ # Restores an elastic cluster from a snapshot.
859
1042
  #
860
1043
  # @option params [required, String] :cluster_name
861
- # The name of the Elastic DocumentDB cluster.
1044
+ # The name of the elastic cluster.
862
1045
  #
863
1046
  # @option params [String] :kms_key_id
864
- # The KMS key identifier to use to encrypt the new Elastic DocumentDB
865
- # cluster.
1047
+ # The KMS key identifier to use to encrypt the new Amazon DocumentDB
1048
+ # elastic clusters cluster.
866
1049
  #
867
1050
  # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
868
1051
  # encryption key. If you are creating a cluster using the same Amazon
869
1052
  # account that owns this KMS encryption key, you can use the KMS key
870
1053
  # alias instead of the ARN as the KMS encryption key.
871
1054
  #
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.
1055
+ # If an encryption key is not specified here, Amazon DocumentDB uses the
1056
+ # default encryption key that KMS creates for your account. Your account
1057
+ # has a different default encryption key for each Amazon Region.
1058
+ #
1059
+ # @option params [Integer] :shard_capacity
1060
+ # The capacity of each shard in the new restored elastic cluster.
1061
+ #
1062
+ # @option params [Integer] :shard_instance_count
1063
+ # The number of replica instances applying to all shards in the elastic
1064
+ # cluster. A `shardInstanceCount` value of 1 means there is one writer
1065
+ # instance, and any additional instances are replicas that can be used
1066
+ # for reads and to improve availability.
875
1067
  #
876
1068
  # @option params [required, String] :snapshot_arn
877
- # The arn of the Elastic DocumentDB snapshot.
1069
+ # The ARN identifier of the elastic cluster snapshot.
878
1070
  #
879
1071
  # @option params [Array<String>] :subnet_ids
880
- # The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
1072
+ # The Amazon EC2 subnet IDs for the elastic cluster.
881
1073
  #
882
1074
  # @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.
1075
+ # A list of the tag names to be assigned to the restored elastic
1076
+ # cluster, in the form of an array of key-value pairs in which the key
1077
+ # is the tag name and the value is the key value.
886
1078
  #
887
1079
  # @option params [Array<String>] :vpc_security_group_ids
888
- # A list of EC2 VPC security groups to associate with the Elastic
889
- # DocumentDB cluster.
1080
+ # A list of EC2 VPC security groups to associate with the elastic
1081
+ # cluster.
890
1082
  #
891
1083
  # @return [Types::RestoreClusterFromSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
892
1084
  #
@@ -897,6 +1089,8 @@ module Aws::DocDBElastic
897
1089
  # resp = client.restore_cluster_from_snapshot({
898
1090
  # cluster_name: "String", # required
899
1091
  # kms_key_id: "String",
1092
+ # shard_capacity: 1,
1093
+ # shard_instance_count: 1,
900
1094
  # snapshot_arn: "String", # required
901
1095
  # subnet_ids: ["String"],
902
1096
  # tags: {
@@ -909,15 +1103,22 @@ module Aws::DocDBElastic
909
1103
  #
910
1104
  # resp.cluster.admin_user_name #=> String
911
1105
  # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
1106
+ # resp.cluster.backup_retention_period #=> Integer
912
1107
  # resp.cluster.cluster_arn #=> String
913
1108
  # resp.cluster.cluster_endpoint #=> String
914
1109
  # resp.cluster.cluster_name #=> String
915
1110
  # resp.cluster.create_time #=> String
916
1111
  # resp.cluster.kms_key_id #=> String
1112
+ # resp.cluster.preferred_backup_window #=> String
917
1113
  # resp.cluster.preferred_maintenance_window #=> String
918
1114
  # resp.cluster.shard_capacity #=> Integer
919
1115
  # 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"
1116
+ # resp.cluster.shard_instance_count #=> Integer
1117
+ # resp.cluster.shards #=> Array
1118
+ # resp.cluster.shards[0].create_time #=> String
1119
+ # resp.cluster.shards[0].shard_id #=> String
1120
+ # 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"
1121
+ # 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
1122
  # resp.cluster.subnet_ids #=> Array
922
1123
  # resp.cluster.subnet_ids[0] #=> String
923
1124
  # resp.cluster.vpc_security_group_ids #=> Array
@@ -932,13 +1133,113 @@ module Aws::DocDBElastic
932
1133
  req.send_request(options)
933
1134
  end
934
1135
 
935
- # Adds metadata tags to a Elastic DocumentDB resource
1136
+ # Restarts the stopped elastic cluster that is specified by
1137
+ # `clusterARN`.
1138
+ #
1139
+ # @option params [required, String] :cluster_arn
1140
+ # The ARN identifier of the elastic cluster.
1141
+ #
1142
+ # @return [Types::StartClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1143
+ #
1144
+ # * {Types::StartClusterOutput#cluster #cluster} => Types::Cluster
1145
+ #
1146
+ # @example Request syntax with placeholder values
1147
+ #
1148
+ # resp = client.start_cluster({
1149
+ # cluster_arn: "String", # required
1150
+ # })
1151
+ #
1152
+ # @example Response structure
1153
+ #
1154
+ # resp.cluster.admin_user_name #=> String
1155
+ # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
1156
+ # resp.cluster.backup_retention_period #=> Integer
1157
+ # resp.cluster.cluster_arn #=> String
1158
+ # resp.cluster.cluster_endpoint #=> String
1159
+ # resp.cluster.cluster_name #=> String
1160
+ # resp.cluster.create_time #=> String
1161
+ # resp.cluster.kms_key_id #=> String
1162
+ # resp.cluster.preferred_backup_window #=> String
1163
+ # resp.cluster.preferred_maintenance_window #=> String
1164
+ # resp.cluster.shard_capacity #=> Integer
1165
+ # resp.cluster.shard_count #=> Integer
1166
+ # resp.cluster.shard_instance_count #=> Integer
1167
+ # resp.cluster.shards #=> Array
1168
+ # resp.cluster.shards[0].create_time #=> String
1169
+ # resp.cluster.shards[0].shard_id #=> String
1170
+ # 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"
1171
+ # 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"
1172
+ # resp.cluster.subnet_ids #=> Array
1173
+ # resp.cluster.subnet_ids[0] #=> String
1174
+ # resp.cluster.vpc_security_group_ids #=> Array
1175
+ # resp.cluster.vpc_security_group_ids[0] #=> String
1176
+ #
1177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StartCluster AWS API Documentation
1178
+ #
1179
+ # @overload start_cluster(params = {})
1180
+ # @param [Hash] params ({})
1181
+ def start_cluster(params = {}, options = {})
1182
+ req = build_request(:start_cluster, params)
1183
+ req.send_request(options)
1184
+ end
1185
+
1186
+ # Stops the running elastic cluster that is specified by `clusterArn`.
1187
+ # The elastic cluster must be in the *available* state.
1188
+ #
1189
+ # @option params [required, String] :cluster_arn
1190
+ # The ARN identifier of the elastic cluster.
1191
+ #
1192
+ # @return [Types::StopClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1193
+ #
1194
+ # * {Types::StopClusterOutput#cluster #cluster} => Types::Cluster
1195
+ #
1196
+ # @example Request syntax with placeholder values
1197
+ #
1198
+ # resp = client.stop_cluster({
1199
+ # cluster_arn: "String", # required
1200
+ # })
1201
+ #
1202
+ # @example Response structure
1203
+ #
1204
+ # resp.cluster.admin_user_name #=> String
1205
+ # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
1206
+ # resp.cluster.backup_retention_period #=> Integer
1207
+ # resp.cluster.cluster_arn #=> String
1208
+ # resp.cluster.cluster_endpoint #=> String
1209
+ # resp.cluster.cluster_name #=> String
1210
+ # resp.cluster.create_time #=> String
1211
+ # resp.cluster.kms_key_id #=> String
1212
+ # resp.cluster.preferred_backup_window #=> String
1213
+ # resp.cluster.preferred_maintenance_window #=> String
1214
+ # resp.cluster.shard_capacity #=> Integer
1215
+ # resp.cluster.shard_count #=> Integer
1216
+ # resp.cluster.shard_instance_count #=> Integer
1217
+ # resp.cluster.shards #=> Array
1218
+ # resp.cluster.shards[0].create_time #=> String
1219
+ # resp.cluster.shards[0].shard_id #=> String
1220
+ # 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"
1221
+ # 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"
1222
+ # resp.cluster.subnet_ids #=> Array
1223
+ # resp.cluster.subnet_ids[0] #=> String
1224
+ # resp.cluster.vpc_security_group_ids #=> Array
1225
+ # resp.cluster.vpc_security_group_ids[0] #=> String
1226
+ #
1227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StopCluster AWS API Documentation
1228
+ #
1229
+ # @overload stop_cluster(params = {})
1230
+ # @param [Hash] params ({})
1231
+ def stop_cluster(params = {}, options = {})
1232
+ req = build_request(:stop_cluster, params)
1233
+ req.send_request(options)
1234
+ end
1235
+
1236
+ # Adds metadata tags to an elastic cluster resource
936
1237
  #
937
1238
  # @option params [required, String] :resource_arn
938
- # The arn of the Elastic DocumentDB resource.
1239
+ # The ARN identifier of the elastic cluster resource.
939
1240
  #
940
1241
  # @option params [required, Hash<String,String>] :tags
941
- # The tags to be assigned to the Elastic DocumentDB resource.
1242
+ # The tags that are assigned to the elastic cluster resource.
942
1243
  #
943
1244
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
944
1245
  #
@@ -960,13 +1261,13 @@ module Aws::DocDBElastic
960
1261
  req.send_request(options)
961
1262
  end
962
1263
 
963
- # Removes metadata tags to a Elastic DocumentDB resource
1264
+ # Removes metadata tags from an elastic cluster resource
964
1265
  #
965
1266
  # @option params [required, String] :resource_arn
966
- # The arn of the Elastic DocumentDB resource.
1267
+ # The ARN identifier of the elastic cluster resource.
967
1268
  #
968
1269
  # @option params [required, Array<String>] :tag_keys
969
- # The tag keys to be removed from the Elastic DocumentDB resource.
1270
+ # The tag keys to be removed from the elastic cluster resource.
970
1271
  #
971
1272
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
972
1273
  #
@@ -986,28 +1287,38 @@ module Aws::DocDBElastic
986
1287
  req.send_request(options)
987
1288
  end
988
1289
 
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
1290
+ # Modifies an elastic cluster. This includes updating
1291
+ # admin-username/password, upgrading the API version, and setting up a
1292
+ # backup window and maintenance window
992
1293
  #
993
1294
  # @option params [String] :admin_user_password
994
- # The password for the Elastic DocumentDB cluster administrator. This
1295
+ # The password associated with the elastic cluster administrator. This
995
1296
  # password can contain any printable ASCII character except forward
996
1297
  # slash (/), double quote ("), or the "at" symbol (@).
997
1298
  #
998
1299
  # *Constraints*: Must contain from 8 to 100 characters.
999
1300
  #
1000
1301
  # @option params [String] :auth_type
1001
- # The authentication type for the Elastic DocumentDB cluster.
1302
+ # The authentication type used to determine where to fetch the password
1303
+ # used for accessing the elastic cluster. Valid types are `PLAIN_TEXT`
1304
+ # or `SECRET_ARN`.
1305
+ #
1306
+ # @option params [Integer] :backup_retention_period
1307
+ # The number of days for which automatic snapshots are retained.
1002
1308
  #
1003
1309
  # @option params [String] :client_token
1004
- # The client token for the Elastic DocumentDB cluster.
1310
+ # The client token for the elastic cluster.
1005
1311
  #
1006
1312
  # **A suitable default value is auto-generated.** You should normally
1007
1313
  # not need to pass this option.**
1008
1314
  #
1009
1315
  # @option params [required, String] :cluster_arn
1010
- # The arn of the Elastic DocumentDB cluster.
1316
+ # The ARN identifier of the elastic cluster.
1317
+ #
1318
+ # @option params [String] :preferred_backup_window
1319
+ # The daily time range during which automated backups are created if
1320
+ # automated backups are enabled, as determined by the
1321
+ # `backupRetentionPeriod`.
1011
1322
  #
1012
1323
  # @option params [String] :preferred_maintenance_window
1013
1324
  # The weekly time range during which system maintenance can occur, in
@@ -1024,17 +1335,24 @@ module Aws::DocDBElastic
1024
1335
  # *Constraints*: Minimum 30-minute window.
1025
1336
  #
1026
1337
  # @option params [Integer] :shard_capacity
1027
- # The capacity of each shard in the Elastic DocumentDB cluster.
1338
+ # The number of vCPUs assigned to each elastic cluster shard. Maximum is
1339
+ # 64. Allowed values are 2, 4, 8, 16, 32, 64.
1028
1340
  #
1029
1341
  # @option params [Integer] :shard_count
1030
- # The number of shards to create in the Elastic DocumentDB cluster.
1342
+ # The number of shards assigned to the elastic cluster. Maximum is 32.
1343
+ #
1344
+ # @option params [Integer] :shard_instance_count
1345
+ # The number of replica instances applying to all shards in the elastic
1346
+ # cluster. A `shardInstanceCount` value of 1 means there is one writer
1347
+ # instance, and any additional instances are replicas that can be used
1348
+ # for reads and to improve availability.
1031
1349
  #
1032
1350
  # @option params [Array<String>] :subnet_ids
1033
- # The number of shards to create in the Elastic DocumentDB cluster.
1351
+ # The Amazon EC2 subnet IDs for the elastic cluster.
1034
1352
  #
1035
1353
  # @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.
1354
+ # A list of EC2 VPC security groups to associate with the elastic
1355
+ # cluster.
1038
1356
  #
1039
1357
  # @return [Types::UpdateClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1040
1358
  #
@@ -1045,11 +1363,14 @@ module Aws::DocDBElastic
1045
1363
  # resp = client.update_cluster({
1046
1364
  # admin_user_password: "Password",
1047
1365
  # auth_type: "PLAIN_TEXT", # accepts PLAIN_TEXT, SECRET_ARN
1366
+ # backup_retention_period: 1,
1048
1367
  # client_token: "String",
1049
1368
  # cluster_arn: "String", # required
1369
+ # preferred_backup_window: "String",
1050
1370
  # preferred_maintenance_window: "String",
1051
1371
  # shard_capacity: 1,
1052
1372
  # shard_count: 1,
1373
+ # shard_instance_count: 1,
1053
1374
  # subnet_ids: ["String"],
1054
1375
  # vpc_security_group_ids: ["String"],
1055
1376
  # })
@@ -1058,15 +1379,22 @@ module Aws::DocDBElastic
1058
1379
  #
1059
1380
  # resp.cluster.admin_user_name #=> String
1060
1381
  # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
1382
+ # resp.cluster.backup_retention_period #=> Integer
1061
1383
  # resp.cluster.cluster_arn #=> String
1062
1384
  # resp.cluster.cluster_endpoint #=> String
1063
1385
  # resp.cluster.cluster_name #=> String
1064
1386
  # resp.cluster.create_time #=> String
1065
1387
  # resp.cluster.kms_key_id #=> String
1388
+ # resp.cluster.preferred_backup_window #=> String
1066
1389
  # resp.cluster.preferred_maintenance_window #=> String
1067
1390
  # resp.cluster.shard_capacity #=> Integer
1068
1391
  # 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"
1392
+ # resp.cluster.shard_instance_count #=> Integer
1393
+ # resp.cluster.shards #=> Array
1394
+ # resp.cluster.shards[0].create_time #=> String
1395
+ # resp.cluster.shards[0].shard_id #=> String
1396
+ # 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"
1397
+ # 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
1398
  # resp.cluster.subnet_ids #=> Array
1071
1399
  # resp.cluster.subnet_ids[0] #=> String
1072
1400
  # resp.cluster.vpc_security_group_ids #=> Array
@@ -1094,7 +1422,7 @@ module Aws::DocDBElastic
1094
1422
  params: params,
1095
1423
  config: config)
1096
1424
  context[:gem_name] = 'aws-sdk-docdbelastic'
1097
- context[:gem_version] = '1.11.0'
1425
+ context[:gem_version] = '1.13.0'
1098
1426
  Seahorse::Client::Request.new(handlers, context)
1099
1427
  end
1100
1428