@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.
- package/README.md +42 -7
- package/dist-cjs/index.js +269 -45
- package/dist-es/TimestreamInfluxDB.js +12 -0
- package/dist-es/commands/CreateDbBackupCommand.js +4 -0
- package/dist-es/commands/DeleteDbBackupCommand.js +4 -0
- package/dist-es/commands/GetDbBackupCommand.js +4 -0
- package/dist-es/commands/ListDbBackupsCommand.js +4 -0
- package/dist-es/commands/RestoreFromDbBackupCommand.js +4 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/enums.js +54 -10
- package/dist-es/pagination/ListDbBackupsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +160 -34
- package/dist-types/TimestreamInfluxDB.d.ts +43 -0
- package/dist-types/TimestreamInfluxDBClient.d.ts +7 -2
- package/dist-types/commands/CreateDbBackupCommand.d.ts +137 -0
- package/dist-types/commands/CreateDbClusterCommand.d.ts +10 -1
- package/dist-types/commands/CreateDbInstanceCommand.d.ts +20 -1
- package/dist-types/commands/DeleteDbBackupCommand.d.ts +129 -0
- package/dist-types/commands/DeleteDbClusterCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDbInstanceCommand.d.ts +12 -1
- package/dist-types/commands/GetDbBackupCommand.d.ts +126 -0
- package/dist-types/commands/GetDbClusterCommand.d.ts +11 -1
- package/dist-types/commands/GetDbInstanceCommand.d.ts +11 -1
- package/dist-types/commands/ListDbBackupsCommand.d.ts +103 -0
- package/dist-types/commands/ListDbClustersCommand.d.ts +1 -1
- package/dist-types/commands/ListDbInstancesCommand.d.ts +1 -1
- package/dist-types/commands/ListDbInstancesForClusterCommand.d.ts +1 -1
- package/dist-types/commands/RebootDbClusterCommand.d.ts +1 -1
- package/dist-types/commands/RebootDbInstanceCommand.d.ts +11 -1
- package/dist-types/commands/RestoreFromDbBackupCommand.d.ts +131 -0
- package/dist-types/commands/UpdateDbClusterCommand.d.ts +9 -1
- package/dist-types/commands/UpdateDbInstanceCommand.d.ts +19 -1
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/enums.d.ts +117 -17
- package/dist-types/models/models_0.d.ts +822 -24
- package/dist-types/pagination/ListDbBackupsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +18 -0
- package/dist-types/ts3.4/TimestreamInfluxDB.d.ts +90 -0
- package/dist-types/ts3.4/TimestreamInfluxDBClient.d.ts +27 -0
- package/dist-types/ts3.4/commands/CreateDbBackupCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteDbBackupCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetDbBackupCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListDbBackupsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/RestoreFromDbBackupCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/enums.d.ts +68 -15
- package/dist-types/ts3.4/models/models_0.d.ts +183 -4
- package/dist-types/ts3.4/pagination/ListDbBackupsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +18 -0
- package/package.json +3 -3
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { ListDbBackupsInput, ListDbBackupsOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link ListDbBackupsCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface ListDbBackupsCommandInput extends ListDbBackupsInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link ListDbBackupsCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface ListDbBackupsCommandOutput extends ListDbBackupsOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const ListDbBackupsCommand_base: {
|
|
22
|
+
new (input: ListDbBackupsCommandInput): import("@smithy/core/client").CommandImpl<ListDbBackupsCommandInput, ListDbBackupsCommandOutput, import("..").TimestreamInfluxDBClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [ListDbBackupsCommandInput]): import("@smithy/core/client").CommandImpl<ListDbBackupsCommandInput, ListDbBackupsCommandOutput, import("..").TimestreamInfluxDBClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Returns a list of Timestream for InfluxDB backups.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { TimestreamInfluxDBClient, ListDbBackupsCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
|
|
32
|
+
* // const { TimestreamInfluxDBClient, ListDbBackupsCommand } = 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 = { // ListDbBackupsInput
|
|
37
|
+
* dbResourceId: "STRING_VALUE",
|
|
38
|
+
* nextToken: "STRING_VALUE",
|
|
39
|
+
* maxResults: Number("int"),
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListDbBackupsCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListDbBackupsOutput
|
|
44
|
+
* // items: [ // DbBackupSummaryList // required
|
|
45
|
+
* // { // DbBackupSummary
|
|
46
|
+
* // id: "STRING_VALUE", // required
|
|
47
|
+
* // name: "STRING_VALUE",
|
|
48
|
+
* // arn: "STRING_VALUE", // required
|
|
49
|
+
* // status: "IN_PROGRESS" || "COMPLETED" || "FAILED" || "DELETING" || "DELETED",
|
|
50
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
51
|
+
* // expiresAfter: "STRING_VALUE",
|
|
52
|
+
* // dbResourceId: "STRING_VALUE",
|
|
53
|
+
* // type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "ON_DEMAND" || "CONTINUOUS",
|
|
54
|
+
* // engineType: "INFLUXDB_V2" || "INFLUXDB_V3_CORE" || "INFLUXDB_V3_ENTERPRISE",
|
|
55
|
+
* // deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY" || "MULTI_NODE_READ_REPLICAS",
|
|
56
|
+
* // kmsKeyId: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // nextToken: "STRING_VALUE",
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* @param ListDbBackupsCommandInput - {@link ListDbBackupsCommandInput}
|
|
65
|
+
* @returns {@link ListDbBackupsCommandOutput}
|
|
66
|
+
* @see {@link ListDbBackupsCommandInput} for command's `input` shape.
|
|
67
|
+
* @see {@link ListDbBackupsCommandOutput} for command's `response` shape.
|
|
68
|
+
* @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
71
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InternalServerException} (server fault)
|
|
74
|
+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
+
* <p>The requested resource was not found or does not exist.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
80
|
+
* <p>The request was denied due to request throttling.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ValidationException} (client fault)
|
|
83
|
+
* <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link TimestreamInfluxDBServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>
|
|
87
|
+
*
|
|
88
|
+
*
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export declare class ListDbBackupsCommand extends ListDbBackupsCommand_base {
|
|
92
|
+
/** @internal type navigation helper, not in runtime. */
|
|
93
|
+
protected static __types: {
|
|
94
|
+
api: {
|
|
95
|
+
input: ListDbBackupsInput;
|
|
96
|
+
output: ListDbBackupsOutput;
|
|
97
|
+
};
|
|
98
|
+
sdk: {
|
|
99
|
+
input: ListDbBackupsCommandInput;
|
|
100
|
+
output: ListDbBackupsCommandOutput;
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
}
|
|
@@ -45,7 +45,7 @@ declare const ListDbClustersCommand_base: {
|
|
|
45
45
|
* // id: "STRING_VALUE", // required
|
|
46
46
|
* // name: "STRING_VALUE", // required
|
|
47
47
|
* // arn: "STRING_VALUE", // required
|
|
48
|
-
* // status: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE",
|
|
48
|
+
* // status: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE" || "RESTORING" || "RESTORE_FAILED",
|
|
49
49
|
* // endpoint: "STRING_VALUE",
|
|
50
50
|
* // readerEndpoint: "STRING_VALUE",
|
|
51
51
|
* // port: Number("int"),
|
|
@@ -45,7 +45,7 @@ declare const ListDbInstancesCommand_base: {
|
|
|
45
45
|
* // id: "STRING_VALUE", // required
|
|
46
46
|
* // name: "STRING_VALUE", // required
|
|
47
47
|
* // arn: "STRING_VALUE", // required
|
|
48
|
-
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED",
|
|
48
|
+
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED" || "RESTORING" || "RESTORE_FAILED",
|
|
49
49
|
* // endpoint: "STRING_VALUE",
|
|
50
50
|
* // port: Number("int"),
|
|
51
51
|
* // networkType: "IPV4" || "DUAL",
|
|
@@ -46,7 +46,7 @@ declare const ListDbInstancesForClusterCommand_base: {
|
|
|
46
46
|
* // id: "STRING_VALUE", // required
|
|
47
47
|
* // name: "STRING_VALUE", // required
|
|
48
48
|
* // arn: "STRING_VALUE", // required
|
|
49
|
-
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED",
|
|
49
|
+
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED" || "RESTORING" || "RESTORE_FAILED",
|
|
50
50
|
* // endpoint: "STRING_VALUE",
|
|
51
51
|
* // port: Number("int"),
|
|
52
52
|
* // networkType: "IPV4" || "DUAL",
|
|
@@ -42,7 +42,7 @@ declare const RebootDbClusterCommand_base: {
|
|
|
42
42
|
* const command = new RebootDbClusterCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
44
|
* // { // RebootDbClusterOutput
|
|
45
|
-
* // dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE",
|
|
45
|
+
* // dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE" || "RESTORING" || "RESTORE_FAILED",
|
|
46
46
|
* // };
|
|
47
47
|
*
|
|
48
48
|
* ```
|
|
@@ -42,7 +42,7 @@ declare const RebootDbInstanceCommand_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 RebootDbInstanceCommand_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
|
* ```
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { RestoreFromDbBackupInput, RestoreFromDbBackupOutput } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link RestoreFromDbBackupCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface RestoreFromDbBackupCommandInput extends RestoreFromDbBackupInput {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link RestoreFromDbBackupCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface RestoreFromDbBackupCommandOutput extends RestoreFromDbBackupOutput, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const RestoreFromDbBackupCommand_base: {
|
|
22
|
+
new (input: RestoreFromDbBackupCommandInput): import("@smithy/core/client").CommandImpl<RestoreFromDbBackupCommandInput, RestoreFromDbBackupCommandOutput, import("..").TimestreamInfluxDBClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: RestoreFromDbBackupCommandInput): import("@smithy/core/client").CommandImpl<RestoreFromDbBackupCommandInput, RestoreFromDbBackupCommandOutput, import("..").TimestreamInfluxDBClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Restores a Timestream for InfluxDB resource from a backup. By default, a new resource is created. You can optionally restore to the same resource using the REPLACE_EXISTING restore mode.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { TimestreamInfluxDBClient, RestoreFromDbBackupCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
|
|
32
|
+
* // const { TimestreamInfluxDBClient, RestoreFromDbBackupCommand } = 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 = { // RestoreFromDbBackupInput
|
|
37
|
+
* name: "STRING_VALUE", // required
|
|
38
|
+
* dbBackupId: "STRING_VALUE", // required
|
|
39
|
+
* restoreToTime: new Date("TIMESTAMP"),
|
|
40
|
+
* restoreMode: "NEW_RESOURCE" || "REPLACE_EXISTING",
|
|
41
|
+
* vpcSubnetIds: [ // VpcSubnetIdList
|
|
42
|
+
* "STRING_VALUE",
|
|
43
|
+
* ],
|
|
44
|
+
* vpcSecurityGroupIds: [ // VpcSecurityGroupIdList
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* publiclyAccessible: true || false,
|
|
48
|
+
* logDeliveryConfiguration: { // LogDeliveryConfiguration
|
|
49
|
+
* s3Configuration: { // S3Configuration
|
|
50
|
+
* bucketName: "STRING_VALUE", // required
|
|
51
|
+
* enabled: true || false, // required
|
|
52
|
+
* },
|
|
53
|
+
* },
|
|
54
|
+
* maintenanceSchedule: { // MaintenanceSchedule
|
|
55
|
+
* timezone: "STRING_VALUE", // required
|
|
56
|
+
* preferredMaintenanceWindow: "STRING_VALUE", // required
|
|
57
|
+
* },
|
|
58
|
+
* tags: { // RequestTagMap
|
|
59
|
+
* "<keys>": "STRING_VALUE",
|
|
60
|
+
* },
|
|
61
|
+
* port: Number("int"),
|
|
62
|
+
* networkType: "IPV4" || "DUAL",
|
|
63
|
+
* deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY" || "MULTI_NODE_READ_REPLICAS",
|
|
64
|
+
* dbBackupConfigurations: [ // DbBackupConfigurationInputList
|
|
65
|
+
* { // DbBackupConfiguration
|
|
66
|
+
* type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required
|
|
67
|
+
* retentionDays: Number("int"), // required
|
|
68
|
+
* enabled: true || false, // required
|
|
69
|
+
* customSchedule: "STRING_VALUE",
|
|
70
|
+
* },
|
|
71
|
+
* ],
|
|
72
|
+
* kmsKeyId: "STRING_VALUE",
|
|
73
|
+
* };
|
|
74
|
+
* const command = new RestoreFromDbBackupCommand(input);
|
|
75
|
+
* const response = await client.send(command);
|
|
76
|
+
* // { // RestoreFromDbBackupOutput
|
|
77
|
+
* // restoredDbResourceId: "STRING_VALUE",
|
|
78
|
+
* // restoreStatus: "RESTORING",
|
|
79
|
+
* // resourceType: "DB_INSTANCE" || "DB_CLUSTER",
|
|
80
|
+
* // engineType: "INFLUXDB_V2" || "INFLUXDB_V3_CORE" || "INFLUXDB_V3_ENTERPRISE",
|
|
81
|
+
* // deploymentType: "SINGLE_AZ" || "WITH_MULTIAZ_STANDBY" || "MULTI_NODE_READ_REPLICAS",
|
|
82
|
+
* // };
|
|
83
|
+
*
|
|
84
|
+
* ```
|
|
85
|
+
*
|
|
86
|
+
* @param RestoreFromDbBackupCommandInput - {@link RestoreFromDbBackupCommandInput}
|
|
87
|
+
* @returns {@link RestoreFromDbBackupCommandOutput}
|
|
88
|
+
* @see {@link RestoreFromDbBackupCommandInput} for command's `input` shape.
|
|
89
|
+
* @see {@link RestoreFromDbBackupCommandOutput} for command's `response` shape.
|
|
90
|
+
* @see {@link TimestreamInfluxDBClientResolvedConfig | config} for TimestreamInfluxDBClient's `config` shape.
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
93
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link ConflictException} (client fault)
|
|
96
|
+
* <p>The request conflicts with an existing resource in Timestream for InfluxDB.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link InternalServerException} (server fault)
|
|
99
|
+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
102
|
+
* <p>The requested resource was not found or does not exist.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
105
|
+
* <p>The request exceeds the service quota.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
108
|
+
* <p>The request was denied due to request throttling.</p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link ValidationException} (client fault)
|
|
111
|
+
* <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link TimestreamInfluxDBServiceException}
|
|
114
|
+
* <p>Base exception class for all service exceptions from TimestreamInfluxDB service.</p>
|
|
115
|
+
*
|
|
116
|
+
*
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export declare class RestoreFromDbBackupCommand extends RestoreFromDbBackupCommand_base {
|
|
120
|
+
/** @internal type navigation helper, not in runtime. */
|
|
121
|
+
protected static __types: {
|
|
122
|
+
api: {
|
|
123
|
+
input: RestoreFromDbBackupInput;
|
|
124
|
+
output: RestoreFromDbBackupOutput;
|
|
125
|
+
};
|
|
126
|
+
sdk: {
|
|
127
|
+
input: RestoreFromDbBackupCommandInput;
|
|
128
|
+
output: RestoreFromDbBackupCommandOutput;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
}
|
|
@@ -49,11 +49,19 @@ declare const UpdateDbClusterCommand_base: {
|
|
|
49
49
|
* timezone: "STRING_VALUE", // required
|
|
50
50
|
* preferredMaintenanceWindow: "STRING_VALUE", // required
|
|
51
51
|
* },
|
|
52
|
+
* dbBackupConfigurations: [ // DbBackupConfigurationInputList
|
|
53
|
+
* { // DbBackupConfiguration
|
|
54
|
+
* type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required
|
|
55
|
+
* retentionDays: Number("int"), // required
|
|
56
|
+
* enabled: true || false, // required
|
|
57
|
+
* customSchedule: "STRING_VALUE",
|
|
58
|
+
* },
|
|
59
|
+
* ],
|
|
52
60
|
* };
|
|
53
61
|
* const command = new UpdateDbClusterCommand(input);
|
|
54
62
|
* const response = await client.send(command);
|
|
55
63
|
* // { // UpdateDbClusterOutput
|
|
56
|
-
* // dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE",
|
|
64
|
+
* // dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED" || "MAINTENANCE" || "UPDATING_INSTANCE_TYPE" || "REBOOTING" || "REBOOT_FAILED" || "PARTIALLY_AVAILABLE" || "RESTORING" || "RESTORE_FAILED",
|
|
57
65
|
* // };
|
|
58
66
|
*
|
|
59
67
|
* ```
|
|
@@ -51,6 +51,14 @@ declare const UpdateDbInstanceCommand_base: {
|
|
|
51
51
|
* timezone: "STRING_VALUE", // required
|
|
52
52
|
* preferredMaintenanceWindow: "STRING_VALUE", // required
|
|
53
53
|
* },
|
|
54
|
+
* dbBackupConfigurations: [ // DbBackupConfigurationInputList
|
|
55
|
+
* { // DbBackupConfiguration
|
|
56
|
+
* type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required
|
|
57
|
+
* retentionDays: Number("int"), // required
|
|
58
|
+
* enabled: true || false, // required
|
|
59
|
+
* customSchedule: "STRING_VALUE",
|
|
60
|
+
* },
|
|
61
|
+
* ],
|
|
54
62
|
* };
|
|
55
63
|
* const command = new UpdateDbInstanceCommand(input);
|
|
56
64
|
* const response = await client.send(command);
|
|
@@ -58,7 +66,7 @@ declare const UpdateDbInstanceCommand_base: {
|
|
|
58
66
|
* // id: "STRING_VALUE", // required
|
|
59
67
|
* // name: "STRING_VALUE", // required
|
|
60
68
|
* // arn: "STRING_VALUE", // required
|
|
61
|
-
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED",
|
|
69
|
+
* // status: "CREATING" || "AVAILABLE" || "DELETING" || "MODIFYING" || "UPDATING" || "DELETED" || "FAILED" || "UPDATING_DEPLOYMENT_TYPE" || "UPDATING_INSTANCE_TYPE" || "MAINTENANCE" || "REBOOTING" || "REBOOT_FAILED" || "RESTORING" || "RESTORE_FAILED",
|
|
62
70
|
* // endpoint: "STRING_VALUE",
|
|
63
71
|
* // port: Number("int"),
|
|
64
72
|
* // networkType: "IPV4" || "DUAL",
|
|
@@ -94,6 +102,16 @@ declare const UpdateDbInstanceCommand_base: {
|
|
|
94
102
|
* // },
|
|
95
103
|
* // lastMaintenanceTime: new Date("TIMESTAMP"),
|
|
96
104
|
* // nextMaintenanceTime: new Date("TIMESTAMP"),
|
|
105
|
+
* // dbBackupConfigurations: [ // DbBackupConfigurationOutputList
|
|
106
|
+
* // { // DbBackupConfigurationOutput
|
|
107
|
+
* // type: "HOURLY" || "DAILY" || "WEEKLY" || "MONTHLY" || "CUSTOM_SCHEDULE" || "CONTINUOUS", // required
|
|
108
|
+
* // retentionDays: Number("int"), // required
|
|
109
|
+
* // enabled: true || false, // required
|
|
110
|
+
* // customSchedule: "STRING_VALUE",
|
|
111
|
+
* // nextAutomatedBackupTime: new Date("TIMESTAMP"),
|
|
112
|
+
* // },
|
|
113
|
+
* // ],
|
|
114
|
+
* // kmsKeyId: "STRING_VALUE",
|
|
97
115
|
* // };
|
|
98
116
|
*
|
|
99
117
|
* ```
|
|
@@ -1,11 +1,15 @@
|
|
|
1
|
+
export * from "./CreateDbBackupCommand";
|
|
1
2
|
export * from "./CreateDbClusterCommand";
|
|
2
3
|
export * from "./CreateDbInstanceCommand";
|
|
3
4
|
export * from "./CreateDbParameterGroupCommand";
|
|
5
|
+
export * from "./DeleteDbBackupCommand";
|
|
4
6
|
export * from "./DeleteDbClusterCommand";
|
|
5
7
|
export * from "./DeleteDbInstanceCommand";
|
|
8
|
+
export * from "./GetDbBackupCommand";
|
|
6
9
|
export * from "./GetDbClusterCommand";
|
|
7
10
|
export * from "./GetDbInstanceCommand";
|
|
8
11
|
export * from "./GetDbParameterGroupCommand";
|
|
12
|
+
export * from "./ListDbBackupsCommand";
|
|
9
13
|
export * from "./ListDbClustersCommand";
|
|
10
14
|
export * from "./ListDbInstancesCommand";
|
|
11
15
|
export * from "./ListDbInstancesForClusterCommand";
|
|
@@ -13,6 +17,7 @@ export * from "./ListDbParameterGroupsCommand";
|
|
|
13
17
|
export * from "./ListTagsForResourceCommand";
|
|
14
18
|
export * from "./RebootDbClusterCommand";
|
|
15
19
|
export * from "./RebootDbInstanceCommand";
|
|
20
|
+
export * from "./RestoreFromDbBackupCommand";
|
|
16
21
|
export * from "./TagResourceCommand";
|
|
17
22
|
export * from "./UntagResourceCommand";
|
|
18
23
|
export * from "./UpdateDbClusterCommand";
|
|
@@ -34,13 +34,28 @@ export type DbStorageType = (typeof DbStorageType)[keyof typeof DbStorageType];
|
|
|
34
34
|
* @public
|
|
35
35
|
* @enum
|
|
36
36
|
*/
|
|
37
|
-
export declare const
|
|
37
|
+
export declare const ResourceDeploymentType: {
|
|
38
38
|
readonly MULTI_NODE_READ_REPLICAS: "MULTI_NODE_READ_REPLICAS";
|
|
39
|
+
readonly SINGLE_AZ: "SINGLE_AZ";
|
|
40
|
+
readonly WITH_MULTIAZ_STANDBY: "WITH_MULTIAZ_STANDBY";
|
|
39
41
|
};
|
|
40
42
|
/**
|
|
41
43
|
* @public
|
|
42
44
|
*/
|
|
43
|
-
export type
|
|
45
|
+
export type ResourceDeploymentType = (typeof ResourceDeploymentType)[keyof typeof ResourceDeploymentType];
|
|
46
|
+
/**
|
|
47
|
+
* @public
|
|
48
|
+
* @enum
|
|
49
|
+
*/
|
|
50
|
+
export declare const EngineType: {
|
|
51
|
+
readonly INFLUXDB_V2: "INFLUXDB_V2";
|
|
52
|
+
readonly INFLUXDB_V3_CORE: "INFLUXDB_V3_CORE";
|
|
53
|
+
readonly INFLUXDB_V3_ENTERPRISE: "INFLUXDB_V3_ENTERPRISE";
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
export type EngineType = (typeof EngineType)[keyof typeof EngineType];
|
|
44
59
|
/**
|
|
45
60
|
* @public
|
|
46
61
|
* @enum
|
|
@@ -69,23 +84,34 @@ export type NetworkType = (typeof NetworkType)[keyof typeof NetworkType];
|
|
|
69
84
|
* @public
|
|
70
85
|
* @enum
|
|
71
86
|
*/
|
|
72
|
-
export declare const
|
|
73
|
-
readonly
|
|
74
|
-
readonly CREATING: "CREATING";
|
|
87
|
+
export declare const DbBackupStatus: {
|
|
88
|
+
readonly COMPLETED: "COMPLETED";
|
|
75
89
|
readonly DELETED: "DELETED";
|
|
76
90
|
readonly DELETING: "DELETING";
|
|
77
91
|
readonly FAILED: "FAILED";
|
|
78
|
-
readonly
|
|
79
|
-
readonly PARTIALLY_AVAILABLE: "PARTIALLY_AVAILABLE";
|
|
80
|
-
readonly REBOOTING: "REBOOTING";
|
|
81
|
-
readonly REBOOT_FAILED: "REBOOT_FAILED";
|
|
82
|
-
readonly UPDATING: "UPDATING";
|
|
83
|
-
readonly UPDATING_INSTANCE_TYPE: "UPDATING_INSTANCE_TYPE";
|
|
92
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
84
93
|
};
|
|
85
94
|
/**
|
|
86
95
|
* @public
|
|
87
96
|
*/
|
|
88
|
-
export type
|
|
97
|
+
export type DbBackupStatus = (typeof DbBackupStatus)[keyof typeof DbBackupStatus];
|
|
98
|
+
/**
|
|
99
|
+
* @public
|
|
100
|
+
* @enum
|
|
101
|
+
*/
|
|
102
|
+
export declare const DbBackupType: {
|
|
103
|
+
readonly CONTINUOUS: "CONTINUOUS";
|
|
104
|
+
readonly CUSTOM_SCHEDULE: "CUSTOM_SCHEDULE";
|
|
105
|
+
readonly DAILY: "DAILY";
|
|
106
|
+
readonly HOURLY: "HOURLY";
|
|
107
|
+
readonly MONTHLY: "MONTHLY";
|
|
108
|
+
readonly ON_DEMAND: "ON_DEMAND";
|
|
109
|
+
readonly WEEKLY: "WEEKLY";
|
|
110
|
+
};
|
|
111
|
+
/**
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
export type DbBackupType = (typeof DbBackupType)[keyof typeof DbBackupType];
|
|
89
115
|
/**
|
|
90
116
|
* @public
|
|
91
117
|
* @enum
|
|
@@ -102,15 +128,87 @@ export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof
|
|
|
102
128
|
* @public
|
|
103
129
|
* @enum
|
|
104
130
|
*/
|
|
105
|
-
export declare const
|
|
106
|
-
readonly
|
|
107
|
-
readonly
|
|
108
|
-
readonly
|
|
131
|
+
export declare const AutomatedDbBackupType: {
|
|
132
|
+
readonly CONTINUOUS: "CONTINUOUS";
|
|
133
|
+
readonly CUSTOM_SCHEDULE: "CUSTOM_SCHEDULE";
|
|
134
|
+
readonly DAILY: "DAILY";
|
|
135
|
+
readonly HOURLY: "HOURLY";
|
|
136
|
+
readonly MONTHLY: "MONTHLY";
|
|
137
|
+
readonly WEEKLY: "WEEKLY";
|
|
109
138
|
};
|
|
110
139
|
/**
|
|
111
140
|
* @public
|
|
112
141
|
*/
|
|
113
|
-
export type
|
|
142
|
+
export type AutomatedDbBackupType = (typeof AutomatedDbBackupType)[keyof typeof AutomatedDbBackupType];
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
* @enum
|
|
146
|
+
*/
|
|
147
|
+
export declare const RestoreMode: {
|
|
148
|
+
readonly NEW_RESOURCE: "NEW_RESOURCE";
|
|
149
|
+
readonly REPLACE_EXISTING: "REPLACE_EXISTING";
|
|
150
|
+
};
|
|
151
|
+
/**
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
export type RestoreMode = (typeof RestoreMode)[keyof typeof RestoreMode];
|
|
155
|
+
/**
|
|
156
|
+
* @public
|
|
157
|
+
* @enum
|
|
158
|
+
*/
|
|
159
|
+
export declare const ResourceType: {
|
|
160
|
+
readonly DB_CLUSTER: "DB_CLUSTER";
|
|
161
|
+
readonly DB_INSTANCE: "DB_INSTANCE";
|
|
162
|
+
};
|
|
163
|
+
/**
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
167
|
+
/**
|
|
168
|
+
* @public
|
|
169
|
+
* @enum
|
|
170
|
+
*/
|
|
171
|
+
export declare const RestoreStatus: {
|
|
172
|
+
readonly RESTORING: "RESTORING";
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
export type RestoreStatus = (typeof RestoreStatus)[keyof typeof RestoreStatus];
|
|
178
|
+
/**
|
|
179
|
+
* @public
|
|
180
|
+
* @enum
|
|
181
|
+
*/
|
|
182
|
+
export declare const ClusterDeploymentType: {
|
|
183
|
+
readonly MULTI_NODE_READ_REPLICAS: "MULTI_NODE_READ_REPLICAS";
|
|
184
|
+
};
|
|
185
|
+
/**
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
export type ClusterDeploymentType = (typeof ClusterDeploymentType)[keyof typeof ClusterDeploymentType];
|
|
189
|
+
/**
|
|
190
|
+
* @public
|
|
191
|
+
* @enum
|
|
192
|
+
*/
|
|
193
|
+
export declare const ClusterStatus: {
|
|
194
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
195
|
+
readonly CREATING: "CREATING";
|
|
196
|
+
readonly DELETED: "DELETED";
|
|
197
|
+
readonly DELETING: "DELETING";
|
|
198
|
+
readonly FAILED: "FAILED";
|
|
199
|
+
readonly MAINTENANCE: "MAINTENANCE";
|
|
200
|
+
readonly PARTIALLY_AVAILABLE: "PARTIALLY_AVAILABLE";
|
|
201
|
+
readonly REBOOTING: "REBOOTING";
|
|
202
|
+
readonly REBOOT_FAILED: "REBOOT_FAILED";
|
|
203
|
+
readonly RESTORE_FAILED: "RESTORE_FAILED";
|
|
204
|
+
readonly RESTORING: "RESTORING";
|
|
205
|
+
readonly UPDATING: "UPDATING";
|
|
206
|
+
readonly UPDATING_INSTANCE_TYPE: "UPDATING_INSTANCE_TYPE";
|
|
207
|
+
};
|
|
208
|
+
/**
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
export type ClusterStatus = (typeof ClusterStatus)[keyof typeof ClusterStatus];
|
|
114
212
|
/**
|
|
115
213
|
* @public
|
|
116
214
|
* @enum
|
|
@@ -154,6 +252,8 @@ export declare const Status: {
|
|
|
154
252
|
readonly MODIFYING: "MODIFYING";
|
|
155
253
|
readonly REBOOTING: "REBOOTING";
|
|
156
254
|
readonly REBOOT_FAILED: "REBOOT_FAILED";
|
|
255
|
+
readonly RESTORE_FAILED: "RESTORE_FAILED";
|
|
256
|
+
readonly RESTORING: "RESTORING";
|
|
157
257
|
readonly UPDATING: "UPDATING";
|
|
158
258
|
readonly UPDATING_DEPLOYMENT_TYPE: "UPDATING_DEPLOYMENT_TYPE";
|
|
159
259
|
readonly UPDATING_INSTANCE_TYPE: "UPDATING_INSTANCE_TYPE";
|