aws-sdk-docdbelastic 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1099 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
35
+
36
+ Aws::Plugins::GlobalConfiguration.add_identifier(:docdbelastic)
37
+
38
+ module Aws::DocDBElastic
39
+ # An API client for DocDBElastic. To construct a client, you need to configure a `:region` and `:credentials`.
40
+ #
41
+ # client = Aws::DocDBElastic::Client.new(
42
+ # region: region_name,
43
+ # credentials: credentials,
44
+ # # ...
45
+ # )
46
+ #
47
+ # For details on configuring region and credentials see
48
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
49
+ #
50
+ # See {#initialize} for a full list of supported configuration options.
51
+ class Client < Seahorse::Client::Base
52
+
53
+ include Aws::ClientStubs
54
+
55
+ @identifier = :docdbelastic
56
+
57
+ set_api(ClientApi::API)
58
+
59
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
60
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
61
+ add_plugin(Aws::Plugins::Logging)
62
+ add_plugin(Aws::Plugins::ParamConverter)
63
+ add_plugin(Aws::Plugins::ParamValidator)
64
+ add_plugin(Aws::Plugins::UserAgent)
65
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
66
+ add_plugin(Aws::Plugins::RetryErrors)
67
+ add_plugin(Aws::Plugins::GlobalConfiguration)
68
+ add_plugin(Aws::Plugins::RegionalEndpoint)
69
+ add_plugin(Aws::Plugins::EndpointDiscovery)
70
+ add_plugin(Aws::Plugins::EndpointPattern)
71
+ add_plugin(Aws::Plugins::ResponsePaging)
72
+ add_plugin(Aws::Plugins::StubResponses)
73
+ add_plugin(Aws::Plugins::IdempotencyToken)
74
+ add_plugin(Aws::Plugins::JsonvalueConverter)
75
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
76
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
77
+ add_plugin(Aws::Plugins::TransferEncoding)
78
+ add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
82
+ add_plugin(Aws::Plugins::Sign)
83
+ add_plugin(Aws::Plugins::Protocols::RestJson)
84
+ add_plugin(Aws::DocDBElastic::Plugins::Endpoints)
85
+
86
+ # @overload initialize(options)
87
+ # @param [Hash] options
88
+ # @option options [required, Aws::CredentialProvider] :credentials
89
+ # Your AWS credentials. This can be an instance of any one of the
90
+ # following classes:
91
+ #
92
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
93
+ # credentials.
94
+ #
95
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
96
+ # shared file, such as `~/.aws/config`.
97
+ #
98
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
99
+ #
100
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
101
+ # assume a role after providing credentials via the web.
102
+ #
103
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
104
+ # access token generated from `aws login`.
105
+ #
106
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
107
+ # process that outputs to stdout.
108
+ #
109
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
110
+ # from an EC2 IMDS on an EC2 instance.
111
+ #
112
+ # * `Aws::ECSCredentials` - Used for loading credentials from
113
+ # instances running in ECS.
114
+ #
115
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
116
+ # from the Cognito Identity service.
117
+ #
118
+ # When `:credentials` are not configured directly, the following
119
+ # locations will be searched for credentials:
120
+ #
121
+ # * `Aws.config[:credentials]`
122
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
123
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
124
+ # * `~/.aws/credentials`
125
+ # * `~/.aws/config`
126
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
127
+ # are very aggressive. Construct and pass an instance of
128
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
129
+ # enable retries and extended timeouts. Instance profile credential
130
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
131
+ # to true.
132
+ #
133
+ # @option options [required, String] :region
134
+ # The AWS region to connect to. The configured `:region` is
135
+ # used to determine the service `:endpoint`. When not passed,
136
+ # a default `:region` is searched for in the following locations:
137
+ #
138
+ # * `Aws.config[:region]`
139
+ # * `ENV['AWS_REGION']`
140
+ # * `ENV['AMAZON_REGION']`
141
+ # * `ENV['AWS_DEFAULT_REGION']`
142
+ # * `~/.aws/credentials`
143
+ # * `~/.aws/config`
144
+ #
145
+ # @option options [String] :access_key_id
146
+ #
147
+ # @option options [Boolean] :active_endpoint_cache (false)
148
+ # When set to `true`, a thread polling for endpoints will be running in
149
+ # the background every 60 secs (default). Defaults to `false`.
150
+ #
151
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
152
+ # Used only in `adaptive` retry mode. When true, the request will sleep
153
+ # until there is sufficent client side capacity to retry the request.
154
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
155
+ # not retry instead of sleeping.
156
+ #
157
+ # @option options [Boolean] :client_side_monitoring (false)
158
+ # When `true`, client-side metrics will be collected for all API requests from
159
+ # this client.
160
+ #
161
+ # @option options [String] :client_side_monitoring_client_id ("")
162
+ # Allows you to provide an identifier for this client which will be attached to
163
+ # all generated client side metrics. Defaults to an empty string.
164
+ #
165
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
166
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
167
+ # side monitoring agent is running on, where client metrics will be published via UDP.
168
+ #
169
+ # @option options [Integer] :client_side_monitoring_port (31000)
170
+ # Required for publishing client metrics. The port that the client side monitoring
171
+ # agent is running on, where client metrics will be published via UDP.
172
+ #
173
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
174
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
175
+ # will use the Client Side Monitoring Agent Publisher.
176
+ #
177
+ # @option options [Boolean] :convert_params (true)
178
+ # When `true`, an attempt is made to coerce request parameters into
179
+ # the required types.
180
+ #
181
+ # @option options [Boolean] :correct_clock_skew (true)
182
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
183
+ # a clock skew correction and retry requests with skewed client clocks.
184
+ #
185
+ # @option options [String] :defaults_mode ("legacy")
186
+ # See {Aws::DefaultsModeConfiguration} for a list of the
187
+ # accepted modes and the configuration defaults that are included.
188
+ #
189
+ # @option options [Boolean] :disable_host_prefix_injection (false)
190
+ # Set to true to disable SDK automatically adding host prefix
191
+ # to default service endpoint when available.
192
+ #
193
+ # @option options [String] :endpoint
194
+ # The client endpoint is normally constructed from the `:region`
195
+ # option. You should only configure an `:endpoint` when connecting
196
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
197
+ #
198
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
199
+ # Used for the maximum size limit of the LRU cache storing endpoints data
200
+ # for endpoint discovery enabled operations. Defaults to 1000.
201
+ #
202
+ # @option options [Integer] :endpoint_cache_max_threads (10)
203
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
204
+ #
205
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
206
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
207
+ # Use this option to config the time interval in seconds for making
208
+ # requests fetching endpoints information. Defaults to 60 sec.
209
+ #
210
+ # @option options [Boolean] :endpoint_discovery (false)
211
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
212
+ #
213
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
214
+ # The log formatter.
215
+ #
216
+ # @option options [Symbol] :log_level (:info)
217
+ # The log level to send messages to the `:logger` at.
218
+ #
219
+ # @option options [Logger] :logger
220
+ # The Logger instance to send log messages to. If this option
221
+ # is not set, logging will be disabled.
222
+ #
223
+ # @option options [Integer] :max_attempts (3)
224
+ # An integer representing the maximum number attempts that will be made for
225
+ # a single request, including the initial attempt. For example,
226
+ # setting this value to 5 will result in a request being retried up to
227
+ # 4 times. Used in `standard` and `adaptive` retry modes.
228
+ #
229
+ # @option options [String] :profile ("default")
230
+ # Used when loading credentials from the shared credentials file
231
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
232
+ #
233
+ # @option options [Proc] :retry_backoff
234
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
235
+ # This option is only used in the `legacy` retry mode.
236
+ #
237
+ # @option options [Float] :retry_base_delay (0.3)
238
+ # The base delay in seconds used by the default backoff function. This option
239
+ # is only used in the `legacy` retry mode.
240
+ #
241
+ # @option options [Symbol] :retry_jitter (:none)
242
+ # A delay randomiser function used by the default backoff function.
243
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
244
+ # otherwise a Proc that takes and returns a number. This option is only used
245
+ # in the `legacy` retry mode.
246
+ #
247
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
248
+ #
249
+ # @option options [Integer] :retry_limit (3)
250
+ # The maximum number of times to retry failed requests. Only
251
+ # ~ 500 level server errors and certain ~ 400 level client errors
252
+ # are retried. Generally, these are throttling errors, data
253
+ # checksum errors, networking errors, timeout errors, auth errors,
254
+ # endpoint discovery, and errors from expired credentials.
255
+ # This option is only used in the `legacy` retry mode.
256
+ #
257
+ # @option options [Integer] :retry_max_delay (0)
258
+ # The maximum number of seconds to delay between retries (0 for no limit)
259
+ # used by the default backoff function. This option is only used in the
260
+ # `legacy` retry mode.
261
+ #
262
+ # @option options [String] :retry_mode ("legacy")
263
+ # Specifies which retry algorithm to use. Values are:
264
+ #
265
+ # * `legacy` - The pre-existing retry behavior. This is default value if
266
+ # no retry mode is provided.
267
+ #
268
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
269
+ # This includes support for retry quotas, which limit the number of
270
+ # unsuccessful retries a client can make.
271
+ #
272
+ # * `adaptive` - An experimental retry mode that includes all the
273
+ # functionality of `standard` mode along with automatic client side
274
+ # throttling. This is a provisional mode that may change behavior
275
+ # in the future.
276
+ #
277
+ #
278
+ # @option options [String] :secret_access_key
279
+ #
280
+ # @option options [String] :session_token
281
+ #
282
+ # @option options [Boolean] :stub_responses (false)
283
+ # Causes the client to return stubbed responses. By default
284
+ # fake responses are generated and returned. You can specify
285
+ # the response data to return or errors to raise by calling
286
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
287
+ #
288
+ # ** Please note ** When response stubbing is enabled, no HTTP
289
+ # requests are made, and retries are disabled.
290
+ #
291
+ # @option options [Aws::TokenProvider] :token_provider
292
+ # A Bearer Token Provider. This can be an instance of any one of the
293
+ # following classes:
294
+ #
295
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
296
+ # tokens.
297
+ #
298
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
299
+ # access token generated from `aws login`.
300
+ #
301
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
302
+ # will be used to search for tokens configured for your profile in shared configuration files.
303
+ #
304
+ # @option options [Boolean] :use_dualstack_endpoint
305
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
306
+ # will be used if available.
307
+ #
308
+ # @option options [Boolean] :use_fips_endpoint
309
+ # When set to `true`, fips compatible endpoints will be used if available.
310
+ # When a `fips` region is used, the region is normalized and this config
311
+ # is set to `true`.
312
+ #
313
+ # @option options [Boolean] :validate_params (true)
314
+ # When `true`, request parameters are validated before
315
+ # sending the request.
316
+ #
317
+ # @option options [Aws::DocDBElastic::EndpointProvider] :endpoint_provider
318
+ # 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`
319
+ #
320
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
321
+ # requests through. Formatted like 'http://proxy.com:123'.
322
+ #
323
+ # @option options [Float] :http_open_timeout (15) The number of
324
+ # seconds to wait when opening a HTTP session before raising a
325
+ # `Timeout::Error`.
326
+ #
327
+ # @option options [Float] :http_read_timeout (60) The default
328
+ # number of seconds to wait for response data. This value can
329
+ # safely be set per-request on the session.
330
+ #
331
+ # @option options [Float] :http_idle_timeout (5) The number of
332
+ # seconds a connection is allowed to sit idle before it is
333
+ # considered stale. Stale connections are closed and removed
334
+ # from the pool before making a request.
335
+ #
336
+ # @option options [Float] :http_continue_timeout (1) The number of
337
+ # seconds to wait for a 100-continue response before sending the
338
+ # request body. This option has no effect unless the request has
339
+ # "Expect" header set to "100-continue". Defaults to `nil` which
340
+ # disables this behaviour. This value can safely be set per
341
+ # request on the session.
342
+ #
343
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
344
+ # in seconds.
345
+ #
346
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
347
+ # HTTP debug output will be sent to the `:logger`.
348
+ #
349
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
350
+ # SSL peer certificates are verified when establishing a
351
+ # connection.
352
+ #
353
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
354
+ # certificate authority bundle file that should be used when
355
+ # verifying peer certificates. If you do not pass
356
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
357
+ # will be used if available.
358
+ #
359
+ # @option options [String] :ssl_ca_directory Full path of the
360
+ # directory that contains the unbundled SSL certificate
361
+ # authority files for verifying peer certificates. If you do
362
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
363
+ # system default will be used if available.
364
+ #
365
+ def initialize(*args)
366
+ super
367
+ end
368
+
369
+ # @!group API Operations
370
+
371
+ # Creates a new Elastic DocumentDB cluster and returns its Cluster
372
+ # structure.
373
+ #
374
+ # @option params [required, String] :admin_user_name
375
+ # The name of the Elastic DocumentDB cluster administrator.
376
+ #
377
+ # *Constraints*\:
378
+ #
379
+ # * Must be from 1 to 63 letters or numbers.
380
+ #
381
+ # * The first character must be a letter.
382
+ #
383
+ # * Cannot be a reserved word.
384
+ #
385
+ # @option params [required, String] :admin_user_password
386
+ # The password for the Elastic DocumentDB cluster administrator and can
387
+ # contain any printable ASCII characters.
388
+ #
389
+ # *Constraints*\:
390
+ #
391
+ # * Must contain from 8 to 100 characters.
392
+ #
393
+ # * Cannot contain a forward slash (/), double quote ("), or the "at"
394
+ # symbol (@).
395
+ #
396
+ # @option params [required, String] :auth_type
397
+ # The authentication type for the Elastic DocumentDB cluster.
398
+ #
399
+ # @option params [String] :client_token
400
+ # The client token for the Elastic DocumentDB cluster.
401
+ #
402
+ # **A suitable default value is auto-generated.** You should normally
403
+ # not need to pass this option.**
404
+ #
405
+ # @option params [required, String] :cluster_name
406
+ # The name of the new Elastic DocumentDB cluster. This parameter is
407
+ # stored as a lowercase string.
408
+ #
409
+ # *Constraints*\:
410
+ #
411
+ # * Must contain from 1 to 63 letters, numbers, or hyphens.
412
+ #
413
+ # * The first character must be a letter.
414
+ #
415
+ # * Cannot end with a hyphen or contain two consecutive hyphens.
416
+ #
417
+ # *Example*\: `my-cluster`
418
+ #
419
+ # @option params [String] :kms_key_id
420
+ # The KMS key identifier to use to encrypt the new Elastic DocumentDB
421
+ # cluster.
422
+ #
423
+ # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
424
+ # encryption key. If you are creating a cluster using the same Amazon
425
+ # account that owns this KMS encryption key, you can use the KMS key
426
+ # alias instead of the ARN as the KMS encryption key.
427
+ #
428
+ # If an encryption key is not specified, Elastic DocumentDB uses the
429
+ # default encryption key that KMS creates for your account. Your account
430
+ # has a different default encryption key for each Amazon Region.
431
+ #
432
+ # @option params [String] :preferred_maintenance_window
433
+ # The weekly time range during which system maintenance can occur, in
434
+ # Universal Coordinated Time (UTC).
435
+ #
436
+ # *Format*\: `ddd:hh24:mi-ddd:hh24:mi`
437
+ #
438
+ # *Default*\: a 30-minute window selected at random from an 8-hour block
439
+ # of time for each Amazon Web Services Region, occurring on a random day
440
+ # of the week.
441
+ #
442
+ # *Valid days*\: Mon, Tue, Wed, Thu, Fri, Sat, Sun
443
+ #
444
+ # *Constraints*\: Minimum 30-minute window.
445
+ #
446
+ # @option params [required, Integer] :shard_capacity
447
+ # The capacity of each shard in the new Elastic DocumentDB cluster.
448
+ #
449
+ # @option params [required, Integer] :shard_count
450
+ # The number of shards to create in the new Elastic DocumentDB cluster.
451
+ #
452
+ # @option params [Array<String>] :subnet_ids
453
+ # The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
454
+ #
455
+ # @option params [Hash<String,String>] :tags
456
+ # The tags to be assigned to the new Elastic DocumentDB cluster.
457
+ #
458
+ # @option params [Array<String>] :vpc_security_group_ids
459
+ # A list of EC2 VPC security groups to associate with the new Elastic
460
+ # DocumentDB cluster.
461
+ #
462
+ # @return [Types::CreateClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
463
+ #
464
+ # * {Types::CreateClusterOutput#cluster #cluster} => Types::Cluster
465
+ #
466
+ # @example Request syntax with placeholder values
467
+ #
468
+ # resp = client.create_cluster({
469
+ # admin_user_name: "String", # required
470
+ # admin_user_password: "Password", # required
471
+ # auth_type: "PLAIN_TEXT", # required, accepts PLAIN_TEXT, SECRET_ARN
472
+ # client_token: "String",
473
+ # cluster_name: "String", # required
474
+ # kms_key_id: "String",
475
+ # preferred_maintenance_window: "String",
476
+ # shard_capacity: 1, # required
477
+ # shard_count: 1, # required
478
+ # subnet_ids: ["String"],
479
+ # tags: {
480
+ # "TagKey" => "TagValue",
481
+ # },
482
+ # vpc_security_group_ids: ["String"],
483
+ # })
484
+ #
485
+ # @example Response structure
486
+ #
487
+ # resp.cluster.admin_user_name #=> String
488
+ # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
489
+ # resp.cluster.cluster_arn #=> String
490
+ # resp.cluster.cluster_endpoint #=> String
491
+ # resp.cluster.cluster_name #=> String
492
+ # resp.cluster.create_time #=> String
493
+ # resp.cluster.kms_key_id #=> String
494
+ # resp.cluster.preferred_maintenance_window #=> String
495
+ # resp.cluster.shard_capacity #=> Integer
496
+ # resp.cluster.shard_count #=> Integer
497
+ # 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"
498
+ # resp.cluster.subnet_ids #=> Array
499
+ # resp.cluster.subnet_ids[0] #=> String
500
+ # resp.cluster.vpc_security_group_ids #=> Array
501
+ # resp.cluster.vpc_security_group_ids[0] #=> String
502
+ #
503
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateCluster AWS API Documentation
504
+ #
505
+ # @overload create_cluster(params = {})
506
+ # @param [Hash] params ({})
507
+ def create_cluster(params = {}, options = {})
508
+ req = build_request(:create_cluster, params)
509
+ req.send_request(options)
510
+ end
511
+
512
+ # Creates a snapshot of a cluster.
513
+ #
514
+ # @option params [required, String] :cluster_arn
515
+ # The arn of the Elastic DocumentDB cluster that the snapshot will be
516
+ # taken from.
517
+ #
518
+ # @option params [required, String] :snapshot_name
519
+ # The name of the Elastic DocumentDB snapshot.
520
+ #
521
+ # @option params [Hash<String,String>] :tags
522
+ # The tags to be assigned to the new Elastic DocumentDB snapshot.
523
+ #
524
+ # @return [Types::CreateClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
525
+ #
526
+ # * {Types::CreateClusterSnapshotOutput#snapshot #snapshot} => Types::ClusterSnapshot
527
+ #
528
+ # @example Request syntax with placeholder values
529
+ #
530
+ # resp = client.create_cluster_snapshot({
531
+ # cluster_arn: "String", # required
532
+ # snapshot_name: "CreateClusterSnapshotInputSnapshotNameString", # required
533
+ # tags: {
534
+ # "TagKey" => "TagValue",
535
+ # },
536
+ # })
537
+ #
538
+ # @example Response structure
539
+ #
540
+ # resp.snapshot.admin_user_name #=> String
541
+ # resp.snapshot.cluster_arn #=> String
542
+ # resp.snapshot.cluster_creation_time #=> String
543
+ # resp.snapshot.kms_key_id #=> String
544
+ # resp.snapshot.snapshot_arn #=> String
545
+ # resp.snapshot.snapshot_creation_time #=> String
546
+ # resp.snapshot.snapshot_name #=> String
547
+ # 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"
548
+ # resp.snapshot.subnet_ids #=> Array
549
+ # resp.snapshot.subnet_ids[0] #=> String
550
+ # resp.snapshot.vpc_security_group_ids #=> Array
551
+ # resp.snapshot.vpc_security_group_ids[0] #=> String
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterSnapshot AWS API Documentation
554
+ #
555
+ # @overload create_cluster_snapshot(params = {})
556
+ # @param [Hash] params ({})
557
+ def create_cluster_snapshot(params = {}, options = {})
558
+ req = build_request(:create_cluster_snapshot, params)
559
+ req.send_request(options)
560
+ end
561
+
562
+ # Delete a Elastic DocumentDB cluster.
563
+ #
564
+ # @option params [required, String] :cluster_arn
565
+ # The arn of the Elastic DocumentDB cluster that is to be deleted.
566
+ #
567
+ # @return [Types::DeleteClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
568
+ #
569
+ # * {Types::DeleteClusterOutput#cluster #cluster} => Types::Cluster
570
+ #
571
+ # @example Request syntax with placeholder values
572
+ #
573
+ # resp = client.delete_cluster({
574
+ # cluster_arn: "String", # required
575
+ # })
576
+ #
577
+ # @example Response structure
578
+ #
579
+ # resp.cluster.admin_user_name #=> String
580
+ # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
581
+ # resp.cluster.cluster_arn #=> String
582
+ # resp.cluster.cluster_endpoint #=> String
583
+ # resp.cluster.cluster_name #=> String
584
+ # resp.cluster.create_time #=> String
585
+ # resp.cluster.kms_key_id #=> String
586
+ # resp.cluster.preferred_maintenance_window #=> String
587
+ # resp.cluster.shard_capacity #=> Integer
588
+ # resp.cluster.shard_count #=> Integer
589
+ # 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"
590
+ # resp.cluster.subnet_ids #=> Array
591
+ # resp.cluster.subnet_ids[0] #=> String
592
+ # resp.cluster.vpc_security_group_ids #=> Array
593
+ # resp.cluster.vpc_security_group_ids[0] #=> String
594
+ #
595
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteCluster AWS API Documentation
596
+ #
597
+ # @overload delete_cluster(params = {})
598
+ # @param [Hash] params ({})
599
+ def delete_cluster(params = {}, options = {})
600
+ req = build_request(:delete_cluster, params)
601
+ req.send_request(options)
602
+ end
603
+
604
+ # Delete a Elastic DocumentDB snapshot.
605
+ #
606
+ # @option params [required, String] :snapshot_arn
607
+ # The arn of the Elastic DocumentDB snapshot that is to be deleted.
608
+ #
609
+ # @return [Types::DeleteClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
610
+ #
611
+ # * {Types::DeleteClusterSnapshotOutput#snapshot #snapshot} => Types::ClusterSnapshot
612
+ #
613
+ # @example Request syntax with placeholder values
614
+ #
615
+ # resp = client.delete_cluster_snapshot({
616
+ # snapshot_arn: "String", # required
617
+ # })
618
+ #
619
+ # @example Response structure
620
+ #
621
+ # resp.snapshot.admin_user_name #=> String
622
+ # resp.snapshot.cluster_arn #=> String
623
+ # resp.snapshot.cluster_creation_time #=> String
624
+ # resp.snapshot.kms_key_id #=> String
625
+ # resp.snapshot.snapshot_arn #=> String
626
+ # resp.snapshot.snapshot_creation_time #=> String
627
+ # resp.snapshot.snapshot_name #=> String
628
+ # 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"
629
+ # resp.snapshot.subnet_ids #=> Array
630
+ # resp.snapshot.subnet_ids[0] #=> String
631
+ # resp.snapshot.vpc_security_group_ids #=> Array
632
+ # resp.snapshot.vpc_security_group_ids[0] #=> String
633
+ #
634
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteClusterSnapshot AWS API Documentation
635
+ #
636
+ # @overload delete_cluster_snapshot(params = {})
637
+ # @param [Hash] params ({})
638
+ def delete_cluster_snapshot(params = {}, options = {})
639
+ req = build_request(:delete_cluster_snapshot, params)
640
+ req.send_request(options)
641
+ end
642
+
643
+ # Returns information about a specific Elastic DocumentDB cluster.
644
+ #
645
+ # @option params [required, String] :cluster_arn
646
+ # The arn of the Elastic DocumentDB cluster.
647
+ #
648
+ # @return [Types::GetClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
649
+ #
650
+ # * {Types::GetClusterOutput#cluster #cluster} => Types::Cluster
651
+ #
652
+ # @example Request syntax with placeholder values
653
+ #
654
+ # resp = client.get_cluster({
655
+ # cluster_arn: "String", # required
656
+ # })
657
+ #
658
+ # @example Response structure
659
+ #
660
+ # resp.cluster.admin_user_name #=> String
661
+ # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
662
+ # resp.cluster.cluster_arn #=> String
663
+ # resp.cluster.cluster_endpoint #=> String
664
+ # resp.cluster.cluster_name #=> String
665
+ # resp.cluster.create_time #=> String
666
+ # resp.cluster.kms_key_id #=> String
667
+ # resp.cluster.preferred_maintenance_window #=> String
668
+ # resp.cluster.shard_capacity #=> Integer
669
+ # resp.cluster.shard_count #=> Integer
670
+ # 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"
671
+ # resp.cluster.subnet_ids #=> Array
672
+ # resp.cluster.subnet_ids[0] #=> String
673
+ # resp.cluster.vpc_security_group_ids #=> Array
674
+ # resp.cluster.vpc_security_group_ids[0] #=> String
675
+ #
676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetCluster AWS API Documentation
677
+ #
678
+ # @overload get_cluster(params = {})
679
+ # @param [Hash] params ({})
680
+ def get_cluster(params = {}, options = {})
681
+ req = build_request(:get_cluster, params)
682
+ req.send_request(options)
683
+ end
684
+
685
+ # Returns information about a specific Elastic DocumentDB snapshot
686
+ #
687
+ # @option params [required, String] :snapshot_arn
688
+ # The arn of the Elastic DocumentDB snapshot.
689
+ #
690
+ # @return [Types::GetClusterSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
691
+ #
692
+ # * {Types::GetClusterSnapshotOutput#snapshot #snapshot} => Types::ClusterSnapshot
693
+ #
694
+ # @example Request syntax with placeholder values
695
+ #
696
+ # resp = client.get_cluster_snapshot({
697
+ # snapshot_arn: "String", # required
698
+ # })
699
+ #
700
+ # @example Response structure
701
+ #
702
+ # resp.snapshot.admin_user_name #=> String
703
+ # resp.snapshot.cluster_arn #=> String
704
+ # resp.snapshot.cluster_creation_time #=> String
705
+ # resp.snapshot.kms_key_id #=> String
706
+ # resp.snapshot.snapshot_arn #=> String
707
+ # resp.snapshot.snapshot_creation_time #=> String
708
+ # resp.snapshot.snapshot_name #=> String
709
+ # 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"
710
+ # resp.snapshot.subnet_ids #=> Array
711
+ # resp.snapshot.subnet_ids[0] #=> String
712
+ # resp.snapshot.vpc_security_group_ids #=> Array
713
+ # resp.snapshot.vpc_security_group_ids[0] #=> String
714
+ #
715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterSnapshot AWS API Documentation
716
+ #
717
+ # @overload get_cluster_snapshot(params = {})
718
+ # @param [Hash] params ({})
719
+ def get_cluster_snapshot(params = {}, options = {})
720
+ req = build_request(:get_cluster_snapshot, params)
721
+ req.send_request(options)
722
+ end
723
+
724
+ # Returns information about Elastic DocumentDB snapshots for a specified
725
+ # cluster.
726
+ #
727
+ # @option params [String] :cluster_arn
728
+ # The arn of the Elastic DocumentDB cluster.
729
+ #
730
+ # @option params [Integer] :max_results
731
+ # The maximum number of entries to recieve in the response.
732
+ #
733
+ # @option params [String] :next_token
734
+ # The nextToken which is used the get the next page of data.
735
+ #
736
+ # @return [Types::ListClusterSnapshotsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
737
+ #
738
+ # * {Types::ListClusterSnapshotsOutput#next_token #next_token} => String
739
+ # * {Types::ListClusterSnapshotsOutput#snapshots #snapshots} => Array&lt;Types::ClusterSnapshotInList&gt;
740
+ #
741
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
742
+ #
743
+ # @example Request syntax with placeholder values
744
+ #
745
+ # resp = client.list_cluster_snapshots({
746
+ # cluster_arn: "String",
747
+ # max_results: 1,
748
+ # next_token: "PaginationToken",
749
+ # })
750
+ #
751
+ # @example Response structure
752
+ #
753
+ # resp.next_token #=> String
754
+ # resp.snapshots #=> Array
755
+ # resp.snapshots[0].cluster_arn #=> String
756
+ # resp.snapshots[0].snapshot_arn #=> String
757
+ # resp.snapshots[0].snapshot_creation_time #=> String
758
+ # resp.snapshots[0].snapshot_name #=> String
759
+ # 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"
760
+ #
761
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusterSnapshots AWS API Documentation
762
+ #
763
+ # @overload list_cluster_snapshots(params = {})
764
+ # @param [Hash] params ({})
765
+ def list_cluster_snapshots(params = {}, options = {})
766
+ req = build_request(:list_cluster_snapshots, params)
767
+ req.send_request(options)
768
+ end
769
+
770
+ # Returns information about provisioned Elastic DocumentDB clusters.
771
+ #
772
+ # @option params [Integer] :max_results
773
+ # The maximum number of entries to recieve in the response.
774
+ #
775
+ # @option params [String] :next_token
776
+ # The nextToken which is used the get the next page of data.
777
+ #
778
+ # @return [Types::ListClustersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
779
+ #
780
+ # * {Types::ListClustersOutput#clusters #clusters} => Array&lt;Types::ClusterInList&gt;
781
+ # * {Types::ListClustersOutput#next_token #next_token} => String
782
+ #
783
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
784
+ #
785
+ # @example Request syntax with placeholder values
786
+ #
787
+ # resp = client.list_clusters({
788
+ # max_results: 1,
789
+ # next_token: "PaginationToken",
790
+ # })
791
+ #
792
+ # @example Response structure
793
+ #
794
+ # resp.clusters #=> Array
795
+ # resp.clusters[0].cluster_arn #=> String
796
+ # resp.clusters[0].cluster_name #=> String
797
+ # 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"
798
+ # resp.next_token #=> String
799
+ #
800
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusters AWS API Documentation
801
+ #
802
+ # @overload list_clusters(params = {})
803
+ # @param [Hash] params ({})
804
+ def list_clusters(params = {}, options = {})
805
+ req = build_request(:list_clusters, params)
806
+ req.send_request(options)
807
+ end
808
+
809
+ # Lists all tags on a Elastic DocumentDB resource
810
+ #
811
+ # @option params [required, String] :resource_arn
812
+ # The arn of the Elastic DocumentDB resource.
813
+ #
814
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
815
+ #
816
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
817
+ #
818
+ # @example Request syntax with placeholder values
819
+ #
820
+ # resp = client.list_tags_for_resource({
821
+ # resource_arn: "Arn", # required
822
+ # })
823
+ #
824
+ # @example Response structure
825
+ #
826
+ # resp.tags #=> Hash
827
+ # resp.tags["TagKey"] #=> String
828
+ #
829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListTagsForResource AWS API Documentation
830
+ #
831
+ # @overload list_tags_for_resource(params = {})
832
+ # @param [Hash] params ({})
833
+ def list_tags_for_resource(params = {}, options = {})
834
+ req = build_request(:list_tags_for_resource, params)
835
+ req.send_request(options)
836
+ end
837
+
838
+ # Restores a Elastic DocumentDB cluster from a snapshot.
839
+ #
840
+ # @option params [required, String] :cluster_name
841
+ # The name of the Elastic DocumentDB cluster.
842
+ #
843
+ # @option params [String] :kms_key_id
844
+ # The KMS key identifier to use to encrypt the new Elastic DocumentDB
845
+ # cluster.
846
+ #
847
+ # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
848
+ # encryption key. If you are creating a cluster using the same Amazon
849
+ # account that owns this KMS encryption key, you can use the KMS key
850
+ # alias instead of the ARN as the KMS encryption key.
851
+ #
852
+ # If an encryption key is not specified here, Elastic DocumentDB uses
853
+ # the default encryption key that KMS creates for your account. Your
854
+ # account has a different default encryption key for each Amazon Region.
855
+ #
856
+ # @option params [required, String] :snapshot_arn
857
+ # The arn of the Elastic DocumentDB snapshot.
858
+ #
859
+ # @option params [Array<String>] :subnet_ids
860
+ # The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
861
+ #
862
+ # @option params [Hash<String,String>] :tags
863
+ # A list of the tag names to be assigned to the restored DB cluster, in
864
+ # the form of an array of key-value pairs in which the key is the tag
865
+ # name and the value is the key value.
866
+ #
867
+ # @option params [Array<String>] :vpc_security_group_ids
868
+ # A list of EC2 VPC security groups to associate with the Elastic
869
+ # DocumentDB cluster.
870
+ #
871
+ # @return [Types::RestoreClusterFromSnapshotOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
872
+ #
873
+ # * {Types::RestoreClusterFromSnapshotOutput#cluster #cluster} => Types::Cluster
874
+ #
875
+ # @example Request syntax with placeholder values
876
+ #
877
+ # resp = client.restore_cluster_from_snapshot({
878
+ # cluster_name: "String", # required
879
+ # kms_key_id: "String",
880
+ # snapshot_arn: "String", # required
881
+ # subnet_ids: ["String"],
882
+ # tags: {
883
+ # "TagKey" => "TagValue",
884
+ # },
885
+ # vpc_security_group_ids: ["String"],
886
+ # })
887
+ #
888
+ # @example Response structure
889
+ #
890
+ # resp.cluster.admin_user_name #=> String
891
+ # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
892
+ # resp.cluster.cluster_arn #=> String
893
+ # resp.cluster.cluster_endpoint #=> String
894
+ # resp.cluster.cluster_name #=> String
895
+ # resp.cluster.create_time #=> String
896
+ # resp.cluster.kms_key_id #=> String
897
+ # resp.cluster.preferred_maintenance_window #=> String
898
+ # resp.cluster.shard_capacity #=> Integer
899
+ # resp.cluster.shard_count #=> Integer
900
+ # 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"
901
+ # resp.cluster.subnet_ids #=> Array
902
+ # resp.cluster.subnet_ids[0] #=> String
903
+ # resp.cluster.vpc_security_group_ids #=> Array
904
+ # resp.cluster.vpc_security_group_ids[0] #=> String
905
+ #
906
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot AWS API Documentation
907
+ #
908
+ # @overload restore_cluster_from_snapshot(params = {})
909
+ # @param [Hash] params ({})
910
+ def restore_cluster_from_snapshot(params = {}, options = {})
911
+ req = build_request(:restore_cluster_from_snapshot, params)
912
+ req.send_request(options)
913
+ end
914
+
915
+ # Adds metadata tags to a Elastic DocumentDB resource
916
+ #
917
+ # @option params [required, String] :resource_arn
918
+ # The arn of the Elastic DocumentDB resource.
919
+ #
920
+ # @option params [required, Hash<String,String>] :tags
921
+ # The tags to be assigned to the Elastic DocumentDB resource.
922
+ #
923
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
924
+ #
925
+ # @example Request syntax with placeholder values
926
+ #
927
+ # resp = client.tag_resource({
928
+ # resource_arn: "Arn", # required
929
+ # tags: { # required
930
+ # "TagKey" => "TagValue",
931
+ # },
932
+ # })
933
+ #
934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/TagResource AWS API Documentation
935
+ #
936
+ # @overload tag_resource(params = {})
937
+ # @param [Hash] params ({})
938
+ def tag_resource(params = {}, options = {})
939
+ req = build_request(:tag_resource, params)
940
+ req.send_request(options)
941
+ end
942
+
943
+ # Removes metadata tags to a Elastic DocumentDB resource
944
+ #
945
+ # @option params [required, String] :resource_arn
946
+ # The arn of the Elastic DocumentDB resource.
947
+ #
948
+ # @option params [required, Array<String>] :tag_keys
949
+ # The tag keys to be removed from the Elastic DocumentDB resource.
950
+ #
951
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
952
+ #
953
+ # @example Request syntax with placeholder values
954
+ #
955
+ # resp = client.untag_resource({
956
+ # resource_arn: "Arn", # required
957
+ # tag_keys: ["TagKey"], # required
958
+ # })
959
+ #
960
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UntagResource AWS API Documentation
961
+ #
962
+ # @overload untag_resource(params = {})
963
+ # @param [Hash] params ({})
964
+ def untag_resource(params = {}, options = {})
965
+ req = build_request(:untag_resource, params)
966
+ req.send_request(options)
967
+ end
968
+
969
+ # Modifies a Elastic DocumentDB cluster. This includes updating
970
+ # admin-username/password, upgrading API version setting up a backup
971
+ # window and maintenance window
972
+ #
973
+ # @option params [String] :admin_user_password
974
+ # The password for the Elastic DocumentDB cluster administrator. This
975
+ # password can contain any printable ASCII character except forward
976
+ # slash (/), double quote ("), or the "at" symbol (@).
977
+ #
978
+ # *Constraints*\: Must contain from 8 to 100 characters.
979
+ #
980
+ # @option params [String] :auth_type
981
+ # The authentication type for the Elastic DocumentDB cluster.
982
+ #
983
+ # @option params [String] :client_token
984
+ # The client token for the Elastic DocumentDB cluster.
985
+ #
986
+ # **A suitable default value is auto-generated.** You should normally
987
+ # not need to pass this option.**
988
+ #
989
+ # @option params [required, String] :cluster_arn
990
+ # The arn of the Elastic DocumentDB cluster.
991
+ #
992
+ # @option params [String] :preferred_maintenance_window
993
+ # The weekly time range during which system maintenance can occur, in
994
+ # Universal Coordinated Time (UTC).
995
+ #
996
+ # *Format*\: `ddd:hh24:mi-ddd:hh24:mi`
997
+ #
998
+ # *Default*\: a 30-minute window selected at random from an 8-hour block
999
+ # of time for each Amazon Web Services Region, occurring on a random day
1000
+ # of the week.
1001
+ #
1002
+ # *Valid days*\: Mon, Tue, Wed, Thu, Fri, Sat, Sun
1003
+ #
1004
+ # *Constraints*\: Minimum 30-minute window.
1005
+ #
1006
+ # @option params [Integer] :shard_capacity
1007
+ # The capacity of each shard in the Elastic DocumentDB cluster.
1008
+ #
1009
+ # @option params [Integer] :shard_count
1010
+ # The number of shards to create in the Elastic DocumentDB cluster.
1011
+ #
1012
+ # @option params [Array<String>] :subnet_ids
1013
+ # The number of shards to create in the Elastic DocumentDB cluster.
1014
+ #
1015
+ # @option params [Array<String>] :vpc_security_group_ids
1016
+ # A list of EC2 VPC security groups to associate with the new Elastic
1017
+ # DocumentDB cluster.
1018
+ #
1019
+ # @return [Types::UpdateClusterOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1020
+ #
1021
+ # * {Types::UpdateClusterOutput#cluster #cluster} => Types::Cluster
1022
+ #
1023
+ # @example Request syntax with placeholder values
1024
+ #
1025
+ # resp = client.update_cluster({
1026
+ # admin_user_password: "Password",
1027
+ # auth_type: "PLAIN_TEXT", # accepts PLAIN_TEXT, SECRET_ARN
1028
+ # client_token: "String",
1029
+ # cluster_arn: "String", # required
1030
+ # preferred_maintenance_window: "String",
1031
+ # shard_capacity: 1,
1032
+ # shard_count: 1,
1033
+ # subnet_ids: ["String"],
1034
+ # vpc_security_group_ids: ["String"],
1035
+ # })
1036
+ #
1037
+ # @example Response structure
1038
+ #
1039
+ # resp.cluster.admin_user_name #=> String
1040
+ # resp.cluster.auth_type #=> String, one of "PLAIN_TEXT", "SECRET_ARN"
1041
+ # resp.cluster.cluster_arn #=> String
1042
+ # resp.cluster.cluster_endpoint #=> String
1043
+ # resp.cluster.cluster_name #=> String
1044
+ # resp.cluster.create_time #=> String
1045
+ # resp.cluster.kms_key_id #=> String
1046
+ # resp.cluster.preferred_maintenance_window #=> String
1047
+ # resp.cluster.shard_capacity #=> Integer
1048
+ # resp.cluster.shard_count #=> Integer
1049
+ # 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"
1050
+ # resp.cluster.subnet_ids #=> Array
1051
+ # resp.cluster.subnet_ids[0] #=> String
1052
+ # resp.cluster.vpc_security_group_ids #=> Array
1053
+ # resp.cluster.vpc_security_group_ids[0] #=> String
1054
+ #
1055
+ # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UpdateCluster AWS API Documentation
1056
+ #
1057
+ # @overload update_cluster(params = {})
1058
+ # @param [Hash] params ({})
1059
+ def update_cluster(params = {}, options = {})
1060
+ req = build_request(:update_cluster, params)
1061
+ req.send_request(options)
1062
+ end
1063
+
1064
+ # @!endgroup
1065
+
1066
+ # @param params ({})
1067
+ # @api private
1068
+ def build_request(operation_name, params = {})
1069
+ handlers = @handlers.for(operation_name)
1070
+ context = Seahorse::Client::RequestContext.new(
1071
+ operation_name: operation_name,
1072
+ operation: config.api.operation(operation_name),
1073
+ client: self,
1074
+ params: params,
1075
+ config: config)
1076
+ context[:gem_name] = 'aws-sdk-docdbelastic'
1077
+ context[:gem_version] = '1.0.0'
1078
+ Seahorse::Client::Request.new(handlers, context)
1079
+ end
1080
+
1081
+ # @api private
1082
+ # @deprecated
1083
+ def waiter_names
1084
+ []
1085
+ end
1086
+
1087
+ class << self
1088
+
1089
+ # @api private
1090
+ attr_reader :identifier
1091
+
1092
+ # @api private
1093
+ def errors_module
1094
+ Errors
1095
+ end
1096
+
1097
+ end
1098
+ end
1099
+ end