@aws-sdk/client-docdb-elastic 3.523.0 → 3.525.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 +194 -29
  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 +90 -3
  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
@@ -3,6 +3,23 @@ import { _json, collectBody, decorateServiceException as __decorateServiceExcept
3
3
  import { v4 as generateIdempotencyToken } from "uuid";
4
4
  import { DocDBElasticServiceException as __BaseException } from "../models/DocDBElasticServiceException";
5
5
  import { AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, } from "../models/models_0";
6
+ export const se_CopyClusterSnapshotCommand = async (input, context) => {
7
+ const b = rb(input, context);
8
+ const headers = {
9
+ "content-type": "application/json",
10
+ };
11
+ b.bp("/cluster-snapshot/{snapshotArn}/copy");
12
+ b.p("snapshotArn", () => input.snapshotArn, "{snapshotArn}", false);
13
+ let body;
14
+ body = JSON.stringify(take(input, {
15
+ copyTags: [],
16
+ kmsKeyId: [],
17
+ tags: (_) => _json(_),
18
+ targetSnapshotName: [],
19
+ }));
20
+ b.m("POST").h(headers).b(body);
21
+ return b.build();
22
+ };
6
23
  export const se_CreateClusterCommand = async (input, context) => {
7
24
  const b = rb(input, context);
8
25
  const headers = {
@@ -14,12 +31,15 @@ export const se_CreateClusterCommand = async (input, context) => {
14
31
  adminUserName: [],
15
32
  adminUserPassword: [],
16
33
  authType: [],
34
+ backupRetentionPeriod: [],
17
35
  clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
18
36
  clusterName: [],
19
37
  kmsKeyId: [],
38
+ preferredBackupWindow: [],
20
39
  preferredMaintenanceWindow: [],
21
40
  shardCapacity: [],
22
41
  shardCount: [],
42
+ shardInstanceCount: [],
23
43
  subnetIds: (_) => _json(_),
24
44
  tags: (_) => _json(_),
25
45
  vpcSecurityGroupIds: (_) => _json(_),
@@ -98,6 +118,7 @@ export const se_ListClusterSnapshotsCommand = async (input, context) => {
98
118
  [_cA]: [, input[_cA]],
99
119
  [_nT]: [, input[_nT]],
100
120
  [_mR]: [() => input.maxResults !== void 0, () => input[_mR].toString()],
121
+ [_sT]: [, input[_sT]],
101
122
  });
102
123
  let body;
103
124
  b.m("GET").h(headers).q(query).b(body);
@@ -123,6 +144,8 @@ export const se_RestoreClusterFromSnapshotCommand = async (input, context) => {
123
144
  body = JSON.stringify(take(input, {
124
145
  clusterName: [],
125
146
  kmsKeyId: [],
147
+ shardCapacity: [],
148
+ shardInstanceCount: [],
126
149
  subnetIds: (_) => _json(_),
127
150
  tags: (_) => _json(_),
128
151
  vpcSecurityGroupIds: (_) => _json(_),
@@ -130,6 +153,24 @@ export const se_RestoreClusterFromSnapshotCommand = async (input, context) => {
130
153
  b.m("POST").h(headers).b(body);
131
154
  return b.build();
132
155
  };
156
+ export const se_StartClusterCommand = async (input, context) => {
157
+ const b = rb(input, context);
158
+ const headers = {};
159
+ b.bp("/cluster/{clusterArn}/start");
160
+ b.p("clusterArn", () => input.clusterArn, "{clusterArn}", false);
161
+ let body;
162
+ b.m("POST").h(headers).b(body);
163
+ return b.build();
164
+ };
165
+ export const se_StopClusterCommand = async (input, context) => {
166
+ const b = rb(input, context);
167
+ const headers = {};
168
+ b.bp("/cluster/{clusterArn}/stop");
169
+ b.p("clusterArn", () => input.clusterArn, "{clusterArn}", false);
170
+ let body;
171
+ b.m("POST").h(headers).b(body);
172
+ return b.build();
173
+ };
133
174
  export const se_TagResourceCommand = async (input, context) => {
134
175
  const b = rb(input, context);
135
176
  const headers = {
@@ -170,16 +211,33 @@ export const se_UpdateClusterCommand = async (input, context) => {
170
211
  body = JSON.stringify(take(input, {
171
212
  adminUserPassword: [],
172
213
  authType: [],
214
+ backupRetentionPeriod: [],
173
215
  clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
216
+ preferredBackupWindow: [],
174
217
  preferredMaintenanceWindow: [],
175
218
  shardCapacity: [],
176
219
  shardCount: [],
220
+ shardInstanceCount: [],
177
221
  subnetIds: (_) => _json(_),
178
222
  vpcSecurityGroupIds: (_) => _json(_),
179
223
  }));
180
224
  b.m("PUT").h(headers).b(body);
181
225
  return b.build();
182
226
  };
227
+ export const de_CopyClusterSnapshotCommand = async (output, context) => {
228
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
229
+ return de_CommandError(output, context);
230
+ }
231
+ const contents = map({
232
+ $metadata: deserializeMetadata(output),
233
+ });
234
+ const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
235
+ const doc = take(data, {
236
+ snapshot: _json,
237
+ });
238
+ Object.assign(contents, doc);
239
+ return contents;
240
+ };
183
241
  export const de_CreateClusterCommand = async (output, context) => {
184
242
  if (output.statusCode !== 200 && output.statusCode >= 300) {
185
243
  return de_CommandError(output, context);
@@ -322,6 +380,34 @@ export const de_RestoreClusterFromSnapshotCommand = async (output, context) => {
322
380
  Object.assign(contents, doc);
323
381
  return contents;
324
382
  };
383
+ export const de_StartClusterCommand = async (output, context) => {
384
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
385
+ return de_CommandError(output, context);
386
+ }
387
+ const contents = map({
388
+ $metadata: deserializeMetadata(output),
389
+ });
390
+ const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
391
+ const doc = take(data, {
392
+ cluster: _json,
393
+ });
394
+ Object.assign(contents, doc);
395
+ return contents;
396
+ };
397
+ export const de_StopClusterCommand = async (output, context) => {
398
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
399
+ return de_CommandError(output, context);
400
+ }
401
+ const contents = map({
402
+ $metadata: deserializeMetadata(output),
403
+ });
404
+ const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
405
+ const doc = take(data, {
406
+ cluster: _json,
407
+ });
408
+ Object.assign(contents, doc);
409
+ return contents;
410
+ };
325
411
  export const de_TagResourceCommand = async (output, context) => {
326
412
  if (output.statusCode !== 200 && output.statusCode >= 300) {
327
413
  return de_CommandError(output, context);
@@ -372,6 +458,9 @@ const de_CommandError = async (output, context) => {
372
458
  case "InternalServerException":
373
459
  case "com.amazonaws.docdbelastic#InternalServerException":
374
460
  throw await de_InternalServerExceptionRes(parsedOutput, context);
461
+ case "ResourceNotFoundException":
462
+ case "com.amazonaws.docdbelastic#ResourceNotFoundException":
463
+ throw await de_ResourceNotFoundExceptionRes(parsedOutput, context);
375
464
  case "ServiceQuotaExceededException":
376
465
  case "com.amazonaws.docdbelastic#ServiceQuotaExceededException":
377
466
  throw await de_ServiceQuotaExceededExceptionRes(parsedOutput, context);
@@ -381,9 +470,6 @@ const de_CommandError = async (output, context) => {
381
470
  case "ValidationException":
382
471
  case "com.amazonaws.docdbelastic#ValidationException":
383
472
  throw await de_ValidationExceptionRes(parsedOutput, context);
384
- case "ResourceNotFoundException":
385
- case "com.amazonaws.docdbelastic#ResourceNotFoundException":
386
- throw await de_ResourceNotFoundExceptionRes(parsedOutput, context);
387
473
  default:
388
474
  const parsedBody = parsedOutput.body;
389
475
  return throwDefaultError({
@@ -510,6 +596,7 @@ const _mR = "maxResults";
510
596
  const _nT = "nextToken";
511
597
  const _rAS = "retryAfterSeconds";
512
598
  const _ra = "retry-after";
599
+ const _sT = "snapshotType";
513
600
  const _tK = "tagKeys";
514
601
  const parseBody = (streamBody, context) => collectBodyString(streamBody, context).then((encoded) => {
515
602
  if (encoded.length) {
@@ -1,4 +1,5 @@
1
1
  import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
2
+ import { CopyClusterSnapshotCommandInput, CopyClusterSnapshotCommandOutput } from "./commands/CopyClusterSnapshotCommand";
2
3
  import { CreateClusterCommandInput, CreateClusterCommandOutput } from "./commands/CreateClusterCommand";
3
4
  import { CreateClusterSnapshotCommandInput, CreateClusterSnapshotCommandOutput } from "./commands/CreateClusterSnapshotCommand";
4
5
  import { DeleteClusterCommandInput, DeleteClusterCommandOutput } from "./commands/DeleteClusterCommand";
@@ -9,11 +10,19 @@ import { ListClustersCommandInput, ListClustersCommandOutput } from "./commands/
9
10
  import { ListClusterSnapshotsCommandInput, ListClusterSnapshotsCommandOutput } from "./commands/ListClusterSnapshotsCommand";
10
11
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
11
12
  import { RestoreClusterFromSnapshotCommandInput, RestoreClusterFromSnapshotCommandOutput } from "./commands/RestoreClusterFromSnapshotCommand";
13
+ import { StartClusterCommandInput, StartClusterCommandOutput } from "./commands/StartClusterCommand";
14
+ import { StopClusterCommandInput, StopClusterCommandOutput } from "./commands/StopClusterCommand";
12
15
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
13
16
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
14
17
  import { UpdateClusterCommandInput, UpdateClusterCommandOutput } from "./commands/UpdateClusterCommand";
15
18
  import { DocDBElasticClient } from "./DocDBElasticClient";
16
19
  export interface DocDBElastic {
20
+ /**
21
+ * @see {@link CopyClusterSnapshotCommand}
22
+ */
23
+ copyClusterSnapshot(args: CopyClusterSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<CopyClusterSnapshotCommandOutput>;
24
+ copyClusterSnapshot(args: CopyClusterSnapshotCommandInput, cb: (err: any, data?: CopyClusterSnapshotCommandOutput) => void): void;
25
+ copyClusterSnapshot(args: CopyClusterSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyClusterSnapshotCommandOutput) => void): void;
17
26
  /**
18
27
  * @see {@link CreateClusterCommand}
19
28
  */
@@ -74,6 +83,18 @@ export interface DocDBElastic {
74
83
  restoreClusterFromSnapshot(args: RestoreClusterFromSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<RestoreClusterFromSnapshotCommandOutput>;
75
84
  restoreClusterFromSnapshot(args: RestoreClusterFromSnapshotCommandInput, cb: (err: any, data?: RestoreClusterFromSnapshotCommandOutput) => void): void;
76
85
  restoreClusterFromSnapshot(args: RestoreClusterFromSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreClusterFromSnapshotCommandOutput) => void): void;
86
+ /**
87
+ * @see {@link StartClusterCommand}
88
+ */
89
+ startCluster(args: StartClusterCommandInput, options?: __HttpHandlerOptions): Promise<StartClusterCommandOutput>;
90
+ startCluster(args: StartClusterCommandInput, cb: (err: any, data?: StartClusterCommandOutput) => void): void;
91
+ startCluster(args: StartClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartClusterCommandOutput) => void): void;
92
+ /**
93
+ * @see {@link StopClusterCommand}
94
+ */
95
+ stopCluster(args: StopClusterCommandInput, options?: __HttpHandlerOptions): Promise<StopClusterCommandOutput>;
96
+ stopCluster(args: StopClusterCommandInput, cb: (err: any, data?: StopClusterCommandOutput) => void): void;
97
+ stopCluster(args: StopClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopClusterCommandOutput) => void): void;
77
98
  /**
78
99
  * @see {@link TagResourceCommand}
79
100
  */
@@ -95,7 +116,21 @@ export interface DocDBElastic {
95
116
  }
96
117
  /**
97
118
  * @public
98
- * <p>The new Amazon Elastic DocumentDB service endpoint.</p>
119
+ * <fullname>Amazon DocumentDB elastic clusters</fullname>
120
+ * <p>Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity.
121
+ * Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.</p>
122
+ * <p>Amazon DocumentDB elastic-clusters were created to:</p>
123
+ * <ul>
124
+ * <li>
125
+ * <p>provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.</p>
126
+ * </li>
127
+ * <li>
128
+ * <p>give customers higher connection limits, and to reduce downtime from patching.</p>
129
+ * </li>
130
+ * <li>
131
+ * <p>continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.</p>
132
+ * </li>
133
+ * </ul>
99
134
  */
100
135
  export declare class DocDBElastic extends DocDBElasticClient implements DocDBElastic {
101
136
  }
@@ -7,6 +7,7 @@ import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol
7
7
  import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
8
8
  import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
9
9
  import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
10
+ import { CopyClusterSnapshotCommandInput, CopyClusterSnapshotCommandOutput } from "./commands/CopyClusterSnapshotCommand";
10
11
  import { CreateClusterCommandInput, CreateClusterCommandOutput } from "./commands/CreateClusterCommand";
11
12
  import { CreateClusterSnapshotCommandInput, CreateClusterSnapshotCommandOutput } from "./commands/CreateClusterSnapshotCommand";
12
13
  import { DeleteClusterCommandInput, DeleteClusterCommandOutput } from "./commands/DeleteClusterCommand";
@@ -17,6 +18,8 @@ import { ListClustersCommandInput, ListClustersCommandOutput } from "./commands/
17
18
  import { ListClusterSnapshotsCommandInput, ListClusterSnapshotsCommandOutput } from "./commands/ListClusterSnapshotsCommand";
18
19
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
19
20
  import { RestoreClusterFromSnapshotCommandInput, RestoreClusterFromSnapshotCommandOutput } from "./commands/RestoreClusterFromSnapshotCommand";
21
+ import { StartClusterCommandInput, StartClusterCommandOutput } from "./commands/StartClusterCommand";
22
+ import { StopClusterCommandInput, StopClusterCommandOutput } from "./commands/StopClusterCommand";
20
23
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
21
24
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
22
25
  import { UpdateClusterCommandInput, UpdateClusterCommandOutput } from "./commands/UpdateClusterCommand";
@@ -26,11 +29,11 @@ export { __Client };
26
29
  /**
27
30
  * @public
28
31
  */
29
- export type ServiceInputTypes = CreateClusterCommandInput | CreateClusterSnapshotCommandInput | DeleteClusterCommandInput | DeleteClusterSnapshotCommandInput | GetClusterCommandInput | GetClusterSnapshotCommandInput | ListClusterSnapshotsCommandInput | ListClustersCommandInput | ListTagsForResourceCommandInput | RestoreClusterFromSnapshotCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateClusterCommandInput;
32
+ export type ServiceInputTypes = CopyClusterSnapshotCommandInput | CreateClusterCommandInput | CreateClusterSnapshotCommandInput | DeleteClusterCommandInput | DeleteClusterSnapshotCommandInput | GetClusterCommandInput | GetClusterSnapshotCommandInput | ListClusterSnapshotsCommandInput | ListClustersCommandInput | ListTagsForResourceCommandInput | RestoreClusterFromSnapshotCommandInput | StartClusterCommandInput | StopClusterCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateClusterCommandInput;
30
33
  /**
31
34
  * @public
32
35
  */
33
- export type ServiceOutputTypes = CreateClusterCommandOutput | CreateClusterSnapshotCommandOutput | DeleteClusterCommandOutput | DeleteClusterSnapshotCommandOutput | GetClusterCommandOutput | GetClusterSnapshotCommandOutput | ListClusterSnapshotsCommandOutput | ListClustersCommandOutput | ListTagsForResourceCommandOutput | RestoreClusterFromSnapshotCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateClusterCommandOutput;
36
+ export type ServiceOutputTypes = CopyClusterSnapshotCommandOutput | CreateClusterCommandOutput | CreateClusterSnapshotCommandOutput | DeleteClusterCommandOutput | DeleteClusterSnapshotCommandOutput | GetClusterCommandOutput | GetClusterSnapshotCommandOutput | ListClusterSnapshotsCommandOutput | ListClustersCommandOutput | ListTagsForResourceCommandOutput | RestoreClusterFromSnapshotCommandOutput | StartClusterCommandOutput | StopClusterCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateClusterCommandOutput;
34
37
  /**
35
38
  * @public
36
39
  */
@@ -165,7 +168,21 @@ export interface DocDBElasticClientResolvedConfig extends DocDBElasticClientReso
165
168
  }
166
169
  /**
167
170
  * @public
168
- * <p>The new Amazon Elastic DocumentDB service endpoint.</p>
171
+ * <fullname>Amazon DocumentDB elastic clusters</fullname>
172
+ * <p>Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity.
173
+ * Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.</p>
174
+ * <p>Amazon DocumentDB elastic-clusters were created to:</p>
175
+ * <ul>
176
+ * <li>
177
+ * <p>provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.</p>
178
+ * </li>
179
+ * <li>
180
+ * <p>give customers higher connection limits, and to reduce downtime from patching.</p>
181
+ * </li>
182
+ * <li>
183
+ * <p>continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.</p>
184
+ * </li>
185
+ * </ul>
169
186
  */
170
187
  export declare class DocDBElasticClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, DocDBElasticClientResolvedConfig> {
171
188
  /**
@@ -0,0 +1,101 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient";
4
+ import { CopyClusterSnapshotInput, CopyClusterSnapshotOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link CopyClusterSnapshotCommand}.
13
+ */
14
+ export interface CopyClusterSnapshotCommandInput extends CopyClusterSnapshotInput {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link CopyClusterSnapshotCommand}.
20
+ */
21
+ export interface CopyClusterSnapshotCommandOutput extends CopyClusterSnapshotOutput, __MetadataBearer {
22
+ }
23
+ declare const CopyClusterSnapshotCommand_base: {
24
+ new (input: CopyClusterSnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<CopyClusterSnapshotCommandInput, CopyClusterSnapshotCommandOutput, DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
26
+ };
27
+ /**
28
+ * @public
29
+ * <p>Copies a snapshot of an elastic cluster.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { DocDBElasticClient, CopyClusterSnapshotCommand } from "@aws-sdk/client-docdb-elastic"; // ES Modules import
34
+ * // const { DocDBElasticClient, CopyClusterSnapshotCommand } = require("@aws-sdk/client-docdb-elastic"); // CommonJS import
35
+ * const client = new DocDBElasticClient(config);
36
+ * const input = { // CopyClusterSnapshotInput
37
+ * snapshotArn: "STRING_VALUE", // required
38
+ * targetSnapshotName: "STRING_VALUE", // required
39
+ * kmsKeyId: "STRING_VALUE",
40
+ * copyTags: true || false,
41
+ * tags: { // TagMap
42
+ * "<keys>": "STRING_VALUE",
43
+ * },
44
+ * };
45
+ * const command = new CopyClusterSnapshotCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // CopyClusterSnapshotOutput
48
+ * // snapshot: { // ClusterSnapshot
49
+ * // subnetIds: [ // StringList // required
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // snapshotName: "STRING_VALUE", // required
53
+ * // snapshotArn: "STRING_VALUE", // required
54
+ * // snapshotCreationTime: "STRING_VALUE", // required
55
+ * // clusterArn: "STRING_VALUE", // required
56
+ * // clusterCreationTime: "STRING_VALUE", // required
57
+ * // status: "STRING_VALUE", // required
58
+ * // vpcSecurityGroupIds: [ // required
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // adminUserName: "STRING_VALUE", // required
62
+ * // kmsKeyId: "STRING_VALUE", // required
63
+ * // snapshotType: "STRING_VALUE",
64
+ * // },
65
+ * // };
66
+ *
67
+ * ```
68
+ *
69
+ * @param CopyClusterSnapshotCommandInput - {@link CopyClusterSnapshotCommandInput}
70
+ * @returns {@link CopyClusterSnapshotCommandOutput}
71
+ * @see {@link CopyClusterSnapshotCommandInput} for command's `input` shape.
72
+ * @see {@link CopyClusterSnapshotCommandOutput} for command's `response` shape.
73
+ * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape.
74
+ *
75
+ * @throws {@link AccessDeniedException} (client fault)
76
+ * <p>An exception that occurs when there are not sufficient permissions to perform an action.</p>
77
+ *
78
+ * @throws {@link ConflictException} (client fault)
79
+ * <p>There was an access conflict.</p>
80
+ *
81
+ * @throws {@link InternalServerException} (server fault)
82
+ * <p>There was an internal server error.</p>
83
+ *
84
+ * @throws {@link ResourceNotFoundException} (client fault)
85
+ * <p>The specified resource could not be located.</p>
86
+ *
87
+ * @throws {@link ServiceQuotaExceededException} (client fault)
88
+ * <p>The service quota for the action was exceeded.</p>
89
+ *
90
+ * @throws {@link ThrottlingException} (client fault)
91
+ * <p>ThrottlingException will be thrown when request was denied due to request throttling.</p>
92
+ *
93
+ * @throws {@link ValidationException} (client fault)
94
+ * <p>A structure defining a validation exception.</p>
95
+ *
96
+ * @throws {@link DocDBElasticServiceException}
97
+ * <p>Base exception class for all service exceptions from DocDBElastic service.</p>
98
+ *
99
+ */
100
+ export declare class CopyClusterSnapshotCommand extends CopyClusterSnapshotCommand_base {
101
+ }
@@ -26,7 +26,7 @@ declare const CreateClusterCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Creates a new Elastic DocumentDB cluster and returns its Cluster structure.</p>
29
+ * <p>Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -52,6 +52,9 @@ declare const CreateClusterCommand_base: {
52
52
  * tags: { // TagMap
53
53
  * "<keys>": "STRING_VALUE",
54
54
  * },
55
+ * backupRetentionPeriod: Number("int"),
56
+ * preferredBackupWindow: "STRING_VALUE",
57
+ * shardInstanceCount: Number("int"),
55
58
  * };
56
59
  * const command = new CreateClusterCommand(input);
57
60
  * const response = await client.send(command);
@@ -74,6 +77,16 @@ declare const CreateClusterCommand_base: {
74
77
  * // ],
75
78
  * // preferredMaintenanceWindow: "STRING_VALUE", // required
76
79
  * // kmsKeyId: "STRING_VALUE", // required
80
+ * // shards: [ // ShardList
81
+ * // { // Shard
82
+ * // shardId: "STRING_VALUE", // required
83
+ * // createTime: "STRING_VALUE", // required
84
+ * // status: "STRING_VALUE", // required
85
+ * // },
86
+ * // ],
87
+ * // backupRetentionPeriod: Number("int"),
88
+ * // preferredBackupWindow: "STRING_VALUE",
89
+ * // shardInstanceCount: Number("int"),
77
90
  * // },
78
91
  * // };
79
92
  *
@@ -26,7 +26,7 @@ declare const CreateClusterSnapshotCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Creates a snapshot of a cluster.</p>
29
+ * <p>Creates a snapshot of an elastic cluster.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -58,6 +58,7 @@ declare const CreateClusterSnapshotCommand_base: {
58
58
  * // ],
59
59
  * // adminUserName: "STRING_VALUE", // required
60
60
  * // kmsKeyId: "STRING_VALUE", // required
61
+ * // snapshotType: "STRING_VALUE",
61
62
  * // },
62
63
  * // };
63
64
  *
@@ -26,7 +26,7 @@ declare const DeleteClusterCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Delete a Elastic DocumentDB cluster.</p>
29
+ * <p>Delete an elastic cluster.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -57,6 +57,16 @@ declare const DeleteClusterCommand_base: {
57
57
  * // ],
58
58
  * // preferredMaintenanceWindow: "STRING_VALUE", // required
59
59
  * // kmsKeyId: "STRING_VALUE", // required
60
+ * // shards: [ // ShardList
61
+ * // { // Shard
62
+ * // shardId: "STRING_VALUE", // required
63
+ * // createTime: "STRING_VALUE", // required
64
+ * // status: "STRING_VALUE", // required
65
+ * // },
66
+ * // ],
67
+ * // backupRetentionPeriod: Number("int"),
68
+ * // preferredBackupWindow: "STRING_VALUE",
69
+ * // shardInstanceCount: Number("int"),
60
70
  * // },
61
71
  * // };
62
72
  *
@@ -26,7 +26,7 @@ declare const DeleteClusterSnapshotCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Delete a Elastic DocumentDB snapshot.</p>
29
+ * <p>Delete an elastic cluster snapshot.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -54,6 +54,7 @@ declare const DeleteClusterSnapshotCommand_base: {
54
54
  * // ],
55
55
  * // adminUserName: "STRING_VALUE", // required
56
56
  * // kmsKeyId: "STRING_VALUE", // required
57
+ * // snapshotType: "STRING_VALUE",
57
58
  * // },
58
59
  * // };
59
60
  *
@@ -26,7 +26,7 @@ declare const GetClusterCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Returns information about a specific Elastic DocumentDB cluster.</p>
29
+ * <p>Returns information about a specific elastic cluster.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -57,6 +57,16 @@ declare const GetClusterCommand_base: {
57
57
  * // ],
58
58
  * // preferredMaintenanceWindow: "STRING_VALUE", // required
59
59
  * // kmsKeyId: "STRING_VALUE", // required
60
+ * // shards: [ // ShardList
61
+ * // { // Shard
62
+ * // shardId: "STRING_VALUE", // required
63
+ * // createTime: "STRING_VALUE", // required
64
+ * // status: "STRING_VALUE", // required
65
+ * // },
66
+ * // ],
67
+ * // backupRetentionPeriod: Number("int"),
68
+ * // preferredBackupWindow: "STRING_VALUE",
69
+ * // shardInstanceCount: Number("int"),
60
70
  * // },
61
71
  * // };
62
72
  *
@@ -26,7 +26,7 @@ declare const GetClusterSnapshotCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Returns information about a specific Elastic DocumentDB snapshot</p>
29
+ * <p>Returns information about a specific elastic cluster snapshot</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -54,6 +54,7 @@ declare const GetClusterSnapshotCommand_base: {
54
54
  * // ],
55
55
  * // adminUserName: "STRING_VALUE", // required
56
56
  * // kmsKeyId: "STRING_VALUE", // required
57
+ * // snapshotType: "STRING_VALUE",
57
58
  * // },
58
59
  * // };
59
60
  *
@@ -26,7 +26,7 @@ declare const ListClusterSnapshotsCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Returns information about Elastic DocumentDB snapshots for a specified cluster.</p>
29
+ * <p>Returns information about snapshots for a specified elastic cluster.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -37,6 +37,7 @@ declare const ListClusterSnapshotsCommand_base: {
37
37
  * clusterArn: "STRING_VALUE",
38
38
  * nextToken: "STRING_VALUE",
39
39
  * maxResults: Number("int"),
40
+ * snapshotType: "STRING_VALUE",
40
41
  * };
41
42
  * const command = new ListClusterSnapshotsCommand(input);
42
43
  * const response = await client.send(command);
@@ -26,7 +26,7 @@ declare const ListClustersCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Returns information about provisioned Elastic DocumentDB clusters.</p>
29
+ * <p>Returns information about provisioned Amazon DocumentDB elastic clusters.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -26,7 +26,7 @@ declare const ListTagsForResourceCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Lists all tags on a Elastic DocumentDB resource</p>
29
+ * <p>Lists all tags on a elastic cluster resource</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -26,7 +26,7 @@ declare const RestoreClusterFromSnapshotCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Restores a Elastic DocumentDB cluster from a snapshot.</p>
29
+ * <p>Restores an elastic cluster from a snapshot.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -46,6 +46,8 @@ declare const RestoreClusterFromSnapshotCommand_base: {
46
46
  * tags: { // TagMap
47
47
  * "<keys>": "STRING_VALUE",
48
48
  * },
49
+ * shardCapacity: Number("int"),
50
+ * shardInstanceCount: Number("int"),
49
51
  * };
50
52
  * const command = new RestoreClusterFromSnapshotCommand(input);
51
53
  * const response = await client.send(command);
@@ -68,6 +70,16 @@ declare const RestoreClusterFromSnapshotCommand_base: {
68
70
  * // ],
69
71
  * // preferredMaintenanceWindow: "STRING_VALUE", // required
70
72
  * // kmsKeyId: "STRING_VALUE", // required
73
+ * // shards: [ // ShardList
74
+ * // { // Shard
75
+ * // shardId: "STRING_VALUE", // required
76
+ * // createTime: "STRING_VALUE", // required
77
+ * // status: "STRING_VALUE", // required
78
+ * // },
79
+ * // ],
80
+ * // backupRetentionPeriod: Number("int"),
81
+ * // preferredBackupWindow: "STRING_VALUE",
82
+ * // shardInstanceCount: Number("int"),
71
83
  * // },
72
84
  * // };
73
85
  *