@aws-sdk/client-timestream-influxdb 3.1100.0 → 3.1102.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 (53) hide show
  1. package/README.md +42 -7
  2. package/dist-cjs/index.js +269 -45
  3. package/dist-es/TimestreamInfluxDB.js +12 -0
  4. package/dist-es/commands/CreateDbBackupCommand.js +4 -0
  5. package/dist-es/commands/DeleteDbBackupCommand.js +4 -0
  6. package/dist-es/commands/GetDbBackupCommand.js +4 -0
  7. package/dist-es/commands/ListDbBackupsCommand.js +4 -0
  8. package/dist-es/commands/RestoreFromDbBackupCommand.js +4 -0
  9. package/dist-es/commands/index.js +5 -0
  10. package/dist-es/models/enums.js +54 -10
  11. package/dist-es/pagination/ListDbBackupsPaginator.js +4 -0
  12. package/dist-es/pagination/index.js +1 -0
  13. package/dist-es/schemas/schemas_0.js +160 -34
  14. package/dist-types/TimestreamInfluxDB.d.ts +43 -0
  15. package/dist-types/TimestreamInfluxDBClient.d.ts +7 -2
  16. package/dist-types/commands/CreateDbBackupCommand.d.ts +137 -0
  17. package/dist-types/commands/CreateDbClusterCommand.d.ts +10 -1
  18. package/dist-types/commands/CreateDbInstanceCommand.d.ts +20 -1
  19. package/dist-types/commands/DeleteDbBackupCommand.d.ts +129 -0
  20. package/dist-types/commands/DeleteDbClusterCommand.d.ts +2 -1
  21. package/dist-types/commands/DeleteDbInstanceCommand.d.ts +12 -1
  22. package/dist-types/commands/GetDbBackupCommand.d.ts +126 -0
  23. package/dist-types/commands/GetDbClusterCommand.d.ts +11 -1
  24. package/dist-types/commands/GetDbInstanceCommand.d.ts +11 -1
  25. package/dist-types/commands/ListDbBackupsCommand.d.ts +103 -0
  26. package/dist-types/commands/ListDbClustersCommand.d.ts +1 -1
  27. package/dist-types/commands/ListDbInstancesCommand.d.ts +1 -1
  28. package/dist-types/commands/ListDbInstancesForClusterCommand.d.ts +1 -1
  29. package/dist-types/commands/RebootDbClusterCommand.d.ts +1 -1
  30. package/dist-types/commands/RebootDbInstanceCommand.d.ts +11 -1
  31. package/dist-types/commands/RestoreFromDbBackupCommand.d.ts +131 -0
  32. package/dist-types/commands/UpdateDbClusterCommand.d.ts +9 -1
  33. package/dist-types/commands/UpdateDbInstanceCommand.d.ts +19 -1
  34. package/dist-types/commands/index.d.ts +5 -0
  35. package/dist-types/models/enums.d.ts +117 -17
  36. package/dist-types/models/models_0.d.ts +822 -24
  37. package/dist-types/pagination/ListDbBackupsPaginator.d.ts +7 -0
  38. package/dist-types/pagination/index.d.ts +1 -0
  39. package/dist-types/schemas/schemas_0.d.ts +18 -0
  40. package/dist-types/ts3.4/TimestreamInfluxDB.d.ts +90 -0
  41. package/dist-types/ts3.4/TimestreamInfluxDBClient.d.ts +27 -0
  42. package/dist-types/ts3.4/commands/CreateDbBackupCommand.d.ts +38 -0
  43. package/dist-types/ts3.4/commands/DeleteDbBackupCommand.d.ts +38 -0
  44. package/dist-types/ts3.4/commands/GetDbBackupCommand.d.ts +38 -0
  45. package/dist-types/ts3.4/commands/ListDbBackupsCommand.d.ts +38 -0
  46. package/dist-types/ts3.4/commands/RestoreFromDbBackupCommand.d.ts +39 -0
  47. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  48. package/dist-types/ts3.4/models/enums.d.ts +68 -15
  49. package/dist-types/ts3.4/models/models_0.d.ts +183 -4
  50. package/dist-types/ts3.4/pagination/ListDbBackupsPaginator.d.ts +11 -0
  51. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  52. package/dist-types/ts3.4/schemas/schemas_0.d.ts +18 -0
  53. package/package.json +3 -3
@@ -0,0 +1,137 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { CreateDbBackupInput, CreateDbBackupOutput } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link CreateDbBackupCommand}.
11
+ */
12
+ export interface CreateDbBackupCommandInput extends CreateDbBackupInput {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link CreateDbBackupCommand}.
18
+ */
19
+ export interface CreateDbBackupCommandOutput extends CreateDbBackupOutput, __MetadataBearer {
20
+ }
21
+ declare const CreateDbBackupCommand_base: {
22
+ new (input: CreateDbBackupCommandInput): import("@smithy/core/client").CommandImpl<CreateDbBackupCommandInput, CreateDbBackupCommandOutput, import("..").TimestreamInfluxDBClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: CreateDbBackupCommandInput): import("@smithy/core/client").CommandImpl<CreateDbBackupCommandInput, CreateDbBackupCommandOutput, import("..").TimestreamInfluxDBClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Creates a new on-demand backup of a Timestream for InfluxDB resource.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { TimestreamInfluxDBClient, CreateDbBackupCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
32
+ * // const { TimestreamInfluxDBClient, CreateDbBackupCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import
33
+ * // import type { TimestreamInfluxDBClientConfig } from "@aws-sdk/client-timestream-influxdb";
34
+ * const config = {}; // type is TimestreamInfluxDBClientConfig
35
+ * const client = new TimestreamInfluxDBClient(config);
36
+ * const input = { // CreateDbBackupInput
37
+ * name: "STRING_VALUE", // required
38
+ * dbResourceId: "STRING_VALUE", // required
39
+ * retentionDays: Number("int"),
40
+ * tags: { // RequestTagMap
41
+ * "<keys>": "STRING_VALUE",
42
+ * },
43
+ * };
44
+ * const command = new CreateDbBackupCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // CreateDbBackupOutput
47
+ * // id: "STRING_VALUE", // required
48
+ * // name: "STRING_VALUE",
49
+ * // arn: "STRING_VALUE", // required
50
+ * // status: "IN_PROGRESS" || "COMPLETED" || "FAILED" || "DELETING" || "DELETED",
51
+ * // createdAt: new Date("TIMESTAMP"),
52
+ * // expiresAfter: "STRING_VALUE",
53
+ * // dbResourceId: "STRING_VALUE",
54
+ * // type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "ON_DEMAND" || "CONTINUOUS",
55
+ * // engineType: "INFLUXDB_V2" || "INFLUXDB_V3_CORE" || "INFLUXDB_V3_ENTERPRISE",
56
+ * // deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY" || "MULTI_NODE_READ_REPLICAS",
57
+ * // kmsKeyId: "STRING_VALUE",
58
+ * // clusterConfiguration: { // ClusterConfiguration
59
+ * // ingestQueryInstances: Number("int"),
60
+ * // queryOnlyInstances: Number("int"),
61
+ * // dedicatedCompactor: true || false,
62
+ * // },
63
+ * // dbParameterGroupId: "STRING_VALUE",
64
+ * // dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge" || "db.influx.24xlarge",
65
+ * // logDeliveryConfiguration: { // LogDeliveryConfiguration
66
+ * // s3Configuration: { // S3Configuration
67
+ * // bucketName: "STRING_VALUE", // required
68
+ * // enabled: true || false, // required
69
+ * // },
70
+ * // },
71
+ * // failoverMode: "AUTOMATIC" || "NO_FAILOVER",
72
+ * // dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
73
+ * // allocatedStorage: Number("int"),
74
+ * // vpcSubnetIds: [ // VpcSubnetIdList
75
+ * // "STRING_VALUE",
76
+ * // ],
77
+ * // vpcSecurityGroupIds: [ // VpcSecurityGroupIdList
78
+ * // "STRING_VALUE",
79
+ * // ],
80
+ * // publiclyAccessible: true || false,
81
+ * // port: Number("int"),
82
+ * // networkType: "IPV4" || "DUAL",
83
+ * // influxAuthParametersSecretArn: "STRING_VALUE",
84
+ * // maintenanceSchedule: { // MaintenanceSchedule
85
+ * // timezone: "STRING_VALUE", // required
86
+ * // preferredMaintenanceWindow: "STRING_VALUE", // required
87
+ * // },
88
+ * // };
89
+ *
90
+ * ```
91
+ *
92
+ * @param CreateDbBackupCommandInput - {@link CreateDbBackupCommandInput}
93
+ * @returns {@link CreateDbBackupCommandOutput}
94
+ * @see {@link CreateDbBackupCommandInput} for command's `input` shape.
95
+ * @see {@link CreateDbBackupCommandOutput} for command's `response` shape.
96
+ * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape.
97
+ *
98
+ * @throws {@link AccessDeniedException} (client fault)
99
+ * <p>You do not have sufficient access to perform this action.</p>
100
+ *
101
+ * @throws {@link ConflictException} (client fault)
102
+ * <p>The request conflicts with an existing resource in Timestream for InfluxDB.</p>
103
+ *
104
+ * @throws {@link InternalServerException} (server fault)
105
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
106
+ *
107
+ * @throws {@link ResourceNotFoundException} (client fault)
108
+ * <p>The requested resource was not found or does not exist.</p>
109
+ *
110
+ * @throws {@link ServiceQuotaExceededException} (client fault)
111
+ * <p>The request exceeds the service quota.</p>
112
+ *
113
+ * @throws {@link ThrottlingException} (client fault)
114
+ * <p>The request was denied due to request throttling.</p>
115
+ *
116
+ * @throws {@link ValidationException} (client fault)
117
+ * <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
118
+ *
119
+ * @throws {@link TimestreamInfluxDBServiceException}
120
+ * <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>
121
+ *
122
+ *
123
+ * @public
124
+ */
125
+ export declare class CreateDbBackupCommand extends CreateDbBackupCommand_base {
126
+ /** @internal type navigation helper, not in runtime. */
127
+ protected static __types: {
128
+ api: {
129
+ input: CreateDbBackupInput;
130
+ output: CreateDbBackupOutput;
131
+ };
132
+ sdk: {
133
+ input: CreateDbBackupCommandInput;
134
+ output: CreateDbBackupCommandOutput;
135
+ };
136
+ };
137
+ }
@@ -64,6 +64,15 @@ declare const CreateDbClusterCommand_base: {
64
64
  * timezone: "STRING_VALUE", // required
65
65
  * preferredMaintenanceWindow: "STRING_VALUE", // required
66
66
  * },
67
+ * dbBackupConfigurations: [ // DbBackupConfigurationInputList
68
+ * { // DbBackupConfiguration
69
+ * type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required
70
+ * retentionDays: Number("int"), // required
71
+ * enabled: true || false, // required
72
+ * customSchedule: "STRING_VALUE",
73
+ * },
74
+ * ],
75
+ * kmsKeyId: "STRING_VALUE",
67
76
  * tags: { // RequestTagMap
68
77
  * "<keys>": "STRING_VALUE",
69
78
  * },
@@ -72,7 +81,7 @@ declare const CreateDbClusterCommand_base: {
72
81
  * const response = await client.send(command);
73
82
  * // { // CreateDbClusterOutput
74
83
  * // dbClusterId: "STRING_VALUE",
75
- * // dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE",
84
+ * // dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE" || "RESTORING" || "RESTORE_FAILED",
76
85
  * // };
77
86
  *
78
87
  * ```
@@ -66,6 +66,15 @@ declare const CreateDbInstanceCommand_base: {
66
66
  * },
67
67
  * port: Number("int"),
68
68
  * networkType: "IPV4" || "DUAL",
69
+ * dbBackupConfigurations: [ // DbBackupConfigurationInputList
70
+ * { // DbBackupConfiguration
71
+ * type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required
72
+ * retentionDays: Number("int"), // required
73
+ * enabled: true || false, // required
74
+ * customSchedule: "STRING_VALUE",
75
+ * },
76
+ * ],
77
+ * kmsKeyId: "STRING_VALUE",
69
78
  * };
70
79
  * const command = new CreateDbInstanceCommand(input);
71
80
  * const response = await client.send(command);
@@ -73,7 +82,7 @@ declare const CreateDbInstanceCommand_base: {
73
82
  * // id: "STRING_VALUE", // required
74
83
  * // name: "STRING_VALUE", // required
75
84
  * // arn: "STRING_VALUE", // required
76
- * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED",
85
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED" || "RESTORING" || "RESTORE_FAILED",
77
86
  * // endpoint: "STRING_VALUE",
78
87
  * // port: Number("int"),
79
88
  * // networkType: "IPV4" || "DUAL",
@@ -109,6 +118,16 @@ declare const CreateDbInstanceCommand_base: {
109
118
  * // },
110
119
  * // lastMaintenanceTime: new Date("TIMESTAMP"),
111
120
  * // nextMaintenanceTime: new Date("TIMESTAMP"),
121
+ * // dbBackupConfigurations: [ // DbBackupConfigurationOutputList
122
+ * // { // DbBackupConfigurationOutput
123
+ * // type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required
124
+ * // retentionDays: Number("int"), // required
125
+ * // enabled: true || false, // required
126
+ * // customSchedule: "STRING_VALUE",
127
+ * // nextAutomatedBackupTime: new Date("TIMESTAMP"),
128
+ * // },
129
+ * // ],
130
+ * // kmsKeyId: "STRING_VALUE",
112
131
  * // };
113
132
  *
114
133
  * ```
@@ -0,0 +1,129 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { DeleteDbBackupInput, DeleteDbBackupOutput } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link DeleteDbBackupCommand}.
11
+ */
12
+ export interface DeleteDbBackupCommandInput extends DeleteDbBackupInput {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link DeleteDbBackupCommand}.
18
+ */
19
+ export interface DeleteDbBackupCommandOutput extends DeleteDbBackupOutput, __MetadataBearer {
20
+ }
21
+ declare const DeleteDbBackupCommand_base: {
22
+ new (input: DeleteDbBackupCommandInput): import("@smithy/core/client").CommandImpl<DeleteDbBackupCommandInput, DeleteDbBackupCommandOutput, import("..").TimestreamInfluxDBClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: DeleteDbBackupCommandInput): import("@smithy/core/client").CommandImpl<DeleteDbBackupCommandInput, DeleteDbBackupCommandOutput, import("..").TimestreamInfluxDBClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Deletes a Timestream for InfluxDB backup.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { TimestreamInfluxDBClient, DeleteDbBackupCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
32
+ * // const { TimestreamInfluxDBClient, DeleteDbBackupCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import
33
+ * // import type { TimestreamInfluxDBClientConfig } from "@aws-sdk/client-timestream-influxdb";
34
+ * const config = {}; // type is TimestreamInfluxDBClientConfig
35
+ * const client = new TimestreamInfluxDBClient(config);
36
+ * const input = { // DeleteDbBackupInput
37
+ * identifier: "STRING_VALUE", // required
38
+ * };
39
+ * const command = new DeleteDbBackupCommand(input);
40
+ * const response = await client.send(command);
41
+ * // { // DeleteDbBackupOutput
42
+ * // id: "STRING_VALUE", // required
43
+ * // name: "STRING_VALUE",
44
+ * // arn: "STRING_VALUE", // required
45
+ * // status: "IN_PROGRESS" || "COMPLETED" || "FAILED" || "DELETING" || "DELETED",
46
+ * // createdAt: new Date("TIMESTAMP"),
47
+ * // expiresAfter: "STRING_VALUE",
48
+ * // dbResourceId: "STRING_VALUE",
49
+ * // type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "ON_DEMAND" || "CONTINUOUS",
50
+ * // engineType: "INFLUXDB_V2" || "INFLUXDB_V3_CORE" || "INFLUXDB_V3_ENTERPRISE",
51
+ * // deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY" || "MULTI_NODE_READ_REPLICAS",
52
+ * // kmsKeyId: "STRING_VALUE",
53
+ * // clusterConfiguration: { // ClusterConfiguration
54
+ * // ingestQueryInstances: Number("int"),
55
+ * // queryOnlyInstances: Number("int"),
56
+ * // dedicatedCompactor: true || false,
57
+ * // },
58
+ * // dbParameterGroupId: "STRING_VALUE",
59
+ * // dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge" || "db.influx.24xlarge",
60
+ * // logDeliveryConfiguration: { // LogDeliveryConfiguration
61
+ * // s3Configuration: { // S3Configuration
62
+ * // bucketName: "STRING_VALUE", // required
63
+ * // enabled: true || false, // required
64
+ * // },
65
+ * // },
66
+ * // failoverMode: "AUTOMATIC" || "NO_FAILOVER",
67
+ * // dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
68
+ * // allocatedStorage: Number("int"),
69
+ * // vpcSubnetIds: [ // VpcSubnetIdList
70
+ * // "STRING_VALUE",
71
+ * // ],
72
+ * // vpcSecurityGroupIds: [ // VpcSecurityGroupIdList
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // publiclyAccessible: true || false,
76
+ * // port: Number("int"),
77
+ * // networkType: "IPV4" || "DUAL",
78
+ * // influxAuthParametersSecretArn: "STRING_VALUE",
79
+ * // maintenanceSchedule: { // MaintenanceSchedule
80
+ * // timezone: "STRING_VALUE", // required
81
+ * // preferredMaintenanceWindow: "STRING_VALUE", // required
82
+ * // },
83
+ * // };
84
+ *
85
+ * ```
86
+ *
87
+ * @param DeleteDbBackupCommandInput - {@link DeleteDbBackupCommandInput}
88
+ * @returns {@link DeleteDbBackupCommandOutput}
89
+ * @see {@link DeleteDbBackupCommandInput} for command's `input` shape.
90
+ * @see {@link DeleteDbBackupCommandOutput} for command's `response` shape.
91
+ * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape.
92
+ *
93
+ * @throws {@link AccessDeniedException} (client fault)
94
+ * <p>You do not have sufficient access to perform this action.</p>
95
+ *
96
+ * @throws {@link ConflictException} (client fault)
97
+ * <p>The request conflicts with an existing resource in Timestream for InfluxDB.</p>
98
+ *
99
+ * @throws {@link InternalServerException} (server fault)
100
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
101
+ *
102
+ * @throws {@link ResourceNotFoundException} (client fault)
103
+ * <p>The requested resource was not found or does not exist.</p>
104
+ *
105
+ * @throws {@link ThrottlingException} (client fault)
106
+ * <p>The request was denied due to request throttling.</p>
107
+ *
108
+ * @throws {@link ValidationException} (client fault)
109
+ * <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
110
+ *
111
+ * @throws {@link TimestreamInfluxDBServiceException}
112
+ * <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>
113
+ *
114
+ *
115
+ * @public
116
+ */
117
+ export declare class DeleteDbBackupCommand extends DeleteDbBackupCommand_base {
118
+ /** @internal type navigation helper, not in runtime. */
119
+ protected static __types: {
120
+ api: {
121
+ input: DeleteDbBackupInput;
122
+ output: DeleteDbBackupOutput;
123
+ };
124
+ sdk: {
125
+ input: DeleteDbBackupCommandInput;
126
+ output: DeleteDbBackupCommandOutput;
127
+ };
128
+ };
129
+ }
@@ -35,11 +35,12 @@ declare const DeleteDbClusterCommand_base: {
35
35
  * const client = new TimestreamInfluxDBClient(config);
36
36
  * const input = { // DeleteDbClusterInput
37
37
  * dbClusterId: "STRING_VALUE", // required
38
+ * retainAutomatedBackups: true || false,
38
39
  * };
39
40
  * const command = new DeleteDbClusterCommand(input);
40
41
  * const response = await client.send(command);
41
42
  * // { // DeleteDbClusterOutput
42
- * // dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE",
43
+ * // dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE" || "RESTORING" || "RESTORE_FAILED",
43
44
  * // };
44
45
  *
45
46
  * ```
@@ -35,6 +35,7 @@ declare const DeleteDbInstanceCommand_base: {
35
35
  * const client = new TimestreamInfluxDBClient(config);
36
36
  * const input = { // DeleteDbInstanceInput
37
37
  * identifier: "STRING_VALUE", // required
38
+ * retainAutomatedBackups: true || false,
38
39
  * };
39
40
  * const command = new DeleteDbInstanceCommand(input);
40
41
  * const response = await client.send(command);
@@ -42,7 +43,7 @@ declare const DeleteDbInstanceCommand_base: {
42
43
  * // id: "STRING_VALUE", // required
43
44
  * // name: "STRING_VALUE", // required
44
45
  * // arn: "STRING_VALUE", // required
45
- * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED",
46
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED" || "RESTORING" || "RESTORE_FAILED",
46
47
  * // endpoint: "STRING_VALUE",
47
48
  * // port: Number("int"),
48
49
  * // networkType: "IPV4" || "DUAL",
@@ -78,6 +79,16 @@ declare const DeleteDbInstanceCommand_base: {
78
79
  * // },
79
80
  * // lastMaintenanceTime: new Date("TIMESTAMP"),
80
81
  * // nextMaintenanceTime: new Date("TIMESTAMP"),
82
+ * // dbBackupConfigurations: [ // DbBackupConfigurationOutputList
83
+ * // { // DbBackupConfigurationOutput
84
+ * // type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required
85
+ * // retentionDays: Number("int"), // required
86
+ * // enabled: true || false, // required
87
+ * // customSchedule: "STRING_VALUE",
88
+ * // nextAutomatedBackupTime: new Date("TIMESTAMP"),
89
+ * // },
90
+ * // ],
91
+ * // kmsKeyId: "STRING_VALUE",
81
92
  * // };
82
93
  *
83
94
  * ```
@@ -0,0 +1,126 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { GetDbBackupInput, GetDbBackupOutput } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link GetDbBackupCommand}.
11
+ */
12
+ export interface GetDbBackupCommandInput extends GetDbBackupInput {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link GetDbBackupCommand}.
18
+ */
19
+ export interface GetDbBackupCommandOutput extends GetDbBackupOutput, __MetadataBearer {
20
+ }
21
+ declare const GetDbBackupCommand_base: {
22
+ new (input: GetDbBackupCommandInput): import("@smithy/core/client").CommandImpl<GetDbBackupCommandInput, GetDbBackupCommandOutput, import("..").TimestreamInfluxDBClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: GetDbBackupCommandInput): import("@smithy/core/client").CommandImpl<GetDbBackupCommandInput, GetDbBackupCommandOutput, import("..").TimestreamInfluxDBClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Returns information about a specific Timestream for InfluxDB backup.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { TimestreamInfluxDBClient, GetDbBackupCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
32
+ * // const { TimestreamInfluxDBClient, GetDbBackupCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import
33
+ * // import type { TimestreamInfluxDBClientConfig } from "@aws-sdk/client-timestream-influxdb";
34
+ * const config = {}; // type is TimestreamInfluxDBClientConfig
35
+ * const client = new TimestreamInfluxDBClient(config);
36
+ * const input = { // GetDbBackupInput
37
+ * identifier: "STRING_VALUE", // required
38
+ * };
39
+ * const command = new GetDbBackupCommand(input);
40
+ * const response = await client.send(command);
41
+ * // { // GetDbBackupOutput
42
+ * // id: "STRING_VALUE", // required
43
+ * // name: "STRING_VALUE",
44
+ * // arn: "STRING_VALUE", // required
45
+ * // status: "IN_PROGRESS" || "COMPLETED" || "FAILED" || "DELETING" || "DELETED",
46
+ * // createdAt: new Date("TIMESTAMP"),
47
+ * // expiresAfter: "STRING_VALUE",
48
+ * // dbResourceId: "STRING_VALUE",
49
+ * // type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "ON_DEMAND" || "CONTINUOUS",
50
+ * // engineType: "INFLUXDB_V2" || "INFLUXDB_V3_CORE" || "INFLUXDB_V3_ENTERPRISE",
51
+ * // deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY" || "MULTI_NODE_READ_REPLICAS",
52
+ * // kmsKeyId: "STRING_VALUE",
53
+ * // clusterConfiguration: { // ClusterConfiguration
54
+ * // ingestQueryInstances: Number("int"),
55
+ * // queryOnlyInstances: Number("int"),
56
+ * // dedicatedCompactor: true || false,
57
+ * // },
58
+ * // dbParameterGroupId: "STRING_VALUE",
59
+ * // dbInstanceType: "db.influx.medium" || "db.influx.large" || "db.influx.xlarge" || "db.influx.2xlarge" || "db.influx.4xlarge" || "db.influx.8xlarge" || "db.influx.12xlarge" || "db.influx.16xlarge" || "db.influx.24xlarge",
60
+ * // logDeliveryConfiguration: { // LogDeliveryConfiguration
61
+ * // s3Configuration: { // S3Configuration
62
+ * // bucketName: "STRING_VALUE", // required
63
+ * // enabled: true || false, // required
64
+ * // },
65
+ * // },
66
+ * // failoverMode: "AUTOMATIC" || "NO_FAILOVER",
67
+ * // dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
68
+ * // allocatedStorage: Number("int"),
69
+ * // vpcSubnetIds: [ // VpcSubnetIdList
70
+ * // "STRING_VALUE",
71
+ * // ],
72
+ * // vpcSecurityGroupIds: [ // VpcSecurityGroupIdList
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // publiclyAccessible: true || false,
76
+ * // port: Number("int"),
77
+ * // networkType: "IPV4" || "DUAL",
78
+ * // influxAuthParametersSecretArn: "STRING_VALUE",
79
+ * // maintenanceSchedule: { // MaintenanceSchedule
80
+ * // timezone: "STRING_VALUE", // required
81
+ * // preferredMaintenanceWindow: "STRING_VALUE", // required
82
+ * // },
83
+ * // };
84
+ *
85
+ * ```
86
+ *
87
+ * @param GetDbBackupCommandInput - {@link GetDbBackupCommandInput}
88
+ * @returns {@link GetDbBackupCommandOutput}
89
+ * @see {@link GetDbBackupCommandInput} for command's `input` shape.
90
+ * @see {@link GetDbBackupCommandOutput} for command's `response` shape.
91
+ * @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape.
92
+ *
93
+ * @throws {@link AccessDeniedException} (client fault)
94
+ * <p>You do not have sufficient access to perform this action.</p>
95
+ *
96
+ * @throws {@link InternalServerException} (server fault)
97
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
98
+ *
99
+ * @throws {@link ResourceNotFoundException} (client fault)
100
+ * <p>The requested resource was not found or does not exist.</p>
101
+ *
102
+ * @throws {@link ThrottlingException} (client fault)
103
+ * <p>The request was denied due to request throttling.</p>
104
+ *
105
+ * @throws {@link ValidationException} (client fault)
106
+ * <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
107
+ *
108
+ * @throws {@link TimestreamInfluxDBServiceException}
109
+ * <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>
110
+ *
111
+ *
112
+ * @public
113
+ */
114
+ export declare class GetDbBackupCommand extends GetDbBackupCommand_base {
115
+ /** @internal type navigation helper, not in runtime. */
116
+ protected static __types: {
117
+ api: {
118
+ input: GetDbBackupInput;
119
+ output: GetDbBackupOutput;
120
+ };
121
+ sdk: {
122
+ input: GetDbBackupCommandInput;
123
+ output: GetDbBackupCommandOutput;
124
+ };
125
+ };
126
+ }
@@ -42,7 +42,7 @@ declare const GetDbClusterCommand_base: {
42
42
  * // id: "STRING_VALUE", // required
43
43
  * // name: "STRING_VALUE", // required
44
44
  * // arn: "STRING_VALUE", // required
45
- * // status: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE",
45
+ * // status: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE" || "RESTORING" || "RESTORE_FAILED",
46
46
  * // endpoint: "STRING_VALUE",
47
47
  * // readerEndpoint: "STRING_VALUE",
48
48
  * // port: Number("int"),
@@ -79,6 +79,16 @@ declare const GetDbClusterCommand_base: {
79
79
  * // queryOnlyInstances: Number("int"),
80
80
  * // dedicatedCompactor: true || false,
81
81
  * // },
82
+ * // dbBackupConfigurations: [ // DbBackupConfigurationOutputList
83
+ * // { // DbBackupConfigurationOutput
84
+ * // type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required
85
+ * // retentionDays: Number("int"), // required
86
+ * // enabled: true || false, // required
87
+ * // customSchedule: "STRING_VALUE",
88
+ * // nextAutomatedBackupTime: new Date("TIMESTAMP"),
89
+ * // },
90
+ * // ],
91
+ * // kmsKeyId: "STRING_VALUE",
82
92
  * // };
83
93
  *
84
94
  * ```
@@ -42,7 +42,7 @@ declare const GetDbInstanceCommand_base: {
42
42
  * // id: "STRING_VALUE", // required
43
43
  * // name: "STRING_VALUE", // required
44
44
  * // arn: "STRING_VALUE", // required
45
- * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED",
45
+ * // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED" || "RESTORING" || "RESTORE_FAILED",
46
46
  * // endpoint: "STRING_VALUE",
47
47
  * // port: Number("int"),
48
48
  * // networkType: "IPV4" || "DUAL",
@@ -78,6 +78,16 @@ declare const GetDbInstanceCommand_base: {
78
78
  * // },
79
79
  * // lastMaintenanceTime: new Date("TIMESTAMP"),
80
80
  * // nextMaintenanceTime: new Date("TIMESTAMP"),
81
+ * // dbBackupConfigurations: [ // DbBackupConfigurationOutputList
82
+ * // { // DbBackupConfigurationOutput
83
+ * // type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required
84
+ * // retentionDays: Number("int"), // required
85
+ * // enabled: true || false, // required
86
+ * // customSchedule: "STRING_VALUE",
87
+ * // nextAutomatedBackupTime: new Date("TIMESTAMP"),
88
+ * // },
89
+ * // ],
90
+ * // kmsKeyId: "STRING_VALUE",
81
91
  * // };
82
92
  *
83
93
  * ```