@aws-sdk/client-docdb-elastic 3.221.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 (131) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +205 -0
  3. package/dist-cjs/DocDBElastic.js +202 -0
  4. package/dist-cjs/DocDBElasticClient.js +40 -0
  5. package/dist-cjs/commands/CreateClusterCommand.js +46 -0
  6. package/dist-cjs/commands/CreateClusterSnapshotCommand.js +46 -0
  7. package/dist-cjs/commands/DeleteClusterCommand.js +46 -0
  8. package/dist-cjs/commands/DeleteClusterSnapshotCommand.js +46 -0
  9. package/dist-cjs/commands/GetClusterCommand.js +46 -0
  10. package/dist-cjs/commands/GetClusterSnapshotCommand.js +46 -0
  11. package/dist-cjs/commands/ListClusterSnapshotsCommand.js +46 -0
  12. package/dist-cjs/commands/ListClustersCommand.js +46 -0
  13. package/dist-cjs/commands/ListTagsForResourceCommand.js +46 -0
  14. package/dist-cjs/commands/RestoreClusterFromSnapshotCommand.js +46 -0
  15. package/dist-cjs/commands/TagResourceCommand.js +46 -0
  16. package/dist-cjs/commands/UntagResourceCommand.js +46 -0
  17. package/dist-cjs/commands/UpdateClusterCommand.js +46 -0
  18. package/dist-cjs/commands/index.js +16 -0
  19. package/dist-cjs/endpoint/EndpointParameters.js +12 -0
  20. package/dist-cjs/endpoint/endpointResolver.js +12 -0
  21. package/dist-cjs/endpoint/ruleset.js +312 -0
  22. package/dist-cjs/index.js +11 -0
  23. package/dist-cjs/models/DocDBElasticServiceException.js +11 -0
  24. package/dist-cjs/models/index.js +4 -0
  25. package/dist-cjs/models/models_0.js +255 -0
  26. package/dist-cjs/pagination/Interfaces.js +2 -0
  27. package/dist-cjs/pagination/ListClusterSnapshotsPaginator.js +36 -0
  28. package/dist-cjs/pagination/ListClustersPaginator.js +36 -0
  29. package/dist-cjs/pagination/index.js +6 -0
  30. package/dist-cjs/protocols/Aws_restJson1.js +1197 -0
  31. package/dist-cjs/runtimeConfig.browser.js +42 -0
  32. package/dist-cjs/runtimeConfig.js +50 -0
  33. package/dist-cjs/runtimeConfig.native.js +15 -0
  34. package/dist-cjs/runtimeConfig.shared.js +18 -0
  35. package/dist-es/DocDBElastic.js +198 -0
  36. package/dist-es/DocDBElasticClient.js +36 -0
  37. package/dist-es/commands/CreateClusterCommand.js +42 -0
  38. package/dist-es/commands/CreateClusterSnapshotCommand.js +42 -0
  39. package/dist-es/commands/DeleteClusterCommand.js +42 -0
  40. package/dist-es/commands/DeleteClusterSnapshotCommand.js +42 -0
  41. package/dist-es/commands/GetClusterCommand.js +42 -0
  42. package/dist-es/commands/GetClusterSnapshotCommand.js +42 -0
  43. package/dist-es/commands/ListClusterSnapshotsCommand.js +42 -0
  44. package/dist-es/commands/ListClustersCommand.js +42 -0
  45. package/dist-es/commands/ListTagsForResourceCommand.js +42 -0
  46. package/dist-es/commands/RestoreClusterFromSnapshotCommand.js +42 -0
  47. package/dist-es/commands/TagResourceCommand.js +42 -0
  48. package/dist-es/commands/UntagResourceCommand.js +42 -0
  49. package/dist-es/commands/UpdateClusterCommand.js +42 -0
  50. package/dist-es/commands/index.js +13 -0
  51. package/dist-es/endpoint/EndpointParameters.js +8 -0
  52. package/dist-es/endpoint/endpointResolver.js +8 -0
  53. package/dist-es/endpoint/ruleset.js +309 -0
  54. package/dist-es/index.js +6 -0
  55. package/dist-es/models/DocDBElasticServiceException.js +7 -0
  56. package/dist-es/models/index.js +1 -0
  57. package/dist-es/models/models_0.js +214 -0
  58. package/dist-es/pagination/Interfaces.js +1 -0
  59. package/dist-es/pagination/ListClusterSnapshotsPaginator.js +32 -0
  60. package/dist-es/pagination/ListClustersPaginator.js +32 -0
  61. package/dist-es/pagination/index.js +3 -0
  62. package/dist-es/protocols/Aws_restJson1.js +1168 -0
  63. package/dist-es/runtimeConfig.browser.js +37 -0
  64. package/dist-es/runtimeConfig.js +45 -0
  65. package/dist-es/runtimeConfig.native.js +11 -0
  66. package/dist-es/runtimeConfig.shared.js +14 -0
  67. package/dist-types/DocDBElastic.d.ts +99 -0
  68. package/dist-types/DocDBElasticClient.d.ts +154 -0
  69. package/dist-types/commands/CreateClusterCommand.d.ts +37 -0
  70. package/dist-types/commands/CreateClusterSnapshotCommand.d.ts +37 -0
  71. package/dist-types/commands/DeleteClusterCommand.d.ts +37 -0
  72. package/dist-types/commands/DeleteClusterSnapshotCommand.d.ts +37 -0
  73. package/dist-types/commands/GetClusterCommand.d.ts +37 -0
  74. package/dist-types/commands/GetClusterSnapshotCommand.d.ts +37 -0
  75. package/dist-types/commands/ListClusterSnapshotsCommand.d.ts +37 -0
  76. package/dist-types/commands/ListClustersCommand.d.ts +37 -0
  77. package/dist-types/commands/ListTagsForResourceCommand.d.ts +37 -0
  78. package/dist-types/commands/RestoreClusterFromSnapshotCommand.d.ts +37 -0
  79. package/dist-types/commands/TagResourceCommand.d.ts +37 -0
  80. package/dist-types/commands/UntagResourceCommand.d.ts +37 -0
  81. package/dist-types/commands/UpdateClusterCommand.d.ts +38 -0
  82. package/dist-types/commands/index.d.ts +13 -0
  83. package/dist-types/endpoint/EndpointParameters.d.ts +19 -0
  84. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  85. package/dist-types/endpoint/ruleset.d.ts +2 -0
  86. package/dist-types/index.d.ts +6 -0
  87. package/dist-types/models/DocDBElasticServiceException.d.ts +10 -0
  88. package/dist-types/models/index.d.ts +1 -0
  89. package/dist-types/models/models_0.d.ts +782 -0
  90. package/dist-types/pagination/Interfaces.d.ts +6 -0
  91. package/dist-types/pagination/ListClusterSnapshotsPaginator.d.ts +4 -0
  92. package/dist-types/pagination/ListClustersPaginator.d.ts +4 -0
  93. package/dist-types/pagination/index.d.ts +3 -0
  94. package/dist-types/protocols/Aws_restJson1.d.ts +41 -0
  95. package/dist-types/runtimeConfig.browser.d.ts +42 -0
  96. package/dist-types/runtimeConfig.d.ts +42 -0
  97. package/dist-types/runtimeConfig.native.d.ts +41 -0
  98. package/dist-types/runtimeConfig.shared.d.ts +16 -0
  99. package/dist-types/ts3.4/DocDBElastic.d.ts +225 -0
  100. package/dist-types/ts3.4/DocDBElasticClient.d.ts +190 -0
  101. package/dist-types/ts3.4/commands/CreateClusterCommand.d.ts +34 -0
  102. package/dist-types/ts3.4/commands/CreateClusterSnapshotCommand.d.ts +41 -0
  103. package/dist-types/ts3.4/commands/DeleteClusterCommand.d.ts +34 -0
  104. package/dist-types/ts3.4/commands/DeleteClusterSnapshotCommand.d.ts +41 -0
  105. package/dist-types/ts3.4/commands/GetClusterCommand.d.ts +34 -0
  106. package/dist-types/ts3.4/commands/GetClusterSnapshotCommand.d.ts +38 -0
  107. package/dist-types/ts3.4/commands/ListClusterSnapshotsCommand.d.ts +41 -0
  108. package/dist-types/ts3.4/commands/ListClustersCommand.d.ts +34 -0
  109. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +38 -0
  110. package/dist-types/ts3.4/commands/RestoreClusterFromSnapshotCommand.d.ts +41 -0
  111. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +34 -0
  112. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +37 -0
  113. package/dist-types/ts3.4/commands/UpdateClusterCommand.d.ts +34 -0
  114. package/dist-types/ts3.4/commands/index.d.ts +13 -0
  115. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +34 -0
  116. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  117. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  118. package/dist-types/ts3.4/index.d.ts +6 -0
  119. package/dist-types/ts3.4/models/DocDBElasticServiceException.d.ts +7 -0
  120. package/dist-types/ts3.4/models/index.d.ts +1 -0
  121. package/dist-types/ts3.4/models/models_0.d.ts +320 -0
  122. package/dist-types/ts3.4/pagination/Interfaces.d.ts +7 -0
  123. package/dist-types/ts3.4/pagination/ListClusterSnapshotsPaginator.d.ts +11 -0
  124. package/dist-types/ts3.4/pagination/ListClustersPaginator.d.ts +11 -0
  125. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  126. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +161 -0
  127. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +88 -0
  128. package/dist-types/ts3.4/runtimeConfig.d.ts +88 -0
  129. package/dist-types/ts3.4/runtimeConfig.native.d.ts +77 -0
  130. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +16 -0
  131. package/package.json +103 -0
@@ -0,0 +1,782 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { DocDBElasticServiceException as __BaseException } from "./DocDBElasticServiceException";
3
+ /**
4
+ * <p>An exception that occurs when there are not sufficient permissions to perform an action.</p>
5
+ */
6
+ export declare class AccessDeniedException extends __BaseException {
7
+ readonly name: "AccessDeniedException";
8
+ readonly $fault: "client";
9
+ /**
10
+ * @internal
11
+ */
12
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
13
+ }
14
+ export declare enum Auth {
15
+ PLAIN_TEXT = "PLAIN_TEXT",
16
+ SECRET_ARN = "SECRET_ARN"
17
+ }
18
+ /**
19
+ * <p>There was an access conflict.</p>
20
+ */
21
+ export declare class ConflictException extends __BaseException {
22
+ readonly name: "ConflictException";
23
+ readonly $fault: "client";
24
+ /**
25
+ * <p>The ID of the resource where there was an access conflict.</p>
26
+ */
27
+ resourceId: string | undefined;
28
+ /**
29
+ * <p>The type of the resource where there was an access conflict.</p>
30
+ */
31
+ resourceType: string | undefined;
32
+ /**
33
+ * @internal
34
+ */
35
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
36
+ }
37
+ export interface CreateClusterInput {
38
+ /**
39
+ * <p>The name of the new Elastic DocumentDB cluster. This parameter is stored as
40
+ * a lowercase string.</p>
41
+ * <p>
42
+ * <i>Constraints</i>:</p>
43
+ * <ul>
44
+ * <li>
45
+ * <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p>
46
+ * </li>
47
+ * <li>
48
+ * <p>The first character must be a letter.</p>
49
+ * </li>
50
+ * <li>
51
+ * <p>Cannot end with a hyphen or contain two consecutive hyphens.</p>
52
+ * </li>
53
+ * </ul>
54
+ * <p>
55
+ * <i>Example</i>: <code>my-cluster</code>
56
+ * </p>
57
+ */
58
+ clusterName: string | undefined;
59
+ /**
60
+ * <p>The authentication type for the Elastic DocumentDB cluster.</p>
61
+ */
62
+ authType: Auth | string | undefined;
63
+ /**
64
+ * <p>The name of the Elastic DocumentDB cluster administrator.</p>
65
+ * <p>
66
+ * <i>Constraints</i>:</p>
67
+ * <ul>
68
+ * <li>
69
+ * <p>Must be from 1 to 63 letters or numbers.</p>
70
+ * </li>
71
+ * <li>
72
+ * <p>The first character must be a letter.</p>
73
+ * </li>
74
+ * <li>
75
+ * <p>Cannot be a reserved word.</p>
76
+ * </li>
77
+ * </ul>
78
+ */
79
+ adminUserName: string | undefined;
80
+ /**
81
+ * <p>The password for the Elastic DocumentDB cluster administrator and can
82
+ * contain any printable ASCII characters.</p>
83
+ * <p>
84
+ * <i>Constraints</i>:</p>
85
+ * <ul>
86
+ * <li>
87
+ * <p>Must contain from 8 to 100 characters.</p>
88
+ * </li>
89
+ * <li>
90
+ * <p>Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).</p>
91
+ * </li>
92
+ * </ul>
93
+ */
94
+ adminUserPassword: string | undefined;
95
+ /**
96
+ * <p>The capacity of each shard in the new Elastic DocumentDB cluster.</p>
97
+ */
98
+ shardCapacity: number | undefined;
99
+ /**
100
+ * <p>The number of shards to create in the new Elastic DocumentDB cluster.</p>
101
+ */
102
+ shardCount: number | undefined;
103
+ /**
104
+ * <p>A list of EC2 VPC security groups to associate with the new
105
+ * Elastic DocumentDB cluster.</p>
106
+ */
107
+ vpcSecurityGroupIds?: string[];
108
+ /**
109
+ * <p>The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.</p>
110
+ */
111
+ subnetIds?: string[];
112
+ /**
113
+ * <p>The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.</p>
114
+ * <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
115
+ * encryption key. If you are creating a cluster using the same Amazon account
116
+ * that owns this KMS encryption key, you can use the KMS key alias instead
117
+ * of the ARN as the KMS encryption key.</p>
118
+ * <p>If an encryption key is not specified, Elastic DocumentDB uses the
119
+ * default encryption key that KMS creates for your account. Your account
120
+ * has a different default encryption key for each Amazon Region.</p>
121
+ */
122
+ kmsKeyId?: string;
123
+ /**
124
+ * <p>The client token for the Elastic DocumentDB cluster.</p>
125
+ */
126
+ clientToken?: string;
127
+ /**
128
+ * <p>The weekly time range during which system maintenance can occur,
129
+ * in Universal Coordinated Time (UTC).</p>
130
+ * <p>
131
+ * <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code>
132
+ * </p>
133
+ * <p>
134
+ * <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>
135
+ * <p>
136
+ * <i>Valid days</i>: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
137
+ * <p>
138
+ * <i>Constraints</i>: Minimum 30-minute window.</p>
139
+ */
140
+ preferredMaintenanceWindow?: string;
141
+ /**
142
+ * <p>The tags to be assigned to the new Elastic DocumentDB cluster.</p>
143
+ */
144
+ tags?: Record<string, string>;
145
+ }
146
+ export declare enum Status {
147
+ ACTIVE = "ACTIVE",
148
+ CREATING = "CREATING",
149
+ DELETING = "DELETING",
150
+ INACCESSIBLE_ENCRYPTION_CREDS = "INACCESSIBLE_ENCRYPTION_CREDS",
151
+ INVALID_SECURITY_GROUP_ID = "INVALID_SECURITY_GROUP_ID",
152
+ INVALID_SUBNET_ID = "INVALID_SUBNET_ID",
153
+ IP_ADDRESS_LIMIT_EXCEEDED = "IP_ADDRESS_LIMIT_EXCEEDED",
154
+ UPDATING = "UPDATING",
155
+ VPC_ENDPOINT_LIMIT_EXCEEDED = "VPC_ENDPOINT_LIMIT_EXCEEDED"
156
+ }
157
+ /**
158
+ * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
159
+ */
160
+ export interface Cluster {
161
+ /**
162
+ * <p>The name of the Elastic DocumentDB cluster.</p>
163
+ */
164
+ clusterName: string | undefined;
165
+ /**
166
+ * <p>The arn of the Elastic DocumentDB cluster.</p>
167
+ */
168
+ clusterArn: string | undefined;
169
+ /**
170
+ * <p>The status of the Elastic DocumentDB cluster.</p>
171
+ */
172
+ status: Status | string | undefined;
173
+ /**
174
+ * <p>The URL used to connect to the Elastic DocumentDB cluster.</p>
175
+ */
176
+ clusterEndpoint: string | undefined;
177
+ /**
178
+ * <p>The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).</p>
179
+ */
180
+ createTime: string | undefined;
181
+ /**
182
+ * <p>The name of the Elastic DocumentDB cluster administrator.</p>
183
+ */
184
+ adminUserName: string | undefined;
185
+ /**
186
+ * <p>The authentication type for the Elastic DocumentDB cluster.</p>
187
+ */
188
+ authType: Auth | string | undefined;
189
+ /**
190
+ * <p>The capacity of each shard in the Elastic DocumentDB cluster.</p>
191
+ */
192
+ shardCapacity: number | undefined;
193
+ /**
194
+ * <p>The number of shards in the Elastic DocumentDB cluster.</p>
195
+ */
196
+ shardCount: number | undefined;
197
+ /**
198
+ * <p>A list of EC2 VPC security groups associated with this cluster.</p>
199
+ */
200
+ vpcSecurityGroupIds: string[] | undefined;
201
+ /**
202
+ * <p>The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.</p>
203
+ */
204
+ subnetIds: string[] | undefined;
205
+ /**
206
+ * <p>The weekly time range during which system maintenance can occur,
207
+ * in Universal Coordinated Time (UTC).</p>
208
+ * <p>
209
+ * <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code>
210
+ * </p>
211
+ */
212
+ preferredMaintenanceWindow: string | undefined;
213
+ /**
214
+ * <p>The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.</p>
215
+ */
216
+ kmsKeyId: string | undefined;
217
+ }
218
+ export interface CreateClusterOutput {
219
+ /**
220
+ * <p>The new Elastic DocumentDB cluster that has been created.</p>
221
+ */
222
+ cluster: Cluster | undefined;
223
+ }
224
+ /**
225
+ * <p>There was an internal server error.</p>
226
+ */
227
+ export declare class InternalServerException extends __BaseException {
228
+ readonly name: "InternalServerException";
229
+ readonly $fault: "server";
230
+ $retryable: {};
231
+ /**
232
+ * @internal
233
+ */
234
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
235
+ }
236
+ /**
237
+ * <p>The service quota for the action was exceeded.</p>
238
+ */
239
+ export declare class ServiceQuotaExceededException extends __BaseException {
240
+ readonly name: "ServiceQuotaExceededException";
241
+ readonly $fault: "client";
242
+ /**
243
+ * @internal
244
+ */
245
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
246
+ }
247
+ /**
248
+ * <p>ThrottlingException will be thrown when request was denied due to request throttling.</p>
249
+ */
250
+ export declare class ThrottlingException extends __BaseException {
251
+ readonly name: "ThrottlingException";
252
+ readonly $fault: "client";
253
+ $retryable: {};
254
+ /**
255
+ * <p>The number of seconds to wait before retrying the operation.</p>
256
+ */
257
+ retryAfterSeconds?: number;
258
+ /**
259
+ * @internal
260
+ */
261
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
262
+ }
263
+ /**
264
+ * <p>A specific field in which a given validation exception occurred.</p>
265
+ */
266
+ export interface ValidationExceptionField {
267
+ /**
268
+ * <p>The name of the field where the validation exception occurred.</p>
269
+ */
270
+ name: string | undefined;
271
+ /**
272
+ * <p>An error message describing the validation exception in this field.</p>
273
+ */
274
+ message: string | undefined;
275
+ }
276
+ export declare enum ValidationExceptionReason {
277
+ CANNOT_PARSE = "cannotParse",
278
+ FIELD_VALIDATION_FAILED = "fieldValidationFailed",
279
+ OTHER = "other",
280
+ UNKNOWN_OPERATION = "unknownOperation"
281
+ }
282
+ /**
283
+ * <p>A structure defining a validation exception.</p>
284
+ */
285
+ export declare class ValidationException extends __BaseException {
286
+ readonly name: "ValidationException";
287
+ readonly $fault: "client";
288
+ /**
289
+ * <p>The reason why the validation exception occurred (one of <code>unknownOperation</code>,
290
+ * <code>cannotParse</code>, <code>fieldValidationFailed</code>, or <code>other</code>).</p>
291
+ */
292
+ reason: ValidationExceptionReason | string | undefined;
293
+ /**
294
+ * <p>A list of the fields in which the validation exception occurred.</p>
295
+ */
296
+ fieldList?: ValidationExceptionField[];
297
+ /**
298
+ * @internal
299
+ */
300
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
301
+ }
302
+ export interface CreateClusterSnapshotInput {
303
+ /**
304
+ * <p>The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.</p>
305
+ */
306
+ clusterArn: string | undefined;
307
+ /**
308
+ * <p>The name of the Elastic DocumentDB snapshot.</p>
309
+ */
310
+ snapshotName: string | undefined;
311
+ /**
312
+ * <p>The tags to be assigned to the new Elastic DocumentDB snapshot.</p>
313
+ */
314
+ tags?: Record<string, string>;
315
+ }
316
+ /**
317
+ * <p>Returns information about a specific Elastic DocumentDB snapshot.</p>
318
+ */
319
+ export interface ClusterSnapshot {
320
+ /**
321
+ * <p>A list of the IDs of subnets associated with the DB cluster snapshot.</p>
322
+ */
323
+ subnetIds: string[] | undefined;
324
+ /**
325
+ * <p>The name of the Elastic DocumentDB snapshot.</p>
326
+ */
327
+ snapshotName: string | undefined;
328
+ /**
329
+ * <p>The arn of the Elastic DocumentDB snapshot</p>
330
+ */
331
+ snapshotArn: string | undefined;
332
+ /**
333
+ * <p>The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).</p>
334
+ */
335
+ snapshotCreationTime: string | undefined;
336
+ /**
337
+ * <p>The arn of the Elastic DocumentDB cluster.</p>
338
+ */
339
+ clusterArn: string | undefined;
340
+ /**
341
+ * <p>The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).</p>
342
+ */
343
+ clusterCreationTime: string | undefined;
344
+ /**
345
+ * <p>The status of the Elastic DocumentDB snapshot.</p>
346
+ */
347
+ status: Status | string | undefined;
348
+ /**
349
+ * <p>A list of the IDs of the VPC security groups associated with the cluster snapshot.</p>
350
+ */
351
+ vpcSecurityGroupIds: string[] | undefined;
352
+ /**
353
+ * <p>The name of the Elastic DocumentDB cluster administrator.</p>
354
+ */
355
+ adminUserName: string | undefined;
356
+ /**
357
+ * <p>The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.</p>
358
+ */
359
+ kmsKeyId: string | undefined;
360
+ }
361
+ export interface CreateClusterSnapshotOutput {
362
+ /**
363
+ * <p>Returns information about the new Elastic DocumentDB snapshot.</p>
364
+ */
365
+ snapshot: ClusterSnapshot | undefined;
366
+ }
367
+ /**
368
+ * <p>The specified resource could not be located.</p>
369
+ */
370
+ export declare class ResourceNotFoundException extends __BaseException {
371
+ readonly name: "ResourceNotFoundException";
372
+ readonly $fault: "client";
373
+ /**
374
+ * <p>The ID of the resource that could not be located.</p>
375
+ */
376
+ resourceId: string | undefined;
377
+ /**
378
+ * <p>The type of the resource that could not be found.</p>
379
+ */
380
+ resourceType: string | undefined;
381
+ /**
382
+ * @internal
383
+ */
384
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
385
+ }
386
+ export interface DeleteClusterInput {
387
+ /**
388
+ * <p>The arn of the Elastic DocumentDB cluster that is to be deleted.</p>
389
+ */
390
+ clusterArn: string | undefined;
391
+ }
392
+ export interface DeleteClusterOutput {
393
+ /**
394
+ * <p>Returns information about the newly deleted Elastic DocumentDB cluster.</p>
395
+ */
396
+ cluster: Cluster | undefined;
397
+ }
398
+ export interface DeleteClusterSnapshotInput {
399
+ /**
400
+ * <p>The arn of the Elastic DocumentDB snapshot that is to be deleted.</p>
401
+ */
402
+ snapshotArn: string | undefined;
403
+ }
404
+ export interface DeleteClusterSnapshotOutput {
405
+ /**
406
+ * <p>Returns information about the newly deleted Elastic DocumentDB snapshot.</p>
407
+ */
408
+ snapshot: ClusterSnapshot | undefined;
409
+ }
410
+ export interface GetClusterInput {
411
+ /**
412
+ * <p>The arn of the Elastic DocumentDB cluster.</p>
413
+ */
414
+ clusterArn: string | undefined;
415
+ }
416
+ export interface GetClusterOutput {
417
+ /**
418
+ * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
419
+ */
420
+ cluster: Cluster | undefined;
421
+ }
422
+ export interface GetClusterSnapshotInput {
423
+ /**
424
+ * <p>The arn of the Elastic DocumentDB snapshot.</p>
425
+ */
426
+ snapshotArn: string | undefined;
427
+ }
428
+ export interface GetClusterSnapshotOutput {
429
+ /**
430
+ * <p>Returns information about a specific Elastic DocumentDB snapshot.</p>
431
+ */
432
+ snapshot: ClusterSnapshot | undefined;
433
+ }
434
+ export interface ListClustersInput {
435
+ /**
436
+ * <p>The nextToken which is used the get the next page of data.</p>
437
+ */
438
+ nextToken?: string;
439
+ /**
440
+ * <p>The maximum number of entries to recieve in the response.</p>
441
+ */
442
+ maxResults?: number;
443
+ }
444
+ /**
445
+ * <p>A list of Elastic DocumentDB cluster.</p>
446
+ */
447
+ export interface ClusterInList {
448
+ /**
449
+ * <p>The name of the Elastic DocumentDB cluster.</p>
450
+ */
451
+ clusterName: string | undefined;
452
+ /**
453
+ * <p>The arn of the Elastic DocumentDB cluster.</p>
454
+ */
455
+ clusterArn: string | undefined;
456
+ /**
457
+ * <p>The status of the Elastic DocumentDB cluster.</p>
458
+ */
459
+ status: Status | string | undefined;
460
+ }
461
+ export interface ListClustersOutput {
462
+ /**
463
+ * <p>A list of Elastic DocumentDB cluster.</p>
464
+ */
465
+ clusters?: ClusterInList[];
466
+ /**
467
+ * <p>The response will provide a nextToken if there is more data beyond the maxResults.</p>
468
+ * <p>If there is no more data in the responce, the nextToken will not be returned.</p>
469
+ */
470
+ nextToken?: string;
471
+ }
472
+ export interface ListClusterSnapshotsInput {
473
+ /**
474
+ * <p>The arn of the Elastic DocumentDB cluster.</p>
475
+ */
476
+ clusterArn?: string;
477
+ /**
478
+ * <p>The nextToken which is used the get the next page of data.</p>
479
+ */
480
+ nextToken?: string;
481
+ /**
482
+ * <p>The maximum number of entries to recieve in the response.</p>
483
+ */
484
+ maxResults?: number;
485
+ }
486
+ /**
487
+ * <p>A list of Elastic DocumentDB snapshots.</p>
488
+ */
489
+ export interface ClusterSnapshotInList {
490
+ /**
491
+ * <p>The name of the Elastic DocumentDB snapshot.</p>
492
+ */
493
+ snapshotName: string | undefined;
494
+ /**
495
+ * <p>The arn of the Elastic DocumentDB snapshot</p>
496
+ */
497
+ snapshotArn: string | undefined;
498
+ /**
499
+ * <p>The arn of the Elastic DocumentDB cluster.</p>
500
+ */
501
+ clusterArn: string | undefined;
502
+ /**
503
+ * <p>The status of the Elastic DocumentDB snapshot.</p>
504
+ */
505
+ status: Status | string | undefined;
506
+ /**
507
+ * <p>The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).</p>
508
+ */
509
+ snapshotCreationTime: string | undefined;
510
+ }
511
+ export interface ListClusterSnapshotsOutput {
512
+ /**
513
+ * <p>A list of Elastic DocumentDB snapshots for a specified cluster.</p>
514
+ */
515
+ snapshots?: ClusterSnapshotInList[];
516
+ /**
517
+ * <p>The response will provide a nextToken if there is more data beyond the maxResults.</p>
518
+ * <p>If there is no more data in the responce, the nextToken will not be returned.</p>
519
+ */
520
+ nextToken?: string;
521
+ }
522
+ export interface ListTagsForResourceRequest {
523
+ /**
524
+ * <p>The arn of the Elastic DocumentDB resource.</p>
525
+ */
526
+ resourceArn: string | undefined;
527
+ }
528
+ export interface ListTagsForResourceResponse {
529
+ /**
530
+ * <p>The list of tags for the specified Elastic DocumentDB resource.</p>
531
+ */
532
+ tags?: Record<string, string>;
533
+ }
534
+ export interface RestoreClusterFromSnapshotInput {
535
+ /**
536
+ * <p>The name of the Elastic DocumentDB cluster.</p>
537
+ */
538
+ clusterName: string | undefined;
539
+ /**
540
+ * <p>The arn of the Elastic DocumentDB snapshot.</p>
541
+ */
542
+ snapshotArn: string | undefined;
543
+ /**
544
+ * <p>A list of EC2 VPC security groups to associate with the
545
+ * Elastic DocumentDB cluster.</p>
546
+ */
547
+ vpcSecurityGroupIds?: string[];
548
+ /**
549
+ * <p>The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.</p>
550
+ */
551
+ subnetIds?: string[];
552
+ /**
553
+ * <p>The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.</p>
554
+ * <p>The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
555
+ * encryption key. If you are creating a cluster using the same Amazon account
556
+ * that owns this KMS encryption key, you can use the KMS key alias instead
557
+ * of the ARN as the KMS encryption key.</p>
558
+ * <p>If an encryption key is not specified here, Elastic DocumentDB uses the
559
+ * default encryption key that KMS creates for your account. Your account
560
+ * has a different default encryption key for each Amazon Region.</p>
561
+ */
562
+ kmsKeyId?: string;
563
+ /**
564
+ * <p>A list of the tag names to be assigned to the restored DB cluster,
565
+ * in the form of an array of key-value pairs in which the key
566
+ * is the tag name and the value is the key value.</p>
567
+ */
568
+ tags?: Record<string, string>;
569
+ }
570
+ export interface RestoreClusterFromSnapshotOutput {
571
+ /**
572
+ * <p>Returns information about a the restored Elastic DocumentDB cluster.</p>
573
+ */
574
+ cluster: Cluster | undefined;
575
+ }
576
+ export interface TagResourceRequest {
577
+ /**
578
+ * <p>The arn of the Elastic DocumentDB resource.</p>
579
+ */
580
+ resourceArn: string | undefined;
581
+ /**
582
+ * <p>The tags to be assigned to the Elastic DocumentDB resource.</p>
583
+ */
584
+ tags: Record<string, string> | undefined;
585
+ }
586
+ export interface TagResourceResponse {
587
+ }
588
+ export interface UntagResourceRequest {
589
+ /**
590
+ * <p>The arn of the Elastic DocumentDB resource.</p>
591
+ */
592
+ resourceArn: string | undefined;
593
+ /**
594
+ * <p>The tag keys to be removed from the Elastic DocumentDB resource.</p>
595
+ */
596
+ tagKeys: string[] | undefined;
597
+ }
598
+ export interface UntagResourceResponse {
599
+ }
600
+ export interface UpdateClusterInput {
601
+ /**
602
+ * <p>The arn of the Elastic DocumentDB cluster.</p>
603
+ */
604
+ clusterArn: string | undefined;
605
+ /**
606
+ * <p>The authentication type for the Elastic DocumentDB cluster.</p>
607
+ */
608
+ authType?: Auth | string;
609
+ /**
610
+ * <p>The capacity of each shard in the Elastic DocumentDB cluster.</p>
611
+ */
612
+ shardCapacity?: number;
613
+ /**
614
+ * <p>The number of shards to create in the Elastic DocumentDB cluster.</p>
615
+ */
616
+ shardCount?: number;
617
+ /**
618
+ * <p>A list of EC2 VPC security groups to associate with the new
619
+ * Elastic DocumentDB cluster.</p>
620
+ */
621
+ vpcSecurityGroupIds?: string[];
622
+ /**
623
+ * <p>The number of shards to create in the Elastic DocumentDB cluster.</p>
624
+ */
625
+ subnetIds?: string[];
626
+ /**
627
+ * <p>The password for the Elastic DocumentDB cluster administrator. This password can
628
+ * contain any printable ASCII character except forward slash (/),
629
+ * double quote ("), or the "at" symbol (@).</p>
630
+ * <p>
631
+ * <i>Constraints</i>: Must contain from 8 to 100 characters.</p>
632
+ */
633
+ adminUserPassword?: string;
634
+ /**
635
+ * <p>The client token for the Elastic DocumentDB cluster.</p>
636
+ */
637
+ clientToken?: string;
638
+ /**
639
+ * <p>The weekly time range during which system maintenance can occur,
640
+ * in Universal Coordinated Time (UTC).</p>
641
+ * <p>
642
+ * <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code>
643
+ * </p>
644
+ * <p>
645
+ * <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>
646
+ * <p>
647
+ * <i>Valid days</i>: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
648
+ * <p>
649
+ * <i>Constraints</i>: Minimum 30-minute window.</p>
650
+ */
651
+ preferredMaintenanceWindow?: string;
652
+ }
653
+ export interface UpdateClusterOutput {
654
+ /**
655
+ * <p>Returns information about the updated Elastic DocumentDB cluster.</p>
656
+ */
657
+ cluster: Cluster | undefined;
658
+ }
659
+ /**
660
+ * @internal
661
+ */
662
+ export declare const CreateClusterInputFilterSensitiveLog: (obj: CreateClusterInput) => any;
663
+ /**
664
+ * @internal
665
+ */
666
+ export declare const ClusterFilterSensitiveLog: (obj: Cluster) => any;
667
+ /**
668
+ * @internal
669
+ */
670
+ export declare const CreateClusterOutputFilterSensitiveLog: (obj: CreateClusterOutput) => any;
671
+ /**
672
+ * @internal
673
+ */
674
+ export declare const ValidationExceptionFieldFilterSensitiveLog: (obj: ValidationExceptionField) => any;
675
+ /**
676
+ * @internal
677
+ */
678
+ export declare const CreateClusterSnapshotInputFilterSensitiveLog: (obj: CreateClusterSnapshotInput) => any;
679
+ /**
680
+ * @internal
681
+ */
682
+ export declare const ClusterSnapshotFilterSensitiveLog: (obj: ClusterSnapshot) => any;
683
+ /**
684
+ * @internal
685
+ */
686
+ export declare const CreateClusterSnapshotOutputFilterSensitiveLog: (obj: CreateClusterSnapshotOutput) => any;
687
+ /**
688
+ * @internal
689
+ */
690
+ export declare const DeleteClusterInputFilterSensitiveLog: (obj: DeleteClusterInput) => any;
691
+ /**
692
+ * @internal
693
+ */
694
+ export declare const DeleteClusterOutputFilterSensitiveLog: (obj: DeleteClusterOutput) => any;
695
+ /**
696
+ * @internal
697
+ */
698
+ export declare const DeleteClusterSnapshotInputFilterSensitiveLog: (obj: DeleteClusterSnapshotInput) => any;
699
+ /**
700
+ * @internal
701
+ */
702
+ export declare const DeleteClusterSnapshotOutputFilterSensitiveLog: (obj: DeleteClusterSnapshotOutput) => any;
703
+ /**
704
+ * @internal
705
+ */
706
+ export declare const GetClusterInputFilterSensitiveLog: (obj: GetClusterInput) => any;
707
+ /**
708
+ * @internal
709
+ */
710
+ export declare const GetClusterOutputFilterSensitiveLog: (obj: GetClusterOutput) => any;
711
+ /**
712
+ * @internal
713
+ */
714
+ export declare const GetClusterSnapshotInputFilterSensitiveLog: (obj: GetClusterSnapshotInput) => any;
715
+ /**
716
+ * @internal
717
+ */
718
+ export declare const GetClusterSnapshotOutputFilterSensitiveLog: (obj: GetClusterSnapshotOutput) => any;
719
+ /**
720
+ * @internal
721
+ */
722
+ export declare const ListClustersInputFilterSensitiveLog: (obj: ListClustersInput) => any;
723
+ /**
724
+ * @internal
725
+ */
726
+ export declare const ClusterInListFilterSensitiveLog: (obj: ClusterInList) => any;
727
+ /**
728
+ * @internal
729
+ */
730
+ export declare const ListClustersOutputFilterSensitiveLog: (obj: ListClustersOutput) => any;
731
+ /**
732
+ * @internal
733
+ */
734
+ export declare const ListClusterSnapshotsInputFilterSensitiveLog: (obj: ListClusterSnapshotsInput) => any;
735
+ /**
736
+ * @internal
737
+ */
738
+ export declare const ClusterSnapshotInListFilterSensitiveLog: (obj: ClusterSnapshotInList) => any;
739
+ /**
740
+ * @internal
741
+ */
742
+ export declare const ListClusterSnapshotsOutputFilterSensitiveLog: (obj: ListClusterSnapshotsOutput) => any;
743
+ /**
744
+ * @internal
745
+ */
746
+ export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
747
+ /**
748
+ * @internal
749
+ */
750
+ export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
751
+ /**
752
+ * @internal
753
+ */
754
+ export declare const RestoreClusterFromSnapshotInputFilterSensitiveLog: (obj: RestoreClusterFromSnapshotInput) => any;
755
+ /**
756
+ * @internal
757
+ */
758
+ export declare const RestoreClusterFromSnapshotOutputFilterSensitiveLog: (obj: RestoreClusterFromSnapshotOutput) => any;
759
+ /**
760
+ * @internal
761
+ */
762
+ export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
763
+ /**
764
+ * @internal
765
+ */
766
+ export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
767
+ /**
768
+ * @internal
769
+ */
770
+ export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
771
+ /**
772
+ * @internal
773
+ */
774
+ export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
775
+ /**
776
+ * @internal
777
+ */
778
+ export declare const UpdateClusterInputFilterSensitiveLog: (obj: UpdateClusterInput) => any;
779
+ /**
780
+ * @internal
781
+ */
782
+ export declare const UpdateClusterOutputFilterSensitiveLog: (obj: UpdateClusterOutput) => any;