@aws-sdk/client-docdb-elastic 3.523.0 → 3.529.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/README.md +40 -1
  2. package/dist-cjs/index.js +208 -83
  3. package/dist-es/DocDBElastic.js +6 -0
  4. package/dist-es/commands/CopyClusterSnapshotCommand.js +24 -0
  5. package/dist-es/commands/StartClusterCommand.js +24 -0
  6. package/dist-es/commands/StopClusterCommand.js +24 -0
  7. package/dist-es/commands/index.js +3 -0
  8. package/dist-es/models/models_0.js +28 -14
  9. package/dist-es/protocols/Aws_restJson1.js +91 -43
  10. package/dist-types/DocDBElastic.d.ts +36 -1
  11. package/dist-types/DocDBElasticClient.d.ts +20 -3
  12. package/dist-types/commands/CopyClusterSnapshotCommand.d.ts +101 -0
  13. package/dist-types/commands/CreateClusterCommand.d.ts +14 -1
  14. package/dist-types/commands/CreateClusterSnapshotCommand.d.ts +2 -1
  15. package/dist-types/commands/DeleteClusterCommand.d.ts +11 -1
  16. package/dist-types/commands/DeleteClusterSnapshotCommand.d.ts +2 -1
  17. package/dist-types/commands/GetClusterCommand.d.ts +11 -1
  18. package/dist-types/commands/GetClusterSnapshotCommand.d.ts +2 -1
  19. package/dist-types/commands/ListClusterSnapshotsCommand.d.ts +2 -1
  20. package/dist-types/commands/ListClustersCommand.d.ts +1 -1
  21. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  22. package/dist-types/commands/RestoreClusterFromSnapshotCommand.d.ts +13 -1
  23. package/dist-types/commands/StartClusterCommand.d.ts +101 -0
  24. package/dist-types/commands/StopClusterCommand.d.ts +102 -0
  25. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  26. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  27. package/dist-types/commands/UpdateClusterCommand.d.ts +15 -2
  28. package/dist-types/commands/index.d.ts +3 -0
  29. package/dist-types/index.d.ts +15 -1
  30. package/dist-types/models/models_0.d.ts +478 -232
  31. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  32. package/dist-types/ts3.4/DocDBElastic.d.ts +51 -0
  33. package/dist-types/ts3.4/DocDBElasticClient.d.ts +18 -0
  34. package/dist-types/ts3.4/commands/CopyClusterSnapshotCommand.d.ts +30 -0
  35. package/dist-types/ts3.4/commands/StartClusterCommand.d.ts +26 -0
  36. package/dist-types/ts3.4/commands/StopClusterCommand.d.ts +26 -0
  37. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  38. package/dist-types/ts3.4/models/models_0.d.ts +98 -42
  39. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  40. package/package.json +17 -17
  41. package/dist-cjs/DocDBElastic.js +0 -1
  42. package/dist-cjs/DocDBElasticClient.js +0 -1
  43. package/dist-cjs/auth/httpAuthExtensionConfiguration.js +0 -1
  44. package/dist-cjs/commands/CreateClusterCommand.js +0 -1
  45. package/dist-cjs/commands/CreateClusterSnapshotCommand.js +0 -1
  46. package/dist-cjs/commands/DeleteClusterCommand.js +0 -1
  47. package/dist-cjs/commands/DeleteClusterSnapshotCommand.js +0 -1
  48. package/dist-cjs/commands/GetClusterCommand.js +0 -1
  49. package/dist-cjs/commands/GetClusterSnapshotCommand.js +0 -1
  50. package/dist-cjs/commands/ListClusterSnapshotsCommand.js +0 -1
  51. package/dist-cjs/commands/ListClustersCommand.js +0 -1
  52. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -1
  53. package/dist-cjs/commands/RestoreClusterFromSnapshotCommand.js +0 -1
  54. package/dist-cjs/commands/TagResourceCommand.js +0 -1
  55. package/dist-cjs/commands/UntagResourceCommand.js +0 -1
  56. package/dist-cjs/commands/UpdateClusterCommand.js +0 -1
  57. package/dist-cjs/commands/index.js +0 -1
  58. package/dist-cjs/endpoint/EndpointParameters.js +0 -1
  59. package/dist-cjs/extensionConfiguration.js +0 -1
  60. package/dist-cjs/models/DocDBElasticServiceException.js +0 -1
  61. package/dist-cjs/models/index.js +0 -1
  62. package/dist-cjs/models/models_0.js +0 -1
  63. package/dist-cjs/pagination/Interfaces.js +0 -1
  64. package/dist-cjs/pagination/ListClusterSnapshotsPaginator.js +0 -1
  65. package/dist-cjs/pagination/ListClustersPaginator.js +0 -1
  66. package/dist-cjs/pagination/index.js +0 -1
  67. package/dist-cjs/protocols/Aws_restJson1.js +0 -1
  68. package/dist-cjs/runtimeExtensions.js +0 -1
@@ -49,139 +49,89 @@ export declare class ConflictException extends __BaseException {
49
49
  /**
50
50
  * @public
51
51
  */
52
- export interface CreateClusterInput {
53
- /**
54
- * @public
55
- * <p>The name of the new Elastic DocumentDB cluster. This parameter is stored as
56
- * a lowercase string.</p>
57
- * <p>
58
- * <i>Constraints</i>:</p>
59
- * <ul>
60
- * <li>
61
- * <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p>
62
- * </li>
63
- * <li>
64
- * <p>The first character must be a letter.</p>
65
- * </li>
66
- * <li>
67
- * <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
68
- * </li>
69
- * </ul>
70
- * <p>
71
- * <i>Example</i>: <code>my-cluster</code>
72
- * </p>
73
- */
74
- clusterName: string | undefined;
52
+ export interface CopyClusterSnapshotInput {
75
53
  /**
76
54
  * @public
77
- * <p>The authentication type for the Elastic DocumentDB cluster.</p>
55
+ * <p>The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.</p>
78
56
  */
79
- authType: Auth | undefined;
57
+ snapshotArn: string | undefined;
80
58
  /**
81
59
  * @public
82
- * <p>The name of the Elastic DocumentDB cluster administrator.</p>
83
- * <p>
84
- * <i>Constraints</i>:</p>
60
+ * <p>The identifier of the new elastic cluster snapshot to create from the source cluster snapshot.
61
+ * This parameter is not case sensitive.</p>
62
+ * <p>Constraints:</p>
85
63
  * <ul>
86
64
  * <li>
87
- * <p>Must be from 1 to 63 letters or numbers.</p>
65
+ * <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p>
88
66
  * </li>
89
67
  * <li>
90
68
  * <p>The first character must be a letter.</p>
91
69
  * </li>
92
70
  * <li>
93
- * <p>Cannot be a reserved word.</p>
94
- * </li>
95
- * </ul>
96
- */
97
- adminUserName: string | undefined;
98
- /**
99
- * @public
100
- * <p>The password for the Elastic DocumentDB cluster administrator and can
101
- * contain any printable ASCII characters.</p>
102
- * <p>
103
- * <i>Constraints</i>:</p>
104
- * <ul>
105
- * <li>
106
- * <p>Must contain from 8 to 100 characters.</p>
107
- * </li>
108
- * <li>
109
- * <p>Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).</p>
71
+ * <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
110
72
  * </li>
111
73
  * </ul>
74
+ * <p>Example: <code>elastic-cluster-snapshot-5</code>
75
+ * </p>
112
76
  */
113
- adminUserPassword: string | undefined;
114
- /**
115
- * @public
116
- * <p>The capacity of each shard in the new Elastic DocumentDB cluster.</p>
117
- */
118
- shardCapacity: number | undefined;
119
- /**
120
- * @public
121
- * <p>The number of shards to create in the new Elastic DocumentDB cluster.</p>
122
- */
123
- shardCount: number | undefined;
124
- /**
125
- * @public
126
- * <p>A list of EC2 VPC security groups to associate with the new
127
- * Elastic DocumentDB cluster.</p>
128
- */
129
- vpcSecurityGroupIds?: string[];
130
- /**
131
- * @public
132
- * <p>The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.</p>
133
- */
134
- subnetIds?: string[];
77
+ targetSnapshotName: string | undefined;
135
78
  /**
136
79
  * @public
137
- * <p>The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.</p>
138
- * <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
139
- * encryption key. If you are creating a cluster using the same Amazon account
140
- * that owns this KMS encryption key, you can use the KMS key alias instead
141
- * of the ARN as the KMS encryption key.</p>
142
- * <p>If an encryption key is not specified, Elastic DocumentDB uses the
143
- * default encryption key that KMS creates for your account. Your account
144
- * has a different default encryption key for each Amazon Region.</p>
80
+ * <p>The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot.
81
+ * The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.</p>
82
+ * <p>If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new Amazon Web ServicesS KMS encryption key.
83
+ * If you don't specify a value for <code>KmsKeyId</code>, then the copy of the elastic cluster snapshot is encrypted with the same <code>AWS</code> KMS key as the source elastic cluster snapshot.</p>
84
+ * <p>To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set <code>KmsKeyId</code> to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region.
85
+ * Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.</p>
86
+ * <p>If you copy an unencrypted elastic cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>
145
87
  */
146
88
  kmsKeyId?: string;
147
89
  /**
148
90
  * @public
149
- * <p>The client token for the Elastic DocumentDB cluster.</p>
150
- */
151
- clientToken?: string;
152
- /**
153
- * @public
154
- * <p>The weekly time range during which system maintenance can occur,
155
- * in Universal Coordinated Time (UTC).</p>
156
- * <p>
157
- * <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code>
158
- * </p>
159
- * <p>
160
- * <i>Default</i>: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.</p>
161
- * <p>
162
- * <i>Valid days</i>: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
163
- * <p>
164
- * <i>Constraints</i>: Minimum 30-minute window.</p>
91
+ * <p>Set to <code>true</code> to copy all tags from the source cluster snapshot to the target elastic cluster snapshot.
92
+ * The default is <code>false</code>.</p>
165
93
  */
166
- preferredMaintenanceWindow?: string;
94
+ copyTags?: boolean;
167
95
  /**
168
96
  * @public
169
- * <p>The tags to be assigned to the new Elastic DocumentDB cluster.</p>
97
+ * <p>The tags to be assigned to the elastic cluster snapshot.</p>
170
98
  */
171
99
  tags?: Record<string, string>;
172
100
  }
101
+ /**
102
+ * @public
103
+ * @enum
104
+ */
105
+ export declare const SnapshotType: {
106
+ readonly AUTOMATED: "AUTOMATED";
107
+ readonly MANUAL: "MANUAL";
108
+ };
109
+ /**
110
+ * @public
111
+ */
112
+ export type SnapshotType = (typeof SnapshotType)[keyof typeof SnapshotType];
173
113
  /**
174
114
  * @public
175
115
  * @enum
176
116
  */
177
117
  export declare const Status: {
178
118
  readonly ACTIVE: "ACTIVE";
119
+ readonly COPYING: "COPYING";
179
120
  readonly CREATING: "CREATING";
180
121
  readonly DELETING: "DELETING";
181
122
  readonly INACCESSIBLE_ENCRYPTION_CREDS: "INACCESSIBLE_ENCRYPTION_CREDS";
123
+ readonly INACCESSIBLE_SECRET_ARN: "INACCESSIBLE_SECRET_ARN";
124
+ readonly INACCESSIBLE_VPC_ENDPOINT: "INACCESSIBLE_VPC_ENDPOINT";
125
+ readonly INCOMPATIBLE_NETWORK: "INCOMPATIBLE_NETWORK";
182
126
  readonly INVALID_SECURITY_GROUP_ID: "INVALID_SECURITY_GROUP_ID";
183
127
  readonly INVALID_SUBNET_ID: "INVALID_SUBNET_ID";
184
128
  readonly IP_ADDRESS_LIMIT_EXCEEDED: "IP_ADDRESS_LIMIT_EXCEEDED";
129
+ readonly MERGING: "MERGING";
130
+ readonly MODIFYING: "MODIFYING";
131
+ readonly SPLITTING: "SPLITTING";
132
+ readonly STARTING: "STARTING";
133
+ readonly STOPPED: "STOPPED";
134
+ readonly STOPPING: "STOPPING";
185
135
  readonly UPDATING: "UPDATING";
186
136
  readonly VPC_ENDPOINT_LIMIT_EXCEEDED: "VPC_ENDPOINT_LIMIT_EXCEEDED";
187
137
  };
@@ -191,88 +141,89 @@ export declare const Status: {
191
141
  export type Status = (typeof Status)[keyof typeof Status];
192
142
  /**
193
143
  * @public
194
- * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
144
+ * <p>Returns information about a specific elastic cluster snapshot.</p>
195
145
  */
196
- export interface Cluster {
197
- /**
198
- * @public
199
- * <p>The name of the Elastic DocumentDB cluster.</p>
200
- */
201
- clusterName: string | undefined;
202
- /**
203
- * @public
204
- * <p>The arn of the Elastic DocumentDB cluster.</p>
205
- */
206
- clusterArn: string | undefined;
146
+ export interface ClusterSnapshot {
207
147
  /**
208
148
  * @public
209
- * <p>The status of the Elastic DocumentDB cluster.</p>
149
+ * <p>The Amazon EC2 subnet IDs for the elastic cluster.</p>
210
150
  */
211
- status: Status | undefined;
151
+ subnetIds: string[] | undefined;
212
152
  /**
213
153
  * @public
214
- * <p>The URL used to connect to the Elastic DocumentDB cluster.</p>
154
+ * <p>The name of the elastic cluster snapshot.</p>
215
155
  */
216
- clusterEndpoint: string | undefined;
156
+ snapshotName: string | undefined;
217
157
  /**
218
158
  * @public
219
- * <p>The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).</p>
159
+ * <p>The ARN identifier of the elastic cluster snapshot.</p>
220
160
  */
221
- createTime: string | undefined;
161
+ snapshotArn: string | undefined;
222
162
  /**
223
163
  * @public
224
- * <p>The name of the Elastic DocumentDB cluster administrator.</p>
164
+ * <p>The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).</p>
225
165
  */
226
- adminUserName: string | undefined;
166
+ snapshotCreationTime: string | undefined;
227
167
  /**
228
168
  * @public
229
- * <p>The authentication type for the Elastic DocumentDB cluster.</p>
169
+ * <p>The ARN identifier of the elastic cluster.</p>
230
170
  */
231
- authType: Auth | undefined;
171
+ clusterArn: string | undefined;
232
172
  /**
233
173
  * @public
234
- * <p>The capacity of each shard in the Elastic DocumentDB cluster.</p>
174
+ * <p>The time when the elastic cluster was created in Universal Coordinated Time (UTC).</p>
235
175
  */
236
- shardCapacity: number | undefined;
176
+ clusterCreationTime: string | undefined;
237
177
  /**
238
178
  * @public
239
- * <p>The number of shards in the Elastic DocumentDB cluster.</p>
179
+ * <p>The status of the elastic cluster snapshot.</p>
240
180
  */
241
- shardCount: number | undefined;
181
+ status: Status | undefined;
242
182
  /**
243
183
  * @public
244
- * <p>A list of EC2 VPC security groups associated with this cluster.</p>
184
+ * <p>A list of EC2 VPC security groups to associate with the elastic cluster.</p>
245
185
  */
246
186
  vpcSecurityGroupIds: string[] | undefined;
247
187
  /**
248
188
  * @public
249
- * <p>The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.</p>
189
+ * <p>The name of the elastic cluster administrator.</p>
250
190
  */
251
- subnetIds: string[] | undefined;
191
+ adminUserName: string | undefined;
252
192
  /**
253
193
  * @public
254
- * <p>The weekly time range during which system maintenance can occur,
255
- * in Universal Coordinated Time (UTC).</p>
256
- * <p>
257
- * <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code>
258
- * </p>
194
+ * <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key.
195
+ * If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
196
+ * If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account.
197
+ * Your account has a different default encryption key for each Amazon Region.
198
+ * </p>
259
199
  */
260
- preferredMaintenanceWindow: string | undefined;
200
+ kmsKeyId: string | undefined;
261
201
  /**
262
202
  * @public
263
- * <p>The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.</p>
203
+ * <p>The type of cluster snapshots to be returned.
204
+ * You can specify one of the following values:</p>
205
+ * <ul>
206
+ * <li>
207
+ * <p>
208
+ * <code>automated</code> - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.</p>
209
+ * </li>
210
+ * <li>
211
+ * <p>
212
+ * <code>manual</code> - Return all cluster snapshots that you have manually created for your Amazon Web Services account.</p>
213
+ * </li>
214
+ * </ul>
264
215
  */
265
- kmsKeyId: string | undefined;
216
+ snapshotType?: SnapshotType;
266
217
  }
267
218
  /**
268
219
  * @public
269
220
  */
270
- export interface CreateClusterOutput {
221
+ export interface CopyClusterSnapshotOutput {
271
222
  /**
272
223
  * @public
273
- * <p>The new Elastic DocumentDB cluster that has been created.</p>
224
+ * <p>Returns information about a specific elastic cluster snapshot.</p>
274
225
  */
275
- cluster: Cluster | undefined;
226
+ snapshot: ClusterSnapshot | undefined;
276
227
  }
277
228
  /**
278
229
  * @public
@@ -287,6 +238,28 @@ export declare class InternalServerException extends __BaseException {
287
238
  */
288
239
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
289
240
  }
241
+ /**
242
+ * @public
243
+ * <p>The specified resource could not be located.</p>
244
+ */
245
+ export declare class ResourceNotFoundException extends __BaseException {
246
+ readonly name: "ResourceNotFoundException";
247
+ readonly $fault: "client";
248
+ /**
249
+ * @public
250
+ * <p>The ID of the resource that could not be located.</p>
251
+ */
252
+ resourceId: string | undefined;
253
+ /**
254
+ * @public
255
+ * <p>The type of the resource that could not be found.</p>
256
+ */
257
+ resourceType: string | undefined;
258
+ /**
259
+ * @internal
260
+ */
261
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
262
+ }
290
263
  /**
291
264
  * @public
292
265
  * <p>The service quota for the action was exceeded.</p>
@@ -373,110 +346,299 @@ export declare class ValidationException extends __BaseException {
373
346
  /**
374
347
  * @public
375
348
  */
376
- export interface CreateClusterSnapshotInput {
349
+ export interface CreateClusterInput {
377
350
  /**
378
351
  * @public
379
- * <p>The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.</p>
352
+ * <p>The name of the new elastic cluster. This parameter is stored as
353
+ * a lowercase string.</p>
354
+ * <p>
355
+ * <i>Constraints</i>:</p>
356
+ * <ul>
357
+ * <li>
358
+ * <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p>
359
+ * </li>
360
+ * <li>
361
+ * <p>The first character must be a letter.</p>
362
+ * </li>
363
+ * <li>
364
+ * <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
365
+ * </li>
366
+ * </ul>
367
+ * <p>
368
+ * <i>Example</i>: <code>my-cluster</code>
369
+ * </p>
380
370
  */
381
- clusterArn: string | undefined;
371
+ clusterName: string | undefined;
382
372
  /**
383
373
  * @public
384
- * <p>The name of the Elastic DocumentDB snapshot.</p>
374
+ * <p>The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
375
+ * Valid types are <code>PLAIN_TEXT</code> or <code>SECRET_ARN</code>.</p>
385
376
  */
386
- snapshotName: string | undefined;
377
+ authType: Auth | undefined;
387
378
  /**
388
379
  * @public
389
- * <p>The tags to be assigned to the new Elastic DocumentDB snapshot.</p>
380
+ * <p>The name of the Amazon DocumentDB elastic clusters administrator.</p>
381
+ * <p>
382
+ * <i>Constraints</i>:</p>
383
+ * <ul>
384
+ * <li>
385
+ * <p>Must be from 1 to 63 letters or numbers.</p>
386
+ * </li>
387
+ * <li>
388
+ * <p>The first character must be a letter.</p>
389
+ * </li>
390
+ * <li>
391
+ * <p>Cannot be a reserved word.</p>
392
+ * </li>
393
+ * </ul>
394
+ */
395
+ adminUserName: string | undefined;
396
+ /**
397
+ * @public
398
+ * <p>The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.</p>
399
+ * <p>
400
+ * <i>Constraints</i>:</p>
401
+ * <ul>
402
+ * <li>
403
+ * <p>Must contain from 8 to 100 characters.</p>
404
+ * </li>
405
+ * <li>
406
+ * <p>Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).</p>
407
+ * </li>
408
+ * </ul>
409
+ */
410
+ adminUserPassword: string | undefined;
411
+ /**
412
+ * @public
413
+ * <p>The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.</p>
414
+ */
415
+ shardCapacity: number | undefined;
416
+ /**
417
+ * @public
418
+ * <p>The number of shards assigned to the elastic cluster. Maximum is 32.</p>
419
+ */
420
+ shardCount: number | undefined;
421
+ /**
422
+ * @public
423
+ * <p>A list of EC2 VPC security groups to associate with the new
424
+ * elastic cluster.</p>
425
+ */
426
+ vpcSecurityGroupIds?: string[];
427
+ /**
428
+ * @public
429
+ * <p>The Amazon EC2 subnet IDs for the new elastic cluster.</p>
430
+ */
431
+ subnetIds?: string[];
432
+ /**
433
+ * @public
434
+ * <p>The KMS key identifier to use to encrypt the new elastic cluster.</p>
435
+ * <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
436
+ * encryption key. If you are creating a cluster using the same Amazon account
437
+ * that owns this KMS encryption key, you can use the KMS key alias instead
438
+ * of the ARN as the KMS encryption key.</p>
439
+ * <p>If an encryption key is not specified, Amazon DocumentDB uses the
440
+ * default encryption key that KMS creates for your account. Your account
441
+ * has a different default encryption key for each Amazon Region.</p>
442
+ */
443
+ kmsKeyId?: string;
444
+ /**
445
+ * @public
446
+ * <p>The client token for the elastic cluster.</p>
447
+ */
448
+ clientToken?: string;
449
+ /**
450
+ * @public
451
+ * <p>The weekly time range during which system maintenance can occur,
452
+ * in Universal Coordinated Time (UTC).</p>
453
+ * <p>
454
+ * <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code>
455
+ * </p>
456
+ * <p>
457
+ * <i>Default</i>: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.</p>
458
+ * <p>
459
+ * <i>Valid days</i>: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
460
+ * <p>
461
+ * <i>Constraints</i>: Minimum 30-minute window.</p>
462
+ */
463
+ preferredMaintenanceWindow?: string;
464
+ /**
465
+ * @public
466
+ * <p>The tags to be assigned to the new elastic cluster.</p>
390
467
  */
391
468
  tags?: Record<string, string>;
469
+ /**
470
+ * @public
471
+ * <p>The number of days for which automatic snapshots are retained.</p>
472
+ */
473
+ backupRetentionPeriod?: number;
474
+ /**
475
+ * @public
476
+ * <p>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>backupRetentionPeriod</code>.</p>
477
+ */
478
+ preferredBackupWindow?: string;
479
+ /**
480
+ * @public
481
+ * <p>The number of replica instances applying to all shards in the elastic cluster.
482
+ * A <code>shardInstanceCount</code> value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.</p>
483
+ */
484
+ shardInstanceCount?: number;
392
485
  }
393
486
  /**
394
487
  * @public
395
- * <p>Returns information about a specific Elastic DocumentDB snapshot.</p>
488
+ * <p>The name of the shard.</p>
396
489
  */
397
- export interface ClusterSnapshot {
490
+ export interface Shard {
398
491
  /**
399
492
  * @public
400
- * <p>A list of the IDs of subnets associated with the DB cluster snapshot.</p>
493
+ * <p>The ID of the shard.</p>
401
494
  */
402
- subnetIds: string[] | undefined;
495
+ shardId: string | undefined;
403
496
  /**
404
497
  * @public
405
- * <p>The name of the Elastic DocumentDB snapshot.</p>
498
+ * <p>The time when the shard was created in Universal Coordinated Time (UTC).</p>
406
499
  */
407
- snapshotName: string | undefined;
500
+ createTime: string | undefined;
408
501
  /**
409
502
  * @public
410
- * <p>The arn of the Elastic DocumentDB snapshot</p>
503
+ * <p>The current status of the shard.</p>
411
504
  */
412
- snapshotArn: string | undefined;
505
+ status: Status | undefined;
506
+ }
507
+ /**
508
+ * @public
509
+ * <p>Returns information about a specific elastic cluster.</p>
510
+ */
511
+ export interface Cluster {
413
512
  /**
414
513
  * @public
415
- * <p>The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).</p>
514
+ * <p>The name of the elastic cluster.</p>
416
515
  */
417
- snapshotCreationTime: string | undefined;
516
+ clusterName: string | undefined;
418
517
  /**
419
518
  * @public
420
- * <p>The arn of the Elastic DocumentDB cluster.</p>
519
+ * <p>The ARN identifier of the elastic cluster.</p>
421
520
  */
422
521
  clusterArn: string | undefined;
423
522
  /**
424
523
  * @public
425
- * <p>The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).</p>
524
+ * <p>The status of the elastic cluster.</p>
426
525
  */
427
- clusterCreationTime: string | undefined;
526
+ status: Status | undefined;
428
527
  /**
429
528
  * @public
430
- * <p>The status of the Elastic DocumentDB snapshot.</p>
529
+ * <p>The URL used to connect to the elastic cluster.</p>
431
530
  */
432
- status: Status | undefined;
531
+ clusterEndpoint: string | undefined;
433
532
  /**
434
533
  * @public
435
- * <p>A list of the IDs of the VPC security groups associated with the cluster snapshot.</p>
534
+ * <p>The time when the elastic cluster was created in Universal Coordinated Time (UTC).</p>
436
535
  */
437
- vpcSecurityGroupIds: string[] | undefined;
536
+ createTime: string | undefined;
438
537
  /**
439
538
  * @public
440
- * <p>The name of the Elastic DocumentDB cluster administrator.</p>
539
+ * <p>The name of the elastic cluster administrator.</p>
441
540
  */
442
541
  adminUserName: string | undefined;
443
542
  /**
444
543
  * @public
445
- * <p>The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.</p>
544
+ * <p>The authentication type for the elastic cluster.</p>
545
+ */
546
+ authType: Auth | undefined;
547
+ /**
548
+ * @public
549
+ * <p>The number of vCPUs assigned to each elastic cluster shard. Maximum is 64.
550
+ * Allowed values are 2, 4, 8, 16, 32, 64.</p>
551
+ */
552
+ shardCapacity: number | undefined;
553
+ /**
554
+ * @public
555
+ * <p>The number of shards assigned to the elastic cluster. Maximum is 32.</p>
556
+ */
557
+ shardCount: number | undefined;
558
+ /**
559
+ * @public
560
+ * <p>A list of EC2 VPC security groups associated with thie elastic cluster.</p>
561
+ */
562
+ vpcSecurityGroupIds: string[] | undefined;
563
+ /**
564
+ * @public
565
+ * <p>The Amazon EC2 subnet IDs for the elastic cluster.</p>
566
+ */
567
+ subnetIds: string[] | undefined;
568
+ /**
569
+ * @public
570
+ * <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
571
+ * <p>
572
+ * <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code>
573
+ * </p>
574
+ */
575
+ preferredMaintenanceWindow: string | undefined;
576
+ /**
577
+ * @public
578
+ * <p>The KMS key identifier to use to encrypt the elastic cluster.</p>
446
579
  */
447
580
  kmsKeyId: string | undefined;
581
+ /**
582
+ * @public
583
+ * <p>The total number of shards in the cluster.</p>
584
+ */
585
+ shards?: Shard[];
586
+ /**
587
+ * @public
588
+ * <p>The number of days for which automatic snapshots are retained.</p>
589
+ */
590
+ backupRetentionPeriod?: number;
591
+ /**
592
+ * @public
593
+ * <p>The daily time range during which automated backups are created if automated backups are enabled, as determined by <code>backupRetentionPeriod</code>.</p>
594
+ */
595
+ preferredBackupWindow?: string;
596
+ /**
597
+ * @public
598
+ * <p>The number of replica instances applying to all shards in the cluster.
599
+ * A <code>shardInstanceCount</code> value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.</p>
600
+ */
601
+ shardInstanceCount?: number;
448
602
  }
449
603
  /**
450
604
  * @public
451
605
  */
452
- export interface CreateClusterSnapshotOutput {
606
+ export interface CreateClusterOutput {
453
607
  /**
454
608
  * @public
455
- * <p>Returns information about the new Elastic DocumentDB snapshot.</p>
609
+ * <p>The new elastic cluster that has been created.</p>
456
610
  */
457
- snapshot: ClusterSnapshot | undefined;
611
+ cluster: Cluster | undefined;
458
612
  }
459
613
  /**
460
614
  * @public
461
- * <p>The specified resource could not be located.</p>
462
615
  */
463
- export declare class ResourceNotFoundException extends __BaseException {
464
- readonly name: "ResourceNotFoundException";
465
- readonly $fault: "client";
616
+ export interface CreateClusterSnapshotInput {
466
617
  /**
467
618
  * @public
468
- * <p>The ID of the resource that could not be located.</p>
619
+ * <p>The ARN identifier of the elastic cluster of which you want to create a snapshot.</p>
469
620
  */
470
- resourceId: string | undefined;
621
+ clusterArn: string | undefined;
471
622
  /**
472
623
  * @public
473
- * <p>The type of the resource that could not be found.</p>
624
+ * <p>The name of the new elastic cluster snapshot.</p>
474
625
  */
475
- resourceType: string | undefined;
626
+ snapshotName: string | undefined;
476
627
  /**
477
- * @internal
628
+ * @public
629
+ * <p>The tags to be assigned to the new elastic cluster snapshot.</p>
478
630
  */
479
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
631
+ tags?: Record<string, string>;
632
+ }
633
+ /**
634
+ * @public
635
+ */
636
+ export interface CreateClusterSnapshotOutput {
637
+ /**
638
+ * @public
639
+ * <p>Returns information about the new elastic cluster snapshot.</p>
640
+ */
641
+ snapshot: ClusterSnapshot | undefined;
480
642
  }
481
643
  /**
482
644
  * @public
@@ -484,7 +646,7 @@ export declare class ResourceNotFoundException extends __BaseException {
484
646
  export interface DeleteClusterInput {
485
647
  /**
486
648
  * @public
487
- * <p>The arn of the Elastic DocumentDB cluster that is to be deleted.</p>
649
+ * <p>The ARN identifier of the elastic cluster that is to be deleted.</p>
488
650
  */
489
651
  clusterArn: string | undefined;
490
652
  }
@@ -494,7 +656,7 @@ export interface DeleteClusterInput {
494
656
  export interface DeleteClusterOutput {
495
657
  /**
496
658
  * @public
497
- * <p>Returns information about the newly deleted Elastic DocumentDB cluster.</p>
659
+ * <p>Returns information about the newly deleted elastic cluster.</p>
498
660
  */
499
661
  cluster: Cluster | undefined;
500
662
  }
@@ -504,7 +666,7 @@ export interface DeleteClusterOutput {
504
666
  export interface DeleteClusterSnapshotInput {
505
667
  /**
506
668
  * @public
507
- * <p>The arn of the Elastic DocumentDB snapshot that is to be deleted.</p>
669
+ * <p>The ARN identifier of the elastic cluster snapshot that is to be deleted.</p>
508
670
  */
509
671
  snapshotArn: string | undefined;
510
672
  }
@@ -514,7 +676,7 @@ export interface DeleteClusterSnapshotInput {
514
676
  export interface DeleteClusterSnapshotOutput {
515
677
  /**
516
678
  * @public
517
- * <p>Returns information about the newly deleted Elastic DocumentDB snapshot.</p>
679
+ * <p>Returns information about the newly deleted elastic cluster snapshot.</p>
518
680
  */
519
681
  snapshot: ClusterSnapshot | undefined;
520
682
  }
@@ -524,7 +686,7 @@ export interface DeleteClusterSnapshotOutput {
524
686
  export interface GetClusterInput {
525
687
  /**
526
688
  * @public
527
- * <p>The arn of the Elastic DocumentDB cluster.</p>
689
+ * <p>The ARN identifier of the elastic cluster.</p>
528
690
  */
529
691
  clusterArn: string | undefined;
530
692
  }
@@ -534,7 +696,7 @@ export interface GetClusterInput {
534
696
  export interface GetClusterOutput {
535
697
  /**
536
698
  * @public
537
- * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
699
+ * <p>Returns information about a specific elastic cluster.</p>
538
700
  */
539
701
  cluster: Cluster | undefined;
540
702
  }
@@ -544,7 +706,7 @@ export interface GetClusterOutput {
544
706
  export interface GetClusterSnapshotInput {
545
707
  /**
546
708
  * @public
547
- * <p>The arn of the Elastic DocumentDB snapshot.</p>
709
+ * <p>The ARN identifier of the elastic cluster snapshot.</p>
548
710
  */
549
711
  snapshotArn: string | undefined;
550
712
  }
@@ -554,7 +716,7 @@ export interface GetClusterSnapshotInput {
554
716
  export interface GetClusterSnapshotOutput {
555
717
  /**
556
718
  * @public
557
- * <p>Returns information about a specific Elastic DocumentDB snapshot.</p>
719
+ * <p>Returns information about a specific elastic cluster snapshot.</p>
558
720
  */
559
721
  snapshot: ClusterSnapshot | undefined;
560
722
  }
@@ -564,33 +726,35 @@ export interface GetClusterSnapshotOutput {
564
726
  export interface ListClustersInput {
565
727
  /**
566
728
  * @public
567
- * <p>The nextToken which is used the get the next page of data.</p>
729
+ * <p>A pagination token provided by a previous request.
730
+ * If this parameter is specified, the response includes only records beyond this token, up to the value specified by <code>max-results</code>.</p>
731
+ * <p>If there is no more data in the responce, the <code>nextToken</code> will not be returned.</p>
568
732
  */
569
733
  nextToken?: string;
570
734
  /**
571
735
  * @public
572
- * <p>The maximum number of entries to recieve in the response.</p>
736
+ * <p>The maximum number of elastic cluster snapshot results to receive in the response.</p>
573
737
  */
574
738
  maxResults?: number;
575
739
  }
576
740
  /**
577
741
  * @public
578
- * <p>A list of Elastic DocumentDB cluster.</p>
742
+ * <p>A list of Amazon DocumentDB elastic clusters.</p>
579
743
  */
580
744
  export interface ClusterInList {
581
745
  /**
582
746
  * @public
583
- * <p>The name of the Elastic DocumentDB cluster.</p>
747
+ * <p>The name of the elastic cluster.</p>
584
748
  */
585
749
  clusterName: string | undefined;
586
750
  /**
587
751
  * @public
588
- * <p>The arn of the Elastic DocumentDB cluster.</p>
752
+ * <p>The ARN identifier of the elastic cluster.</p>
589
753
  */
590
754
  clusterArn: string | undefined;
591
755
  /**
592
756
  * @public
593
- * <p>The status of the Elastic DocumentDB cluster.</p>
757
+ * <p>The status of the elastic cluster.</p>
594
758
  */
595
759
  status: Status | undefined;
596
760
  }
@@ -600,13 +764,14 @@ export interface ClusterInList {
600
764
  export interface ListClustersOutput {
601
765
  /**
602
766
  * @public
603
- * <p>A list of Elastic DocumentDB cluster.</p>
767
+ * <p>A list of Amazon DocumentDB elastic clusters.</p>
604
768
  */
605
769
  clusters?: ClusterInList[];
606
770
  /**
607
771
  * @public
608
- * <p>The response will provide a nextToken if there is more data beyond the maxResults.</p>
609
- * <p>If there is no more data in the responce, the nextToken will not be returned.</p>
772
+ * <p>A pagination token provided by a previous request.
773
+ * If this parameter is specified, the response includes only records beyond this token, up to the value specified by <code>max-results</code>.</p>
774
+ * <p>If there is no more data in the responce, the <code>nextToken</code> will not be returned.</p>
610
775
  */
611
776
  nextToken?: string;
612
777
  }
@@ -616,48 +781,65 @@ export interface ListClustersOutput {
616
781
  export interface ListClusterSnapshotsInput {
617
782
  /**
618
783
  * @public
619
- * <p>The arn of the Elastic DocumentDB cluster.</p>
784
+ * <p>The ARN identifier of the elastic cluster.</p>
620
785
  */
621
786
  clusterArn?: string;
622
787
  /**
623
788
  * @public
624
- * <p>The nextToken which is used the get the next page of data.</p>
789
+ * <p>A pagination token provided by a previous request.
790
+ * If this parameter is specified, the response includes only records beyond this token, up to the value specified by <code>max-results</code>.</p>
791
+ * <p>If there is no more data in the responce, the <code>nextToken</code> will not be returned.</p>
625
792
  */
626
793
  nextToken?: string;
627
794
  /**
628
795
  * @public
629
- * <p>The maximum number of entries to recieve in the response.</p>
796
+ * <p>The maximum number of elastic cluster snapshot results to receive in the response.</p>
630
797
  */
631
798
  maxResults?: number;
799
+ /**
800
+ * @public
801
+ * <p>The type of cluster snapshots to be returned. You can specify one of the following values:</p>
802
+ * <ul>
803
+ * <li>
804
+ * <p>
805
+ * <code>automated</code> - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.</p>
806
+ * </li>
807
+ * <li>
808
+ * <p>
809
+ * <code>manual</code> - Return all cluster snapshots that you have manually created for your Amazon Web Services account.</p>
810
+ * </li>
811
+ * </ul>
812
+ */
813
+ snapshotType?: string;
632
814
  }
633
815
  /**
634
816
  * @public
635
- * <p>A list of Elastic DocumentDB snapshots.</p>
817
+ * <p>A list of elastic cluster snapshots.</p>
636
818
  */
637
819
  export interface ClusterSnapshotInList {
638
820
  /**
639
821
  * @public
640
- * <p>The name of the Elastic DocumentDB snapshot.</p>
822
+ * <p>The name of the elastic cluster snapshot.</p>
641
823
  */
642
824
  snapshotName: string | undefined;
643
825
  /**
644
826
  * @public
645
- * <p>The arn of the Elastic DocumentDB snapshot</p>
827
+ * <p>The ARN identifier of the elastic cluster snapshot.</p>
646
828
  */
647
829
  snapshotArn: string | undefined;
648
830
  /**
649
831
  * @public
650
- * <p>The arn of the Elastic DocumentDB cluster.</p>
832
+ * <p>The ARN identifier of the elastic cluster.</p>
651
833
  */
652
834
  clusterArn: string | undefined;
653
835
  /**
654
836
  * @public
655
- * <p>The status of the Elastic DocumentDB snapshot.</p>
837
+ * <p>The status of the elastic cluster snapshot.</p>
656
838
  */
657
839
  status: Status | undefined;
658
840
  /**
659
841
  * @public
660
- * <p>The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).</p>
842
+ * <p>The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).</p>
661
843
  */
662
844
  snapshotCreationTime: string | undefined;
663
845
  }
@@ -667,13 +849,14 @@ export interface ClusterSnapshotInList {
667
849
  export interface ListClusterSnapshotsOutput {
668
850
  /**
669
851
  * @public
670
- * <p>A list of Elastic DocumentDB snapshots for a specified cluster.</p>
852
+ * <p>A list of snapshots for a specified elastic cluster.</p>
671
853
  */
672
854
  snapshots?: ClusterSnapshotInList[];
673
855
  /**
674
856
  * @public
675
- * <p>The response will provide a nextToken if there is more data beyond the maxResults.</p>
676
- * <p>If there is no more data in the responce, the nextToken will not be returned.</p>
857
+ * <p>A pagination token provided by a previous request.
858
+ * If this parameter is specified, the response includes only records beyond this token, up to the value specified by <code>max-results</code>.</p>
859
+ * <p>If there is no more data in the responce, the <code>nextToken</code> will not be returned.</p>
677
860
  */
678
861
  nextToken?: string;
679
862
  }
@@ -683,7 +866,7 @@ export interface ListClusterSnapshotsOutput {
683
866
  export interface ListTagsForResourceRequest {
684
867
  /**
685
868
  * @public
686
- * <p>The arn of the Elastic DocumentDB resource.</p>
869
+ * <p>The ARN identifier of the elastic cluster resource.</p>
687
870
  */
688
871
  resourceArn: string | undefined;
689
872
  }
@@ -693,7 +876,7 @@ export interface ListTagsForResourceRequest {
693
876
  export interface ListTagsForResourceResponse {
694
877
  /**
695
878
  * @public
696
- * <p>The list of tags for the specified Elastic DocumentDB resource.</p>
879
+ * <p>The list of tags for the specified elastic cluster resource.</p>
697
880
  */
698
881
  tags?: Record<string, string>;
699
882
  }
@@ -703,44 +886,52 @@ export interface ListTagsForResourceResponse {
703
886
  export interface RestoreClusterFromSnapshotInput {
704
887
  /**
705
888
  * @public
706
- * <p>The name of the Elastic DocumentDB cluster.</p>
889
+ * <p>The name of the elastic cluster.</p>
707
890
  */
708
891
  clusterName: string | undefined;
709
892
  /**
710
893
  * @public
711
- * <p>The arn of the Elastic DocumentDB snapshot.</p>
894
+ * <p>The ARN identifier of the elastic cluster snapshot.</p>
712
895
  */
713
896
  snapshotArn: string | undefined;
714
897
  /**
715
898
  * @public
716
- * <p>A list of EC2 VPC security groups to associate with the
717
- * Elastic DocumentDB cluster.</p>
899
+ * <p>A list of EC2 VPC security groups to associate with the elastic cluster.</p>
718
900
  */
719
901
  vpcSecurityGroupIds?: string[];
720
902
  /**
721
903
  * @public
722
- * <p>The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.</p>
904
+ * <p>The Amazon EC2 subnet IDs for the elastic cluster.</p>
723
905
  */
724
906
  subnetIds?: string[];
725
907
  /**
726
908
  * @public
727
- * <p>The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.</p>
909
+ * <p>The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.</p>
728
910
  * <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
729
911
  * encryption key. If you are creating a cluster using the same Amazon account
730
912
  * that owns this KMS encryption key, you can use the KMS key alias instead
731
913
  * of the ARN as the KMS encryption key.</p>
732
- * <p>If an encryption key is not specified here, Elastic DocumentDB uses the
914
+ * <p>If an encryption key is not specified here, Amazon DocumentDB uses the
733
915
  * default encryption key that KMS creates for your account. Your account
734
916
  * has a different default encryption key for each Amazon Region.</p>
735
917
  */
736
918
  kmsKeyId?: string;
737
919
  /**
738
920
  * @public
739
- * <p>A list of the tag names to be assigned to the restored DB cluster,
740
- * in the form of an array of key-value pairs in which the key
741
- * is the tag name and the value is the key value.</p>
921
+ * <p>A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.</p>
742
922
  */
743
923
  tags?: Record<string, string>;
924
+ /**
925
+ * @public
926
+ * <p>The capacity of each shard in the new restored elastic cluster.</p>
927
+ */
928
+ shardCapacity?: number;
929
+ /**
930
+ * @public
931
+ * <p>The number of replica instances applying to all shards in the elastic cluster.
932
+ * A <code>shardInstanceCount</code> value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.</p>
933
+ */
934
+ shardInstanceCount?: number;
744
935
  }
745
936
  /**
746
937
  * @public
@@ -748,7 +939,47 @@ export interface RestoreClusterFromSnapshotInput {
748
939
  export interface RestoreClusterFromSnapshotOutput {
749
940
  /**
750
941
  * @public
751
- * <p>Returns information about a the restored Elastic DocumentDB cluster.</p>
942
+ * <p>Returns information about a the restored elastic cluster.</p>
943
+ */
944
+ cluster: Cluster | undefined;
945
+ }
946
+ /**
947
+ * @public
948
+ */
949
+ export interface StartClusterInput {
950
+ /**
951
+ * @public
952
+ * <p>The ARN identifier of the elastic cluster.</p>
953
+ */
954
+ clusterArn: string | undefined;
955
+ }
956
+ /**
957
+ * @public
958
+ */
959
+ export interface StartClusterOutput {
960
+ /**
961
+ * @public
962
+ * <p>Returns information about a specific elastic cluster.</p>
963
+ */
964
+ cluster: Cluster | undefined;
965
+ }
966
+ /**
967
+ * @public
968
+ */
969
+ export interface StopClusterInput {
970
+ /**
971
+ * @public
972
+ * <p>The ARN identifier of the elastic cluster.</p>
973
+ */
974
+ clusterArn: string | undefined;
975
+ }
976
+ /**
977
+ * @public
978
+ */
979
+ export interface StopClusterOutput {
980
+ /**
981
+ * @public
982
+ * <p>Returns information about a specific elastic cluster.</p>
752
983
  */
753
984
  cluster: Cluster | undefined;
754
985
  }
@@ -758,12 +989,12 @@ export interface RestoreClusterFromSnapshotOutput {
758
989
  export interface TagResourceRequest {
759
990
  /**
760
991
  * @public
761
- * <p>The arn of the Elastic DocumentDB resource.</p>
992
+ * <p>The ARN identifier of the elastic cluster resource.</p>
762
993
  */
763
994
  resourceArn: string | undefined;
764
995
  /**
765
996
  * @public
766
- * <p>The tags to be assigned to the Elastic DocumentDB resource.</p>
997
+ * <p>The tags that are assigned to the elastic cluster resource.</p>
767
998
  */
768
999
  tags: Record<string, string> | undefined;
769
1000
  }
@@ -778,12 +1009,12 @@ export interface TagResourceResponse {
778
1009
  export interface UntagResourceRequest {
779
1010
  /**
780
1011
  * @public
781
- * <p>The arn of the Elastic DocumentDB resource.</p>
1012
+ * <p>The ARN identifier of the elastic cluster resource.</p>
782
1013
  */
783
1014
  resourceArn: string | undefined;
784
1015
  /**
785
1016
  * @public
786
- * <p>The tag keys to be removed from the Elastic DocumentDB resource.</p>
1017
+ * <p>The tag keys to be removed from the elastic cluster resource.</p>
787
1018
  */
788
1019
  tagKeys: string[] | undefined;
789
1020
  }
@@ -798,53 +1029,52 @@ export interface UntagResourceResponse {
798
1029
  export interface UpdateClusterInput {
799
1030
  /**
800
1031
  * @public
801
- * <p>The arn of the Elastic DocumentDB cluster.</p>
1032
+ * <p>The ARN identifier of the elastic cluster.</p>
802
1033
  */
803
1034
  clusterArn: string | undefined;
804
1035
  /**
805
1036
  * @public
806
- * <p>The authentication type for the Elastic DocumentDB cluster.</p>
1037
+ * <p>The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
1038
+ * Valid types are <code>PLAIN_TEXT</code> or <code>SECRET_ARN</code>.</p>
807
1039
  */
808
1040
  authType?: Auth;
809
1041
  /**
810
1042
  * @public
811
- * <p>The capacity of each shard in the Elastic DocumentDB cluster.</p>
1043
+ * <p>The number of vCPUs assigned to each elastic cluster shard.
1044
+ * Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.</p>
812
1045
  */
813
1046
  shardCapacity?: number;
814
1047
  /**
815
1048
  * @public
816
- * <p>The number of shards to create in the Elastic DocumentDB cluster.</p>
1049
+ * <p>The number of shards assigned to the elastic cluster. Maximum is 32.</p>
817
1050
  */
818
1051
  shardCount?: number;
819
1052
  /**
820
1053
  * @public
821
- * <p>A list of EC2 VPC security groups to associate with the new
822
- * Elastic DocumentDB cluster.</p>
1054
+ * <p>A list of EC2 VPC security groups to associate with the elastic cluster.</p>
823
1055
  */
824
1056
  vpcSecurityGroupIds?: string[];
825
1057
  /**
826
1058
  * @public
827
- * <p>The number of shards to create in the Elastic DocumentDB cluster.</p>
1059
+ * <p>The Amazon EC2 subnet IDs for the elastic cluster.</p>
828
1060
  */
829
1061
  subnetIds?: string[];
830
1062
  /**
831
1063
  * @public
832
- * <p>The password for the Elastic DocumentDB cluster administrator. This password can
833
- * contain any printable ASCII character except forward slash (/),
834
- * double quote ("), or the "at" symbol (@).</p>
1064
+ * <p>The password associated with the elastic cluster administrator.
1065
+ * This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).</p>
835
1066
  * <p>
836
1067
  * <i>Constraints</i>: Must contain from 8 to 100 characters.</p>
837
1068
  */
838
1069
  adminUserPassword?: string;
839
1070
  /**
840
1071
  * @public
841
- * <p>The client token for the Elastic DocumentDB cluster.</p>
1072
+ * <p>The client token for the elastic cluster.</p>
842
1073
  */
843
1074
  clientToken?: string;
844
1075
  /**
845
1076
  * @public
846
- * <p>The weekly time range during which system maintenance can occur,
847
- * in Universal Coordinated Time (UTC).</p>
1077
+ * <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
848
1078
  * <p>
849
1079
  * <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code>
850
1080
  * </p>
@@ -856,6 +1086,22 @@ export interface UpdateClusterInput {
856
1086
  * <i>Constraints</i>: Minimum 30-minute window.</p>
857
1087
  */
858
1088
  preferredMaintenanceWindow?: string;
1089
+ /**
1090
+ * @public
1091
+ * <p>The number of days for which automatic snapshots are retained.</p>
1092
+ */
1093
+ backupRetentionPeriod?: number;
1094
+ /**
1095
+ * @public
1096
+ * <p>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>backupRetentionPeriod</code>.</p>
1097
+ */
1098
+ preferredBackupWindow?: string;
1099
+ /**
1100
+ * @public
1101
+ * <p>The number of replica instances applying to all shards in the elastic cluster.
1102
+ * A <code>shardInstanceCount</code> value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.</p>
1103
+ */
1104
+ shardInstanceCount?: number;
859
1105
  }
860
1106
  /**
861
1107
  * @public
@@ -863,7 +1109,7 @@ export interface UpdateClusterInput {
863
1109
  export interface UpdateClusterOutput {
864
1110
  /**
865
1111
  * @public
866
- * <p>Returns information about the updated Elastic DocumentDB cluster.</p>
1112
+ * <p>Returns information about the updated elastic cluster.</p>
867
1113
  */
868
1114
  cluster: Cluster | undefined;
869
1115
  }