Skip to content

Commit b77c92f

Browse files
author
awstools
committed
feat(client-timestream-influxdb): This release introduces APIs to manage DbClusters and adds support for read replicas
1 parent 1f1905e commit b77c92f

20 files changed

+3348
-234
lines changed

clients/client-timestream-influxdb/README.md

+55-7
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,16 @@ using your favorite package manager:
2323

2424
The AWS SDK is modulized by clients and commands.
2525
To send a request, you only need to import the `TimestreamInfluxDBClient` and
26-
the commands you need, for example `ListDbInstancesCommand`:
26+
the commands you need, for example `ListDbClustersCommand`:
2727

2828
```js
2929
// ES5 example
30-
const { TimestreamInfluxDBClient, ListDbInstancesCommand } = require("@aws-sdk/client-timestream-influxdb");
30+
const { TimestreamInfluxDBClient, ListDbClustersCommand } = require("@aws-sdk/client-timestream-influxdb");
3131
```
3232

3333
```ts
3434
// ES6+ example
35-
import { TimestreamInfluxDBClient, ListDbInstancesCommand } from "@aws-sdk/client-timestream-influxdb";
35+
import { TimestreamInfluxDBClient, ListDbClustersCommand } from "@aws-sdk/client-timestream-influxdb";
3636
```
3737

3838
### Usage
@@ -51,7 +51,7 @@ const client = new TimestreamInfluxDBClient({ region: "REGION" });
5151
const params = {
5252
/** input parameters */
5353
};
54-
const command = new ListDbInstancesCommand(params);
54+
const command = new ListDbClustersCommand(params);
5555
```
5656

5757
#### Async/await
@@ -130,15 +130,15 @@ const client = new AWS.TimestreamInfluxDB({ region: "REGION" });
130130

131131
// async/await.
132132
try {
133-
const data = await client.listDbInstances(params);
133+
const data = await client.listDbClusters(params);
134134
// process data.
135135
} catch (error) {
136136
// error handling.
137137
}
138138

139139
// Promises.
140140
client
141-
.listDbInstances(params)
141+
.listDbClusters(params)
142142
.then((data) => {
143143
// process data.
144144
})
@@ -147,7 +147,7 @@ client
147147
});
148148

149149
// callbacks.
150-
client.listDbInstances(params, (err, data) => {
150+
client.listDbClusters(params, (err, data) => {
151151
// process err and data.
152152
});
153153
```
@@ -203,6 +203,14 @@ see LICENSE for more information.
203203

204204
## Client Commands (Operations List)
205205

206+
<details>
207+
<summary>
208+
CreateDbCluster
209+
</summary>
210+
211+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/CreateDbClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/CreateDbClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/CreateDbClusterCommandOutput/)
212+
213+
</details>
206214
<details>
207215
<summary>
208216
CreateDbInstance
@@ -218,6 +226,14 @@ CreateDbParameterGroup
218226

219227
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/CreateDbParameterGroupCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/CreateDbParameterGroupCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/CreateDbParameterGroupCommandOutput/)
220228

229+
</details>
230+
<details>
231+
<summary>
232+
DeleteDbCluster
233+
</summary>
234+
235+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/DeleteDbClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/DeleteDbClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/DeleteDbClusterCommandOutput/)
236+
221237
</details>
222238
<details>
223239
<summary>
@@ -226,6 +242,14 @@ DeleteDbInstance
226242

227243
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/DeleteDbInstanceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/DeleteDbInstanceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/DeleteDbInstanceCommandOutput/)
228244

245+
</details>
246+
<details>
247+
<summary>
248+
GetDbCluster
249+
</summary>
250+
251+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/GetDbClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/GetDbClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/GetDbClusterCommandOutput/)
252+
229253
</details>
230254
<details>
231255
<summary>
@@ -242,6 +266,14 @@ GetDbParameterGroup
242266

243267
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/GetDbParameterGroupCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/GetDbParameterGroupCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/GetDbParameterGroupCommandOutput/)
244268

269+
</details>
270+
<details>
271+
<summary>
272+
ListDbClusters
273+
</summary>
274+
275+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/ListDbClustersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/ListDbClustersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/ListDbClustersCommandOutput/)
276+
245277
</details>
246278
<details>
247279
<summary>
@@ -250,6 +282,14 @@ ListDbInstances
250282

251283
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/ListDbInstancesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/ListDbInstancesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/ListDbInstancesCommandOutput/)
252284

285+
</details>
286+
<details>
287+
<summary>
288+
ListDbInstancesForCluster
289+
</summary>
290+
291+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/ListDbInstancesForClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/ListDbInstancesForClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/ListDbInstancesForClusterCommandOutput/)
292+
253293
</details>
254294
<details>
255295
<summary>
@@ -282,6 +322,14 @@ UntagResource
282322

283323
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/UntagResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/UntagResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/UntagResourceCommandOutput/)
284324

325+
</details>
326+
<details>
327+
<summary>
328+
UpdateDbCluster
329+
</summary>
330+
331+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/timestream-influxdb/command/UpdateDbClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/UpdateDbClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-timestream-influxdb/Interface/UpdateDbClusterCommandOutput/)
332+
285333
</details>
286334
<details>
287335
<summary>

clients/client-timestream-influxdb/src/TimestreamInfluxDB.ts

+121
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
import { createAggregatedClient } from "@smithy/smithy-client";
33
import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
44

5+
import {
6+
CreateDbClusterCommand,
7+
CreateDbClusterCommandInput,
8+
CreateDbClusterCommandOutput,
9+
} from "./commands/CreateDbClusterCommand";
510
import {
611
CreateDbInstanceCommand,
712
CreateDbInstanceCommandInput,
@@ -12,11 +17,21 @@ import {
1217
CreateDbParameterGroupCommandInput,
1318
CreateDbParameterGroupCommandOutput,
1419
} from "./commands/CreateDbParameterGroupCommand";
20+
import {
21+
DeleteDbClusterCommand,
22+
DeleteDbClusterCommandInput,
23+
DeleteDbClusterCommandOutput,
24+
} from "./commands/DeleteDbClusterCommand";
1525
import {
1626
DeleteDbInstanceCommand,
1727
DeleteDbInstanceCommandInput,
1828
DeleteDbInstanceCommandOutput,
1929
} from "./commands/DeleteDbInstanceCommand";
30+
import {
31+
GetDbClusterCommand,
32+
GetDbClusterCommandInput,
33+
GetDbClusterCommandOutput,
34+
} from "./commands/GetDbClusterCommand";
2035
import {
2136
GetDbInstanceCommand,
2237
GetDbInstanceCommandInput,
@@ -27,11 +42,21 @@ import {
2742
GetDbParameterGroupCommandInput,
2843
GetDbParameterGroupCommandOutput,
2944
} from "./commands/GetDbParameterGroupCommand";
45+
import {
46+
ListDbClustersCommand,
47+
ListDbClustersCommandInput,
48+
ListDbClustersCommandOutput,
49+
} from "./commands/ListDbClustersCommand";
3050
import {
3151
ListDbInstancesCommand,
3252
ListDbInstancesCommandInput,
3353
ListDbInstancesCommandOutput,
3454
} from "./commands/ListDbInstancesCommand";
55+
import {
56+
ListDbInstancesForClusterCommand,
57+
ListDbInstancesForClusterCommandInput,
58+
ListDbInstancesForClusterCommandOutput,
59+
} from "./commands/ListDbInstancesForClusterCommand";
3560
import {
3661
ListDbParameterGroupsCommand,
3762
ListDbParameterGroupsCommandInput,
@@ -48,6 +73,11 @@ import {
4873
UntagResourceCommandInput,
4974
UntagResourceCommandOutput,
5075
} from "./commands/UntagResourceCommand";
76+
import {
77+
UpdateDbClusterCommand,
78+
UpdateDbClusterCommandInput,
79+
UpdateDbClusterCommandOutput,
80+
} from "./commands/UpdateDbClusterCommand";
5181
import {
5282
UpdateDbInstanceCommand,
5383
UpdateDbInstanceCommandInput,
@@ -56,20 +86,40 @@ import {
5686
import { TimestreamInfluxDBClient, TimestreamInfluxDBClientConfig } from "./TimestreamInfluxDBClient";
5787

5888
const commands = {
89+
CreateDbClusterCommand,
5990
CreateDbInstanceCommand,
6091
CreateDbParameterGroupCommand,
92+
DeleteDbClusterCommand,
6193
DeleteDbInstanceCommand,
94+
GetDbClusterCommand,
6295
GetDbInstanceCommand,
6396
GetDbParameterGroupCommand,
97+
ListDbClustersCommand,
6498
ListDbInstancesCommand,
99+
ListDbInstancesForClusterCommand,
65100
ListDbParameterGroupsCommand,
66101
ListTagsForResourceCommand,
67102
TagResourceCommand,
68103
UntagResourceCommand,
104+
UpdateDbClusterCommand,
69105
UpdateDbInstanceCommand,
70106
};
71107

72108
export interface TimestreamInfluxDB {
109+
/**
110+
* @see {@link CreateDbClusterCommand}
111+
*/
112+
createDbCluster(
113+
args: CreateDbClusterCommandInput,
114+
options?: __HttpHandlerOptions
115+
): Promise<CreateDbClusterCommandOutput>;
116+
createDbCluster(args: CreateDbClusterCommandInput, cb: (err: any, data?: CreateDbClusterCommandOutput) => void): void;
117+
createDbCluster(
118+
args: CreateDbClusterCommandInput,
119+
options: __HttpHandlerOptions,
120+
cb: (err: any, data?: CreateDbClusterCommandOutput) => void
121+
): void;
122+
73123
/**
74124
* @see {@link CreateDbInstanceCommand}
75125
*/
@@ -104,6 +154,20 @@ export interface TimestreamInfluxDB {
104154
cb: (err: any, data?: CreateDbParameterGroupCommandOutput) => void
105155
): void;
106156

157+
/**
158+
* @see {@link DeleteDbClusterCommand}
159+
*/
160+
deleteDbCluster(
161+
args: DeleteDbClusterCommandInput,
162+
options?: __HttpHandlerOptions
163+
): Promise<DeleteDbClusterCommandOutput>;
164+
deleteDbCluster(args: DeleteDbClusterCommandInput, cb: (err: any, data?: DeleteDbClusterCommandOutput) => void): void;
165+
deleteDbCluster(
166+
args: DeleteDbClusterCommandInput,
167+
options: __HttpHandlerOptions,
168+
cb: (err: any, data?: DeleteDbClusterCommandOutput) => void
169+
): void;
170+
107171
/**
108172
* @see {@link DeleteDbInstanceCommand}
109173
*/
@@ -121,6 +185,17 @@ export interface TimestreamInfluxDB {
121185
cb: (err: any, data?: DeleteDbInstanceCommandOutput) => void
122186
): void;
123187

188+
/**
189+
* @see {@link GetDbClusterCommand}
190+
*/
191+
getDbCluster(args: GetDbClusterCommandInput, options?: __HttpHandlerOptions): Promise<GetDbClusterCommandOutput>;
192+
getDbCluster(args: GetDbClusterCommandInput, cb: (err: any, data?: GetDbClusterCommandOutput) => void): void;
193+
getDbCluster(
194+
args: GetDbClusterCommandInput,
195+
options: __HttpHandlerOptions,
196+
cb: (err: any, data?: GetDbClusterCommandOutput) => void
197+
): void;
198+
124199
/**
125200
* @see {@link GetDbInstanceCommand}
126201
*/
@@ -149,6 +224,21 @@ export interface TimestreamInfluxDB {
149224
cb: (err: any, data?: GetDbParameterGroupCommandOutput) => void
150225
): void;
151226

227+
/**
228+
* @see {@link ListDbClustersCommand}
229+
*/
230+
listDbClusters(): Promise<ListDbClustersCommandOutput>;
231+
listDbClusters(
232+
args: ListDbClustersCommandInput,
233+
options?: __HttpHandlerOptions
234+
): Promise<ListDbClustersCommandOutput>;
235+
listDbClusters(args: ListDbClustersCommandInput, cb: (err: any, data?: ListDbClustersCommandOutput) => void): void;
236+
listDbClusters(
237+
args: ListDbClustersCommandInput,
238+
options: __HttpHandlerOptions,
239+
cb: (err: any, data?: ListDbClustersCommandOutput) => void
240+
): void;
241+
152242
/**
153243
* @see {@link ListDbInstancesCommand}
154244
*/
@@ -164,6 +254,23 @@ export interface TimestreamInfluxDB {
164254
cb: (err: any, data?: ListDbInstancesCommandOutput) => void
165255
): void;
166256

257+
/**
258+
* @see {@link ListDbInstancesForClusterCommand}
259+
*/
260+
listDbInstancesForCluster(
261+
args: ListDbInstancesForClusterCommandInput,
262+
options?: __HttpHandlerOptions
263+
): Promise<ListDbInstancesForClusterCommandOutput>;
264+
listDbInstancesForCluster(
265+
args: ListDbInstancesForClusterCommandInput,
266+
cb: (err: any, data?: ListDbInstancesForClusterCommandOutput) => void
267+
): void;
268+
listDbInstancesForCluster(
269+
args: ListDbInstancesForClusterCommandInput,
270+
options: __HttpHandlerOptions,
271+
cb: (err: any, data?: ListDbInstancesForClusterCommandOutput) => void
272+
): void;
273+
167274
/**
168275
* @see {@link ListDbParameterGroupsCommand}
169276
*/
@@ -221,6 +328,20 @@ export interface TimestreamInfluxDB {
221328
cb: (err: any, data?: UntagResourceCommandOutput) => void
222329
): void;
223330

331+
/**
332+
* @see {@link UpdateDbClusterCommand}
333+
*/
334+
updateDbCluster(
335+
args: UpdateDbClusterCommandInput,
336+
options?: __HttpHandlerOptions
337+
): Promise<UpdateDbClusterCommandOutput>;
338+
updateDbCluster(args: UpdateDbClusterCommandInput, cb: (err: any, data?: UpdateDbClusterCommandOutput) => void): void;
339+
updateDbCluster(
340+
args: UpdateDbClusterCommandInput,
341+
options: __HttpHandlerOptions,
342+
cb: (err: any, data?: UpdateDbClusterCommandOutput) => void
343+
): void;
344+
224345
/**
225346
* @see {@link UpdateDbInstanceCommand}
226347
*/

0 commit comments

Comments
 (0)