aws-sdk-docdbelastic 1.11.0 → 1.13.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-docdbelastic/client.rb +455 -127
- data/lib/aws-sdk-docdbelastic/client_api.rb +95 -0
- data/lib/aws-sdk-docdbelastic/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-docdbelastic/endpoints.rb +42 -0
- data/lib/aws-sdk-docdbelastic/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-docdbelastic/types.rb +396 -118
- data/lib/aws-sdk-docdbelastic.rb +2 -2
- data/sig/client.rbs +44 -1
- data/sig/types.rbs +59 -4
- metadata +4 -4
@@ -25,36 +25,45 @@ module Aws::DocDBElastic
|
|
25
25
|
include Aws::Structure
|
26
26
|
end
|
27
27
|
|
28
|
-
# Returns information about a specific
|
28
|
+
# Returns information about a specific elastic cluster.
|
29
29
|
#
|
30
30
|
# @!attribute [rw] admin_user_name
|
31
|
-
# The name of the
|
31
|
+
# The name of the elastic cluster administrator.
|
32
32
|
# @return [String]
|
33
33
|
#
|
34
34
|
# @!attribute [rw] auth_type
|
35
|
-
# The authentication type for the
|
35
|
+
# The authentication type for the elastic cluster.
|
36
36
|
# @return [String]
|
37
37
|
#
|
38
|
+
# @!attribute [rw] backup_retention_period
|
39
|
+
# The number of days for which automatic snapshots are retained.
|
40
|
+
# @return [Integer]
|
41
|
+
#
|
38
42
|
# @!attribute [rw] cluster_arn
|
39
|
-
# The
|
43
|
+
# The ARN identifier of the elastic cluster.
|
40
44
|
# @return [String]
|
41
45
|
#
|
42
46
|
# @!attribute [rw] cluster_endpoint
|
43
|
-
# The URL used to connect to the
|
47
|
+
# The URL used to connect to the elastic cluster.
|
44
48
|
# @return [String]
|
45
49
|
#
|
46
50
|
# @!attribute [rw] cluster_name
|
47
|
-
# The name of the
|
51
|
+
# The name of the elastic cluster.
|
48
52
|
# @return [String]
|
49
53
|
#
|
50
54
|
# @!attribute [rw] create_time
|
51
|
-
# The time when the
|
52
|
-
#
|
55
|
+
# The time when the elastic cluster was created in Universal
|
56
|
+
# Coordinated Time (UTC).
|
53
57
|
# @return [String]
|
54
58
|
#
|
55
59
|
# @!attribute [rw] kms_key_id
|
56
|
-
# The KMS key identifier to use to encrypt the
|
57
|
-
#
|
60
|
+
# The KMS key identifier to use to encrypt the elastic cluster.
|
61
|
+
# @return [String]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] preferred_backup_window
|
64
|
+
# The daily time range during which automated backups are created if
|
65
|
+
# automated backups are enabled, as determined by
|
66
|
+
# `backupRetentionPeriod`.
|
58
67
|
# @return [String]
|
59
68
|
#
|
60
69
|
# @!attribute [rw] preferred_maintenance_window
|
@@ -65,23 +74,36 @@ module Aws::DocDBElastic
|
|
65
74
|
# @return [String]
|
66
75
|
#
|
67
76
|
# @!attribute [rw] shard_capacity
|
68
|
-
# The
|
77
|
+
# The number of vCPUs assigned to each elastic cluster shard. Maximum
|
78
|
+
# is 64. Allowed values are 2, 4, 8, 16, 32, 64.
|
69
79
|
# @return [Integer]
|
70
80
|
#
|
71
81
|
# @!attribute [rw] shard_count
|
72
|
-
# The number of shards
|
82
|
+
# The number of shards assigned to the elastic cluster. Maximum is 32.
|
83
|
+
# @return [Integer]
|
84
|
+
#
|
85
|
+
# @!attribute [rw] shard_instance_count
|
86
|
+
# The number of replica instances applying to all shards in the
|
87
|
+
# cluster. A `shardInstanceCount` value of 1 means there is one writer
|
88
|
+
# instance, and any additional instances are replicas that can be used
|
89
|
+
# for reads and to improve availability.
|
73
90
|
# @return [Integer]
|
74
91
|
#
|
92
|
+
# @!attribute [rw] shards
|
93
|
+
# The total number of shards in the cluster.
|
94
|
+
# @return [Array<Types::Shard>]
|
95
|
+
#
|
75
96
|
# @!attribute [rw] status
|
76
|
-
# The status of the
|
97
|
+
# The status of the elastic cluster.
|
77
98
|
# @return [String]
|
78
99
|
#
|
79
100
|
# @!attribute [rw] subnet_ids
|
80
|
-
# The Amazon EC2 subnet IDs for the
|
101
|
+
# The Amazon EC2 subnet IDs for the elastic cluster.
|
81
102
|
# @return [Array<String>]
|
82
103
|
#
|
83
104
|
# @!attribute [rw] vpc_security_group_ids
|
84
|
-
# A list of EC2 VPC security groups associated with
|
105
|
+
# A list of EC2 VPC security groups associated with thie elastic
|
106
|
+
# cluster.
|
85
107
|
# @return [Array<String>]
|
86
108
|
#
|
87
109
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/Cluster AWS API Documentation
|
@@ -89,14 +111,18 @@ module Aws::DocDBElastic
|
|
89
111
|
class Cluster < Struct.new(
|
90
112
|
:admin_user_name,
|
91
113
|
:auth_type,
|
114
|
+
:backup_retention_period,
|
92
115
|
:cluster_arn,
|
93
116
|
:cluster_endpoint,
|
94
117
|
:cluster_name,
|
95
118
|
:create_time,
|
96
119
|
:kms_key_id,
|
120
|
+
:preferred_backup_window,
|
97
121
|
:preferred_maintenance_window,
|
98
122
|
:shard_capacity,
|
99
123
|
:shard_count,
|
124
|
+
:shard_instance_count,
|
125
|
+
:shards,
|
100
126
|
:status,
|
101
127
|
:subnet_ids,
|
102
128
|
:vpc_security_group_ids)
|
@@ -104,18 +130,18 @@ module Aws::DocDBElastic
|
|
104
130
|
include Aws::Structure
|
105
131
|
end
|
106
132
|
|
107
|
-
# A list of
|
133
|
+
# A list of Amazon DocumentDB elastic clusters.
|
108
134
|
#
|
109
135
|
# @!attribute [rw] cluster_arn
|
110
|
-
# The
|
136
|
+
# The ARN identifier of the elastic cluster.
|
111
137
|
# @return [String]
|
112
138
|
#
|
113
139
|
# @!attribute [rw] cluster_name
|
114
|
-
# The name of the
|
140
|
+
# The name of the elastic cluster.
|
115
141
|
# @return [String]
|
116
142
|
#
|
117
143
|
# @!attribute [rw] status
|
118
|
-
# The status of the
|
144
|
+
# The status of the elastic cluster.
|
119
145
|
# @return [String]
|
120
146
|
#
|
121
147
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ClusterInList AWS API Documentation
|
@@ -128,51 +154,66 @@ module Aws::DocDBElastic
|
|
128
154
|
include Aws::Structure
|
129
155
|
end
|
130
156
|
|
131
|
-
# Returns information about a specific
|
157
|
+
# Returns information about a specific elastic cluster snapshot.
|
132
158
|
#
|
133
159
|
# @!attribute [rw] admin_user_name
|
134
|
-
# The name of the
|
160
|
+
# The name of the elastic cluster administrator.
|
135
161
|
# @return [String]
|
136
162
|
#
|
137
163
|
# @!attribute [rw] cluster_arn
|
138
|
-
# The
|
164
|
+
# The ARN identifier of the elastic cluster.
|
139
165
|
# @return [String]
|
140
166
|
#
|
141
167
|
# @!attribute [rw] cluster_creation_time
|
142
|
-
# The time when the
|
143
|
-
#
|
168
|
+
# The time when the elastic cluster was created in Universal
|
169
|
+
# Coordinated Time (UTC).
|
144
170
|
# @return [String]
|
145
171
|
#
|
146
172
|
# @!attribute [rw] kms_key_id
|
147
|
-
# The KMS key identifier
|
148
|
-
# cluster
|
173
|
+
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
174
|
+
# encryption key. If you are creating a cluster using the same Amazon
|
175
|
+
# account that owns this KMS encryption key, you can use the KMS key
|
176
|
+
# alias instead of the ARN as the KMS encryption key. If an encryption
|
177
|
+
# key is not specified here, Amazon DocumentDB uses the default
|
178
|
+
# encryption key that KMS creates for your account. Your account has a
|
179
|
+
# different default encryption key for each Amazon Region.
|
149
180
|
# @return [String]
|
150
181
|
#
|
151
182
|
# @!attribute [rw] snapshot_arn
|
152
|
-
# The
|
183
|
+
# The ARN identifier of the elastic cluster snapshot.
|
153
184
|
# @return [String]
|
154
185
|
#
|
155
186
|
# @!attribute [rw] snapshot_creation_time
|
156
|
-
# The time when the
|
157
|
-
#
|
187
|
+
# The time when the elastic cluster snapshot was created in Universal
|
188
|
+
# Coordinated Time (UTC).
|
158
189
|
# @return [String]
|
159
190
|
#
|
160
191
|
# @!attribute [rw] snapshot_name
|
161
|
-
# The name of the
|
192
|
+
# The name of the elastic cluster snapshot.
|
193
|
+
# @return [String]
|
194
|
+
#
|
195
|
+
# @!attribute [rw] snapshot_type
|
196
|
+
# The type of cluster snapshots to be returned. You can specify one of
|
197
|
+
# the following values:
|
198
|
+
#
|
199
|
+
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
200
|
+
# has automatically created for your Amazon Web Services account.
|
201
|
+
#
|
202
|
+
# * `manual` - Return all cluster snapshots that you have manually
|
203
|
+
# created for your Amazon Web Services account.
|
162
204
|
# @return [String]
|
163
205
|
#
|
164
206
|
# @!attribute [rw] status
|
165
|
-
# The status of the
|
207
|
+
# The status of the elastic cluster snapshot.
|
166
208
|
# @return [String]
|
167
209
|
#
|
168
210
|
# @!attribute [rw] subnet_ids
|
169
|
-
#
|
170
|
-
# snapshot.
|
211
|
+
# The Amazon EC2 subnet IDs for the elastic cluster.
|
171
212
|
# @return [Array<String>]
|
172
213
|
#
|
173
214
|
# @!attribute [rw] vpc_security_group_ids
|
174
|
-
# A list of
|
175
|
-
# cluster
|
215
|
+
# A list of EC2 VPC security groups to associate with the elastic
|
216
|
+
# cluster.
|
176
217
|
# @return [Array<String>]
|
177
218
|
#
|
178
219
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ClusterSnapshot AWS API Documentation
|
@@ -185,6 +226,7 @@ module Aws::DocDBElastic
|
|
185
226
|
:snapshot_arn,
|
186
227
|
:snapshot_creation_time,
|
187
228
|
:snapshot_name,
|
229
|
+
:snapshot_type,
|
188
230
|
:status,
|
189
231
|
:subnet_ids,
|
190
232
|
:vpc_security_group_ids)
|
@@ -192,27 +234,27 @@ module Aws::DocDBElastic
|
|
192
234
|
include Aws::Structure
|
193
235
|
end
|
194
236
|
|
195
|
-
# A list of
|
237
|
+
# A list of elastic cluster snapshots.
|
196
238
|
#
|
197
239
|
# @!attribute [rw] cluster_arn
|
198
|
-
# The
|
240
|
+
# The ARN identifier of the elastic cluster.
|
199
241
|
# @return [String]
|
200
242
|
#
|
201
243
|
# @!attribute [rw] snapshot_arn
|
202
|
-
# The
|
244
|
+
# The ARN identifier of the elastic cluster snapshot.
|
203
245
|
# @return [String]
|
204
246
|
#
|
205
247
|
# @!attribute [rw] snapshot_creation_time
|
206
|
-
# The time when the
|
207
|
-
#
|
248
|
+
# The time when the elastic cluster snapshot was created in Universal
|
249
|
+
# Coordinated Time (UTC).
|
208
250
|
# @return [String]
|
209
251
|
#
|
210
252
|
# @!attribute [rw] snapshot_name
|
211
|
-
# The name of the
|
253
|
+
# The name of the elastic cluster snapshot.
|
212
254
|
# @return [String]
|
213
255
|
#
|
214
256
|
# @!attribute [rw] status
|
215
|
-
# The status of the
|
257
|
+
# The status of the elastic cluster snapshot.
|
216
258
|
# @return [String]
|
217
259
|
#
|
218
260
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ClusterSnapshotInList AWS API Documentation
|
@@ -250,8 +292,87 @@ module Aws::DocDBElastic
|
|
250
292
|
include Aws::Structure
|
251
293
|
end
|
252
294
|
|
295
|
+
# @!attribute [rw] copy_tags
|
296
|
+
# Set to `true` to copy all tags from the source cluster snapshot to
|
297
|
+
# the target elastic cluster snapshot. The default is `false`.
|
298
|
+
# @return [Boolean]
|
299
|
+
#
|
300
|
+
# @!attribute [rw] kms_key_id
|
301
|
+
# The Amazon Web Services KMS key ID for an encrypted elastic cluster
|
302
|
+
# snapshot. The Amazon Web Services KMS key ID is the Amazon Resource
|
303
|
+
# Name (ARN), Amazon Web Services KMS key identifier, or the Amazon
|
304
|
+
# Web Services KMS key alias for the Amazon Web Services KMS
|
305
|
+
# encryption key.
|
306
|
+
#
|
307
|
+
# If you copy an encrypted elastic cluster snapshot from your Amazon
|
308
|
+
# Web Services account, you can specify a value for `KmsKeyId` to
|
309
|
+
# encrypt the copy with a new Amazon Web ServicesS KMS encryption key.
|
310
|
+
# If you don't specify a value for `KmsKeyId`, then the copy of the
|
311
|
+
# elastic cluster snapshot is encrypted with the same `AWS` KMS key as
|
312
|
+
# the source elastic cluster snapshot.
|
313
|
+
#
|
314
|
+
# To copy an encrypted elastic cluster snapshot to another Amazon Web
|
315
|
+
# Services region, set `KmsKeyId` to the Amazon Web Services KMS key
|
316
|
+
# ID that you want to use to encrypt the copy of the elastic cluster
|
317
|
+
# snapshot in the destination region. Amazon Web Services KMS
|
318
|
+
# encryption keys are specific to the Amazon Web Services region that
|
319
|
+
# they are created in, and you can't use encryption keys from one
|
320
|
+
# Amazon Web Services region in another Amazon Web Services region.
|
321
|
+
#
|
322
|
+
# If you copy an unencrypted elastic cluster snapshot and specify a
|
323
|
+
# value for the `KmsKeyId` parameter, an error is returned.
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @!attribute [rw] snapshot_arn
|
327
|
+
# The Amazon Resource Name (ARN) identifier of the elastic cluster
|
328
|
+
# snapshot.
|
329
|
+
# @return [String]
|
330
|
+
#
|
331
|
+
# @!attribute [rw] tags
|
332
|
+
# The tags to be assigned to the elastic cluster snapshot.
|
333
|
+
# @return [Hash<String,String>]
|
334
|
+
#
|
335
|
+
# @!attribute [rw] target_snapshot_name
|
336
|
+
# The identifier of the new elastic cluster snapshot to create from
|
337
|
+
# the source cluster snapshot. This parameter is not case sensitive.
|
338
|
+
#
|
339
|
+
# Constraints:
|
340
|
+
#
|
341
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
342
|
+
#
|
343
|
+
# * The first character must be a letter.
|
344
|
+
#
|
345
|
+
# * Cannot end with a hyphen or contain two consecutive hyphens.
|
346
|
+
#
|
347
|
+
# Example: `elastic-cluster-snapshot-5`
|
348
|
+
# @return [String]
|
349
|
+
#
|
350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CopyClusterSnapshotInput AWS API Documentation
|
351
|
+
#
|
352
|
+
class CopyClusterSnapshotInput < Struct.new(
|
353
|
+
:copy_tags,
|
354
|
+
:kms_key_id,
|
355
|
+
:snapshot_arn,
|
356
|
+
:tags,
|
357
|
+
:target_snapshot_name)
|
358
|
+
SENSITIVE = []
|
359
|
+
include Aws::Structure
|
360
|
+
end
|
361
|
+
|
362
|
+
# @!attribute [rw] snapshot
|
363
|
+
# Returns information about a specific elastic cluster snapshot.
|
364
|
+
# @return [Types::ClusterSnapshot]
|
365
|
+
#
|
366
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CopyClusterSnapshotOutput AWS API Documentation
|
367
|
+
#
|
368
|
+
class CopyClusterSnapshotOutput < Struct.new(
|
369
|
+
:snapshot)
|
370
|
+
SENSITIVE = []
|
371
|
+
include Aws::Structure
|
372
|
+
end
|
373
|
+
|
253
374
|
# @!attribute [rw] admin_user_name
|
254
|
-
# The name of the
|
375
|
+
# The name of the Amazon DocumentDB elastic clusters administrator.
|
255
376
|
#
|
256
377
|
# *Constraints*:
|
257
378
|
#
|
@@ -263,8 +384,9 @@ module Aws::DocDBElastic
|
|
263
384
|
# @return [String]
|
264
385
|
#
|
265
386
|
# @!attribute [rw] admin_user_password
|
266
|
-
# The password for the
|
267
|
-
# can contain any printable ASCII
|
387
|
+
# The password for the Amazon DocumentDB elastic clusters
|
388
|
+
# administrator. The password can contain any printable ASCII
|
389
|
+
# characters.
|
268
390
|
#
|
269
391
|
# *Constraints*:
|
270
392
|
#
|
@@ -275,19 +397,25 @@ module Aws::DocDBElastic
|
|
275
397
|
# @return [String]
|
276
398
|
#
|
277
399
|
# @!attribute [rw] auth_type
|
278
|
-
# The authentication type
|
400
|
+
# The authentication type used to determine where to fetch the
|
401
|
+
# password used for accessing the elastic cluster. Valid types are
|
402
|
+
# `PLAIN_TEXT` or `SECRET_ARN`.
|
279
403
|
# @return [String]
|
280
404
|
#
|
405
|
+
# @!attribute [rw] backup_retention_period
|
406
|
+
# The number of days for which automatic snapshots are retained.
|
407
|
+
# @return [Integer]
|
408
|
+
#
|
281
409
|
# @!attribute [rw] client_token
|
282
|
-
# The client token for the
|
410
|
+
# The client token for the elastic cluster.
|
283
411
|
#
|
284
412
|
# **A suitable default value is auto-generated.** You should normally
|
285
413
|
# not need to pass this option.
|
286
414
|
# @return [String]
|
287
415
|
#
|
288
416
|
# @!attribute [rw] cluster_name
|
289
|
-
# The name of the new
|
290
|
-
#
|
417
|
+
# The name of the new elastic cluster. This parameter is stored as a
|
418
|
+
# lowercase string.
|
291
419
|
#
|
292
420
|
# *Constraints*:
|
293
421
|
#
|
@@ -301,20 +429,25 @@ module Aws::DocDBElastic
|
|
301
429
|
# @return [String]
|
302
430
|
#
|
303
431
|
# @!attribute [rw] kms_key_id
|
304
|
-
# The KMS key identifier to use to encrypt the new
|
305
|
-
# cluster.
|
432
|
+
# The KMS key identifier to use to encrypt the new elastic cluster.
|
306
433
|
#
|
307
434
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
308
435
|
# encryption key. If you are creating a cluster using the same Amazon
|
309
436
|
# account that owns this KMS encryption key, you can use the KMS key
|
310
437
|
# alias instead of the ARN as the KMS encryption key.
|
311
438
|
#
|
312
|
-
# If an encryption key is not specified,
|
439
|
+
# If an encryption key is not specified, Amazon DocumentDB uses the
|
313
440
|
# default encryption key that KMS creates for your account. Your
|
314
441
|
# account has a different default encryption key for each Amazon
|
315
442
|
# Region.
|
316
443
|
# @return [String]
|
317
444
|
#
|
445
|
+
# @!attribute [rw] preferred_backup_window
|
446
|
+
# The daily time range during which automated backups are created if
|
447
|
+
# automated backups are enabled, as determined by the
|
448
|
+
# `backupRetentionPeriod`.
|
449
|
+
# @return [String]
|
450
|
+
#
|
318
451
|
# @!attribute [rw] preferred_maintenance_window
|
319
452
|
# The weekly time range during which system maintenance can occur, in
|
320
453
|
# Universal Coordinated Time (UTC).
|
@@ -331,25 +464,32 @@ module Aws::DocDBElastic
|
|
331
464
|
# @return [String]
|
332
465
|
#
|
333
466
|
# @!attribute [rw] shard_capacity
|
334
|
-
# The
|
467
|
+
# The number of vCPUs assigned to each elastic cluster shard. Maximum
|
468
|
+
# is 64. Allowed values are 2, 4, 8, 16, 32, 64.
|
335
469
|
# @return [Integer]
|
336
470
|
#
|
337
471
|
# @!attribute [rw] shard_count
|
338
|
-
# The number of shards to
|
339
|
-
#
|
472
|
+
# The number of shards assigned to the elastic cluster. Maximum is 32.
|
473
|
+
# @return [Integer]
|
474
|
+
#
|
475
|
+
# @!attribute [rw] shard_instance_count
|
476
|
+
# The number of replica instances applying to all shards in the
|
477
|
+
# elastic cluster. A `shardInstanceCount` value of 1 means there is
|
478
|
+
# one writer instance, and any additional instances are replicas that
|
479
|
+
# can be used for reads and to improve availability.
|
340
480
|
# @return [Integer]
|
341
481
|
#
|
342
482
|
# @!attribute [rw] subnet_ids
|
343
|
-
# The Amazon EC2 subnet IDs for the new
|
483
|
+
# The Amazon EC2 subnet IDs for the new elastic cluster.
|
344
484
|
# @return [Array<String>]
|
345
485
|
#
|
346
486
|
# @!attribute [rw] tags
|
347
|
-
# The tags to be assigned to the new
|
487
|
+
# The tags to be assigned to the new elastic cluster.
|
348
488
|
# @return [Hash<String,String>]
|
349
489
|
#
|
350
490
|
# @!attribute [rw] vpc_security_group_ids
|
351
|
-
# A list of EC2 VPC security groups to associate with the new
|
352
|
-
#
|
491
|
+
# A list of EC2 VPC security groups to associate with the new elastic
|
492
|
+
# cluster.
|
353
493
|
# @return [Array<String>]
|
354
494
|
#
|
355
495
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterInput AWS API Documentation
|
@@ -358,12 +498,15 @@ module Aws::DocDBElastic
|
|
358
498
|
:admin_user_name,
|
359
499
|
:admin_user_password,
|
360
500
|
:auth_type,
|
501
|
+
:backup_retention_period,
|
361
502
|
:client_token,
|
362
503
|
:cluster_name,
|
363
504
|
:kms_key_id,
|
505
|
+
:preferred_backup_window,
|
364
506
|
:preferred_maintenance_window,
|
365
507
|
:shard_capacity,
|
366
508
|
:shard_count,
|
509
|
+
:shard_instance_count,
|
367
510
|
:subnet_ids,
|
368
511
|
:tags,
|
369
512
|
:vpc_security_group_ids)
|
@@ -372,7 +515,7 @@ module Aws::DocDBElastic
|
|
372
515
|
end
|
373
516
|
|
374
517
|
# @!attribute [rw] cluster
|
375
|
-
# The new
|
518
|
+
# The new elastic cluster that has been created.
|
376
519
|
# @return [Types::Cluster]
|
377
520
|
#
|
378
521
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterOutput AWS API Documentation
|
@@ -384,16 +527,16 @@ module Aws::DocDBElastic
|
|
384
527
|
end
|
385
528
|
|
386
529
|
# @!attribute [rw] cluster_arn
|
387
|
-
# The
|
388
|
-
#
|
530
|
+
# The ARN identifier of the elastic cluster of which you want to
|
531
|
+
# create a snapshot.
|
389
532
|
# @return [String]
|
390
533
|
#
|
391
534
|
# @!attribute [rw] snapshot_name
|
392
|
-
# The name of the
|
535
|
+
# The name of the new elastic cluster snapshot.
|
393
536
|
# @return [String]
|
394
537
|
#
|
395
538
|
# @!attribute [rw] tags
|
396
|
-
# The tags to be assigned to the new
|
539
|
+
# The tags to be assigned to the new elastic cluster snapshot.
|
397
540
|
# @return [Hash<String,String>]
|
398
541
|
#
|
399
542
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterSnapshotInput AWS API Documentation
|
@@ -407,7 +550,7 @@ module Aws::DocDBElastic
|
|
407
550
|
end
|
408
551
|
|
409
552
|
# @!attribute [rw] snapshot
|
410
|
-
# Returns information about the new
|
553
|
+
# Returns information about the new elastic cluster snapshot.
|
411
554
|
# @return [Types::ClusterSnapshot]
|
412
555
|
#
|
413
556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterSnapshotOutput AWS API Documentation
|
@@ -419,7 +562,7 @@ module Aws::DocDBElastic
|
|
419
562
|
end
|
420
563
|
|
421
564
|
# @!attribute [rw] cluster_arn
|
422
|
-
# The
|
565
|
+
# The ARN identifier of the elastic cluster that is to be deleted.
|
423
566
|
# @return [String]
|
424
567
|
#
|
425
568
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteClusterInput AWS API Documentation
|
@@ -431,8 +574,7 @@ module Aws::DocDBElastic
|
|
431
574
|
end
|
432
575
|
|
433
576
|
# @!attribute [rw] cluster
|
434
|
-
# Returns information about the newly deleted
|
435
|
-
# cluster.
|
577
|
+
# Returns information about the newly deleted elastic cluster.
|
436
578
|
# @return [Types::Cluster]
|
437
579
|
#
|
438
580
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteClusterOutput AWS API Documentation
|
@@ -444,7 +586,8 @@ module Aws::DocDBElastic
|
|
444
586
|
end
|
445
587
|
|
446
588
|
# @!attribute [rw] snapshot_arn
|
447
|
-
# The
|
589
|
+
# The ARN identifier of the elastic cluster snapshot that is to be
|
590
|
+
# deleted.
|
448
591
|
# @return [String]
|
449
592
|
#
|
450
593
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteClusterSnapshotInput AWS API Documentation
|
@@ -456,7 +599,7 @@ module Aws::DocDBElastic
|
|
456
599
|
end
|
457
600
|
|
458
601
|
# @!attribute [rw] snapshot
|
459
|
-
# Returns information about the newly deleted
|
602
|
+
# Returns information about the newly deleted elastic cluster
|
460
603
|
# snapshot.
|
461
604
|
# @return [Types::ClusterSnapshot]
|
462
605
|
#
|
@@ -469,7 +612,7 @@ module Aws::DocDBElastic
|
|
469
612
|
end
|
470
613
|
|
471
614
|
# @!attribute [rw] cluster_arn
|
472
|
-
# The
|
615
|
+
# The ARN identifier of the elastic cluster.
|
473
616
|
# @return [String]
|
474
617
|
#
|
475
618
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterInput AWS API Documentation
|
@@ -481,7 +624,7 @@ module Aws::DocDBElastic
|
|
481
624
|
end
|
482
625
|
|
483
626
|
# @!attribute [rw] cluster
|
484
|
-
# Returns information about a specific
|
627
|
+
# Returns information about a specific elastic cluster.
|
485
628
|
# @return [Types::Cluster]
|
486
629
|
#
|
487
630
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterOutput AWS API Documentation
|
@@ -493,7 +636,7 @@ module Aws::DocDBElastic
|
|
493
636
|
end
|
494
637
|
|
495
638
|
# @!attribute [rw] snapshot_arn
|
496
|
-
# The
|
639
|
+
# The ARN identifier of the elastic cluster snapshot.
|
497
640
|
# @return [String]
|
498
641
|
#
|
499
642
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterSnapshotInput AWS API Documentation
|
@@ -505,7 +648,7 @@ module Aws::DocDBElastic
|
|
505
648
|
end
|
506
649
|
|
507
650
|
# @!attribute [rw] snapshot
|
508
|
-
# Returns information about a specific
|
651
|
+
# Returns information about a specific elastic cluster snapshot.
|
509
652
|
# @return [Types::ClusterSnapshot]
|
510
653
|
#
|
511
654
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterSnapshotOutput AWS API Documentation
|
@@ -530,15 +673,32 @@ module Aws::DocDBElastic
|
|
530
673
|
end
|
531
674
|
|
532
675
|
# @!attribute [rw] cluster_arn
|
533
|
-
# The
|
676
|
+
# The ARN identifier of the elastic cluster.
|
534
677
|
# @return [String]
|
535
678
|
#
|
536
679
|
# @!attribute [rw] max_results
|
537
|
-
# The maximum number of
|
680
|
+
# The maximum number of elastic cluster snapshot results to receive in
|
681
|
+
# the response.
|
538
682
|
# @return [Integer]
|
539
683
|
#
|
540
684
|
# @!attribute [rw] next_token
|
541
|
-
#
|
685
|
+
# A pagination token provided by a previous request. If this parameter
|
686
|
+
# is specified, the response includes only records beyond this token,
|
687
|
+
# up to the value specified by `max-results`.
|
688
|
+
#
|
689
|
+
# If there is no more data in the responce, the `nextToken` will not
|
690
|
+
# be returned.
|
691
|
+
# @return [String]
|
692
|
+
#
|
693
|
+
# @!attribute [rw] snapshot_type
|
694
|
+
# The type of cluster snapshots to be returned. You can specify one of
|
695
|
+
# the following values:
|
696
|
+
#
|
697
|
+
# * `automated` - Return all cluster snapshots that Amazon DocumentDB
|
698
|
+
# has automatically created for your Amazon Web Services account.
|
699
|
+
#
|
700
|
+
# * `manual` - Return all cluster snapshots that you have manually
|
701
|
+
# created for your Amazon Web Services account.
|
542
702
|
# @return [String]
|
543
703
|
#
|
544
704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusterSnapshotsInput AWS API Documentation
|
@@ -546,21 +706,23 @@ module Aws::DocDBElastic
|
|
546
706
|
class ListClusterSnapshotsInput < Struct.new(
|
547
707
|
:cluster_arn,
|
548
708
|
:max_results,
|
549
|
-
:next_token
|
709
|
+
:next_token,
|
710
|
+
:snapshot_type)
|
550
711
|
SENSITIVE = []
|
551
712
|
include Aws::Structure
|
552
713
|
end
|
553
714
|
|
554
715
|
# @!attribute [rw] next_token
|
555
|
-
#
|
556
|
-
# the
|
716
|
+
# A pagination token provided by a previous request. If this parameter
|
717
|
+
# is specified, the response includes only records beyond this token,
|
718
|
+
# up to the value specified by `max-results`.
|
557
719
|
#
|
558
|
-
# If there is no more data in the responce, the nextToken will not
|
559
|
-
# returned.
|
720
|
+
# If there is no more data in the responce, the `nextToken` will not
|
721
|
+
# be returned.
|
560
722
|
# @return [String]
|
561
723
|
#
|
562
724
|
# @!attribute [rw] snapshots
|
563
|
-
# A list of
|
725
|
+
# A list of snapshots for a specified elastic cluster.
|
564
726
|
# @return [Array<Types::ClusterSnapshotInList>]
|
565
727
|
#
|
566
728
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusterSnapshotsOutput AWS API Documentation
|
@@ -573,11 +735,17 @@ module Aws::DocDBElastic
|
|
573
735
|
end
|
574
736
|
|
575
737
|
# @!attribute [rw] max_results
|
576
|
-
# The maximum number of
|
738
|
+
# The maximum number of elastic cluster snapshot results to receive in
|
739
|
+
# the response.
|
577
740
|
# @return [Integer]
|
578
741
|
#
|
579
742
|
# @!attribute [rw] next_token
|
580
|
-
#
|
743
|
+
# A pagination token provided by a previous request. If this parameter
|
744
|
+
# is specified, the response includes only records beyond this token,
|
745
|
+
# up to the value specified by `max-results`.
|
746
|
+
#
|
747
|
+
# If there is no more data in the responce, the `nextToken` will not
|
748
|
+
# be returned.
|
581
749
|
# @return [String]
|
582
750
|
#
|
583
751
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClustersInput AWS API Documentation
|
@@ -590,15 +758,16 @@ module Aws::DocDBElastic
|
|
590
758
|
end
|
591
759
|
|
592
760
|
# @!attribute [rw] clusters
|
593
|
-
# A list of
|
761
|
+
# A list of Amazon DocumentDB elastic clusters.
|
594
762
|
# @return [Array<Types::ClusterInList>]
|
595
763
|
#
|
596
764
|
# @!attribute [rw] next_token
|
597
|
-
#
|
598
|
-
# the
|
765
|
+
# A pagination token provided by a previous request. If this parameter
|
766
|
+
# is specified, the response includes only records beyond this token,
|
767
|
+
# up to the value specified by `max-results`.
|
599
768
|
#
|
600
|
-
# If there is no more data in the responce, the nextToken will not
|
601
|
-
# returned.
|
769
|
+
# If there is no more data in the responce, the `nextToken` will not
|
770
|
+
# be returned.
|
602
771
|
# @return [String]
|
603
772
|
#
|
604
773
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClustersOutput AWS API Documentation
|
@@ -611,7 +780,7 @@ module Aws::DocDBElastic
|
|
611
780
|
end
|
612
781
|
|
613
782
|
# @!attribute [rw] resource_arn
|
614
|
-
# The
|
783
|
+
# The ARN identifier of the elastic cluster resource.
|
615
784
|
# @return [String]
|
616
785
|
#
|
617
786
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListTagsForResourceRequest AWS API Documentation
|
@@ -623,7 +792,7 @@ module Aws::DocDBElastic
|
|
623
792
|
end
|
624
793
|
|
625
794
|
# @!attribute [rw] tags
|
626
|
-
# The list of tags for the specified
|
795
|
+
# The list of tags for the specified elastic cluster resource.
|
627
796
|
# @return [Hash<String,String>]
|
628
797
|
#
|
629
798
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListTagsForResourceResponse AWS API Documentation
|
@@ -659,41 +828,52 @@ module Aws::DocDBElastic
|
|
659
828
|
end
|
660
829
|
|
661
830
|
# @!attribute [rw] cluster_name
|
662
|
-
# The name of the
|
831
|
+
# The name of the elastic cluster.
|
663
832
|
# @return [String]
|
664
833
|
#
|
665
834
|
# @!attribute [rw] kms_key_id
|
666
|
-
# The KMS key identifier to use to encrypt the new
|
667
|
-
# cluster.
|
835
|
+
# The KMS key identifier to use to encrypt the new Amazon DocumentDB
|
836
|
+
# elastic clusters cluster.
|
668
837
|
#
|
669
838
|
# The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
670
839
|
# encryption key. If you are creating a cluster using the same Amazon
|
671
840
|
# account that owns this KMS encryption key, you can use the KMS key
|
672
841
|
# alias instead of the ARN as the KMS encryption key.
|
673
842
|
#
|
674
|
-
# If an encryption key is not specified here,
|
843
|
+
# If an encryption key is not specified here, Amazon DocumentDB uses
|
675
844
|
# the default encryption key that KMS creates for your account. Your
|
676
845
|
# account has a different default encryption key for each Amazon
|
677
846
|
# Region.
|
678
847
|
# @return [String]
|
679
848
|
#
|
849
|
+
# @!attribute [rw] shard_capacity
|
850
|
+
# The capacity of each shard in the new restored elastic cluster.
|
851
|
+
# @return [Integer]
|
852
|
+
#
|
853
|
+
# @!attribute [rw] shard_instance_count
|
854
|
+
# The number of replica instances applying to all shards in the
|
855
|
+
# elastic cluster. A `shardInstanceCount` value of 1 means there is
|
856
|
+
# one writer instance, and any additional instances are replicas that
|
857
|
+
# can be used for reads and to improve availability.
|
858
|
+
# @return [Integer]
|
859
|
+
#
|
680
860
|
# @!attribute [rw] snapshot_arn
|
681
|
-
# The
|
861
|
+
# The ARN identifier of the elastic cluster snapshot.
|
682
862
|
# @return [String]
|
683
863
|
#
|
684
864
|
# @!attribute [rw] subnet_ids
|
685
|
-
# The Amazon EC2 subnet IDs for the
|
865
|
+
# The Amazon EC2 subnet IDs for the elastic cluster.
|
686
866
|
# @return [Array<String>]
|
687
867
|
#
|
688
868
|
# @!attribute [rw] tags
|
689
|
-
# A list of the tag names to be assigned to the restored
|
690
|
-
# in the form of an array of key-value pairs in which the key
|
691
|
-
# tag name and the value is the key value.
|
869
|
+
# A list of the tag names to be assigned to the restored elastic
|
870
|
+
# cluster, in the form of an array of key-value pairs in which the key
|
871
|
+
# is the tag name and the value is the key value.
|
692
872
|
# @return [Hash<String,String>]
|
693
873
|
#
|
694
874
|
# @!attribute [rw] vpc_security_group_ids
|
695
|
-
# A list of EC2 VPC security groups to associate with the
|
696
|
-
#
|
875
|
+
# A list of EC2 VPC security groups to associate with the elastic
|
876
|
+
# cluster.
|
697
877
|
# @return [Array<String>]
|
698
878
|
#
|
699
879
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/RestoreClusterFromSnapshotInput AWS API Documentation
|
@@ -701,6 +881,8 @@ module Aws::DocDBElastic
|
|
701
881
|
class RestoreClusterFromSnapshotInput < Struct.new(
|
702
882
|
:cluster_name,
|
703
883
|
:kms_key_id,
|
884
|
+
:shard_capacity,
|
885
|
+
:shard_instance_count,
|
704
886
|
:snapshot_arn,
|
705
887
|
:subnet_ids,
|
706
888
|
:tags,
|
@@ -710,7 +892,7 @@ module Aws::DocDBElastic
|
|
710
892
|
end
|
711
893
|
|
712
894
|
# @!attribute [rw] cluster
|
713
|
-
# Returns information about a the restored
|
895
|
+
# Returns information about a the restored elastic cluster.
|
714
896
|
# @return [Types::Cluster]
|
715
897
|
#
|
716
898
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/RestoreClusterFromSnapshotOutput AWS API Documentation
|
@@ -734,12 +916,85 @@ module Aws::DocDBElastic
|
|
734
916
|
include Aws::Structure
|
735
917
|
end
|
736
918
|
|
919
|
+
# The name of the shard.
|
920
|
+
#
|
921
|
+
# @!attribute [rw] create_time
|
922
|
+
# The time when the shard was created in Universal Coordinated Time
|
923
|
+
# (UTC).
|
924
|
+
# @return [String]
|
925
|
+
#
|
926
|
+
# @!attribute [rw] shard_id
|
927
|
+
# The ID of the shard.
|
928
|
+
# @return [String]
|
929
|
+
#
|
930
|
+
# @!attribute [rw] status
|
931
|
+
# The current status of the shard.
|
932
|
+
# @return [String]
|
933
|
+
#
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/Shard AWS API Documentation
|
935
|
+
#
|
936
|
+
class Shard < Struct.new(
|
937
|
+
:create_time,
|
938
|
+
:shard_id,
|
939
|
+
:status)
|
940
|
+
SENSITIVE = []
|
941
|
+
include Aws::Structure
|
942
|
+
end
|
943
|
+
|
944
|
+
# @!attribute [rw] cluster_arn
|
945
|
+
# The ARN identifier of the elastic cluster.
|
946
|
+
# @return [String]
|
947
|
+
#
|
948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StartClusterInput AWS API Documentation
|
949
|
+
#
|
950
|
+
class StartClusterInput < Struct.new(
|
951
|
+
:cluster_arn)
|
952
|
+
SENSITIVE = []
|
953
|
+
include Aws::Structure
|
954
|
+
end
|
955
|
+
|
956
|
+
# @!attribute [rw] cluster
|
957
|
+
# Returns information about a specific elastic cluster.
|
958
|
+
# @return [Types::Cluster]
|
959
|
+
#
|
960
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StartClusterOutput AWS API Documentation
|
961
|
+
#
|
962
|
+
class StartClusterOutput < Struct.new(
|
963
|
+
:cluster)
|
964
|
+
SENSITIVE = []
|
965
|
+
include Aws::Structure
|
966
|
+
end
|
967
|
+
|
968
|
+
# @!attribute [rw] cluster_arn
|
969
|
+
# The ARN identifier of the elastic cluster.
|
970
|
+
# @return [String]
|
971
|
+
#
|
972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StopClusterInput AWS API Documentation
|
973
|
+
#
|
974
|
+
class StopClusterInput < Struct.new(
|
975
|
+
:cluster_arn)
|
976
|
+
SENSITIVE = []
|
977
|
+
include Aws::Structure
|
978
|
+
end
|
979
|
+
|
980
|
+
# @!attribute [rw] cluster
|
981
|
+
# Returns information about a specific elastic cluster.
|
982
|
+
# @return [Types::Cluster]
|
983
|
+
#
|
984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StopClusterOutput AWS API Documentation
|
985
|
+
#
|
986
|
+
class StopClusterOutput < Struct.new(
|
987
|
+
:cluster)
|
988
|
+
SENSITIVE = []
|
989
|
+
include Aws::Structure
|
990
|
+
end
|
991
|
+
|
737
992
|
# @!attribute [rw] resource_arn
|
738
|
-
# The
|
993
|
+
# The ARN identifier of the elastic cluster resource.
|
739
994
|
# @return [String]
|
740
995
|
#
|
741
996
|
# @!attribute [rw] tags
|
742
|
-
# The tags
|
997
|
+
# The tags that are assigned to the elastic cluster resource.
|
743
998
|
# @return [Hash<String,String>]
|
744
999
|
#
|
745
1000
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/TagResourceRequest AWS API Documentation
|
@@ -775,11 +1030,11 @@ module Aws::DocDBElastic
|
|
775
1030
|
end
|
776
1031
|
|
777
1032
|
# @!attribute [rw] resource_arn
|
778
|
-
# The
|
1033
|
+
# The ARN identifier of the elastic cluster resource.
|
779
1034
|
# @return [String]
|
780
1035
|
#
|
781
1036
|
# @!attribute [rw] tag_keys
|
782
|
-
# The tag keys to be removed from the
|
1037
|
+
# The tag keys to be removed from the elastic cluster resource.
|
783
1038
|
# @return [Array<String>]
|
784
1039
|
#
|
785
1040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UntagResourceRequest AWS API Documentation
|
@@ -796,7 +1051,7 @@ module Aws::DocDBElastic
|
|
796
1051
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
797
1052
|
|
798
1053
|
# @!attribute [rw] admin_user_password
|
799
|
-
# The password
|
1054
|
+
# The password associated with the elastic cluster administrator. This
|
800
1055
|
# password can contain any printable ASCII character except forward
|
801
1056
|
# slash (/), double quote ("), or the "at" symbol (@).
|
802
1057
|
#
|
@@ -804,18 +1059,30 @@ module Aws::DocDBElastic
|
|
804
1059
|
# @return [String]
|
805
1060
|
#
|
806
1061
|
# @!attribute [rw] auth_type
|
807
|
-
# The authentication type
|
1062
|
+
# The authentication type used to determine where to fetch the
|
1063
|
+
# password used for accessing the elastic cluster. Valid types are
|
1064
|
+
# `PLAIN_TEXT` or `SECRET_ARN`.
|
808
1065
|
# @return [String]
|
809
1066
|
#
|
1067
|
+
# @!attribute [rw] backup_retention_period
|
1068
|
+
# The number of days for which automatic snapshots are retained.
|
1069
|
+
# @return [Integer]
|
1070
|
+
#
|
810
1071
|
# @!attribute [rw] client_token
|
811
|
-
# The client token for the
|
1072
|
+
# The client token for the elastic cluster.
|
812
1073
|
#
|
813
1074
|
# **A suitable default value is auto-generated.** You should normally
|
814
1075
|
# not need to pass this option.
|
815
1076
|
# @return [String]
|
816
1077
|
#
|
817
1078
|
# @!attribute [rw] cluster_arn
|
818
|
-
# The
|
1079
|
+
# The ARN identifier of the elastic cluster.
|
1080
|
+
# @return [String]
|
1081
|
+
#
|
1082
|
+
# @!attribute [rw] preferred_backup_window
|
1083
|
+
# The daily time range during which automated backups are created if
|
1084
|
+
# automated backups are enabled, as determined by the
|
1085
|
+
# `backupRetentionPeriod`.
|
819
1086
|
# @return [String]
|
820
1087
|
#
|
821
1088
|
# @!attribute [rw] preferred_maintenance_window
|
@@ -834,20 +1101,28 @@ module Aws::DocDBElastic
|
|
834
1101
|
# @return [String]
|
835
1102
|
#
|
836
1103
|
# @!attribute [rw] shard_capacity
|
837
|
-
# The
|
1104
|
+
# The number of vCPUs assigned to each elastic cluster shard. Maximum
|
1105
|
+
# is 64. Allowed values are 2, 4, 8, 16, 32, 64.
|
838
1106
|
# @return [Integer]
|
839
1107
|
#
|
840
1108
|
# @!attribute [rw] shard_count
|
841
|
-
# The number of shards to
|
1109
|
+
# The number of shards assigned to the elastic cluster. Maximum is 32.
|
1110
|
+
# @return [Integer]
|
1111
|
+
#
|
1112
|
+
# @!attribute [rw] shard_instance_count
|
1113
|
+
# The number of replica instances applying to all shards in the
|
1114
|
+
# elastic cluster. A `shardInstanceCount` value of 1 means there is
|
1115
|
+
# one writer instance, and any additional instances are replicas that
|
1116
|
+
# can be used for reads and to improve availability.
|
842
1117
|
# @return [Integer]
|
843
1118
|
#
|
844
1119
|
# @!attribute [rw] subnet_ids
|
845
|
-
# The
|
1120
|
+
# The Amazon EC2 subnet IDs for the elastic cluster.
|
846
1121
|
# @return [Array<String>]
|
847
1122
|
#
|
848
1123
|
# @!attribute [rw] vpc_security_group_ids
|
849
|
-
# A list of EC2 VPC security groups to associate with the
|
850
|
-
#
|
1124
|
+
# A list of EC2 VPC security groups to associate with the elastic
|
1125
|
+
# cluster.
|
851
1126
|
# @return [Array<String>]
|
852
1127
|
#
|
853
1128
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UpdateClusterInput AWS API Documentation
|
@@ -855,11 +1130,14 @@ module Aws::DocDBElastic
|
|
855
1130
|
class UpdateClusterInput < Struct.new(
|
856
1131
|
:admin_user_password,
|
857
1132
|
:auth_type,
|
1133
|
+
:backup_retention_period,
|
858
1134
|
:client_token,
|
859
1135
|
:cluster_arn,
|
1136
|
+
:preferred_backup_window,
|
860
1137
|
:preferred_maintenance_window,
|
861
1138
|
:shard_capacity,
|
862
1139
|
:shard_count,
|
1140
|
+
:shard_instance_count,
|
863
1141
|
:subnet_ids,
|
864
1142
|
:vpc_security_group_ids)
|
865
1143
|
SENSITIVE = [:admin_user_password]
|
@@ -867,7 +1145,7 @@ module Aws::DocDBElastic
|
|
867
1145
|
end
|
868
1146
|
|
869
1147
|
# @!attribute [rw] cluster
|
870
|
-
# Returns information about the updated
|
1148
|
+
# Returns information about the updated elastic cluster.
|
871
1149
|
# @return [Types::Cluster]
|
872
1150
|
#
|
873
1151
|
# @see http://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UpdateClusterOutput AWS API Documentation
|