aws-sdk-docdbelastic 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-docdbelastic/client.rb +1099 -0
- data/lib/aws-sdk-docdbelastic/client_api.rb +472 -0
- data/lib/aws-sdk-docdbelastic/customizations.rb +0 -0
- data/lib/aws-sdk-docdbelastic/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-docdbelastic/endpoint_provider.rb +111 -0
- data/lib/aws-sdk-docdbelastic/endpoints.rb +197 -0
- data/lib/aws-sdk-docdbelastic/errors.rb +193 -0
- data/lib/aws-sdk-docdbelastic/plugins/endpoints.rb +94 -0
- data/lib/aws-sdk-docdbelastic/resource.rb +26 -0
- data/lib/aws-sdk-docdbelastic/types.rb +927 -0
- data/lib/aws-sdk-docdbelastic.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,927 @@
|
|
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
|
+
module Aws::DocDBElastic
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# An exception that occurs when there are not sufficient permissions to
|
14
|
+
# perform an action.
|
15
|
+
#
|
16
|
+
# @!attribute [rw] message
|
17
|
+
# An error message explaining why access was denied.
|
18
|
+
# @return [String]
|
19
|
+
#
|
20
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/AccessDeniedException AWS API Documentation
|
21
|
+
#
|
22
|
+
class AccessDeniedException < Struct.new(
|
23
|
+
:message)
|
24
|
+
SENSITIVE = []
|
25
|
+
include Aws::Structure
|
26
|
+
end
|
27
|
+
|
28
|
+
# Returns information about a specific Elastic DocumentDB cluster.
|
29
|
+
#
|
30
|
+
# @!attribute [rw] admin_user_name
|
31
|
+
# The name of the Elastic DocumentDB cluster administrator.
|
32
|
+
# @return [String]
|
33
|
+
#
|
34
|
+
# @!attribute [rw] auth_type
|
35
|
+
# The authentication type for the Elastic DocumentDB cluster.
|
36
|
+
# @return [String]
|
37
|
+
#
|
38
|
+
# @!attribute [rw] cluster_arn
|
39
|
+
# The arn of the Elastic DocumentDB cluster.
|
40
|
+
# @return [String]
|
41
|
+
#
|
42
|
+
# @!attribute [rw] cluster_endpoint
|
43
|
+
# The URL used to connect to the Elastic DocumentDB cluster.
|
44
|
+
# @return [String]
|
45
|
+
#
|
46
|
+
# @!attribute [rw] cluster_name
|
47
|
+
# The name of the Elastic DocumentDB cluster.
|
48
|
+
# @return [String]
|
49
|
+
#
|
50
|
+
# @!attribute [rw] create_time
|
51
|
+
# The time when the Elastic DocumentDB cluster was created in
|
52
|
+
# Universal Coordinated Time (UTC).
|
53
|
+
# @return [String]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] kms_key_id
|
56
|
+
# The KMS key identifier to use to encrypt the Elastic DocumentDB
|
57
|
+
# cluster.
|
58
|
+
# @return [String]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] preferred_maintenance_window
|
61
|
+
# The weekly time range during which system maintenance can occur, in
|
62
|
+
# Universal Coordinated Time (UTC).
|
63
|
+
#
|
64
|
+
# *Format*\: `ddd:hh24:mi-ddd:hh24:mi`
|
65
|
+
# @return [String]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] shard_capacity
|
68
|
+
# The capacity of each shard in the Elastic DocumentDB cluster.
|
69
|
+
# @return [Integer]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] shard_count
|
72
|
+
# The number of shards in the Elastic DocumentDB cluster.
|
73
|
+
# @return [Integer]
|
74
|
+
#
|
75
|
+
# @!attribute [rw] status
|
76
|
+
# The status of the Elastic DocumentDB cluster.
|
77
|
+
# @return [String]
|
78
|
+
#
|
79
|
+
# @!attribute [rw] subnet_ids
|
80
|
+
# The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
|
81
|
+
# @return [Array<String>]
|
82
|
+
#
|
83
|
+
# @!attribute [rw] vpc_security_group_ids
|
84
|
+
# A list of EC2 VPC security groups associated with this cluster.
|
85
|
+
# @return [Array<String>]
|
86
|
+
#
|
87
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/Cluster AWS API Documentation
|
88
|
+
#
|
89
|
+
class Cluster < Struct.new(
|
90
|
+
:admin_user_name,
|
91
|
+
:auth_type,
|
92
|
+
:cluster_arn,
|
93
|
+
:cluster_endpoint,
|
94
|
+
:cluster_name,
|
95
|
+
:create_time,
|
96
|
+
:kms_key_id,
|
97
|
+
:preferred_maintenance_window,
|
98
|
+
:shard_capacity,
|
99
|
+
:shard_count,
|
100
|
+
:status,
|
101
|
+
:subnet_ids,
|
102
|
+
:vpc_security_group_ids)
|
103
|
+
SENSITIVE = []
|
104
|
+
include Aws::Structure
|
105
|
+
end
|
106
|
+
|
107
|
+
# A list of Elastic DocumentDB cluster.
|
108
|
+
#
|
109
|
+
# @!attribute [rw] cluster_arn
|
110
|
+
# The arn of the Elastic DocumentDB cluster.
|
111
|
+
# @return [String]
|
112
|
+
#
|
113
|
+
# @!attribute [rw] cluster_name
|
114
|
+
# The name of the Elastic DocumentDB cluster.
|
115
|
+
# @return [String]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] status
|
118
|
+
# The status of the Elastic DocumentDB cluster.
|
119
|
+
# @return [String]
|
120
|
+
#
|
121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ClusterInList AWS API Documentation
|
122
|
+
#
|
123
|
+
class ClusterInList < Struct.new(
|
124
|
+
:cluster_arn,
|
125
|
+
:cluster_name,
|
126
|
+
:status)
|
127
|
+
SENSITIVE = []
|
128
|
+
include Aws::Structure
|
129
|
+
end
|
130
|
+
|
131
|
+
# Returns information about a specific Elastic DocumentDB snapshot.
|
132
|
+
#
|
133
|
+
# @!attribute [rw] admin_user_name
|
134
|
+
# The name of the Elastic DocumentDB cluster administrator.
|
135
|
+
# @return [String]
|
136
|
+
#
|
137
|
+
# @!attribute [rw] cluster_arn
|
138
|
+
# The arn of the Elastic DocumentDB cluster.
|
139
|
+
# @return [String]
|
140
|
+
#
|
141
|
+
# @!attribute [rw] cluster_creation_time
|
142
|
+
# The time when the Elastic DocumentDB cluster was created in
|
143
|
+
# Universal Coordinated Time (UTC).
|
144
|
+
# @return [String]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] kms_key_id
|
147
|
+
# The KMS key identifier to use to encrypt the Elastic DocumentDB
|
148
|
+
# cluster.
|
149
|
+
# @return [String]
|
150
|
+
#
|
151
|
+
# @!attribute [rw] snapshot_arn
|
152
|
+
# The arn of the Elastic DocumentDB snapshot
|
153
|
+
# @return [String]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] snapshot_creation_time
|
156
|
+
# The time when the Elastic DocumentDB snapshot was created in
|
157
|
+
# Universal Coordinated Time (UTC).
|
158
|
+
# @return [String]
|
159
|
+
#
|
160
|
+
# @!attribute [rw] snapshot_name
|
161
|
+
# The name of the Elastic DocumentDB snapshot.
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] status
|
165
|
+
# The status of the Elastic DocumentDB snapshot.
|
166
|
+
# @return [String]
|
167
|
+
#
|
168
|
+
# @!attribute [rw] subnet_ids
|
169
|
+
# A list of the IDs of subnets associated with the DB cluster
|
170
|
+
# snapshot.
|
171
|
+
# @return [Array<String>]
|
172
|
+
#
|
173
|
+
# @!attribute [rw] vpc_security_group_ids
|
174
|
+
# A list of the IDs of the VPC security groups associated with the
|
175
|
+
# cluster snapshot.
|
176
|
+
# @return [Array<String>]
|
177
|
+
#
|
178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ClusterSnapshot AWS API Documentation
|
179
|
+
#
|
180
|
+
class ClusterSnapshot < Struct.new(
|
181
|
+
:admin_user_name,
|
182
|
+
:cluster_arn,
|
183
|
+
:cluster_creation_time,
|
184
|
+
:kms_key_id,
|
185
|
+
:snapshot_arn,
|
186
|
+
:snapshot_creation_time,
|
187
|
+
:snapshot_name,
|
188
|
+
:status,
|
189
|
+
:subnet_ids,
|
190
|
+
:vpc_security_group_ids)
|
191
|
+
SENSITIVE = []
|
192
|
+
include Aws::Structure
|
193
|
+
end
|
194
|
+
|
195
|
+
# A list of Elastic DocumentDB snapshots.
|
196
|
+
#
|
197
|
+
# @!attribute [rw] cluster_arn
|
198
|
+
# The arn of the Elastic DocumentDB cluster.
|
199
|
+
# @return [String]
|
200
|
+
#
|
201
|
+
# @!attribute [rw] snapshot_arn
|
202
|
+
# The arn of the Elastic DocumentDB snapshot
|
203
|
+
# @return [String]
|
204
|
+
#
|
205
|
+
# @!attribute [rw] snapshot_creation_time
|
206
|
+
# The time when the Elastic DocumentDB snapshot was created in
|
207
|
+
# Universal Coordinated Time (UTC).
|
208
|
+
# @return [String]
|
209
|
+
#
|
210
|
+
# @!attribute [rw] snapshot_name
|
211
|
+
# The name of the Elastic DocumentDB snapshot.
|
212
|
+
# @return [String]
|
213
|
+
#
|
214
|
+
# @!attribute [rw] status
|
215
|
+
# The status of the Elastic DocumentDB snapshot.
|
216
|
+
# @return [String]
|
217
|
+
#
|
218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ClusterSnapshotInList AWS API Documentation
|
219
|
+
#
|
220
|
+
class ClusterSnapshotInList < Struct.new(
|
221
|
+
:cluster_arn,
|
222
|
+
:snapshot_arn,
|
223
|
+
:snapshot_creation_time,
|
224
|
+
:snapshot_name,
|
225
|
+
:status)
|
226
|
+
SENSITIVE = []
|
227
|
+
include Aws::Structure
|
228
|
+
end
|
229
|
+
|
230
|
+
# There was an access conflict.
|
231
|
+
#
|
232
|
+
# @!attribute [rw] message
|
233
|
+
# @return [String]
|
234
|
+
#
|
235
|
+
# @!attribute [rw] resource_id
|
236
|
+
# The ID of the resource where there was an access conflict.
|
237
|
+
# @return [String]
|
238
|
+
#
|
239
|
+
# @!attribute [rw] resource_type
|
240
|
+
# The type of the resource where there was an access conflict.
|
241
|
+
# @return [String]
|
242
|
+
#
|
243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ConflictException AWS API Documentation
|
244
|
+
#
|
245
|
+
class ConflictException < Struct.new(
|
246
|
+
:message,
|
247
|
+
:resource_id,
|
248
|
+
:resource_type)
|
249
|
+
SENSITIVE = []
|
250
|
+
include Aws::Structure
|
251
|
+
end
|
252
|
+
|
253
|
+
# @!attribute [rw] admin_user_name
|
254
|
+
# The name of the Elastic DocumentDB cluster administrator.
|
255
|
+
#
|
256
|
+
# *Constraints*\:
|
257
|
+
#
|
258
|
+
# * Must be from 1 to 63 letters or numbers.
|
259
|
+
#
|
260
|
+
# * The first character must be a letter.
|
261
|
+
#
|
262
|
+
# * Cannot be a reserved word.
|
263
|
+
# @return [String]
|
264
|
+
#
|
265
|
+
# @!attribute [rw] admin_user_password
|
266
|
+
# The password for the Elastic DocumentDB cluster administrator and
|
267
|
+
# can contain any printable ASCII characters.
|
268
|
+
#
|
269
|
+
# *Constraints*\:
|
270
|
+
#
|
271
|
+
# * Must contain from 8 to 100 characters.
|
272
|
+
#
|
273
|
+
# * Cannot contain a forward slash (/), double quote ("), or the
|
274
|
+
# "at" symbol (@).
|
275
|
+
# @return [String]
|
276
|
+
#
|
277
|
+
# @!attribute [rw] auth_type
|
278
|
+
# The authentication type for the Elastic DocumentDB cluster.
|
279
|
+
# @return [String]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] client_token
|
282
|
+
# The client token for the Elastic DocumentDB cluster.
|
283
|
+
#
|
284
|
+
# **A suitable default value is auto-generated.** You should normally
|
285
|
+
# not need to pass this option.
|
286
|
+
# @return [String]
|
287
|
+
#
|
288
|
+
# @!attribute [rw] cluster_name
|
289
|
+
# The name of the new Elastic DocumentDB cluster. This parameter is
|
290
|
+
# stored as a lowercase string.
|
291
|
+
#
|
292
|
+
# *Constraints*\:
|
293
|
+
#
|
294
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
295
|
+
#
|
296
|
+
# * The first character must be a letter.
|
297
|
+
#
|
298
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
299
|
+
#
|
300
|
+
# *Example*\: `my-cluster`
|
301
|
+
# @return [String]
|
302
|
+
#
|
303
|
+
# @!attribute [rw] kms_key_id
|
304
|
+
# The KMS key identifier to use to encrypt the new Elastic DocumentDB
|
305
|
+
# cluster.
|
306
|
+
#
|
307
|
+
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
308
|
+
# encryption key. If you are creating a cluster using the same Amazon
|
309
|
+
# account that owns this KMS encryption key, you can use the KMS key
|
310
|
+
# alias instead of the ARN as the KMS encryption key.
|
311
|
+
#
|
312
|
+
# If an encryption key is not specified, Elastic DocumentDB uses the
|
313
|
+
# default encryption key that KMS creates for your account. Your
|
314
|
+
# account has a different default encryption key for each Amazon
|
315
|
+
# Region.
|
316
|
+
# @return [String]
|
317
|
+
#
|
318
|
+
# @!attribute [rw] preferred_maintenance_window
|
319
|
+
# The weekly time range during which system maintenance can occur, in
|
320
|
+
# Universal Coordinated Time (UTC).
|
321
|
+
#
|
322
|
+
# *Format*\: `ddd:hh24:mi-ddd:hh24:mi`
|
323
|
+
#
|
324
|
+
# *Default*\: a 30-minute window selected at random from an 8-hour
|
325
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
326
|
+
# random day of the week.
|
327
|
+
#
|
328
|
+
# *Valid days*\: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
329
|
+
#
|
330
|
+
# *Constraints*\: Minimum 30-minute window.
|
331
|
+
# @return [String]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] shard_capacity
|
334
|
+
# The capacity of each shard in the new Elastic DocumentDB cluster.
|
335
|
+
# @return [Integer]
|
336
|
+
#
|
337
|
+
# @!attribute [rw] shard_count
|
338
|
+
# The number of shards to create in the new Elastic DocumentDB
|
339
|
+
# cluster.
|
340
|
+
# @return [Integer]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] subnet_ids
|
343
|
+
# The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
|
344
|
+
# @return [Array<String>]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] tags
|
347
|
+
# The tags to be assigned to the new Elastic DocumentDB cluster.
|
348
|
+
# @return [Hash<String,String>]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] vpc_security_group_ids
|
351
|
+
# A list of EC2 VPC security groups to associate with the new Elastic
|
352
|
+
# DocumentDB cluster.
|
353
|
+
# @return [Array<String>]
|
354
|
+
#
|
355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterInput AWS API Documentation
|
356
|
+
#
|
357
|
+
class CreateClusterInput < Struct.new(
|
358
|
+
:admin_user_name,
|
359
|
+
:admin_user_password,
|
360
|
+
:auth_type,
|
361
|
+
:client_token,
|
362
|
+
:cluster_name,
|
363
|
+
:kms_key_id,
|
364
|
+
:preferred_maintenance_window,
|
365
|
+
:shard_capacity,
|
366
|
+
:shard_count,
|
367
|
+
:subnet_ids,
|
368
|
+
:tags,
|
369
|
+
:vpc_security_group_ids)
|
370
|
+
SENSITIVE = [:admin_user_password]
|
371
|
+
include Aws::Structure
|
372
|
+
end
|
373
|
+
|
374
|
+
# @!attribute [rw] cluster
|
375
|
+
# The new Elastic DocumentDB cluster that has been created.
|
376
|
+
# @return [Types::Cluster]
|
377
|
+
#
|
378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterOutput AWS API Documentation
|
379
|
+
#
|
380
|
+
class CreateClusterOutput < Struct.new(
|
381
|
+
:cluster)
|
382
|
+
SENSITIVE = []
|
383
|
+
include Aws::Structure
|
384
|
+
end
|
385
|
+
|
386
|
+
# @!attribute [rw] cluster_arn
|
387
|
+
# The arn of the Elastic DocumentDB cluster that the snapshot will be
|
388
|
+
# taken from.
|
389
|
+
# @return [String]
|
390
|
+
#
|
391
|
+
# @!attribute [rw] snapshot_name
|
392
|
+
# The name of the Elastic DocumentDB snapshot.
|
393
|
+
# @return [String]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] tags
|
396
|
+
# The tags to be assigned to the new Elastic DocumentDB snapshot.
|
397
|
+
# @return [Hash<String,String>]
|
398
|
+
#
|
399
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterSnapshotInput AWS API Documentation
|
400
|
+
#
|
401
|
+
class CreateClusterSnapshotInput < Struct.new(
|
402
|
+
:cluster_arn,
|
403
|
+
:snapshot_name,
|
404
|
+
:tags)
|
405
|
+
SENSITIVE = []
|
406
|
+
include Aws::Structure
|
407
|
+
end
|
408
|
+
|
409
|
+
# @!attribute [rw] snapshot
|
410
|
+
# Returns information about the new Elastic DocumentDB snapshot.
|
411
|
+
# @return [Types::ClusterSnapshot]
|
412
|
+
#
|
413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterSnapshotOutput AWS API Documentation
|
414
|
+
#
|
415
|
+
class CreateClusterSnapshotOutput < Struct.new(
|
416
|
+
:snapshot)
|
417
|
+
SENSITIVE = []
|
418
|
+
include Aws::Structure
|
419
|
+
end
|
420
|
+
|
421
|
+
# @!attribute [rw] cluster_arn
|
422
|
+
# The arn of the Elastic DocumentDB cluster that is to be deleted.
|
423
|
+
# @return [String]
|
424
|
+
#
|
425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteClusterInput AWS API Documentation
|
426
|
+
#
|
427
|
+
class DeleteClusterInput < Struct.new(
|
428
|
+
:cluster_arn)
|
429
|
+
SENSITIVE = []
|
430
|
+
include Aws::Structure
|
431
|
+
end
|
432
|
+
|
433
|
+
# @!attribute [rw] cluster
|
434
|
+
# Returns information about the newly deleted Elastic DocumentDB
|
435
|
+
# cluster.
|
436
|
+
# @return [Types::Cluster]
|
437
|
+
#
|
438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteClusterOutput AWS API Documentation
|
439
|
+
#
|
440
|
+
class DeleteClusterOutput < Struct.new(
|
441
|
+
:cluster)
|
442
|
+
SENSITIVE = []
|
443
|
+
include Aws::Structure
|
444
|
+
end
|
445
|
+
|
446
|
+
# @!attribute [rw] snapshot_arn
|
447
|
+
# The arn of the Elastic DocumentDB snapshot that is to be deleted.
|
448
|
+
# @return [String]
|
449
|
+
#
|
450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteClusterSnapshotInput AWS API Documentation
|
451
|
+
#
|
452
|
+
class DeleteClusterSnapshotInput < Struct.new(
|
453
|
+
:snapshot_arn)
|
454
|
+
SENSITIVE = []
|
455
|
+
include Aws::Structure
|
456
|
+
end
|
457
|
+
|
458
|
+
# @!attribute [rw] snapshot
|
459
|
+
# Returns information about the newly deleted Elastic DocumentDB
|
460
|
+
# snapshot.
|
461
|
+
# @return [Types::ClusterSnapshot]
|
462
|
+
#
|
463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteClusterSnapshotOutput AWS API Documentation
|
464
|
+
#
|
465
|
+
class DeleteClusterSnapshotOutput < Struct.new(
|
466
|
+
:snapshot)
|
467
|
+
SENSITIVE = []
|
468
|
+
include Aws::Structure
|
469
|
+
end
|
470
|
+
|
471
|
+
# @!attribute [rw] cluster_arn
|
472
|
+
# The arn of the Elastic DocumentDB cluster.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterInput AWS API Documentation
|
476
|
+
#
|
477
|
+
class GetClusterInput < Struct.new(
|
478
|
+
:cluster_arn)
|
479
|
+
SENSITIVE = []
|
480
|
+
include Aws::Structure
|
481
|
+
end
|
482
|
+
|
483
|
+
# @!attribute [rw] cluster
|
484
|
+
# Returns information about a specific Elastic DocumentDB cluster.
|
485
|
+
# @return [Types::Cluster]
|
486
|
+
#
|
487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterOutput AWS API Documentation
|
488
|
+
#
|
489
|
+
class GetClusterOutput < Struct.new(
|
490
|
+
:cluster)
|
491
|
+
SENSITIVE = []
|
492
|
+
include Aws::Structure
|
493
|
+
end
|
494
|
+
|
495
|
+
# @!attribute [rw] snapshot_arn
|
496
|
+
# The arn of the Elastic DocumentDB snapshot.
|
497
|
+
# @return [String]
|
498
|
+
#
|
499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterSnapshotInput AWS API Documentation
|
500
|
+
#
|
501
|
+
class GetClusterSnapshotInput < Struct.new(
|
502
|
+
:snapshot_arn)
|
503
|
+
SENSITIVE = []
|
504
|
+
include Aws::Structure
|
505
|
+
end
|
506
|
+
|
507
|
+
# @!attribute [rw] snapshot
|
508
|
+
# Returns information about a specific Elastic DocumentDB snapshot.
|
509
|
+
# @return [Types::ClusterSnapshot]
|
510
|
+
#
|
511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterSnapshotOutput AWS API Documentation
|
512
|
+
#
|
513
|
+
class GetClusterSnapshotOutput < Struct.new(
|
514
|
+
:snapshot)
|
515
|
+
SENSITIVE = []
|
516
|
+
include Aws::Structure
|
517
|
+
end
|
518
|
+
|
519
|
+
# There was an internal server error.
|
520
|
+
#
|
521
|
+
# @!attribute [rw] message
|
522
|
+
# @return [String]
|
523
|
+
#
|
524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/InternalServerException AWS API Documentation
|
525
|
+
#
|
526
|
+
class InternalServerException < Struct.new(
|
527
|
+
:message)
|
528
|
+
SENSITIVE = []
|
529
|
+
include Aws::Structure
|
530
|
+
end
|
531
|
+
|
532
|
+
# @!attribute [rw] cluster_arn
|
533
|
+
# The arn of the Elastic DocumentDB cluster.
|
534
|
+
# @return [String]
|
535
|
+
#
|
536
|
+
# @!attribute [rw] max_results
|
537
|
+
# The maximum number of entries to recieve in the response.
|
538
|
+
# @return [Integer]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] next_token
|
541
|
+
# The nextToken which is used the get the next page of data.
|
542
|
+
# @return [String]
|
543
|
+
#
|
544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusterSnapshotsInput AWS API Documentation
|
545
|
+
#
|
546
|
+
class ListClusterSnapshotsInput < Struct.new(
|
547
|
+
:cluster_arn,
|
548
|
+
:max_results,
|
549
|
+
:next_token)
|
550
|
+
SENSITIVE = []
|
551
|
+
include Aws::Structure
|
552
|
+
end
|
553
|
+
|
554
|
+
# @!attribute [rw] next_token
|
555
|
+
# The response will provide a nextToken if there is more data beyond
|
556
|
+
# the maxResults.
|
557
|
+
#
|
558
|
+
# If there is no more data in the responce, the nextToken will not be
|
559
|
+
# returned.
|
560
|
+
# @return [String]
|
561
|
+
#
|
562
|
+
# @!attribute [rw] snapshots
|
563
|
+
# A list of Elastic DocumentDB snapshots for a specified cluster.
|
564
|
+
# @return [Array<Types::ClusterSnapshotInList>]
|
565
|
+
#
|
566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusterSnapshotsOutput AWS API Documentation
|
567
|
+
#
|
568
|
+
class ListClusterSnapshotsOutput < Struct.new(
|
569
|
+
:next_token,
|
570
|
+
:snapshots)
|
571
|
+
SENSITIVE = []
|
572
|
+
include Aws::Structure
|
573
|
+
end
|
574
|
+
|
575
|
+
# @!attribute [rw] max_results
|
576
|
+
# The maximum number of entries to recieve in the response.
|
577
|
+
# @return [Integer]
|
578
|
+
#
|
579
|
+
# @!attribute [rw] next_token
|
580
|
+
# The nextToken which is used the get the next page of data.
|
581
|
+
# @return [String]
|
582
|
+
#
|
583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClustersInput AWS API Documentation
|
584
|
+
#
|
585
|
+
class ListClustersInput < Struct.new(
|
586
|
+
:max_results,
|
587
|
+
:next_token)
|
588
|
+
SENSITIVE = []
|
589
|
+
include Aws::Structure
|
590
|
+
end
|
591
|
+
|
592
|
+
# @!attribute [rw] clusters
|
593
|
+
# A list of Elastic DocumentDB cluster.
|
594
|
+
# @return [Array<Types::ClusterInList>]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] next_token
|
597
|
+
# The response will provide a nextToken if there is more data beyond
|
598
|
+
# the maxResults.
|
599
|
+
#
|
600
|
+
# If there is no more data in the responce, the nextToken will not be
|
601
|
+
# returned.
|
602
|
+
# @return [String]
|
603
|
+
#
|
604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClustersOutput AWS API Documentation
|
605
|
+
#
|
606
|
+
class ListClustersOutput < Struct.new(
|
607
|
+
:clusters,
|
608
|
+
:next_token)
|
609
|
+
SENSITIVE = []
|
610
|
+
include Aws::Structure
|
611
|
+
end
|
612
|
+
|
613
|
+
# @!attribute [rw] resource_arn
|
614
|
+
# The arn of the Elastic DocumentDB resource.
|
615
|
+
# @return [String]
|
616
|
+
#
|
617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListTagsForResourceRequest AWS API Documentation
|
618
|
+
#
|
619
|
+
class ListTagsForResourceRequest < Struct.new(
|
620
|
+
:resource_arn)
|
621
|
+
SENSITIVE = []
|
622
|
+
include Aws::Structure
|
623
|
+
end
|
624
|
+
|
625
|
+
# @!attribute [rw] tags
|
626
|
+
# The list of tags for the specified Elastic DocumentDB resource.
|
627
|
+
# @return [Hash<String,String>]
|
628
|
+
#
|
629
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListTagsForResourceResponse AWS API Documentation
|
630
|
+
#
|
631
|
+
class ListTagsForResourceResponse < Struct.new(
|
632
|
+
:tags)
|
633
|
+
SENSITIVE = []
|
634
|
+
include Aws::Structure
|
635
|
+
end
|
636
|
+
|
637
|
+
# The specified resource could not be located.
|
638
|
+
#
|
639
|
+
# @!attribute [rw] message
|
640
|
+
# An error message describing the failure.
|
641
|
+
# @return [String]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] resource_id
|
644
|
+
# The ID of the resource that could not be located.
|
645
|
+
# @return [String]
|
646
|
+
#
|
647
|
+
# @!attribute [rw] resource_type
|
648
|
+
# The type of the resource that could not be found.
|
649
|
+
# @return [String]
|
650
|
+
#
|
651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ResourceNotFoundException AWS API Documentation
|
652
|
+
#
|
653
|
+
class ResourceNotFoundException < Struct.new(
|
654
|
+
:message,
|
655
|
+
:resource_id,
|
656
|
+
:resource_type)
|
657
|
+
SENSITIVE = []
|
658
|
+
include Aws::Structure
|
659
|
+
end
|
660
|
+
|
661
|
+
# @!attribute [rw] cluster_name
|
662
|
+
# The name of the Elastic DocumentDB cluster.
|
663
|
+
# @return [String]
|
664
|
+
#
|
665
|
+
# @!attribute [rw] kms_key_id
|
666
|
+
# The KMS key identifier to use to encrypt the new Elastic DocumentDB
|
667
|
+
# cluster.
|
668
|
+
#
|
669
|
+
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
670
|
+
# encryption key. If you are creating a cluster using the same Amazon
|
671
|
+
# account that owns this KMS encryption key, you can use the KMS key
|
672
|
+
# alias instead of the ARN as the KMS encryption key.
|
673
|
+
#
|
674
|
+
# If an encryption key is not specified here, Elastic DocumentDB uses
|
675
|
+
# the default encryption key that KMS creates for your account. Your
|
676
|
+
# account has a different default encryption key for each Amazon
|
677
|
+
# Region.
|
678
|
+
# @return [String]
|
679
|
+
#
|
680
|
+
# @!attribute [rw] snapshot_arn
|
681
|
+
# The arn of the Elastic DocumentDB snapshot.
|
682
|
+
# @return [String]
|
683
|
+
#
|
684
|
+
# @!attribute [rw] subnet_ids
|
685
|
+
# The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
|
686
|
+
# @return [Array<String>]
|
687
|
+
#
|
688
|
+
# @!attribute [rw] tags
|
689
|
+
# A list of the tag names to be assigned to the restored DB cluster,
|
690
|
+
# in the form of an array of key-value pairs in which the key is the
|
691
|
+
# tag name and the value is the key value.
|
692
|
+
# @return [Hash<String,String>]
|
693
|
+
#
|
694
|
+
# @!attribute [rw] vpc_security_group_ids
|
695
|
+
# A list of EC2 VPC security groups to associate with the Elastic
|
696
|
+
# DocumentDB cluster.
|
697
|
+
# @return [Array<String>]
|
698
|
+
#
|
699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/RestoreClusterFromSnapshotInput AWS API Documentation
|
700
|
+
#
|
701
|
+
class RestoreClusterFromSnapshotInput < Struct.new(
|
702
|
+
:cluster_name,
|
703
|
+
:kms_key_id,
|
704
|
+
:snapshot_arn,
|
705
|
+
:subnet_ids,
|
706
|
+
:tags,
|
707
|
+
:vpc_security_group_ids)
|
708
|
+
SENSITIVE = []
|
709
|
+
include Aws::Structure
|
710
|
+
end
|
711
|
+
|
712
|
+
# @!attribute [rw] cluster
|
713
|
+
# Returns information about a the restored Elastic DocumentDB cluster.
|
714
|
+
# @return [Types::Cluster]
|
715
|
+
#
|
716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/RestoreClusterFromSnapshotOutput AWS API Documentation
|
717
|
+
#
|
718
|
+
class RestoreClusterFromSnapshotOutput < Struct.new(
|
719
|
+
:cluster)
|
720
|
+
SENSITIVE = []
|
721
|
+
include Aws::Structure
|
722
|
+
end
|
723
|
+
|
724
|
+
# The service quota for the action was exceeded.
|
725
|
+
#
|
726
|
+
# @!attribute [rw] message
|
727
|
+
# @return [String]
|
728
|
+
#
|
729
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ServiceQuotaExceededException AWS API Documentation
|
730
|
+
#
|
731
|
+
class ServiceQuotaExceededException < Struct.new(
|
732
|
+
:message)
|
733
|
+
SENSITIVE = []
|
734
|
+
include Aws::Structure
|
735
|
+
end
|
736
|
+
|
737
|
+
# @!attribute [rw] resource_arn
|
738
|
+
# The arn of the Elastic DocumentDB resource.
|
739
|
+
# @return [String]
|
740
|
+
#
|
741
|
+
# @!attribute [rw] tags
|
742
|
+
# The tags to be assigned to the Elastic DocumentDB resource.
|
743
|
+
# @return [Hash<String,String>]
|
744
|
+
#
|
745
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/TagResourceRequest AWS API Documentation
|
746
|
+
#
|
747
|
+
class TagResourceRequest < Struct.new(
|
748
|
+
:resource_arn,
|
749
|
+
:tags)
|
750
|
+
SENSITIVE = []
|
751
|
+
include Aws::Structure
|
752
|
+
end
|
753
|
+
|
754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/TagResourceResponse AWS API Documentation
|
755
|
+
#
|
756
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
757
|
+
|
758
|
+
# ThrottlingException will be thrown when request was denied due to
|
759
|
+
# request throttling.
|
760
|
+
#
|
761
|
+
# @!attribute [rw] message
|
762
|
+
# @return [String]
|
763
|
+
#
|
764
|
+
# @!attribute [rw] retry_after_seconds
|
765
|
+
# The number of seconds to wait before retrying the operation.
|
766
|
+
# @return [Integer]
|
767
|
+
#
|
768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ThrottlingException AWS API Documentation
|
769
|
+
#
|
770
|
+
class ThrottlingException < Struct.new(
|
771
|
+
:message,
|
772
|
+
:retry_after_seconds)
|
773
|
+
SENSITIVE = []
|
774
|
+
include Aws::Structure
|
775
|
+
end
|
776
|
+
|
777
|
+
# @!attribute [rw] resource_arn
|
778
|
+
# The arn of the Elastic DocumentDB resource.
|
779
|
+
# @return [String]
|
780
|
+
#
|
781
|
+
# @!attribute [rw] tag_keys
|
782
|
+
# The tag keys to be removed from the Elastic DocumentDB resource.
|
783
|
+
# @return [Array<String>]
|
784
|
+
#
|
785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UntagResourceRequest AWS API Documentation
|
786
|
+
#
|
787
|
+
class UntagResourceRequest < Struct.new(
|
788
|
+
:resource_arn,
|
789
|
+
:tag_keys)
|
790
|
+
SENSITIVE = []
|
791
|
+
include Aws::Structure
|
792
|
+
end
|
793
|
+
|
794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UntagResourceResponse AWS API Documentation
|
795
|
+
#
|
796
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
797
|
+
|
798
|
+
# @!attribute [rw] admin_user_password
|
799
|
+
# The password for the Elastic DocumentDB cluster administrator. This
|
800
|
+
# password can contain any printable ASCII character except forward
|
801
|
+
# slash (/), double quote ("), or the "at" symbol (@).
|
802
|
+
#
|
803
|
+
# *Constraints*\: Must contain from 8 to 100 characters.
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @!attribute [rw] auth_type
|
807
|
+
# The authentication type for the Elastic DocumentDB cluster.
|
808
|
+
# @return [String]
|
809
|
+
#
|
810
|
+
# @!attribute [rw] client_token
|
811
|
+
# The client token for the Elastic DocumentDB cluster.
|
812
|
+
#
|
813
|
+
# **A suitable default value is auto-generated.** You should normally
|
814
|
+
# not need to pass this option.
|
815
|
+
# @return [String]
|
816
|
+
#
|
817
|
+
# @!attribute [rw] cluster_arn
|
818
|
+
# The arn of the Elastic DocumentDB cluster.
|
819
|
+
# @return [String]
|
820
|
+
#
|
821
|
+
# @!attribute [rw] preferred_maintenance_window
|
822
|
+
# The weekly time range during which system maintenance can occur, in
|
823
|
+
# Universal Coordinated Time (UTC).
|
824
|
+
#
|
825
|
+
# *Format*\: `ddd:hh24:mi-ddd:hh24:mi`
|
826
|
+
#
|
827
|
+
# *Default*\: a 30-minute window selected at random from an 8-hour
|
828
|
+
# block of time for each Amazon Web Services Region, occurring on a
|
829
|
+
# random day of the week.
|
830
|
+
#
|
831
|
+
# *Valid days*\: Mon, Tue, Wed, Thu, Fri, Sat, Sun
|
832
|
+
#
|
833
|
+
# *Constraints*\: Minimum 30-minute window.
|
834
|
+
# @return [String]
|
835
|
+
#
|
836
|
+
# @!attribute [rw] shard_capacity
|
837
|
+
# The capacity of each shard in the Elastic DocumentDB cluster.
|
838
|
+
# @return [Integer]
|
839
|
+
#
|
840
|
+
# @!attribute [rw] shard_count
|
841
|
+
# The number of shards to create in the Elastic DocumentDB cluster.
|
842
|
+
# @return [Integer]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] subnet_ids
|
845
|
+
# The number of shards to create in the Elastic DocumentDB cluster.
|
846
|
+
# @return [Array<String>]
|
847
|
+
#
|
848
|
+
# @!attribute [rw] vpc_security_group_ids
|
849
|
+
# A list of EC2 VPC security groups to associate with the new Elastic
|
850
|
+
# DocumentDB cluster.
|
851
|
+
# @return [Array<String>]
|
852
|
+
#
|
853
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UpdateClusterInput AWS API Documentation
|
854
|
+
#
|
855
|
+
class UpdateClusterInput < Struct.new(
|
856
|
+
:admin_user_password,
|
857
|
+
:auth_type,
|
858
|
+
:client_token,
|
859
|
+
:cluster_arn,
|
860
|
+
:preferred_maintenance_window,
|
861
|
+
:shard_capacity,
|
862
|
+
:shard_count,
|
863
|
+
:subnet_ids,
|
864
|
+
:vpc_security_group_ids)
|
865
|
+
SENSITIVE = [:admin_user_password]
|
866
|
+
include Aws::Structure
|
867
|
+
end
|
868
|
+
|
869
|
+
# @!attribute [rw] cluster
|
870
|
+
# Returns information about the updated Elastic DocumentDB cluster.
|
871
|
+
# @return [Types::Cluster]
|
872
|
+
#
|
873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UpdateClusterOutput AWS API Documentation
|
874
|
+
#
|
875
|
+
class UpdateClusterOutput < Struct.new(
|
876
|
+
:cluster)
|
877
|
+
SENSITIVE = []
|
878
|
+
include Aws::Structure
|
879
|
+
end
|
880
|
+
|
881
|
+
# A structure defining a validation exception.
|
882
|
+
#
|
883
|
+
# @!attribute [rw] field_list
|
884
|
+
# A list of the fields in which the validation exception occurred.
|
885
|
+
# @return [Array<Types::ValidationExceptionField>]
|
886
|
+
#
|
887
|
+
# @!attribute [rw] message
|
888
|
+
# An error message describing the validation exception.
|
889
|
+
# @return [String]
|
890
|
+
#
|
891
|
+
# @!attribute [rw] reason
|
892
|
+
# The reason why the validation exception occurred (one of
|
893
|
+
# `unknownOperation`, `cannotParse`, `fieldValidationFailed`, or
|
894
|
+
# `other`).
|
895
|
+
# @return [String]
|
896
|
+
#
|
897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ValidationException AWS API Documentation
|
898
|
+
#
|
899
|
+
class ValidationException < Struct.new(
|
900
|
+
:field_list,
|
901
|
+
:message,
|
902
|
+
:reason)
|
903
|
+
SENSITIVE = []
|
904
|
+
include Aws::Structure
|
905
|
+
end
|
906
|
+
|
907
|
+
# A specific field in which a given validation exception occurred.
|
908
|
+
#
|
909
|
+
# @!attribute [rw] message
|
910
|
+
# An error message describing the validation exception in this field.
|
911
|
+
# @return [String]
|
912
|
+
#
|
913
|
+
# @!attribute [rw] name
|
914
|
+
# The name of the field where the validation exception occurred.
|
915
|
+
# @return [String]
|
916
|
+
#
|
917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ValidationExceptionField AWS API Documentation
|
918
|
+
#
|
919
|
+
class ValidationExceptionField < Struct.new(
|
920
|
+
:message,
|
921
|
+
:name)
|
922
|
+
SENSITIVE = []
|
923
|
+
include Aws::Structure
|
924
|
+
end
|
925
|
+
|
926
|
+
end
|
927
|
+
end
|