@aws-sdk/client-elasticache 3.1152.0 → 3.1154.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 +14 -0
- package/dist-cjs/index.js +187 -31
- package/dist-es/ElastiCache.js +4 -0
- package/dist-es/commands/PrepareMigrationCommand.js +4 -0
- package/dist-es/commands/StopMigrationCommand.js +4 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/enums.js +11 -7
- package/dist-es/models/errors.js +52 -13
- package/dist-es/schemas/schemas_0.js +97 -11
- package/dist-types/ElastiCache.d.ts +16 -0
- package/dist-types/ElastiCacheClient.d.ts +4 -2
- package/dist-types/commands/CompleteMigrationCommand.d.ts +67 -3
- package/dist-types/commands/CreateServerlessCacheCommand.d.ts +8 -0
- package/dist-types/commands/DeleteServerlessCacheCommand.d.ts +8 -0
- package/dist-types/commands/DescribeServerlessCachesCommand.d.ts +8 -0
- package/dist-types/commands/ModifyServerlessCacheCommand.d.ts +8 -0
- package/dist-types/commands/PrepareMigrationCommand.d.ts +147 -0
- package/dist-types/commands/StartMigrationCommand.d.ts +67 -4
- package/dist-types/commands/StopMigrationCommand.d.ts +135 -0
- package/dist-types/commands/TestMigrationCommand.d.ts +6 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/enums.d.ts +27 -15
- package/dist-types/models/errors.d.ts +53 -13
- package/dist-types/models/models_0.d.ts +348 -191
- package/dist-types/schemas/schemas_0.d.ts +13 -0
- package/dist-types/ts3.4/ElastiCache.d.ts +36 -0
- package/dist-types/ts3.4/ElastiCacheClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/CompleteMigrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PrepareMigrationCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StartMigrationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopMigrationCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/enums.d.ts +14 -9
- package/dist-types/ts3.4/models/errors.d.ts +26 -6
- package/dist-types/ts3.4/models/models_0.d.ts +80 -42
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +13 -0
- package/package.json +4 -4
|
@@ -101,6 +101,14 @@ declare const ModifyServerlessCacheCommand_base: {
|
|
|
101
101
|
* // DailySnapshotTime: "STRING_VALUE",
|
|
102
102
|
* // NetworkType: "ipv4" || "ipv6" || "dual_stack",
|
|
103
103
|
* // ConnectionType: "vpc" || "public",
|
|
104
|
+
* // Migration: { // MigrationSummary
|
|
105
|
+
* // Status: "STRING_VALUE",
|
|
106
|
+
* // MigrationEndpoint: {
|
|
107
|
+
* // Address: "STRING_VALUE",
|
|
108
|
+
* // Port: Number("int"),
|
|
109
|
+
* // },
|
|
110
|
+
* // CutoverMode: "STRING_VALUE",
|
|
111
|
+
* // },
|
|
104
112
|
* // },
|
|
105
113
|
* // };
|
|
106
114
|
*
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { PrepareMigrationRequest, PrepareMigrationResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link PrepareMigrationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface PrepareMigrationCommandInput extends PrepareMigrationRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link PrepareMigrationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface PrepareMigrationCommandOutput extends PrepareMigrationResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const PrepareMigrationCommand_base: {
|
|
22
|
+
new (input: PrepareMigrationCommandInput): import("@smithy/core/client").CommandImpl<PrepareMigrationCommandInput, PrepareMigrationCommandOutput, import("..").ElastiCacheClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: PrepareMigrationCommandInput): import("@smithy/core/client").CommandImpl<PrepareMigrationCommandInput, PrepareMigrationCommandOutput, import("..").ElastiCacheClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Prepares the serverless cache for data migration by validating the configuration and setting up the migration resources.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { ElastiCacheClient, PrepareMigrationCommand } from "@aws-sdk/client-elasticache"; // ES Modules import
|
|
32
|
+
* // const { ElastiCacheClient, PrepareMigrationCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import
|
|
33
|
+
* // import type { ElastiCacheClientConfig } from "@aws-sdk/client-elasticache";
|
|
34
|
+
* const config = {}; // type is ElastiCacheClientConfig
|
|
35
|
+
* const client = new ElastiCacheClient(config);
|
|
36
|
+
* const input = { // PrepareMigrationRequest
|
|
37
|
+
* ServerlessCacheName: "STRING_VALUE", // required
|
|
38
|
+
* CustomerNodeEndpointList: [ // CustomerNodeEndpointList // required
|
|
39
|
+
* { // CustomerNodeEndpoint
|
|
40
|
+
* Address: "STRING_VALUE",
|
|
41
|
+
* Port: Number("int"),
|
|
42
|
+
* },
|
|
43
|
+
* ],
|
|
44
|
+
* SourceAuthenticationConfiguration: { // SourceAuthenticationConfiguration
|
|
45
|
+
* SecretManagerConfig: { // SecretManagerAuthConfig
|
|
46
|
+
* SecretArn: "STRING_VALUE",
|
|
47
|
+
* },
|
|
48
|
+
* },
|
|
49
|
+
* SourceTlsConfiguration: { // SourceTlsConfiguration
|
|
50
|
+
* SourceTlsMode: "none" || "verify-ca",
|
|
51
|
+
* SourceTlsCertificate: "STRING_VALUE",
|
|
52
|
+
* },
|
|
53
|
+
* };
|
|
54
|
+
* const command = new PrepareMigrationCommand(input);
|
|
55
|
+
* const response = await client.send(command);
|
|
56
|
+
* // { // PrepareMigrationResponse
|
|
57
|
+
* // ServerlessCache: { // ServerlessCache
|
|
58
|
+
* // ServerlessCacheName: "STRING_VALUE",
|
|
59
|
+
* // Description: "STRING_VALUE",
|
|
60
|
+
* // CreateTime: new Date("TIMESTAMP"),
|
|
61
|
+
* // Status: "STRING_VALUE",
|
|
62
|
+
* // Engine: "STRING_VALUE",
|
|
63
|
+
* // MajorEngineVersion: "STRING_VALUE",
|
|
64
|
+
* // FullEngineVersion: "STRING_VALUE",
|
|
65
|
+
* // CacheUsageLimits: { // CacheUsageLimits
|
|
66
|
+
* // DataStorage: { // DataStorage
|
|
67
|
+
* // Maximum: Number("int"),
|
|
68
|
+
* // Minimum: Number("int"),
|
|
69
|
+
* // Unit: "GB", // required
|
|
70
|
+
* // },
|
|
71
|
+
* // ECPUPerSecond: { // ECPUPerSecond
|
|
72
|
+
* // Maximum: Number("int"),
|
|
73
|
+
* // Minimum: Number("int"),
|
|
74
|
+
* // },
|
|
75
|
+
* // },
|
|
76
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
77
|
+
* // StorageEncryptionType: "none" || "sse-elasticache" || "sse-kms",
|
|
78
|
+
* // SecurityGroupIds: [ // SecurityGroupIdsList
|
|
79
|
+
* // "STRING_VALUE",
|
|
80
|
+
* // ],
|
|
81
|
+
* // Endpoint: { // Endpoint
|
|
82
|
+
* // Address: "STRING_VALUE",
|
|
83
|
+
* // Port: Number("int"),
|
|
84
|
+
* // },
|
|
85
|
+
* // ReaderEndpoint: {
|
|
86
|
+
* // Address: "STRING_VALUE",
|
|
87
|
+
* // Port: Number("int"),
|
|
88
|
+
* // },
|
|
89
|
+
* // ARN: "STRING_VALUE",
|
|
90
|
+
* // UserGroupId: "STRING_VALUE",
|
|
91
|
+
* // SubnetIds: [ // SubnetIdsList
|
|
92
|
+
* // "STRING_VALUE",
|
|
93
|
+
* // ],
|
|
94
|
+
* // SnapshotRetentionLimit: Number("int"),
|
|
95
|
+
* // DailySnapshotTime: "STRING_VALUE",
|
|
96
|
+
* // NetworkType: "ipv4" || "ipv6" || "dual_stack",
|
|
97
|
+
* // ConnectionType: "vpc" || "public",
|
|
98
|
+
* // Migration: { // MigrationSummary
|
|
99
|
+
* // Status: "STRING_VALUE",
|
|
100
|
+
* // MigrationEndpoint: {
|
|
101
|
+
* // Address: "STRING_VALUE",
|
|
102
|
+
* // Port: Number("int"),
|
|
103
|
+
* // },
|
|
104
|
+
* // CutoverMode: "STRING_VALUE",
|
|
105
|
+
* // },
|
|
106
|
+
* // },
|
|
107
|
+
* // };
|
|
108
|
+
*
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
* @param PrepareMigrationCommandInput - {@link PrepareMigrationCommandInput}
|
|
112
|
+
* @returns {@link PrepareMigrationCommandOutput}
|
|
113
|
+
* @see {@link PrepareMigrationCommandInput} for command's `input` shape.
|
|
114
|
+
* @see {@link PrepareMigrationCommandOutput} for command's `response` shape.
|
|
115
|
+
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
118
|
+
* <p>The value for a parameter is invalid.</p>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link InvalidServerlessCacheStateFault} (client fault)
|
|
121
|
+
* <p>The account for these credentials is not currently active.</p>
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link ServerlessCacheAlreadyUnderMigrationFault} (client fault)
|
|
124
|
+
* <p>A migration is already in progress for this serverless cache. You cannot start another migration until the current one completes.</p>
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link ServerlessCacheNotFoundFault} (client fault)
|
|
127
|
+
* <p>The serverless cache was not found or does not exist.</p>
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link ElastiCacheServiceException}
|
|
130
|
+
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
131
|
+
*
|
|
132
|
+
*
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
export declare class PrepareMigrationCommand extends PrepareMigrationCommand_base {
|
|
136
|
+
/** @internal type navigation helper, not in runtime. */
|
|
137
|
+
protected static __types: {
|
|
138
|
+
api: {
|
|
139
|
+
input: PrepareMigrationRequest;
|
|
140
|
+
output: PrepareMigrationResponse;
|
|
141
|
+
};
|
|
142
|
+
sdk: {
|
|
143
|
+
input: PrepareMigrationCommandInput;
|
|
144
|
+
output: PrepareMigrationCommandOutput;
|
|
145
|
+
};
|
|
146
|
+
};
|
|
147
|
+
}
|
|
@@ -20,11 +20,11 @@ export interface StartMigrationCommandOutput extends StartMigrationResponse, __M
|
|
|
20
20
|
}
|
|
21
21
|
declare const StartMigrationCommand_base: {
|
|
22
22
|
new (input: StartMigrationCommandInput): import("@smithy/core/client").CommandImpl<StartMigrationCommandInput, StartMigrationCommandOutput, import("..").ElastiCacheClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
-
new (input: StartMigrationCommandInput): import("@smithy/core/client").CommandImpl<StartMigrationCommandInput, StartMigrationCommandOutput, import("..").ElastiCacheClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (...[input]: [] | [StartMigrationCommandInput]): import("@smithy/core/client").CommandImpl<StartMigrationCommandInput, StartMigrationCommandOutput, import("..").ElastiCacheClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
24
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
25
|
};
|
|
26
26
|
/**
|
|
27
|
-
* <p>
|
|
27
|
+
* <p>Starts the migration of data.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -34,13 +34,16 @@ declare const StartMigrationCommand_base: {
|
|
|
34
34
|
* const config = {}; // type is ElastiCacheClientConfig
|
|
35
35
|
* const client = new ElastiCacheClient(config);
|
|
36
36
|
* const input = { // StartMigrationMessage
|
|
37
|
-
*
|
|
38
|
-
*
|
|
37
|
+
* ServerlessCacheName: "STRING_VALUE",
|
|
38
|
+
* ReplicationGroupId: "STRING_VALUE",
|
|
39
|
+
* CustomerNodeEndpointList: [ // CustomerNodeEndpointList
|
|
39
40
|
* { // CustomerNodeEndpoint
|
|
40
41
|
* Address: "STRING_VALUE",
|
|
41
42
|
* Port: Number("int"),
|
|
42
43
|
* },
|
|
43
44
|
* ],
|
|
45
|
+
* AutoCutover: true || false,
|
|
46
|
+
* ClearTargetCacheData: true || false,
|
|
44
47
|
* };
|
|
45
48
|
* const command = new StartMigrationCommand(input);
|
|
46
49
|
* const response = await client.send(command);
|
|
@@ -169,6 +172,47 @@ declare const StartMigrationCommand_base: {
|
|
|
169
172
|
* // Durability: "default" || "async" || "sync" || "disabled",
|
|
170
173
|
* // EffectiveDurability: "async" || "sync" || "disabled",
|
|
171
174
|
* // },
|
|
175
|
+
* // ServerlessCache: { // ServerlessCache
|
|
176
|
+
* // ServerlessCacheName: "STRING_VALUE",
|
|
177
|
+
* // Description: "STRING_VALUE",
|
|
178
|
+
* // CreateTime: new Date("TIMESTAMP"),
|
|
179
|
+
* // Status: "STRING_VALUE",
|
|
180
|
+
* // Engine: "STRING_VALUE",
|
|
181
|
+
* // MajorEngineVersion: "STRING_VALUE",
|
|
182
|
+
* // FullEngineVersion: "STRING_VALUE",
|
|
183
|
+
* // CacheUsageLimits: { // CacheUsageLimits
|
|
184
|
+
* // DataStorage: { // DataStorage
|
|
185
|
+
* // Maximum: Number("int"),
|
|
186
|
+
* // Minimum: Number("int"),
|
|
187
|
+
* // Unit: "GB", // required
|
|
188
|
+
* // },
|
|
189
|
+
* // ECPUPerSecond: { // ECPUPerSecond
|
|
190
|
+
* // Maximum: Number("int"),
|
|
191
|
+
* // Minimum: Number("int"),
|
|
192
|
+
* // },
|
|
193
|
+
* // },
|
|
194
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
195
|
+
* // StorageEncryptionType: "none" || "sse-elasticache" || "sse-kms",
|
|
196
|
+
* // SecurityGroupIds: [ // SecurityGroupIdsList
|
|
197
|
+
* // "STRING_VALUE",
|
|
198
|
+
* // ],
|
|
199
|
+
* // Endpoint: "<Endpoint>",
|
|
200
|
+
* // ReaderEndpoint: "<Endpoint>",
|
|
201
|
+
* // ARN: "STRING_VALUE",
|
|
202
|
+
* // UserGroupId: "STRING_VALUE",
|
|
203
|
+
* // SubnetIds: [ // SubnetIdsList
|
|
204
|
+
* // "STRING_VALUE",
|
|
205
|
+
* // ],
|
|
206
|
+
* // SnapshotRetentionLimit: Number("int"),
|
|
207
|
+
* // DailySnapshotTime: "STRING_VALUE",
|
|
208
|
+
* // NetworkType: "ipv4" || "ipv6" || "dual_stack",
|
|
209
|
+
* // ConnectionType: "vpc" || "public",
|
|
210
|
+
* // Migration: { // MigrationSummary
|
|
211
|
+
* // Status: "STRING_VALUE",
|
|
212
|
+
* // MigrationEndpoint: "<Endpoint>",
|
|
213
|
+
* // CutoverMode: "STRING_VALUE",
|
|
214
|
+
* // },
|
|
215
|
+
* // },
|
|
172
216
|
* // };
|
|
173
217
|
*
|
|
174
218
|
* ```
|
|
@@ -179,18 +223,37 @@ declare const StartMigrationCommand_base: {
|
|
|
179
223
|
* @see {@link StartMigrationCommandOutput} for command's `response` shape.
|
|
180
224
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
181
225
|
*
|
|
226
|
+
* @throws {@link InvalidCacheClusterStateFault} (client fault)
|
|
227
|
+
* <p>The requested cluster is not in the <code>available</code> state.</p>
|
|
228
|
+
*
|
|
229
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
230
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
231
|
+
*
|
|
182
232
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
183
233
|
* <p>The value for a parameter is invalid.</p>
|
|
184
234
|
*
|
|
185
235
|
* @throws {@link InvalidReplicationGroupStateFault} (client fault)
|
|
186
236
|
* <p>The requested replication group is not in the <code>available</code> state.</p>
|
|
187
237
|
*
|
|
238
|
+
* @throws {@link InvalidServerlessCacheStateFault} (client fault)
|
|
239
|
+
* <p>The account for these credentials is not currently active.</p>
|
|
240
|
+
*
|
|
241
|
+
* @throws {@link MigrationHealthFault} (client fault)
|
|
242
|
+
* <p>The migration is not healthy. Check the events for this serverless cache for more details. For
|
|
243
|
+
* <code>CompleteMigration</code>, set <code>Force</code> to true to bypass this check.</p>
|
|
244
|
+
*
|
|
188
245
|
* @throws {@link ReplicationGroupAlreadyUnderMigrationFault} (client fault)
|
|
189
246
|
* <p>The targeted replication group is not available. </p>
|
|
190
247
|
*
|
|
191
248
|
* @throws {@link ReplicationGroupNotFoundFault} (client fault)
|
|
192
249
|
* <p>The specified replication group does not exist.</p>
|
|
193
250
|
*
|
|
251
|
+
* @throws {@link ServerlessCacheNotFoundFault} (client fault)
|
|
252
|
+
* <p>The serverless cache was not found or does not exist.</p>
|
|
253
|
+
*
|
|
254
|
+
* @throws {@link ServerlessCacheNotUnderMigrationFault} (client fault)
|
|
255
|
+
* <p>The serverless cache is not currently under migration.</p>
|
|
256
|
+
*
|
|
194
257
|
* @throws {@link ElastiCacheServiceException}
|
|
195
258
|
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
196
259
|
*
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
2
|
+
import type { StopMigrationRequest, StopMigrationResponse } from "../models/models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export type { __MetadataBearer };
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*
|
|
10
|
+
* The input for {@link StopMigrationCommand}.
|
|
11
|
+
*/
|
|
12
|
+
export interface StopMigrationCommandInput extends StopMigrationRequest {
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*
|
|
17
|
+
* The output of {@link StopMigrationCommand}.
|
|
18
|
+
*/
|
|
19
|
+
export interface StopMigrationCommandOutput extends StopMigrationResponse, __MetadataBearer {
|
|
20
|
+
}
|
|
21
|
+
declare const StopMigrationCommand_base: {
|
|
22
|
+
new (input: StopMigrationCommandInput): import("@smithy/core/client").CommandImpl<StopMigrationCommandInput, StopMigrationCommandOutput, import("..").ElastiCacheClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
23
|
+
new (input: StopMigrationCommandInput): import("@smithy/core/client").CommandImpl<StopMigrationCommandInput, StopMigrationCommandOutput, import("..").ElastiCacheClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
|
|
24
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* <p>Stops an ongoing data sync between the source and the serverless cache. The migration remains
|
|
28
|
+
* open and the data sync can be restarted. This operation is valid only while the migration is
|
|
29
|
+
* syncing; during cutover it returns
|
|
30
|
+
* <code>InvalidServerlessCacheStateFault</code>.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ElastiCacheClient, StopMigrationCommand } from "@aws-sdk/client-elasticache"; // ES Modules import
|
|
35
|
+
* // const { ElastiCacheClient, StopMigrationCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import
|
|
36
|
+
* // import type { ElastiCacheClientConfig } from "@aws-sdk/client-elasticache";
|
|
37
|
+
* const config = {}; // type is ElastiCacheClientConfig
|
|
38
|
+
* const client = new ElastiCacheClient(config);
|
|
39
|
+
* const input = { // StopMigrationRequest
|
|
40
|
+
* ServerlessCacheName: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new StopMigrationCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // StopMigrationResponse
|
|
45
|
+
* // ServerlessCache: { // ServerlessCache
|
|
46
|
+
* // ServerlessCacheName: "STRING_VALUE",
|
|
47
|
+
* // Description: "STRING_VALUE",
|
|
48
|
+
* // CreateTime: new Date("TIMESTAMP"),
|
|
49
|
+
* // Status: "STRING_VALUE",
|
|
50
|
+
* // Engine: "STRING_VALUE",
|
|
51
|
+
* // MajorEngineVersion: "STRING_VALUE",
|
|
52
|
+
* // FullEngineVersion: "STRING_VALUE",
|
|
53
|
+
* // CacheUsageLimits: { // CacheUsageLimits
|
|
54
|
+
* // DataStorage: { // DataStorage
|
|
55
|
+
* // Maximum: Number("int"),
|
|
56
|
+
* // Minimum: Number("int"),
|
|
57
|
+
* // Unit: "GB", // required
|
|
58
|
+
* // },
|
|
59
|
+
* // ECPUPerSecond: { // ECPUPerSecond
|
|
60
|
+
* // Maximum: Number("int"),
|
|
61
|
+
* // Minimum: Number("int"),
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
65
|
+
* // StorageEncryptionType: "none" || "sse-elasticache" || "sse-kms",
|
|
66
|
+
* // SecurityGroupIds: [ // SecurityGroupIdsList
|
|
67
|
+
* // "STRING_VALUE",
|
|
68
|
+
* // ],
|
|
69
|
+
* // Endpoint: { // Endpoint
|
|
70
|
+
* // Address: "STRING_VALUE",
|
|
71
|
+
* // Port: Number("int"),
|
|
72
|
+
* // },
|
|
73
|
+
* // ReaderEndpoint: {
|
|
74
|
+
* // Address: "STRING_VALUE",
|
|
75
|
+
* // Port: Number("int"),
|
|
76
|
+
* // },
|
|
77
|
+
* // ARN: "STRING_VALUE",
|
|
78
|
+
* // UserGroupId: "STRING_VALUE",
|
|
79
|
+
* // SubnetIds: [ // SubnetIdsList
|
|
80
|
+
* // "STRING_VALUE",
|
|
81
|
+
* // ],
|
|
82
|
+
* // SnapshotRetentionLimit: Number("int"),
|
|
83
|
+
* // DailySnapshotTime: "STRING_VALUE",
|
|
84
|
+
* // NetworkType: "ipv4" || "ipv6" || "dual_stack",
|
|
85
|
+
* // ConnectionType: "vpc" || "public",
|
|
86
|
+
* // Migration: { // MigrationSummary
|
|
87
|
+
* // Status: "STRING_VALUE",
|
|
88
|
+
* // MigrationEndpoint: {
|
|
89
|
+
* // Address: "STRING_VALUE",
|
|
90
|
+
* // Port: Number("int"),
|
|
91
|
+
* // },
|
|
92
|
+
* // CutoverMode: "STRING_VALUE",
|
|
93
|
+
* // },
|
|
94
|
+
* // },
|
|
95
|
+
* // };
|
|
96
|
+
*
|
|
97
|
+
* ```
|
|
98
|
+
*
|
|
99
|
+
* @param StopMigrationCommandInput - {@link StopMigrationCommandInput}
|
|
100
|
+
* @returns {@link StopMigrationCommandOutput}
|
|
101
|
+
* @see {@link StopMigrationCommandInput} for command's `input` shape.
|
|
102
|
+
* @see {@link StopMigrationCommandOutput} for command's `response` shape.
|
|
103
|
+
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link InvalidParameterValueException} (client fault)
|
|
106
|
+
* <p>The value for a parameter is invalid.</p>
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link InvalidServerlessCacheStateFault} (client fault)
|
|
109
|
+
* <p>The account for these credentials is not currently active.</p>
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link ServerlessCacheNotFoundFault} (client fault)
|
|
112
|
+
* <p>The serverless cache was not found or does not exist.</p>
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ServerlessCacheNotUnderMigrationFault} (client fault)
|
|
115
|
+
* <p>The serverless cache is not currently under migration.</p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link ElastiCacheServiceException}
|
|
118
|
+
* <p>Base exception class for all service exceptions from ElastiCache service.</p>
|
|
119
|
+
*
|
|
120
|
+
*
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
export declare class StopMigrationCommand extends StopMigrationCommand_base {
|
|
124
|
+
/** @internal type navigation helper, not in runtime. */
|
|
125
|
+
protected static __types: {
|
|
126
|
+
api: {
|
|
127
|
+
input: StopMigrationRequest;
|
|
128
|
+
output: StopMigrationResponse;
|
|
129
|
+
};
|
|
130
|
+
sdk: {
|
|
131
|
+
input: StopMigrationCommandInput;
|
|
132
|
+
output: StopMigrationCommandOutput;
|
|
133
|
+
};
|
|
134
|
+
};
|
|
135
|
+
}
|
|
@@ -179,6 +179,12 @@ declare const TestMigrationCommand_base: {
|
|
|
179
179
|
* @see {@link TestMigrationCommandOutput} for command's `response` shape.
|
|
180
180
|
* @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape.
|
|
181
181
|
*
|
|
182
|
+
* @throws {@link InvalidCacheClusterStateFault} (client fault)
|
|
183
|
+
* <p>The requested cluster is not in the <code>available</code> state.</p>
|
|
184
|
+
*
|
|
185
|
+
* @throws {@link InvalidParameterCombinationException} (client fault)
|
|
186
|
+
* <p>Two or more incompatible parameters were specified.</p>
|
|
187
|
+
*
|
|
182
188
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
183
189
|
* <p>The value for a parameter is invalid.</p>
|
|
184
190
|
*
|
|
@@ -64,6 +64,7 @@ export * from "./ModifyReplicationGroupShardConfigurationCommand";
|
|
|
64
64
|
export * from "./ModifyServerlessCacheCommand";
|
|
65
65
|
export * from "./ModifyUserCommand";
|
|
66
66
|
export * from "./ModifyUserGroupCommand";
|
|
67
|
+
export * from "./PrepareMigrationCommand";
|
|
67
68
|
export * from "./PurchaseReservedCacheNodesOfferingCommand";
|
|
68
69
|
export * from "./RebalanceSlotsInGlobalReplicationGroupCommand";
|
|
69
70
|
export * from "./RebootCacheClusterCommand";
|
|
@@ -71,5 +72,6 @@ export * from "./RemoveTagsFromResourceCommand";
|
|
|
71
72
|
export * from "./ResetCacheParameterGroupCommand";
|
|
72
73
|
export * from "./RevokeCacheSecurityGroupIngressCommand";
|
|
73
74
|
export * from "./StartMigrationCommand";
|
|
75
|
+
export * from "./StopMigrationCommand";
|
|
74
76
|
export * from "./TestFailoverCommand";
|
|
75
77
|
export * from "./TestMigrationCommand";
|
|
@@ -224,49 +224,49 @@ export type StorageEncryptionType = (typeof StorageEncryptionType)[keyof typeof
|
|
|
224
224
|
* @public
|
|
225
225
|
* @enum
|
|
226
226
|
*/
|
|
227
|
-
export declare const
|
|
228
|
-
readonly
|
|
229
|
-
readonly SINGLE_AZ: "single-az";
|
|
227
|
+
export declare const DataStorageUnit: {
|
|
228
|
+
readonly GB: "GB";
|
|
230
229
|
};
|
|
231
230
|
/**
|
|
232
231
|
* @public
|
|
233
232
|
*/
|
|
234
|
-
export type
|
|
233
|
+
export type DataStorageUnit = (typeof DataStorageUnit)[keyof typeof DataStorageUnit];
|
|
235
234
|
/**
|
|
236
235
|
* @public
|
|
237
236
|
* @enum
|
|
238
237
|
*/
|
|
239
|
-
export declare const
|
|
240
|
-
readonly
|
|
241
|
-
readonly
|
|
238
|
+
export declare const ConnectionType: {
|
|
239
|
+
readonly PUBLIC: "public";
|
|
240
|
+
readonly VPC: "vpc";
|
|
242
241
|
};
|
|
243
242
|
/**
|
|
244
243
|
* @public
|
|
245
244
|
*/
|
|
246
|
-
export type
|
|
245
|
+
export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType];
|
|
247
246
|
/**
|
|
248
247
|
* @public
|
|
249
248
|
* @enum
|
|
250
249
|
*/
|
|
251
|
-
export declare const
|
|
252
|
-
readonly
|
|
250
|
+
export declare const AZMode: {
|
|
251
|
+
readonly CROSS_AZ: "cross-az";
|
|
252
|
+
readonly SINGLE_AZ: "single-az";
|
|
253
253
|
};
|
|
254
254
|
/**
|
|
255
255
|
* @public
|
|
256
256
|
*/
|
|
257
|
-
export type
|
|
257
|
+
export type AZMode = (typeof AZMode)[keyof typeof AZMode];
|
|
258
258
|
/**
|
|
259
259
|
* @public
|
|
260
260
|
* @enum
|
|
261
261
|
*/
|
|
262
|
-
export declare const
|
|
263
|
-
readonly
|
|
264
|
-
readonly
|
|
262
|
+
export declare const OutpostMode: {
|
|
263
|
+
readonly CROSS_OUTPOST: "cross-outpost";
|
|
264
|
+
readonly SINGLE_OUTPOST: "single-outpost";
|
|
265
265
|
};
|
|
266
266
|
/**
|
|
267
267
|
* @public
|
|
268
268
|
*/
|
|
269
|
-
export type
|
|
269
|
+
export type OutpostMode = (typeof OutpostMode)[keyof typeof OutpostMode];
|
|
270
270
|
/**
|
|
271
271
|
* @public
|
|
272
272
|
* @enum
|
|
@@ -416,3 +416,15 @@ export declare const AuthTokenUpdateStrategyType: {
|
|
|
416
416
|
* @public
|
|
417
417
|
*/
|
|
418
418
|
export type AuthTokenUpdateStrategyType = (typeof AuthTokenUpdateStrategyType)[keyof typeof AuthTokenUpdateStrategyType];
|
|
419
|
+
/**
|
|
420
|
+
* @public
|
|
421
|
+
* @enum
|
|
422
|
+
*/
|
|
423
|
+
export declare const TlsMode: {
|
|
424
|
+
readonly none: "none";
|
|
425
|
+
readonly verify_ca: "verify-ca";
|
|
426
|
+
};
|
|
427
|
+
/**
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
export type TlsMode = (typeof TlsMode)[keyof typeof TlsMode];
|
|
@@ -293,6 +293,33 @@ export declare class ServiceUpdateNotFoundFault extends __BaseException {
|
|
|
293
293
|
*/
|
|
294
294
|
constructor(opts: __ExceptionOptionType<ServiceUpdateNotFoundFault, __BaseException>);
|
|
295
295
|
}
|
|
296
|
+
/**
|
|
297
|
+
* <p>The requested cluster is not in the <code>available</code> state.</p>
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
export declare class InvalidCacheClusterStateFault extends __BaseException {
|
|
301
|
+
static readonly shapeId: string;
|
|
302
|
+
readonly name: "InvalidCacheClusterStateFault";
|
|
303
|
+
readonly $fault: "client";
|
|
304
|
+
/**
|
|
305
|
+
* @internal
|
|
306
|
+
*/
|
|
307
|
+
constructor(opts: __ExceptionOptionType<InvalidCacheClusterStateFault, __BaseException>);
|
|
308
|
+
}
|
|
309
|
+
/**
|
|
310
|
+
* <p>The migration is not healthy. Check the events for this serverless cache for more details. For
|
|
311
|
+
* <code>CompleteMigration</code>, set <code>Force</code> to true to bypass this check.</p>
|
|
312
|
+
* @public
|
|
313
|
+
*/
|
|
314
|
+
export declare class MigrationHealthFault extends __BaseException {
|
|
315
|
+
static readonly shapeId: string;
|
|
316
|
+
readonly name: "MigrationHealthFault";
|
|
317
|
+
readonly $fault: "client";
|
|
318
|
+
/**
|
|
319
|
+
* @internal
|
|
320
|
+
*/
|
|
321
|
+
constructor(opts: __ExceptionOptionType<MigrationHealthFault, __BaseException>);
|
|
322
|
+
}
|
|
296
323
|
/**
|
|
297
324
|
* <p>The designated replication group is not available for data migration.</p>
|
|
298
325
|
* @public
|
|
@@ -306,6 +333,19 @@ export declare class ReplicationGroupNotUnderMigrationFault extends __BaseExcept
|
|
|
306
333
|
*/
|
|
307
334
|
constructor(opts: __ExceptionOptionType<ReplicationGroupNotUnderMigrationFault, __BaseException>);
|
|
308
335
|
}
|
|
336
|
+
/**
|
|
337
|
+
* <p>The serverless cache is not currently under migration.</p>
|
|
338
|
+
* @public
|
|
339
|
+
*/
|
|
340
|
+
export declare class ServerlessCacheNotUnderMigrationFault extends __BaseException {
|
|
341
|
+
static readonly shapeId: string;
|
|
342
|
+
readonly name: "ServerlessCacheNotUnderMigrationFault";
|
|
343
|
+
readonly $fault: "client";
|
|
344
|
+
/**
|
|
345
|
+
* @internal
|
|
346
|
+
*/
|
|
347
|
+
constructor(opts: __ExceptionOptionType<ServerlessCacheNotUnderMigrationFault, __BaseException>);
|
|
348
|
+
}
|
|
309
349
|
/**
|
|
310
350
|
* <p>A serverless cache snapshot with this name already exists. Available for Valkey, Redis OSS and Serverless Memcached only.</p>
|
|
311
351
|
* @public
|
|
@@ -620,19 +660,6 @@ export declare class GlobalReplicationGroupAlreadyExistsFault extends __BaseExce
|
|
|
620
660
|
*/
|
|
621
661
|
constructor(opts: __ExceptionOptionType<GlobalReplicationGroupAlreadyExistsFault, __BaseException>);
|
|
622
662
|
}
|
|
623
|
-
/**
|
|
624
|
-
* <p>The requested cluster is not in the <code>available</code> state.</p>
|
|
625
|
-
* @public
|
|
626
|
-
*/
|
|
627
|
-
export declare class InvalidCacheClusterStateFault extends __BaseException {
|
|
628
|
-
static readonly shapeId: string;
|
|
629
|
-
readonly name: "InvalidCacheClusterStateFault";
|
|
630
|
-
readonly $fault: "client";
|
|
631
|
-
/**
|
|
632
|
-
* @internal
|
|
633
|
-
*/
|
|
634
|
-
constructor(opts: __ExceptionOptionType<InvalidCacheClusterStateFault, __BaseException>);
|
|
635
|
-
}
|
|
636
663
|
/**
|
|
637
664
|
* <p>The Global datastore is not available or in primary-only state.</p>
|
|
638
665
|
* @public
|
|
@@ -918,6 +945,19 @@ export declare class SubnetInUse extends __BaseException {
|
|
|
918
945
|
*/
|
|
919
946
|
constructor(opts: __ExceptionOptionType<SubnetInUse, __BaseException>);
|
|
920
947
|
}
|
|
948
|
+
/**
|
|
949
|
+
* <p>A migration is already in progress for this serverless cache. You cannot start another migration until the current one completes.</p>
|
|
950
|
+
* @public
|
|
951
|
+
*/
|
|
952
|
+
export declare class ServerlessCacheAlreadyUnderMigrationFault extends __BaseException {
|
|
953
|
+
static readonly shapeId: string;
|
|
954
|
+
readonly name: "ServerlessCacheAlreadyUnderMigrationFault";
|
|
955
|
+
readonly $fault: "client";
|
|
956
|
+
/**
|
|
957
|
+
* @internal
|
|
958
|
+
*/
|
|
959
|
+
constructor(opts: __ExceptionOptionType<ServerlessCacheAlreadyUnderMigrationFault, __BaseException>);
|
|
960
|
+
}
|
|
921
961
|
/**
|
|
922
962
|
* <p>You already have a reservation with the given identifier.</p>
|
|
923
963
|
* @public
|