@aws-sdk/client-timestream-influxdb 3.749.0 → 3.758.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 (60) hide show
  1. package/README.md +55 -7
  2. package/dist-cjs/TimestreamInfluxDB.js +12 -0
  3. package/dist-cjs/commands/CreateDbClusterCommand.js +27 -0
  4. package/dist-cjs/commands/DeleteDbClusterCommand.js +26 -0
  5. package/dist-cjs/commands/GetDbClusterCommand.js +26 -0
  6. package/dist-cjs/commands/ListDbClustersCommand.js +26 -0
  7. package/dist-cjs/commands/ListDbInstancesForClusterCommand.js +26 -0
  8. package/dist-cjs/commands/UpdateDbClusterCommand.js +26 -0
  9. package/dist-cjs/commands/index.js +6 -0
  10. package/dist-cjs/models/models_0.js +34 -8
  11. package/dist-cjs/pagination/ListDbClustersPaginator.js +7 -0
  12. package/dist-cjs/pagination/ListDbInstancesForClusterPaginator.js +7 -0
  13. package/dist-cjs/pagination/index.js +2 -0
  14. package/dist-cjs/protocols/Aws_json1_0.js +127 -1
  15. package/dist-es/TimestreamInfluxDB.js +12 -0
  16. package/dist-es/commands/CreateDbClusterCommand.js +23 -0
  17. package/dist-es/commands/DeleteDbClusterCommand.js +22 -0
  18. package/dist-es/commands/GetDbClusterCommand.js +22 -0
  19. package/dist-es/commands/ListDbClustersCommand.js +22 -0
  20. package/dist-es/commands/ListDbInstancesForClusterCommand.js +22 -0
  21. package/dist-es/commands/UpdateDbClusterCommand.js +22 -0
  22. package/dist-es/commands/index.js +6 -0
  23. package/dist-es/models/models_0.js +32 -7
  24. package/dist-es/pagination/ListDbClustersPaginator.js +4 -0
  25. package/dist-es/pagination/ListDbInstancesForClusterPaginator.js +4 -0
  26. package/dist-es/pagination/index.js +2 -0
  27. package/dist-es/protocols/Aws_json1_0.js +114 -0
  28. package/dist-types/TimestreamInfluxDB.d.ts +43 -0
  29. package/dist-types/TimestreamInfluxDBClient.d.ts +8 -2
  30. package/dist-types/commands/CreateDbClusterCommand.d.ts +121 -0
  31. package/dist-types/commands/CreateDbInstanceCommand.d.ts +2 -0
  32. package/dist-types/commands/DeleteDbClusterCommand.d.ts +89 -0
  33. package/dist-types/commands/DeleteDbInstanceCommand.d.ts +2 -0
  34. package/dist-types/commands/GetDbClusterCommand.d.ts +113 -0
  35. package/dist-types/commands/GetDbInstanceCommand.d.ts +2 -0
  36. package/dist-types/commands/ListDbClustersCommand.d.ts +103 -0
  37. package/dist-types/commands/ListDbInstancesForClusterCommand.d.ts +104 -0
  38. package/dist-types/commands/UpdateDbClusterCommand.d.ts +99 -0
  39. package/dist-types/commands/UpdateDbInstanceCommand.d.ts +2 -0
  40. package/dist-types/commands/index.d.ts +6 -0
  41. package/dist-types/models/models_0.d.ts +718 -123
  42. package/dist-types/pagination/ListDbClustersPaginator.d.ts +7 -0
  43. package/dist-types/pagination/ListDbInstancesForClusterPaginator.d.ts +7 -0
  44. package/dist-types/pagination/index.d.ts +2 -0
  45. package/dist-types/protocols/Aws_json1_0.d.ts +54 -0
  46. package/dist-types/ts3.4/TimestreamInfluxDB.d.ts +103 -0
  47. package/dist-types/ts3.4/TimestreamInfluxDBClient.d.ts +36 -0
  48. package/dist-types/ts3.4/commands/CreateDbClusterCommand.d.ts +50 -0
  49. package/dist-types/ts3.4/commands/DeleteDbClusterCommand.d.ts +50 -0
  50. package/dist-types/ts3.4/commands/GetDbClusterCommand.d.ts +47 -0
  51. package/dist-types/ts3.4/commands/ListDbClustersCommand.d.ts +47 -0
  52. package/dist-types/ts3.4/commands/ListDbInstancesForClusterCommand.d.ts +51 -0
  53. package/dist-types/ts3.4/commands/UpdateDbClusterCommand.d.ts +50 -0
  54. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  55. package/dist-types/ts3.4/models/models_0.d.ts +184 -38
  56. package/dist-types/ts3.4/pagination/ListDbClustersPaginator.d.ts +11 -0
  57. package/dist-types/ts3.4/pagination/ListDbInstancesForClusterPaginator.d.ts +11 -0
  58. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  59. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +72 -0
  60. package/package.json +12 -12
@@ -65,6 +65,550 @@ export declare const DbStorageType: {
65
65
  * @public
66
66
  */
67
67
  export type DbStorageType = (typeof DbStorageType)[keyof typeof DbStorageType];
68
+ /**
69
+ * @public
70
+ * @enum
71
+ */
72
+ export declare const ClusterDeploymentType: {
73
+ readonly MULTI_NODE_READ_REPLICAS: "MULTI_NODE_READ_REPLICAS";
74
+ };
75
+ /**
76
+ * @public
77
+ */
78
+ export type ClusterDeploymentType = (typeof ClusterDeploymentType)[keyof typeof ClusterDeploymentType];
79
+ /**
80
+ * @public
81
+ * @enum
82
+ */
83
+ export declare const FailoverMode: {
84
+ readonly AUTOMATIC: "AUTOMATIC";
85
+ readonly NO_FAILOVER: "NO_FAILOVER";
86
+ };
87
+ /**
88
+ * @public
89
+ */
90
+ export type FailoverMode = (typeof FailoverMode)[keyof typeof FailoverMode];
91
+ /**
92
+ * <p>Configuration for S3 bucket log delivery.</p>
93
+ * @public
94
+ */
95
+ export interface S3Configuration {
96
+ /**
97
+ * <p>The name of the S3 bucket to deliver logs to.</p>
98
+ * @public
99
+ */
100
+ bucketName: string | undefined;
101
+ /**
102
+ * <p>Indicates whether log delivery to the S3 bucket is enabled.</p>
103
+ * @public
104
+ */
105
+ enabled: boolean | undefined;
106
+ }
107
+ /**
108
+ * <p>Configuration for sending InfluxDB engine logs to send to specified S3 bucket.</p>
109
+ * @public
110
+ */
111
+ export interface LogDeliveryConfiguration {
112
+ /**
113
+ * <p>Configuration for S3 bucket log delivery.</p>
114
+ * @public
115
+ */
116
+ s3Configuration: S3Configuration | undefined;
117
+ }
118
+ /**
119
+ * @public
120
+ * @enum
121
+ */
122
+ export declare const NetworkType: {
123
+ readonly DUAL: "DUAL";
124
+ readonly IPV4: "IPV4";
125
+ };
126
+ /**
127
+ * @public
128
+ */
129
+ export type NetworkType = (typeof NetworkType)[keyof typeof NetworkType];
130
+ /**
131
+ * @public
132
+ */
133
+ export interface CreateDbClusterInput {
134
+ /**
135
+ * <p>The name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB cluster names must be unique per customer and per region.</p>
136
+ * @public
137
+ */
138
+ name: string | undefined;
139
+ /**
140
+ * <p>The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in Amazon Web Services Secrets Manager in your account.</p>
141
+ * @public
142
+ */
143
+ username?: string | undefined;
144
+ /**
145
+ * <p>The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a secret created in Amazon Web Services Secrets Manager in your account.</p>
146
+ * @public
147
+ */
148
+ password: string | undefined;
149
+ /**
150
+ * <p>The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.</p>
151
+ * @public
152
+ */
153
+ organization?: string | undefined;
154
+ /**
155
+ * <p>The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.</p>
156
+ * @public
157
+ */
158
+ bucket?: string | undefined;
159
+ /**
160
+ * <p>The port number on which InfluxDB accepts connections.</p>
161
+ * <p>Valid Values: 1024-65535</p>
162
+ * <p>Default: 8086</p>
163
+ * <p>Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680</p>
164
+ * @public
165
+ */
166
+ port?: number | undefined;
167
+ /**
168
+ * <p>The ID of the DB parameter group to assign to your DB cluster. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.</p>
169
+ * @public
170
+ */
171
+ dbParameterGroupIdentifier?: string | undefined;
172
+ /**
173
+ * <p>The Timestream for InfluxDB DB instance type to run InfluxDB on.</p>
174
+ * @public
175
+ */
176
+ dbInstanceType: DbInstanceType | undefined;
177
+ /**
178
+ * <p>The Timestream for InfluxDB DB storage type to read and write InfluxDB data.</p>
179
+ * <p>You can choose between three different types of provisioned Influx IOPS Included storage according to your workload requirements:</p>
180
+ * <ul>
181
+ * <li>
182
+ * <p>Influx I/O Included 3000 IOPS</p>
183
+ * </li>
184
+ * <li>
185
+ * <p>Influx I/O Included 12000 IOPS</p>
186
+ * </li>
187
+ * <li>
188
+ * <p>Influx I/O Included 16000 IOPS</p>
189
+ * </li>
190
+ * </ul>
191
+ * @public
192
+ */
193
+ dbStorageType?: DbStorageType | undefined;
194
+ /**
195
+ * <p>The amount of storage to allocate for your DB storage type in GiB (gibibytes).</p>
196
+ * @public
197
+ */
198
+ allocatedStorage: number | undefined;
199
+ /**
200
+ * <p>Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>
201
+ * @public
202
+ */
203
+ networkType?: NetworkType | undefined;
204
+ /**
205
+ * <p>Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.</p>
206
+ * @public
207
+ */
208
+ publiclyAccessible?: boolean | undefined;
209
+ /**
210
+ * <p>A list of VPC subnet IDs to associate with the DB cluster. Provide at least two VPC subnet IDs in different Availability Zones when deploying with a Multi-AZ standby.</p>
211
+ * @public
212
+ */
213
+ vpcSubnetIds: string[] | undefined;
214
+ /**
215
+ * <p>A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.</p>
216
+ * @public
217
+ */
218
+ vpcSecurityGroupIds: string[] | undefined;
219
+ /**
220
+ * <p>Specifies the type of cluster to create.</p>
221
+ * @public
222
+ */
223
+ deploymentType: ClusterDeploymentType | undefined;
224
+ /**
225
+ * <p>Specifies the behavior of failure recovery when the primary node of the cluster fails.</p>
226
+ * @public
227
+ */
228
+ failoverMode?: FailoverMode | undefined;
229
+ /**
230
+ * <p>Configuration for sending InfluxDB engine logs to a specified S3 bucket.</p>
231
+ * @public
232
+ */
233
+ logDeliveryConfiguration?: LogDeliveryConfiguration | undefined;
234
+ /**
235
+ * <p>A list of key-value pairs to associate with the DB instance.</p>
236
+ * @public
237
+ */
238
+ tags?: Record<string, string> | undefined;
239
+ }
240
+ /**
241
+ * @public
242
+ * @enum
243
+ */
244
+ export declare const ClusterStatus: {
245
+ readonly AVAILABLE: "AVAILABLE";
246
+ readonly CREATING: "CREATING";
247
+ readonly DELETED: "DELETED";
248
+ readonly DELETING: "DELETING";
249
+ readonly FAILED: "FAILED";
250
+ readonly UPDATING: "UPDATING";
251
+ };
252
+ /**
253
+ * @public
254
+ */
255
+ export type ClusterStatus = (typeof ClusterStatus)[keyof typeof ClusterStatus];
256
+ /**
257
+ * @public
258
+ */
259
+ export interface CreateDbClusterOutput {
260
+ /**
261
+ * <p>A service-generated unique identifier.</p>
262
+ * @public
263
+ */
264
+ dbClusterId?: string | undefined;
265
+ /**
266
+ * <p>The status of the DB cluster.</p>
267
+ * @public
268
+ */
269
+ dbClusterStatus?: ClusterStatus | undefined;
270
+ }
271
+ /**
272
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
273
+ * @public
274
+ */
275
+ export declare class InternalServerException extends __BaseException {
276
+ readonly name: "InternalServerException";
277
+ readonly $fault: "server";
278
+ $retryable: {};
279
+ /**
280
+ * @internal
281
+ */
282
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
283
+ }
284
+ /**
285
+ * <p>The requested resource was not found or does not exist.</p>
286
+ * @public
287
+ */
288
+ export declare class ResourceNotFoundException extends __BaseException {
289
+ readonly name: "ResourceNotFoundException";
290
+ readonly $fault: "client";
291
+ /**
292
+ * <p>The identifier for the Timestream for InfluxDB resource associated with the request.</p>
293
+ * @public
294
+ */
295
+ resourceId: string | undefined;
296
+ /**
297
+ * <p>The type of Timestream for InfluxDB resource associated with the request.</p>
298
+ * @public
299
+ */
300
+ resourceType: string | undefined;
301
+ /**
302
+ * @internal
303
+ */
304
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
305
+ }
306
+ /**
307
+ * <p>The request exceeds the service quota.</p>
308
+ * @public
309
+ */
310
+ export declare class ServiceQuotaExceededException extends __BaseException {
311
+ readonly name: "ServiceQuotaExceededException";
312
+ readonly $fault: "client";
313
+ /**
314
+ * @internal
315
+ */
316
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
317
+ }
318
+ /**
319
+ * <p>The request was denied due to request throttling.</p>
320
+ * @public
321
+ */
322
+ export declare class ThrottlingException extends __BaseException {
323
+ readonly name: "ThrottlingException";
324
+ readonly $fault: "client";
325
+ $retryable: {};
326
+ /**
327
+ * <p>The number of seconds the caller should wait before retrying.</p>
328
+ * @public
329
+ */
330
+ retryAfterSeconds?: number | undefined;
331
+ /**
332
+ * @internal
333
+ */
334
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
335
+ }
336
+ /**
337
+ * @public
338
+ * @enum
339
+ */
340
+ export declare const ValidationExceptionReason: {
341
+ readonly FIELD_VALIDATION_FAILED: "FIELD_VALIDATION_FAILED";
342
+ readonly OTHER: "OTHER";
343
+ };
344
+ /**
345
+ * @public
346
+ */
347
+ export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
348
+ /**
349
+ * <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
350
+ * @public
351
+ */
352
+ export declare class ValidationException extends __BaseException {
353
+ readonly name: "ValidationException";
354
+ readonly $fault: "client";
355
+ /**
356
+ * <p>The reason that validation failed.</p>
357
+ * @public
358
+ */
359
+ reason: ValidationExceptionReason | undefined;
360
+ /**
361
+ * @internal
362
+ */
363
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
364
+ }
365
+ /**
366
+ * @public
367
+ */
368
+ export interface DeleteDbClusterInput {
369
+ /**
370
+ * <p>Service-generated unique identifier of the DB cluster.</p>
371
+ * @public
372
+ */
373
+ dbClusterId: string | undefined;
374
+ }
375
+ /**
376
+ * @public
377
+ */
378
+ export interface DeleteDbClusterOutput {
379
+ /**
380
+ * <p>The status of the DB cluster.</p>
381
+ * @public
382
+ */
383
+ dbClusterStatus?: ClusterStatus | undefined;
384
+ }
385
+ /**
386
+ * @public
387
+ */
388
+ export interface GetDbClusterInput {
389
+ /**
390
+ * <p>Service-generated unique identifier of the DB cluster to retrieve.</p>
391
+ * @public
392
+ */
393
+ dbClusterId: string | undefined;
394
+ }
395
+ /**
396
+ * @public
397
+ */
398
+ export interface GetDbClusterOutput {
399
+ /**
400
+ * <p>Service-generated unique identifier of the DB cluster to retrieve.</p>
401
+ * @public
402
+ */
403
+ id: string | undefined;
404
+ /**
405
+ * <p>Customer-supplied name of the Timestream for InfluxDB cluster.</p>
406
+ * @public
407
+ */
408
+ name: string | undefined;
409
+ /**
410
+ * <p>The Amazon Resource Name (ARN) of the DB cluster.</p>
411
+ * @public
412
+ */
413
+ arn: string | undefined;
414
+ /**
415
+ * <p>The status of the DB cluster.</p>
416
+ * @public
417
+ */
418
+ status?: ClusterStatus | undefined;
419
+ /**
420
+ * <p>The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.</p>
421
+ * @public
422
+ */
423
+ endpoint?: string | undefined;
424
+ /**
425
+ * <p>The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.</p>
426
+ * @public
427
+ */
428
+ readerEndpoint?: string | undefined;
429
+ /**
430
+ * <p>The port number on which InfluxDB accepts connections.</p>
431
+ * @public
432
+ */
433
+ port?: number | undefined;
434
+ /**
435
+ * <p>Deployment type of the DB cluster.</p>
436
+ * @public
437
+ */
438
+ deploymentType?: ClusterDeploymentType | undefined;
439
+ /**
440
+ * <p>The Timestream for InfluxDB instance type that InfluxDB runs on.</p>
441
+ * @public
442
+ */
443
+ dbInstanceType?: DbInstanceType | undefined;
444
+ /**
445
+ * <p>Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>
446
+ * @public
447
+ */
448
+ networkType?: NetworkType | undefined;
449
+ /**
450
+ * <p>The Timestream for InfluxDB DB storage type that InfluxDB stores data on.</p>
451
+ * @public
452
+ */
453
+ dbStorageType?: DbStorageType | undefined;
454
+ /**
455
+ * <p>The amount of storage allocated for your DB storage type (in gibibytes).</p>
456
+ * @public
457
+ */
458
+ allocatedStorage?: number | undefined;
459
+ /**
460
+ * <p>Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.</p>
461
+ * @public
462
+ */
463
+ publiclyAccessible?: boolean | undefined;
464
+ /**
465
+ * <p>The ID of the DB parameter group assigned to your DB cluster.</p>
466
+ * @public
467
+ */
468
+ dbParameterGroupIdentifier?: string | undefined;
469
+ /**
470
+ * <p>Configuration for sending InfluxDB engine logs to send to specified S3 bucket.</p>
471
+ * @public
472
+ */
473
+ logDeliveryConfiguration?: LogDeliveryConfiguration | undefined;
474
+ /**
475
+ * <p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.</p>
476
+ * @public
477
+ */
478
+ influxAuthParametersSecretArn?: string | undefined;
479
+ /**
480
+ * <p>A list of VPC subnet IDs associated with the DB cluster.</p>
481
+ * @public
482
+ */
483
+ vpcSubnetIds?: string[] | undefined;
484
+ /**
485
+ * <p>A list of VPC security group IDs associated with the DB cluster.</p>
486
+ * @public
487
+ */
488
+ vpcSecurityGroupIds?: string[] | undefined;
489
+ /**
490
+ * <p>The configured failover mode for the DB cluster.</p>
491
+ * @public
492
+ */
493
+ failoverMode?: FailoverMode | undefined;
494
+ }
495
+ /**
496
+ * @public
497
+ */
498
+ export interface ListDbClustersInput {
499
+ /**
500
+ * <p>The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.</p>
501
+ * @public
502
+ */
503
+ nextToken?: string | undefined;
504
+ /**
505
+ * <p>The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.</p>
506
+ * @public
507
+ */
508
+ maxResults?: number | undefined;
509
+ }
510
+ /**
511
+ * <p>Describes a summary of a Timestream for InfluxDB cluster.</p>
512
+ * @public
513
+ */
514
+ export interface DbClusterSummary {
515
+ /**
516
+ * <p>Service-generated unique identifier of the DB cluster to retrieve.</p>
517
+ * @public
518
+ */
519
+ id: string | undefined;
520
+ /**
521
+ * <p>Customer supplied name of the Timestream for InfluxDB cluster.</p>
522
+ * @public
523
+ */
524
+ name: string | undefined;
525
+ /**
526
+ * <p>The Amazon Resource Name (ARN) of the DB cluster.</p>
527
+ * @public
528
+ */
529
+ arn: string | undefined;
530
+ /**
531
+ * <p>The status of the DB cluster.</p>
532
+ * @public
533
+ */
534
+ status?: ClusterStatus | undefined;
535
+ /**
536
+ * <p>The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.</p>
537
+ * @public
538
+ */
539
+ endpoint?: string | undefined;
540
+ /**
541
+ * <p>The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.</p>
542
+ * @public
543
+ */
544
+ readerEndpoint?: string | undefined;
545
+ /**
546
+ * <p>The port number on which InfluxDB accepts connections.</p>
547
+ * @public
548
+ */
549
+ port?: number | undefined;
550
+ /**
551
+ * <p>Deployment type of the DB cluster</p>
552
+ * @public
553
+ */
554
+ deploymentType?: ClusterDeploymentType | undefined;
555
+ /**
556
+ * <p>The Timestream for InfluxDB DB instance type that InfluxDB runs on.</p>
557
+ * @public
558
+ */
559
+ dbInstanceType?: DbInstanceType | undefined;
560
+ /**
561
+ * <p>Specifies whether the network type of the Timestream for InfluxDB Cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>
562
+ * @public
563
+ */
564
+ networkType?: NetworkType | undefined;
565
+ /**
566
+ * <p>The Timestream for InfluxDB DB storage type that InfluxDB stores data on.</p>
567
+ * @public
568
+ */
569
+ dbStorageType?: DbStorageType | undefined;
570
+ /**
571
+ * <p>The amount of storage allocated for your DB storage type (in gibibytes).</p>
572
+ * @public
573
+ */
574
+ allocatedStorage?: number | undefined;
575
+ }
576
+ /**
577
+ * @public
578
+ */
579
+ export interface ListDbClustersOutput {
580
+ /**
581
+ * <p>A list of Timestream for InfluxDB cluster summaries.</p>
582
+ * @public
583
+ */
584
+ items: DbClusterSummary[] | undefined;
585
+ /**
586
+ * <p>Token from a previous call of the operation. When this value is provided, the
587
+ * service returns results from where the previous response left off.</p>
588
+ * @public
589
+ */
590
+ nextToken?: string | undefined;
591
+ }
592
+ /**
593
+ * @public
594
+ */
595
+ export interface ListDbInstancesForClusterInput {
596
+ /**
597
+ * <p>Service-generated unique identifier of the DB cluster.</p>
598
+ * @public
599
+ */
600
+ dbClusterId: string | undefined;
601
+ /**
602
+ * <p>The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.</p>
603
+ * @public
604
+ */
605
+ nextToken?: string | undefined;
606
+ /**
607
+ * <p>The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.</p>
608
+ * @public
609
+ */
610
+ maxResults?: number | undefined;
611
+ }
68
612
  /**
69
613
  * @public
70
614
  * @enum
@@ -78,44 +622,164 @@ export declare const DeploymentType: {
78
622
  */
79
623
  export type DeploymentType = (typeof DeploymentType)[keyof typeof DeploymentType];
80
624
  /**
81
- * <p>Configuration for S3 bucket log delivery.</p>
82
625
  * @public
626
+ * @enum
83
627
  */
84
- export interface S3Configuration {
628
+ export declare const InstanceMode: {
629
+ readonly PRIMARY: "PRIMARY";
630
+ readonly REPLICA: "REPLICA";
631
+ readonly STANDBY: "STANDBY";
632
+ };
633
+ /**
634
+ * @public
635
+ */
636
+ export type InstanceMode = (typeof InstanceMode)[keyof typeof InstanceMode];
637
+ /**
638
+ * @public
639
+ * @enum
640
+ */
641
+ export declare const Status: {
642
+ readonly AVAILABLE: "AVAILABLE";
643
+ readonly CREATING: "CREATING";
644
+ readonly DELETED: "DELETED";
645
+ readonly DELETING: "DELETING";
646
+ readonly FAILED: "FAILED";
647
+ readonly MODIFYING: "MODIFYING";
648
+ readonly UPDATING: "UPDATING";
649
+ readonly UPDATING_DEPLOYMENT_TYPE: "UPDATING_DEPLOYMENT_TYPE";
650
+ readonly UPDATING_INSTANCE_TYPE: "UPDATING_INSTANCE_TYPE";
651
+ };
652
+ /**
653
+ * @public
654
+ */
655
+ export type Status = (typeof Status)[keyof typeof Status];
656
+ /**
657
+ * <p>Contains a summary of a DB instance belonging to a DB cluster.</p>
658
+ * @public
659
+ */
660
+ export interface DbInstanceForClusterSummary {
85
661
  /**
86
- * <p>The name of the S3 bucket to deliver logs to.</p>
662
+ * <p>The service-generated unique identifier of the DB instance.</p>
87
663
  * @public
88
664
  */
89
- bucketName: string | undefined;
665
+ id: string | undefined;
90
666
  /**
91
- * <p>Indicates whether log delivery to the S3 bucket is enabled.</p>
667
+ * <p>A service-generated name for the DB instance based on the customer-supplied name for the DB cluster.</p>
92
668
  * @public
93
669
  */
94
- enabled: boolean | undefined;
670
+ name: string | undefined;
671
+ /**
672
+ * <p>The Amazon Resource Name (ARN) of the DB instance.</p>
673
+ * @public
674
+ */
675
+ arn: string | undefined;
676
+ /**
677
+ * <p>The status of the DB instance.</p>
678
+ * @public
679
+ */
680
+ status?: Status | undefined;
681
+ /**
682
+ * <p>The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.</p>
683
+ * @public
684
+ */
685
+ endpoint?: string | undefined;
686
+ /**
687
+ * <p>The port number on which InfluxDB accepts connections.</p>
688
+ * @public
689
+ */
690
+ port?: number | undefined;
691
+ /**
692
+ * <p>Specifies whether the network type of the Timestream for InfluxDB instance is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.</p>
693
+ * @public
694
+ */
695
+ networkType?: NetworkType | undefined;
696
+ /**
697
+ * <p>The Timestream for InfluxDB instance type to run InfluxDB on.</p>
698
+ * @public
699
+ */
700
+ dbInstanceType?: DbInstanceType | undefined;
701
+ /**
702
+ * <p>The storage type for your DB instance.</p>
703
+ * @public
704
+ */
705
+ dbStorageType?: DbStorageType | undefined;
706
+ /**
707
+ * <p>The amount of storage allocated for your DB storage type in GiB (gibibytes).</p>
708
+ * @public
709
+ */
710
+ allocatedStorage?: number | undefined;
711
+ /**
712
+ * <p>Specifies the deployment type if applicable.</p>
713
+ * @public
714
+ */
715
+ deploymentType?: DeploymentType | undefined;
716
+ /**
717
+ * <p>Specifies the DB instance's role in the cluster.</p>
718
+ * @public
719
+ */
720
+ instanceMode?: InstanceMode | undefined;
95
721
  }
96
722
  /**
97
- * <p>Configuration for sending InfluxDB engine logs to send to specified S3 bucket.</p>
98
723
  * @public
99
724
  */
100
- export interface LogDeliveryConfiguration {
725
+ export interface ListDbInstancesForClusterOutput {
101
726
  /**
102
- * <p>Configuration for S3 bucket log delivery.</p>
727
+ * <p>A list of Timestream for InfluxDB instance summaries belonging to the cluster.</p>
103
728
  * @public
104
729
  */
105
- s3Configuration: S3Configuration | undefined;
730
+ items: DbInstanceForClusterSummary[] | undefined;
731
+ /**
732
+ * <p>Token from a previous call of the operation. When this value is provided, the
733
+ * service returns results from where the previous response left off.</p>
734
+ * @public
735
+ */
736
+ nextToken?: string | undefined;
106
737
  }
107
738
  /**
108
739
  * @public
109
- * @enum
110
740
  */
111
- export declare const NetworkType: {
112
- readonly DUAL: "DUAL";
113
- readonly IPV4: "IPV4";
114
- };
741
+ export interface UpdateDbClusterInput {
742
+ /**
743
+ * <p>Service-generated unique identifier of the DB cluster to update.</p>
744
+ * @public
745
+ */
746
+ dbClusterId: string | undefined;
747
+ /**
748
+ * <p>The log delivery configuration to apply to the DB cluster.</p>
749
+ * @public
750
+ */
751
+ logDeliveryConfiguration?: LogDeliveryConfiguration | undefined;
752
+ /**
753
+ * <p>Update the DB cluster to use the specified DB parameter group.</p>
754
+ * @public
755
+ */
756
+ dbParameterGroupIdentifier?: string | undefined;
757
+ /**
758
+ * <p>Update the DB cluster to use the specified port.</p>
759
+ * @public
760
+ */
761
+ port?: number | undefined;
762
+ /**
763
+ * <p>Update the DB cluster to use the specified DB instance Type.</p>
764
+ * @public
765
+ */
766
+ dbInstanceType?: DbInstanceType | undefined;
767
+ /**
768
+ * <p>Update the DB cluster's failover behavior.</p>
769
+ * @public
770
+ */
771
+ failoverMode?: FailoverMode | undefined;
772
+ }
115
773
  /**
116
774
  * @public
117
775
  */
118
- export type NetworkType = (typeof NetworkType)[keyof typeof NetworkType];
776
+ export interface UpdateDbClusterOutput {
777
+ /**
778
+ * <p>The status of the DB cluster.</p>
779
+ * @public
780
+ */
781
+ dbClusterStatus?: ClusterStatus | undefined;
782
+ }
119
783
  /**
120
784
  * @public
121
785
  */
@@ -221,25 +885,6 @@ export interface CreateDbInstanceInput {
221
885
  */
222
886
  networkType?: NetworkType | undefined;
223
887
  }
224
- /**
225
- * @public
226
- * @enum
227
- */
228
- export declare const Status: {
229
- readonly AVAILABLE: "AVAILABLE";
230
- readonly CREATING: "CREATING";
231
- readonly DELETED: "DELETED";
232
- readonly DELETING: "DELETING";
233
- readonly FAILED: "FAILED";
234
- readonly MODIFYING: "MODIFYING";
235
- readonly UPDATING: "UPDATING";
236
- readonly UPDATING_DEPLOYMENT_TYPE: "UPDATING_DEPLOYMENT_TYPE";
237
- readonly UPDATING_INSTANCE_TYPE: "UPDATING_INSTANCE_TYPE";
238
- };
239
- /**
240
- * @public
241
- */
242
- export type Status = (typeof Status)[keyof typeof Status];
243
888
  /**
244
889
  * @public
245
890
  */
@@ -339,100 +984,16 @@ export interface CreateDbInstanceOutput {
339
984
  * @public
340
985
  */
341
986
  influxAuthParametersSecretArn?: string | undefined;
342
- }
343
- /**
344
- * <p>The request processing has failed because of an unknown error, exception or failure.</p>
345
- * @public
346
- */
347
- export declare class InternalServerException extends __BaseException {
348
- readonly name: "InternalServerException";
349
- readonly $fault: "server";
350
- $retryable: {};
351
- /**
352
- * @internal
353
- */
354
- constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
355
- }
356
- /**
357
- * <p>The requested resource was not found or does not exist.</p>
358
- * @public
359
- */
360
- export declare class ResourceNotFoundException extends __BaseException {
361
- readonly name: "ResourceNotFoundException";
362
- readonly $fault: "client";
363
- /**
364
- * <p>The identifier for the Timestream for InfluxDB resource associated with the request.</p>
365
- * @public
366
- */
367
- resourceId: string | undefined;
368
- /**
369
- * <p>The type of Timestream for InfluxDB resource associated with the request.</p>
370
- * @public
371
- */
372
- resourceType: string | undefined;
373
- /**
374
- * @internal
375
- */
376
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
377
- }
378
- /**
379
- * <p>The request exceeds the service quota.</p>
380
- * @public
381
- */
382
- export declare class ServiceQuotaExceededException extends __BaseException {
383
- readonly name: "ServiceQuotaExceededException";
384
- readonly $fault: "client";
385
- /**
386
- * @internal
387
- */
388
- constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
389
- }
390
- /**
391
- * <p>The request was denied due to request throttling.</p>
392
- * @public
393
- */
394
- export declare class ThrottlingException extends __BaseException {
395
- readonly name: "ThrottlingException";
396
- readonly $fault: "client";
397
- $retryable: {};
398
987
  /**
399
- * <p>The number of seconds the caller should wait before retrying.</p>
988
+ * <p>Specifies the DbCluster to which this DbInstance belongs to.</p>
400
989
  * @public
401
990
  */
402
- retryAfterSeconds?: number | undefined;
403
- /**
404
- * @internal
405
- */
406
- constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
407
- }
408
- /**
409
- * @public
410
- * @enum
411
- */
412
- export declare const ValidationExceptionReason: {
413
- readonly FIELD_VALIDATION_FAILED: "FIELD_VALIDATION_FAILED";
414
- readonly OTHER: "OTHER";
415
- };
416
- /**
417
- * @public
418
- */
419
- export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
420
- /**
421
- * <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
422
- * @public
423
- */
424
- export declare class ValidationException extends __BaseException {
425
- readonly name: "ValidationException";
426
- readonly $fault: "client";
991
+ dbClusterId?: string | undefined;
427
992
  /**
428
- * <p>The reason that validation failed.</p>
993
+ * <p>Specifies the DbInstance's role in the cluster.</p>
429
994
  * @public
430
995
  */
431
- reason: ValidationExceptionReason | undefined;
432
- /**
433
- * @internal
434
- */
435
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
996
+ instanceMode?: InstanceMode | undefined;
436
997
  }
437
998
  /**
438
999
  * @public
@@ -543,6 +1104,16 @@ export interface DeleteDbInstanceOutput {
543
1104
  * @public
544
1105
  */
545
1106
  influxAuthParametersSecretArn?: string | undefined;
1107
+ /**
1108
+ * <p>Specifies the DbCluster to which this DbInstance belongs to.</p>
1109
+ * @public
1110
+ */
1111
+ dbClusterId?: string | undefined;
1112
+ /**
1113
+ * <p>Specifies the DbInstance's role in the cluster.</p>
1114
+ * @public
1115
+ */
1116
+ instanceMode?: InstanceMode | undefined;
546
1117
  }
547
1118
  /**
548
1119
  * @public
@@ -653,6 +1224,16 @@ export interface GetDbInstanceOutput {
653
1224
  * @public
654
1225
  */
655
1226
  influxAuthParametersSecretArn?: string | undefined;
1227
+ /**
1228
+ * <p>Specifies the DbCluster to which this DbInstance belongs to.</p>
1229
+ * @public
1230
+ */
1231
+ dbClusterId?: string | undefined;
1232
+ /**
1233
+ * <p>Specifies the DbInstance's role in the cluster.</p>
1234
+ * @public
1235
+ */
1236
+ instanceMode?: InstanceMode | undefined;
656
1237
  }
657
1238
  /**
658
1239
  * @public
@@ -894,6 +1475,16 @@ export interface UpdateDbInstanceOutput {
894
1475
  * @public
895
1476
  */
896
1477
  influxAuthParametersSecretArn?: string | undefined;
1478
+ /**
1479
+ * <p>Specifies the DbCluster to which this DbInstance belongs to.</p>
1480
+ * @public
1481
+ */
1482
+ dbClusterId?: string | undefined;
1483
+ /**
1484
+ * <p>Specifies the DbInstance's role in the cluster.</p>
1485
+ * @public
1486
+ */
1487
+ instanceMode?: InstanceMode | undefined;
897
1488
  }
898
1489
  /**
899
1490
  * @public
@@ -1391,6 +1982,10 @@ export interface UntagResourceRequest {
1391
1982
  */
1392
1983
  tagKeys: string[] | undefined;
1393
1984
  }
1985
+ /**
1986
+ * @internal
1987
+ */
1988
+ export declare const CreateDbClusterInputFilterSensitiveLog: (obj: CreateDbClusterInput) => any;
1394
1989
  /**
1395
1990
  * @internal
1396
1991
  */