@aws-sdk/client-docdb-elastic 3.533.0 → 3.540.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.
- package/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/DocDBElastic.d.ts +3 -1
- package/dist-types/DocDBElasticClient.d.ts +1 -1
- package/dist-types/commands/CopyClusterSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/CreateClusterCommand.d.ts +2 -1
- package/dist-types/commands/CreateClusterSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/DeleteClusterCommand.d.ts +2 -1
- package/dist-types/commands/DeleteClusterSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/GetClusterCommand.d.ts +2 -1
- package/dist-types/commands/GetClusterSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/ListClusterSnapshotsCommand.d.ts +2 -1
- package/dist-types/commands/ListClustersCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/RestoreClusterFromSnapshotCommand.d.ts +2 -1
- package/dist-types/commands/StartClusterCommand.d.ts +2 -1
- package/dist-types/commands/StopClusterCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateClusterCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +137 -137
- package/dist-types/ts3.4/DocDBElastic.d.ts +2 -0
- package/dist-types/ts3.4/commands/CopyClusterSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateClusterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateClusterSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteClusterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteClusterSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetClusterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetClusterSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListClusterSnapshotsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListClustersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RestoreClusterFromSnapshotCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartClusterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopClusterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateClusterCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { DocDBElasticServiceException as __BaseException } from "./DocDBElasticServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>An exception that occurs when there are not sufficient permissions to perform an action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -25,20 +25,20 @@ export declare const Auth: {
|
|
|
25
25
|
*/
|
|
26
26
|
export type Auth = (typeof Auth)[keyof typeof Auth];
|
|
27
27
|
/**
|
|
28
|
-
* @public
|
|
29
28
|
* <p>There was an access conflict.</p>
|
|
29
|
+
* @public
|
|
30
30
|
*/
|
|
31
31
|
export declare class ConflictException extends __BaseException {
|
|
32
32
|
readonly name: "ConflictException";
|
|
33
33
|
readonly $fault: "client";
|
|
34
34
|
/**
|
|
35
|
-
* @public
|
|
36
35
|
* <p>The ID of the resource where there was an access conflict.</p>
|
|
36
|
+
* @public
|
|
37
37
|
*/
|
|
38
38
|
resourceId: string | undefined;
|
|
39
39
|
/**
|
|
40
|
-
* @public
|
|
41
40
|
* <p>The type of the resource where there was an access conflict.</p>
|
|
41
|
+
* @public
|
|
42
42
|
*/
|
|
43
43
|
resourceType: string | undefined;
|
|
44
44
|
/**
|
|
@@ -51,12 +51,11 @@ export declare class ConflictException extends __BaseException {
|
|
|
51
51
|
*/
|
|
52
52
|
export interface CopyClusterSnapshotInput {
|
|
53
53
|
/**
|
|
54
|
-
* @public
|
|
55
54
|
* <p>The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.</p>
|
|
55
|
+
* @public
|
|
56
56
|
*/
|
|
57
57
|
snapshotArn: string | undefined;
|
|
58
58
|
/**
|
|
59
|
-
* @public
|
|
60
59
|
* <p>The identifier of the new elastic cluster snapshot to create from the source cluster snapshot.
|
|
61
60
|
* This parameter is not case sensitive.</p>
|
|
62
61
|
* <p>Constraints:</p>
|
|
@@ -73,10 +72,10 @@ export interface CopyClusterSnapshotInput {
|
|
|
73
72
|
* </ul>
|
|
74
73
|
* <p>Example: <code>elastic-cluster-snapshot-5</code>
|
|
75
74
|
* </p>
|
|
75
|
+
* @public
|
|
76
76
|
*/
|
|
77
77
|
targetSnapshotName: string | undefined;
|
|
78
78
|
/**
|
|
79
|
-
* @public
|
|
80
79
|
* <p>The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot.
|
|
81
80
|
* 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
81
|
* <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.
|
|
@@ -84,17 +83,18 @@ export interface CopyClusterSnapshotInput {
|
|
|
84
83
|
* <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
84
|
* 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
85
|
* <p>If you copy an unencrypted elastic cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>
|
|
86
|
+
* @public
|
|
87
87
|
*/
|
|
88
88
|
kmsKeyId?: string;
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>Set to <code>true</code> to copy all tags from the source cluster snapshot to the target elastic cluster snapshot.
|
|
92
91
|
* The default is <code>false</code>.</p>
|
|
92
|
+
* @public
|
|
93
93
|
*/
|
|
94
94
|
copyTags?: boolean;
|
|
95
95
|
/**
|
|
96
|
-
* @public
|
|
97
96
|
* <p>The tags to be assigned to the elastic cluster snapshot.</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
tags?: Record<string, string>;
|
|
100
100
|
}
|
|
@@ -140,66 +140,65 @@ export declare const Status: {
|
|
|
140
140
|
*/
|
|
141
141
|
export type Status = (typeof Status)[keyof typeof Status];
|
|
142
142
|
/**
|
|
143
|
-
* @public
|
|
144
143
|
* <p>Returns information about a specific elastic cluster snapshot.</p>
|
|
144
|
+
* @public
|
|
145
145
|
*/
|
|
146
146
|
export interface ClusterSnapshot {
|
|
147
147
|
/**
|
|
148
|
-
* @public
|
|
149
148
|
* <p>The Amazon EC2 subnet IDs for the elastic cluster.</p>
|
|
149
|
+
* @public
|
|
150
150
|
*/
|
|
151
151
|
subnetIds: string[] | undefined;
|
|
152
152
|
/**
|
|
153
|
-
* @public
|
|
154
153
|
* <p>The name of the elastic cluster snapshot.</p>
|
|
154
|
+
* @public
|
|
155
155
|
*/
|
|
156
156
|
snapshotName: string | undefined;
|
|
157
157
|
/**
|
|
158
|
-
* @public
|
|
159
158
|
* <p>The ARN identifier of the elastic cluster snapshot.</p>
|
|
159
|
+
* @public
|
|
160
160
|
*/
|
|
161
161
|
snapshotArn: string | undefined;
|
|
162
162
|
/**
|
|
163
|
-
* @public
|
|
164
163
|
* <p>The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).</p>
|
|
164
|
+
* @public
|
|
165
165
|
*/
|
|
166
166
|
snapshotCreationTime: string | undefined;
|
|
167
167
|
/**
|
|
168
|
-
* @public
|
|
169
168
|
* <p>The ARN identifier of the elastic cluster.</p>
|
|
169
|
+
* @public
|
|
170
170
|
*/
|
|
171
171
|
clusterArn: string | undefined;
|
|
172
172
|
/**
|
|
173
|
-
* @public
|
|
174
173
|
* <p>The time when the elastic cluster was created in Universal Coordinated Time (UTC).</p>
|
|
174
|
+
* @public
|
|
175
175
|
*/
|
|
176
176
|
clusterCreationTime: string | undefined;
|
|
177
177
|
/**
|
|
178
|
-
* @public
|
|
179
178
|
* <p>The status of the elastic cluster snapshot.</p>
|
|
179
|
+
* @public
|
|
180
180
|
*/
|
|
181
181
|
status: Status | undefined;
|
|
182
182
|
/**
|
|
183
|
-
* @public
|
|
184
183
|
* <p>A list of EC2 VPC security groups to associate with the elastic cluster.</p>
|
|
184
|
+
* @public
|
|
185
185
|
*/
|
|
186
186
|
vpcSecurityGroupIds: string[] | undefined;
|
|
187
187
|
/**
|
|
188
|
-
* @public
|
|
189
188
|
* <p>The name of the elastic cluster administrator.</p>
|
|
189
|
+
* @public
|
|
190
190
|
*/
|
|
191
191
|
adminUserName: string | undefined;
|
|
192
192
|
/**
|
|
193
|
-
* @public
|
|
194
193
|
* <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key.
|
|
195
194
|
* 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
195
|
* If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account.
|
|
197
196
|
* Your account has a different default encryption key for each Amazon Region.
|
|
198
197
|
* </p>
|
|
198
|
+
* @public
|
|
199
199
|
*/
|
|
200
200
|
kmsKeyId: string | undefined;
|
|
201
201
|
/**
|
|
202
|
-
* @public
|
|
203
202
|
* <p>The type of cluster snapshots to be returned.
|
|
204
203
|
* You can specify one of the following values:</p>
|
|
205
204
|
* <ul>
|
|
@@ -212,6 +211,7 @@ export interface ClusterSnapshot {
|
|
|
212
211
|
* <code>manual</code> - Return all cluster snapshots that you have manually created for your Amazon Web Services account.</p>
|
|
213
212
|
* </li>
|
|
214
213
|
* </ul>
|
|
214
|
+
* @public
|
|
215
215
|
*/
|
|
216
216
|
snapshotType?: SnapshotType;
|
|
217
217
|
}
|
|
@@ -220,14 +220,14 @@ export interface ClusterSnapshot {
|
|
|
220
220
|
*/
|
|
221
221
|
export interface CopyClusterSnapshotOutput {
|
|
222
222
|
/**
|
|
223
|
-
* @public
|
|
224
223
|
* <p>Returns information about a specific elastic cluster snapshot.</p>
|
|
224
|
+
* @public
|
|
225
225
|
*/
|
|
226
226
|
snapshot: ClusterSnapshot | undefined;
|
|
227
227
|
}
|
|
228
228
|
/**
|
|
229
|
-
* @public
|
|
230
229
|
* <p>There was an internal server error.</p>
|
|
230
|
+
* @public
|
|
231
231
|
*/
|
|
232
232
|
export declare class InternalServerException extends __BaseException {
|
|
233
233
|
readonly name: "InternalServerException";
|
|
@@ -239,20 +239,20 @@ export declare class InternalServerException extends __BaseException {
|
|
|
239
239
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
240
240
|
}
|
|
241
241
|
/**
|
|
242
|
-
* @public
|
|
243
242
|
* <p>The specified resource could not be located.</p>
|
|
243
|
+
* @public
|
|
244
244
|
*/
|
|
245
245
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
246
246
|
readonly name: "ResourceNotFoundException";
|
|
247
247
|
readonly $fault: "client";
|
|
248
248
|
/**
|
|
249
|
-
* @public
|
|
250
249
|
* <p>The ID of the resource that could not be located.</p>
|
|
250
|
+
* @public
|
|
251
251
|
*/
|
|
252
252
|
resourceId: string | undefined;
|
|
253
253
|
/**
|
|
254
|
-
* @public
|
|
255
254
|
* <p>The type of the resource that could not be found.</p>
|
|
255
|
+
* @public
|
|
256
256
|
*/
|
|
257
257
|
resourceType: string | undefined;
|
|
258
258
|
/**
|
|
@@ -261,8 +261,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
261
261
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
262
262
|
}
|
|
263
263
|
/**
|
|
264
|
-
* @public
|
|
265
264
|
* <p>The service quota for the action was exceeded.</p>
|
|
265
|
+
* @public
|
|
266
266
|
*/
|
|
267
267
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
268
268
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -273,16 +273,16 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
273
273
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
274
274
|
}
|
|
275
275
|
/**
|
|
276
|
-
* @public
|
|
277
276
|
* <p>ThrottlingException will be thrown when request was denied due to request throttling.</p>
|
|
277
|
+
* @public
|
|
278
278
|
*/
|
|
279
279
|
export declare class ThrottlingException extends __BaseException {
|
|
280
280
|
readonly name: "ThrottlingException";
|
|
281
281
|
readonly $fault: "client";
|
|
282
282
|
$retryable: {};
|
|
283
283
|
/**
|
|
284
|
-
* @public
|
|
285
284
|
* <p>The number of seconds to wait before retrying the operation.</p>
|
|
285
|
+
* @public
|
|
286
286
|
*/
|
|
287
287
|
retryAfterSeconds?: number;
|
|
288
288
|
/**
|
|
@@ -291,18 +291,18 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
291
291
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
292
292
|
}
|
|
293
293
|
/**
|
|
294
|
-
* @public
|
|
295
294
|
* <p>A specific field in which a given validation exception occurred.</p>
|
|
295
|
+
* @public
|
|
296
296
|
*/
|
|
297
297
|
export interface ValidationExceptionField {
|
|
298
298
|
/**
|
|
299
|
-
* @public
|
|
300
299
|
* <p>The name of the field where the validation exception occurred.</p>
|
|
300
|
+
* @public
|
|
301
301
|
*/
|
|
302
302
|
name: string | undefined;
|
|
303
303
|
/**
|
|
304
|
-
* @public
|
|
305
304
|
* <p>An error message describing the validation exception in this field.</p>
|
|
305
|
+
* @public
|
|
306
306
|
*/
|
|
307
307
|
message: string | undefined;
|
|
308
308
|
}
|
|
@@ -321,21 +321,21 @@ export declare const ValidationExceptionReason: {
|
|
|
321
321
|
*/
|
|
322
322
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
323
323
|
/**
|
|
324
|
-
* @public
|
|
325
324
|
* <p>A structure defining a validation exception.</p>
|
|
325
|
+
* @public
|
|
326
326
|
*/
|
|
327
327
|
export declare class ValidationException extends __BaseException {
|
|
328
328
|
readonly name: "ValidationException";
|
|
329
329
|
readonly $fault: "client";
|
|
330
330
|
/**
|
|
331
|
-
* @public
|
|
332
331
|
* <p>The reason why the validation exception occurred (one of <code>unknownOperation</code>,
|
|
333
332
|
* <code>cannotParse</code>, <code>fieldValidationFailed</code>, or <code>other</code>).</p>
|
|
333
|
+
* @public
|
|
334
334
|
*/
|
|
335
335
|
reason: ValidationExceptionReason | undefined;
|
|
336
336
|
/**
|
|
337
|
-
* @public
|
|
338
337
|
* <p>A list of the fields in which the validation exception occurred.</p>
|
|
338
|
+
* @public
|
|
339
339
|
*/
|
|
340
340
|
fieldList?: ValidationExceptionField[];
|
|
341
341
|
/**
|
|
@@ -348,7 +348,6 @@ export declare class ValidationException extends __BaseException {
|
|
|
348
348
|
*/
|
|
349
349
|
export interface CreateClusterInput {
|
|
350
350
|
/**
|
|
351
|
-
* @public
|
|
352
351
|
* <p>The name of the new elastic cluster. This parameter is stored as
|
|
353
352
|
* a lowercase string.</p>
|
|
354
353
|
* <p>
|
|
@@ -367,16 +366,16 @@ export interface CreateClusterInput {
|
|
|
367
366
|
* <p>
|
|
368
367
|
* <i>Example</i>: <code>my-cluster</code>
|
|
369
368
|
* </p>
|
|
369
|
+
* @public
|
|
370
370
|
*/
|
|
371
371
|
clusterName: string | undefined;
|
|
372
372
|
/**
|
|
373
|
-
* @public
|
|
374
373
|
* <p>The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
|
|
375
374
|
* Valid types are <code>PLAIN_TEXT</code> or <code>SECRET_ARN</code>.</p>
|
|
375
|
+
* @public
|
|
376
376
|
*/
|
|
377
377
|
authType: Auth | undefined;
|
|
378
378
|
/**
|
|
379
|
-
* @public
|
|
380
379
|
* <p>The name of the Amazon DocumentDB elastic clusters administrator.</p>
|
|
381
380
|
* <p>
|
|
382
381
|
* <i>Constraints</i>:</p>
|
|
@@ -391,10 +390,10 @@ export interface CreateClusterInput {
|
|
|
391
390
|
* <p>Cannot be a reserved word.</p>
|
|
392
391
|
* </li>
|
|
393
392
|
* </ul>
|
|
393
|
+
* @public
|
|
394
394
|
*/
|
|
395
395
|
adminUserName: string | undefined;
|
|
396
396
|
/**
|
|
397
|
-
* @public
|
|
398
397
|
* <p>The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.</p>
|
|
399
398
|
* <p>
|
|
400
399
|
* <i>Constraints</i>:</p>
|
|
@@ -406,31 +405,31 @@ export interface CreateClusterInput {
|
|
|
406
405
|
* <p>Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).</p>
|
|
407
406
|
* </li>
|
|
408
407
|
* </ul>
|
|
408
|
+
* @public
|
|
409
409
|
*/
|
|
410
410
|
adminUserPassword: string | undefined;
|
|
411
411
|
/**
|
|
412
|
-
* @public
|
|
413
412
|
* <p>The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.</p>
|
|
413
|
+
* @public
|
|
414
414
|
*/
|
|
415
415
|
shardCapacity: number | undefined;
|
|
416
416
|
/**
|
|
417
|
-
* @public
|
|
418
417
|
* <p>The number of shards assigned to the elastic cluster. Maximum is 32.</p>
|
|
418
|
+
* @public
|
|
419
419
|
*/
|
|
420
420
|
shardCount: number | undefined;
|
|
421
421
|
/**
|
|
422
|
-
* @public
|
|
423
422
|
* <p>A list of EC2 VPC security groups to associate with the new
|
|
424
423
|
* elastic cluster.</p>
|
|
424
|
+
* @public
|
|
425
425
|
*/
|
|
426
426
|
vpcSecurityGroupIds?: string[];
|
|
427
427
|
/**
|
|
428
|
-
* @public
|
|
429
428
|
* <p>The Amazon EC2 subnet IDs for the new elastic cluster.</p>
|
|
429
|
+
* @public
|
|
430
430
|
*/
|
|
431
431
|
subnetIds?: string[];
|
|
432
432
|
/**
|
|
433
|
-
* @public
|
|
434
433
|
* <p>The KMS key identifier to use to encrypt the new elastic cluster.</p>
|
|
435
434
|
* <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
|
436
435
|
* encryption key. If you are creating a cluster using the same Amazon account
|
|
@@ -439,15 +438,15 @@ export interface CreateClusterInput {
|
|
|
439
438
|
* <p>If an encryption key is not specified, Amazon DocumentDB uses the
|
|
440
439
|
* default encryption key that KMS creates for your account. Your account
|
|
441
440
|
* has a different default encryption key for each Amazon Region.</p>
|
|
441
|
+
* @public
|
|
442
442
|
*/
|
|
443
443
|
kmsKeyId?: string;
|
|
444
444
|
/**
|
|
445
|
-
* @public
|
|
446
445
|
* <p>The client token for the elastic cluster.</p>
|
|
446
|
+
* @public
|
|
447
447
|
*/
|
|
448
448
|
clientToken?: string;
|
|
449
449
|
/**
|
|
450
|
-
* @public
|
|
451
450
|
* <p>The weekly time range during which system maintenance can occur,
|
|
452
451
|
* in Universal Coordinated Time (UTC).</p>
|
|
453
452
|
* <p>
|
|
@@ -459,144 +458,145 @@ export interface CreateClusterInput {
|
|
|
459
458
|
* <i>Valid days</i>: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
|
|
460
459
|
* <p>
|
|
461
460
|
* <i>Constraints</i>: Minimum 30-minute window.</p>
|
|
461
|
+
* @public
|
|
462
462
|
*/
|
|
463
463
|
preferredMaintenanceWindow?: string;
|
|
464
464
|
/**
|
|
465
|
-
* @public
|
|
466
465
|
* <p>The tags to be assigned to the new elastic cluster.</p>
|
|
466
|
+
* @public
|
|
467
467
|
*/
|
|
468
468
|
tags?: Record<string, string>;
|
|
469
469
|
/**
|
|
470
|
-
* @public
|
|
471
470
|
* <p>The number of days for which automatic snapshots are retained.</p>
|
|
471
|
+
* @public
|
|
472
472
|
*/
|
|
473
473
|
backupRetentionPeriod?: number;
|
|
474
474
|
/**
|
|
475
|
-
* @public
|
|
476
475
|
* <p>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>backupRetentionPeriod</code>.</p>
|
|
476
|
+
* @public
|
|
477
477
|
*/
|
|
478
478
|
preferredBackupWindow?: string;
|
|
479
479
|
/**
|
|
480
|
-
* @public
|
|
481
480
|
* <p>The number of replica instances applying to all shards in the elastic cluster.
|
|
482
481
|
* 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>
|
|
482
|
+
* @public
|
|
483
483
|
*/
|
|
484
484
|
shardInstanceCount?: number;
|
|
485
485
|
}
|
|
486
486
|
/**
|
|
487
|
-
* @public
|
|
488
487
|
* <p>The name of the shard.</p>
|
|
488
|
+
* @public
|
|
489
489
|
*/
|
|
490
490
|
export interface Shard {
|
|
491
491
|
/**
|
|
492
|
-
* @public
|
|
493
492
|
* <p>The ID of the shard.</p>
|
|
493
|
+
* @public
|
|
494
494
|
*/
|
|
495
495
|
shardId: string | undefined;
|
|
496
496
|
/**
|
|
497
|
-
* @public
|
|
498
497
|
* <p>The time when the shard was created in Universal Coordinated Time (UTC).</p>
|
|
498
|
+
* @public
|
|
499
499
|
*/
|
|
500
500
|
createTime: string | undefined;
|
|
501
501
|
/**
|
|
502
|
-
* @public
|
|
503
502
|
* <p>The current status of the shard.</p>
|
|
503
|
+
* @public
|
|
504
504
|
*/
|
|
505
505
|
status: Status | undefined;
|
|
506
506
|
}
|
|
507
507
|
/**
|
|
508
|
-
* @public
|
|
509
508
|
* <p>Returns information about a specific elastic cluster.</p>
|
|
509
|
+
* @public
|
|
510
510
|
*/
|
|
511
511
|
export interface Cluster {
|
|
512
512
|
/**
|
|
513
|
-
* @public
|
|
514
513
|
* <p>The name of the elastic cluster.</p>
|
|
514
|
+
* @public
|
|
515
515
|
*/
|
|
516
516
|
clusterName: string | undefined;
|
|
517
517
|
/**
|
|
518
|
-
* @public
|
|
519
518
|
* <p>The ARN identifier of the elastic cluster.</p>
|
|
519
|
+
* @public
|
|
520
520
|
*/
|
|
521
521
|
clusterArn: string | undefined;
|
|
522
522
|
/**
|
|
523
|
-
* @public
|
|
524
523
|
* <p>The status of the elastic cluster.</p>
|
|
524
|
+
* @public
|
|
525
525
|
*/
|
|
526
526
|
status: Status | undefined;
|
|
527
527
|
/**
|
|
528
|
-
* @public
|
|
529
528
|
* <p>The URL used to connect to the elastic cluster.</p>
|
|
529
|
+
* @public
|
|
530
530
|
*/
|
|
531
531
|
clusterEndpoint: string | undefined;
|
|
532
532
|
/**
|
|
533
|
-
* @public
|
|
534
533
|
* <p>The time when the elastic cluster was created in Universal Coordinated Time (UTC).</p>
|
|
534
|
+
* @public
|
|
535
535
|
*/
|
|
536
536
|
createTime: string | undefined;
|
|
537
537
|
/**
|
|
538
|
-
* @public
|
|
539
538
|
* <p>The name of the elastic cluster administrator.</p>
|
|
539
|
+
* @public
|
|
540
540
|
*/
|
|
541
541
|
adminUserName: string | undefined;
|
|
542
542
|
/**
|
|
543
|
-
* @public
|
|
544
543
|
* <p>The authentication type for the elastic cluster.</p>
|
|
544
|
+
* @public
|
|
545
545
|
*/
|
|
546
546
|
authType: Auth | undefined;
|
|
547
547
|
/**
|
|
548
|
-
* @public
|
|
549
548
|
* <p>The number of vCPUs assigned to each elastic cluster shard. Maximum is 64.
|
|
550
549
|
* Allowed values are 2, 4, 8, 16, 32, 64.</p>
|
|
550
|
+
* @public
|
|
551
551
|
*/
|
|
552
552
|
shardCapacity: number | undefined;
|
|
553
553
|
/**
|
|
554
|
-
* @public
|
|
555
554
|
* <p>The number of shards assigned to the elastic cluster. Maximum is 32.</p>
|
|
555
|
+
* @public
|
|
556
556
|
*/
|
|
557
557
|
shardCount: number | undefined;
|
|
558
558
|
/**
|
|
559
|
-
* @public
|
|
560
559
|
* <p>A list of EC2 VPC security groups associated with thie elastic cluster.</p>
|
|
560
|
+
* @public
|
|
561
561
|
*/
|
|
562
562
|
vpcSecurityGroupIds: string[] | undefined;
|
|
563
563
|
/**
|
|
564
|
-
* @public
|
|
565
564
|
* <p>The Amazon EC2 subnet IDs for the elastic cluster.</p>
|
|
565
|
+
* @public
|
|
566
566
|
*/
|
|
567
567
|
subnetIds: string[] | undefined;
|
|
568
568
|
/**
|
|
569
|
-
* @public
|
|
570
569
|
* <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
|
|
571
570
|
* <p>
|
|
572
571
|
* <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code>
|
|
573
572
|
* </p>
|
|
573
|
+
* @public
|
|
574
574
|
*/
|
|
575
575
|
preferredMaintenanceWindow: string | undefined;
|
|
576
576
|
/**
|
|
577
|
-
* @public
|
|
578
577
|
* <p>The KMS key identifier to use to encrypt the elastic cluster.</p>
|
|
578
|
+
* @public
|
|
579
579
|
*/
|
|
580
580
|
kmsKeyId: string | undefined;
|
|
581
581
|
/**
|
|
582
|
-
* @public
|
|
583
582
|
* <p>The total number of shards in the cluster.</p>
|
|
583
|
+
* @public
|
|
584
584
|
*/
|
|
585
585
|
shards?: Shard[];
|
|
586
586
|
/**
|
|
587
|
-
* @public
|
|
588
587
|
* <p>The number of days for which automatic snapshots are retained.</p>
|
|
588
|
+
* @public
|
|
589
589
|
*/
|
|
590
590
|
backupRetentionPeriod?: number;
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* <p>The daily time range during which automated backups are created if automated backups are enabled, as determined by <code>backupRetentionPeriod</code>.</p>
|
|
593
|
+
* @public
|
|
594
594
|
*/
|
|
595
595
|
preferredBackupWindow?: string;
|
|
596
596
|
/**
|
|
597
|
-
* @public
|
|
598
597
|
* <p>The number of replica instances applying to all shards in the cluster.
|
|
599
598
|
* 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>
|
|
599
|
+
* @public
|
|
600
600
|
*/
|
|
601
601
|
shardInstanceCount?: number;
|
|
602
602
|
}
|
|
@@ -605,8 +605,8 @@ export interface Cluster {
|
|
|
605
605
|
*/
|
|
606
606
|
export interface CreateClusterOutput {
|
|
607
607
|
/**
|
|
608
|
-
* @public
|
|
609
608
|
* <p>The new elastic cluster that has been created.</p>
|
|
609
|
+
* @public
|
|
610
610
|
*/
|
|
611
611
|
cluster: Cluster | undefined;
|
|
612
612
|
}
|
|
@@ -615,18 +615,18 @@ export interface CreateClusterOutput {
|
|
|
615
615
|
*/
|
|
616
616
|
export interface CreateClusterSnapshotInput {
|
|
617
617
|
/**
|
|
618
|
-
* @public
|
|
619
618
|
* <p>The ARN identifier of the elastic cluster of which you want to create a snapshot.</p>
|
|
619
|
+
* @public
|
|
620
620
|
*/
|
|
621
621
|
clusterArn: string | undefined;
|
|
622
622
|
/**
|
|
623
|
-
* @public
|
|
624
623
|
* <p>The name of the new elastic cluster snapshot.</p>
|
|
624
|
+
* @public
|
|
625
625
|
*/
|
|
626
626
|
snapshotName: string | undefined;
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <p>The tags to be assigned to the new elastic cluster snapshot.</p>
|
|
629
|
+
* @public
|
|
630
630
|
*/
|
|
631
631
|
tags?: Record<string, string>;
|
|
632
632
|
}
|
|
@@ -635,8 +635,8 @@ export interface CreateClusterSnapshotInput {
|
|
|
635
635
|
*/
|
|
636
636
|
export interface CreateClusterSnapshotOutput {
|
|
637
637
|
/**
|
|
638
|
-
* @public
|
|
639
638
|
* <p>Returns information about the new elastic cluster snapshot.</p>
|
|
639
|
+
* @public
|
|
640
640
|
*/
|
|
641
641
|
snapshot: ClusterSnapshot | undefined;
|
|
642
642
|
}
|
|
@@ -645,8 +645,8 @@ export interface CreateClusterSnapshotOutput {
|
|
|
645
645
|
*/
|
|
646
646
|
export interface DeleteClusterInput {
|
|
647
647
|
/**
|
|
648
|
-
* @public
|
|
649
648
|
* <p>The ARN identifier of the elastic cluster that is to be deleted.</p>
|
|
649
|
+
* @public
|
|
650
650
|
*/
|
|
651
651
|
clusterArn: string | undefined;
|
|
652
652
|
}
|
|
@@ -655,8 +655,8 @@ export interface DeleteClusterInput {
|
|
|
655
655
|
*/
|
|
656
656
|
export interface DeleteClusterOutput {
|
|
657
657
|
/**
|
|
658
|
-
* @public
|
|
659
658
|
* <p>Returns information about the newly deleted elastic cluster.</p>
|
|
659
|
+
* @public
|
|
660
660
|
*/
|
|
661
661
|
cluster: Cluster | undefined;
|
|
662
662
|
}
|
|
@@ -665,8 +665,8 @@ export interface DeleteClusterOutput {
|
|
|
665
665
|
*/
|
|
666
666
|
export interface DeleteClusterSnapshotInput {
|
|
667
667
|
/**
|
|
668
|
-
* @public
|
|
669
668
|
* <p>The ARN identifier of the elastic cluster snapshot that is to be deleted.</p>
|
|
669
|
+
* @public
|
|
670
670
|
*/
|
|
671
671
|
snapshotArn: string | undefined;
|
|
672
672
|
}
|
|
@@ -675,8 +675,8 @@ export interface DeleteClusterSnapshotInput {
|
|
|
675
675
|
*/
|
|
676
676
|
export interface DeleteClusterSnapshotOutput {
|
|
677
677
|
/**
|
|
678
|
-
* @public
|
|
679
678
|
* <p>Returns information about the newly deleted elastic cluster snapshot.</p>
|
|
679
|
+
* @public
|
|
680
680
|
*/
|
|
681
681
|
snapshot: ClusterSnapshot | undefined;
|
|
682
682
|
}
|
|
@@ -685,8 +685,8 @@ export interface DeleteClusterSnapshotOutput {
|
|
|
685
685
|
*/
|
|
686
686
|
export interface GetClusterInput {
|
|
687
687
|
/**
|
|
688
|
-
* @public
|
|
689
688
|
* <p>The ARN identifier of the elastic cluster.</p>
|
|
689
|
+
* @public
|
|
690
690
|
*/
|
|
691
691
|
clusterArn: string | undefined;
|
|
692
692
|
}
|
|
@@ -695,8 +695,8 @@ export interface GetClusterInput {
|
|
|
695
695
|
*/
|
|
696
696
|
export interface GetClusterOutput {
|
|
697
697
|
/**
|
|
698
|
-
* @public
|
|
699
698
|
* <p>Returns information about a specific elastic cluster.</p>
|
|
699
|
+
* @public
|
|
700
700
|
*/
|
|
701
701
|
cluster: Cluster | undefined;
|
|
702
702
|
}
|
|
@@ -705,8 +705,8 @@ export interface GetClusterOutput {
|
|
|
705
705
|
*/
|
|
706
706
|
export interface GetClusterSnapshotInput {
|
|
707
707
|
/**
|
|
708
|
-
* @public
|
|
709
708
|
* <p>The ARN identifier of the elastic cluster snapshot.</p>
|
|
709
|
+
* @public
|
|
710
710
|
*/
|
|
711
711
|
snapshotArn: string | undefined;
|
|
712
712
|
}
|
|
@@ -715,8 +715,8 @@ export interface GetClusterSnapshotInput {
|
|
|
715
715
|
*/
|
|
716
716
|
export interface GetClusterSnapshotOutput {
|
|
717
717
|
/**
|
|
718
|
-
* @public
|
|
719
718
|
* <p>Returns information about a specific elastic cluster snapshot.</p>
|
|
719
|
+
* @public
|
|
720
720
|
*/
|
|
721
721
|
snapshot: ClusterSnapshot | undefined;
|
|
722
722
|
}
|
|
@@ -725,36 +725,36 @@ export interface GetClusterSnapshotOutput {
|
|
|
725
725
|
*/
|
|
726
726
|
export interface ListClustersInput {
|
|
727
727
|
/**
|
|
728
|
-
* @public
|
|
729
728
|
* <p>A pagination token provided by a previous request.
|
|
730
729
|
* 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
730
|
* <p>If there is no more data in the responce, the <code>nextToken</code> will not be returned.</p>
|
|
731
|
+
* @public
|
|
732
732
|
*/
|
|
733
733
|
nextToken?: string;
|
|
734
734
|
/**
|
|
735
|
-
* @public
|
|
736
735
|
* <p>The maximum number of elastic cluster snapshot results to receive in the response.</p>
|
|
736
|
+
* @public
|
|
737
737
|
*/
|
|
738
738
|
maxResults?: number;
|
|
739
739
|
}
|
|
740
740
|
/**
|
|
741
|
-
* @public
|
|
742
741
|
* <p>A list of Amazon DocumentDB elastic clusters.</p>
|
|
742
|
+
* @public
|
|
743
743
|
*/
|
|
744
744
|
export interface ClusterInList {
|
|
745
745
|
/**
|
|
746
|
-
* @public
|
|
747
746
|
* <p>The name of the elastic cluster.</p>
|
|
747
|
+
* @public
|
|
748
748
|
*/
|
|
749
749
|
clusterName: string | undefined;
|
|
750
750
|
/**
|
|
751
|
-
* @public
|
|
752
751
|
* <p>The ARN identifier of the elastic cluster.</p>
|
|
752
|
+
* @public
|
|
753
753
|
*/
|
|
754
754
|
clusterArn: string | undefined;
|
|
755
755
|
/**
|
|
756
|
-
* @public
|
|
757
756
|
* <p>The status of the elastic cluster.</p>
|
|
757
|
+
* @public
|
|
758
758
|
*/
|
|
759
759
|
status: Status | undefined;
|
|
760
760
|
}
|
|
@@ -763,15 +763,15 @@ export interface ClusterInList {
|
|
|
763
763
|
*/
|
|
764
764
|
export interface ListClustersOutput {
|
|
765
765
|
/**
|
|
766
|
-
* @public
|
|
767
766
|
* <p>A list of Amazon DocumentDB elastic clusters.</p>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
clusters?: ClusterInList[];
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>A pagination token provided by a previous request.
|
|
773
772
|
* 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
773
|
* <p>If there is no more data in the responce, the <code>nextToken</code> will not be returned.</p>
|
|
774
|
+
* @public
|
|
775
775
|
*/
|
|
776
776
|
nextToken?: string;
|
|
777
777
|
}
|
|
@@ -780,24 +780,23 @@ export interface ListClustersOutput {
|
|
|
780
780
|
*/
|
|
781
781
|
export interface ListClusterSnapshotsInput {
|
|
782
782
|
/**
|
|
783
|
-
* @public
|
|
784
783
|
* <p>The ARN identifier of the elastic cluster.</p>
|
|
784
|
+
* @public
|
|
785
785
|
*/
|
|
786
786
|
clusterArn?: string;
|
|
787
787
|
/**
|
|
788
|
-
* @public
|
|
789
788
|
* <p>A pagination token provided by a previous request.
|
|
790
789
|
* 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
790
|
* <p>If there is no more data in the responce, the <code>nextToken</code> will not be returned.</p>
|
|
791
|
+
* @public
|
|
792
792
|
*/
|
|
793
793
|
nextToken?: string;
|
|
794
794
|
/**
|
|
795
|
-
* @public
|
|
796
795
|
* <p>The maximum number of elastic cluster snapshot results to receive in the response.</p>
|
|
796
|
+
* @public
|
|
797
797
|
*/
|
|
798
798
|
maxResults?: number;
|
|
799
799
|
/**
|
|
800
|
-
* @public
|
|
801
800
|
* <p>The type of cluster snapshots to be returned. You can specify one of the following values:</p>
|
|
802
801
|
* <ul>
|
|
803
802
|
* <li>
|
|
@@ -809,37 +808,38 @@ export interface ListClusterSnapshotsInput {
|
|
|
809
808
|
* <code>manual</code> - Return all cluster snapshots that you have manually created for your Amazon Web Services account.</p>
|
|
810
809
|
* </li>
|
|
811
810
|
* </ul>
|
|
811
|
+
* @public
|
|
812
812
|
*/
|
|
813
813
|
snapshotType?: string;
|
|
814
814
|
}
|
|
815
815
|
/**
|
|
816
|
-
* @public
|
|
817
816
|
* <p>A list of elastic cluster snapshots.</p>
|
|
817
|
+
* @public
|
|
818
818
|
*/
|
|
819
819
|
export interface ClusterSnapshotInList {
|
|
820
820
|
/**
|
|
821
|
-
* @public
|
|
822
821
|
* <p>The name of the elastic cluster snapshot.</p>
|
|
822
|
+
* @public
|
|
823
823
|
*/
|
|
824
824
|
snapshotName: string | undefined;
|
|
825
825
|
/**
|
|
826
|
-
* @public
|
|
827
826
|
* <p>The ARN identifier of the elastic cluster snapshot.</p>
|
|
827
|
+
* @public
|
|
828
828
|
*/
|
|
829
829
|
snapshotArn: string | undefined;
|
|
830
830
|
/**
|
|
831
|
-
* @public
|
|
832
831
|
* <p>The ARN identifier of the elastic cluster.</p>
|
|
832
|
+
* @public
|
|
833
833
|
*/
|
|
834
834
|
clusterArn: string | undefined;
|
|
835
835
|
/**
|
|
836
|
-
* @public
|
|
837
836
|
* <p>The status of the elastic cluster snapshot.</p>
|
|
837
|
+
* @public
|
|
838
838
|
*/
|
|
839
839
|
status: Status | undefined;
|
|
840
840
|
/**
|
|
841
|
-
* @public
|
|
842
841
|
* <p>The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).</p>
|
|
842
|
+
* @public
|
|
843
843
|
*/
|
|
844
844
|
snapshotCreationTime: string | undefined;
|
|
845
845
|
}
|
|
@@ -848,15 +848,15 @@ export interface ClusterSnapshotInList {
|
|
|
848
848
|
*/
|
|
849
849
|
export interface ListClusterSnapshotsOutput {
|
|
850
850
|
/**
|
|
851
|
-
* @public
|
|
852
851
|
* <p>A list of snapshots for a specified elastic cluster.</p>
|
|
852
|
+
* @public
|
|
853
853
|
*/
|
|
854
854
|
snapshots?: ClusterSnapshotInList[];
|
|
855
855
|
/**
|
|
856
|
-
* @public
|
|
857
856
|
* <p>A pagination token provided by a previous request.
|
|
858
857
|
* 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
858
|
* <p>If there is no more data in the responce, the <code>nextToken</code> will not be returned.</p>
|
|
859
|
+
* @public
|
|
860
860
|
*/
|
|
861
861
|
nextToken?: string;
|
|
862
862
|
}
|
|
@@ -865,8 +865,8 @@ export interface ListClusterSnapshotsOutput {
|
|
|
865
865
|
*/
|
|
866
866
|
export interface ListTagsForResourceRequest {
|
|
867
867
|
/**
|
|
868
|
-
* @public
|
|
869
868
|
* <p>The ARN identifier of the elastic cluster resource.</p>
|
|
869
|
+
* @public
|
|
870
870
|
*/
|
|
871
871
|
resourceArn: string | undefined;
|
|
872
872
|
}
|
|
@@ -875,8 +875,8 @@ export interface ListTagsForResourceRequest {
|
|
|
875
875
|
*/
|
|
876
876
|
export interface ListTagsForResourceResponse {
|
|
877
877
|
/**
|
|
878
|
-
* @public
|
|
879
878
|
* <p>The list of tags for the specified elastic cluster resource.</p>
|
|
879
|
+
* @public
|
|
880
880
|
*/
|
|
881
881
|
tags?: Record<string, string>;
|
|
882
882
|
}
|
|
@@ -885,27 +885,26 @@ export interface ListTagsForResourceResponse {
|
|
|
885
885
|
*/
|
|
886
886
|
export interface RestoreClusterFromSnapshotInput {
|
|
887
887
|
/**
|
|
888
|
-
* @public
|
|
889
888
|
* <p>The name of the elastic cluster.</p>
|
|
889
|
+
* @public
|
|
890
890
|
*/
|
|
891
891
|
clusterName: string | undefined;
|
|
892
892
|
/**
|
|
893
|
-
* @public
|
|
894
893
|
* <p>The ARN identifier of the elastic cluster snapshot.</p>
|
|
894
|
+
* @public
|
|
895
895
|
*/
|
|
896
896
|
snapshotArn: string | undefined;
|
|
897
897
|
/**
|
|
898
|
-
* @public
|
|
899
898
|
* <p>A list of EC2 VPC security groups to associate with the elastic cluster.</p>
|
|
899
|
+
* @public
|
|
900
900
|
*/
|
|
901
901
|
vpcSecurityGroupIds?: string[];
|
|
902
902
|
/**
|
|
903
|
-
* @public
|
|
904
903
|
* <p>The Amazon EC2 subnet IDs for the elastic cluster.</p>
|
|
904
|
+
* @public
|
|
905
905
|
*/
|
|
906
906
|
subnetIds?: string[];
|
|
907
907
|
/**
|
|
908
|
-
* @public
|
|
909
908
|
* <p>The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.</p>
|
|
910
909
|
* <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
|
|
911
910
|
* encryption key. If you are creating a cluster using the same Amazon account
|
|
@@ -914,22 +913,23 @@ export interface RestoreClusterFromSnapshotInput {
|
|
|
914
913
|
* <p>If an encryption key is not specified here, Amazon DocumentDB uses the
|
|
915
914
|
* default encryption key that KMS creates for your account. Your account
|
|
916
915
|
* has a different default encryption key for each Amazon Region.</p>
|
|
916
|
+
* @public
|
|
917
917
|
*/
|
|
918
918
|
kmsKeyId?: string;
|
|
919
919
|
/**
|
|
920
|
-
* @public
|
|
921
920
|
* <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>
|
|
921
|
+
* @public
|
|
922
922
|
*/
|
|
923
923
|
tags?: Record<string, string>;
|
|
924
924
|
/**
|
|
925
|
-
* @public
|
|
926
925
|
* <p>The capacity of each shard in the new restored elastic cluster.</p>
|
|
926
|
+
* @public
|
|
927
927
|
*/
|
|
928
928
|
shardCapacity?: number;
|
|
929
929
|
/**
|
|
930
|
-
* @public
|
|
931
930
|
* <p>The number of replica instances applying to all shards in the elastic cluster.
|
|
932
931
|
* 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>
|
|
932
|
+
* @public
|
|
933
933
|
*/
|
|
934
934
|
shardInstanceCount?: number;
|
|
935
935
|
}
|
|
@@ -938,8 +938,8 @@ export interface RestoreClusterFromSnapshotInput {
|
|
|
938
938
|
*/
|
|
939
939
|
export interface RestoreClusterFromSnapshotOutput {
|
|
940
940
|
/**
|
|
941
|
-
* @public
|
|
942
941
|
* <p>Returns information about a the restored elastic cluster.</p>
|
|
942
|
+
* @public
|
|
943
943
|
*/
|
|
944
944
|
cluster: Cluster | undefined;
|
|
945
945
|
}
|
|
@@ -948,8 +948,8 @@ export interface RestoreClusterFromSnapshotOutput {
|
|
|
948
948
|
*/
|
|
949
949
|
export interface StartClusterInput {
|
|
950
950
|
/**
|
|
951
|
-
* @public
|
|
952
951
|
* <p>The ARN identifier of the elastic cluster.</p>
|
|
952
|
+
* @public
|
|
953
953
|
*/
|
|
954
954
|
clusterArn: string | undefined;
|
|
955
955
|
}
|
|
@@ -958,8 +958,8 @@ export interface StartClusterInput {
|
|
|
958
958
|
*/
|
|
959
959
|
export interface StartClusterOutput {
|
|
960
960
|
/**
|
|
961
|
-
* @public
|
|
962
961
|
* <p>Returns information about a specific elastic cluster.</p>
|
|
962
|
+
* @public
|
|
963
963
|
*/
|
|
964
964
|
cluster: Cluster | undefined;
|
|
965
965
|
}
|
|
@@ -968,8 +968,8 @@ export interface StartClusterOutput {
|
|
|
968
968
|
*/
|
|
969
969
|
export interface StopClusterInput {
|
|
970
970
|
/**
|
|
971
|
-
* @public
|
|
972
971
|
* <p>The ARN identifier of the elastic cluster.</p>
|
|
972
|
+
* @public
|
|
973
973
|
*/
|
|
974
974
|
clusterArn: string | undefined;
|
|
975
975
|
}
|
|
@@ -978,8 +978,8 @@ export interface StopClusterInput {
|
|
|
978
978
|
*/
|
|
979
979
|
export interface StopClusterOutput {
|
|
980
980
|
/**
|
|
981
|
-
* @public
|
|
982
981
|
* <p>Returns information about a specific elastic cluster.</p>
|
|
982
|
+
* @public
|
|
983
983
|
*/
|
|
984
984
|
cluster: Cluster | undefined;
|
|
985
985
|
}
|
|
@@ -988,13 +988,13 @@ export interface StopClusterOutput {
|
|
|
988
988
|
*/
|
|
989
989
|
export interface TagResourceRequest {
|
|
990
990
|
/**
|
|
991
|
-
* @public
|
|
992
991
|
* <p>The ARN identifier of the elastic cluster resource.</p>
|
|
992
|
+
* @public
|
|
993
993
|
*/
|
|
994
994
|
resourceArn: string | undefined;
|
|
995
995
|
/**
|
|
996
|
-
* @public
|
|
997
996
|
* <p>The tags that are assigned to the elastic cluster resource.</p>
|
|
997
|
+
* @public
|
|
998
998
|
*/
|
|
999
999
|
tags: Record<string, string> | undefined;
|
|
1000
1000
|
}
|
|
@@ -1008,13 +1008,13 @@ export interface TagResourceResponse {
|
|
|
1008
1008
|
*/
|
|
1009
1009
|
export interface UntagResourceRequest {
|
|
1010
1010
|
/**
|
|
1011
|
-
* @public
|
|
1012
1011
|
* <p>The ARN identifier of the elastic cluster resource.</p>
|
|
1012
|
+
* @public
|
|
1013
1013
|
*/
|
|
1014
1014
|
resourceArn: string | undefined;
|
|
1015
1015
|
/**
|
|
1016
|
-
* @public
|
|
1017
1016
|
* <p>The tag keys to be removed from the elastic cluster resource.</p>
|
|
1017
|
+
* @public
|
|
1018
1018
|
*/
|
|
1019
1019
|
tagKeys: string[] | undefined;
|
|
1020
1020
|
}
|
|
@@ -1028,52 +1028,51 @@ export interface UntagResourceResponse {
|
|
|
1028
1028
|
*/
|
|
1029
1029
|
export interface UpdateClusterInput {
|
|
1030
1030
|
/**
|
|
1031
|
-
* @public
|
|
1032
1031
|
* <p>The ARN identifier of the elastic cluster.</p>
|
|
1032
|
+
* @public
|
|
1033
1033
|
*/
|
|
1034
1034
|
clusterArn: string | undefined;
|
|
1035
1035
|
/**
|
|
1036
|
-
* @public
|
|
1037
1036
|
* <p>The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
|
|
1038
1037
|
* Valid types are <code>PLAIN_TEXT</code> or <code>SECRET_ARN</code>.</p>
|
|
1038
|
+
* @public
|
|
1039
1039
|
*/
|
|
1040
1040
|
authType?: Auth;
|
|
1041
1041
|
/**
|
|
1042
|
-
* @public
|
|
1043
1042
|
* <p>The number of vCPUs assigned to each elastic cluster shard.
|
|
1044
1043
|
* Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.</p>
|
|
1044
|
+
* @public
|
|
1045
1045
|
*/
|
|
1046
1046
|
shardCapacity?: number;
|
|
1047
1047
|
/**
|
|
1048
|
-
* @public
|
|
1049
1048
|
* <p>The number of shards assigned to the elastic cluster. Maximum is 32.</p>
|
|
1049
|
+
* @public
|
|
1050
1050
|
*/
|
|
1051
1051
|
shardCount?: number;
|
|
1052
1052
|
/**
|
|
1053
|
-
* @public
|
|
1054
1053
|
* <p>A list of EC2 VPC security groups to associate with the elastic cluster.</p>
|
|
1054
|
+
* @public
|
|
1055
1055
|
*/
|
|
1056
1056
|
vpcSecurityGroupIds?: string[];
|
|
1057
1057
|
/**
|
|
1058
|
-
* @public
|
|
1059
1058
|
* <p>The Amazon EC2 subnet IDs for the elastic cluster.</p>
|
|
1059
|
+
* @public
|
|
1060
1060
|
*/
|
|
1061
1061
|
subnetIds?: string[];
|
|
1062
1062
|
/**
|
|
1063
|
-
* @public
|
|
1064
1063
|
* <p>The password associated with the elastic cluster administrator.
|
|
1065
1064
|
* This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).</p>
|
|
1066
1065
|
* <p>
|
|
1067
1066
|
* <i>Constraints</i>: Must contain from 8 to 100 characters.</p>
|
|
1067
|
+
* @public
|
|
1068
1068
|
*/
|
|
1069
1069
|
adminUserPassword?: string;
|
|
1070
1070
|
/**
|
|
1071
|
-
* @public
|
|
1072
1071
|
* <p>The client token for the elastic cluster.</p>
|
|
1072
|
+
* @public
|
|
1073
1073
|
*/
|
|
1074
1074
|
clientToken?: string;
|
|
1075
1075
|
/**
|
|
1076
|
-
* @public
|
|
1077
1076
|
* <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
|
|
1078
1077
|
* <p>
|
|
1079
1078
|
* <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code>
|
|
@@ -1084,22 +1083,23 @@ export interface UpdateClusterInput {
|
|
|
1084
1083
|
* <i>Valid days</i>: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
|
|
1085
1084
|
* <p>
|
|
1086
1085
|
* <i>Constraints</i>: Minimum 30-minute window.</p>
|
|
1086
|
+
* @public
|
|
1087
1087
|
*/
|
|
1088
1088
|
preferredMaintenanceWindow?: string;
|
|
1089
1089
|
/**
|
|
1090
|
-
* @public
|
|
1091
1090
|
* <p>The number of days for which automatic snapshots are retained.</p>
|
|
1091
|
+
* @public
|
|
1092
1092
|
*/
|
|
1093
1093
|
backupRetentionPeriod?: number;
|
|
1094
1094
|
/**
|
|
1095
|
-
* @public
|
|
1096
1095
|
* <p>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>backupRetentionPeriod</code>.</p>
|
|
1096
|
+
* @public
|
|
1097
1097
|
*/
|
|
1098
1098
|
preferredBackupWindow?: string;
|
|
1099
1099
|
/**
|
|
1100
|
-
* @public
|
|
1101
1100
|
* <p>The number of replica instances applying to all shards in the elastic cluster.
|
|
1102
1101
|
* 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>
|
|
1102
|
+
* @public
|
|
1103
1103
|
*/
|
|
1104
1104
|
shardInstanceCount?: number;
|
|
1105
1105
|
}
|
|
@@ -1108,8 +1108,8 @@ export interface UpdateClusterInput {
|
|
|
1108
1108
|
*/
|
|
1109
1109
|
export interface UpdateClusterOutput {
|
|
1110
1110
|
/**
|
|
1111
|
-
* @public
|
|
1112
1111
|
* <p>Returns information about the updated elastic cluster.</p>
|
|
1112
|
+
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
cluster: Cluster | undefined;
|
|
1115
1115
|
}
|