@aws-sdk/client-dsql 3.806.0 → 3.809.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 +6 -10
- package/dist-cjs/models/models_0.js +4 -0
- package/dist-cjs/protocols/Aws_restJson1.js +5 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +5 -0
- package/dist-types/DSQL.d.ts +6 -10
- package/dist-types/DSQLClient.d.ts +6 -10
- package/dist-types/commands/CreateClusterCommand.d.ts +89 -7
- package/dist-types/commands/CreateMultiRegionClustersCommand.d.ts +10 -8
- package/dist-types/commands/DeleteClusterCommand.d.ts +3 -3
- package/dist-types/commands/DeleteMultiRegionClustersCommand.d.ts +6 -4
- package/dist-types/commands/GetClusterCommand.d.ts +13 -4
- package/dist-types/commands/GetVpcEndpointServiceNameCommand.d.ts +2 -2
- package/dist-types/commands/ListClustersCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateClusterCommand.d.ts +36 -7
- package/dist-types/index.d.ts +6 -10
- package/dist-types/models/models_0.d.ts +140 -83
- package/dist-types/ts3.4/models/models_0.d.ts +15 -2
- package/package.json +15 -15
package/README.md
CHANGED
|
@@ -6,16 +6,12 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript DSQL Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>This is an interface reference for Amazon Aurora DSQL.
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
so your clusters and databases are always available even if an
|
|
16
|
-
Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL
|
|
17
|
-
lets you focus on using your data to acquire new insights for your
|
|
18
|
-
business and customers.</p>
|
|
9
|
+
<p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the
|
|
10
|
+
programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p>
|
|
11
|
+
<p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size.
|
|
12
|
+
is available in both single-Region and multi-Region configurations, so your
|
|
13
|
+
clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to
|
|
14
|
+
acquire new insights for your business and customers.</p>
|
|
19
15
|
|
|
20
16
|
## Installing
|
|
21
17
|
|
|
@@ -21,6 +21,10 @@ exports.ClusterStatus = {
|
|
|
21
21
|
DELETED: "DELETED",
|
|
22
22
|
DELETING: "DELETING",
|
|
23
23
|
FAILED: "FAILED",
|
|
24
|
+
IDLE: "IDLE",
|
|
25
|
+
INACTIVE: "INACTIVE",
|
|
26
|
+
PENDING_DELETE: "PENDING_DELETE",
|
|
27
|
+
PENDING_SETUP: "PENDING_SETUP",
|
|
24
28
|
UPDATING: "UPDATING",
|
|
25
29
|
};
|
|
26
30
|
class ConflictException extends DSQLServiceException_1.DSQLServiceException {
|
|
@@ -17,6 +17,7 @@ const se_CreateClusterCommand = async (input, context) => {
|
|
|
17
17
|
body = JSON.stringify((0, smithy_client_1.take)(input, {
|
|
18
18
|
clientToken: [true, (_) => _ ?? (0, uuid_1.v4)()],
|
|
19
19
|
deletionProtectionEnabled: [],
|
|
20
|
+
multiRegionProperties: (_) => (0, smithy_client_1._json)(_),
|
|
20
21
|
tags: (_) => (0, smithy_client_1._json)(_),
|
|
21
22
|
}));
|
|
22
23
|
b.m("POST").h(headers).b(body);
|
|
@@ -148,6 +149,7 @@ const se_UpdateClusterCommand = async (input, context) => {
|
|
|
148
149
|
body = JSON.stringify((0, smithy_client_1.take)(input, {
|
|
149
150
|
clientToken: [true, (_) => _ ?? (0, uuid_1.v4)()],
|
|
150
151
|
deletionProtectionEnabled: [],
|
|
152
|
+
multiRegionProperties: (_) => (0, smithy_client_1._json)(_),
|
|
151
153
|
}));
|
|
152
154
|
b.m("POST").h(headers).b(body);
|
|
153
155
|
return b.build();
|
|
@@ -166,6 +168,7 @@ const de_CreateClusterCommand = async (output, context) => {
|
|
|
166
168
|
creationTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
167
169
|
deletionProtectionEnabled: smithy_client_1.expectBoolean,
|
|
168
170
|
identifier: smithy_client_1.expectString,
|
|
171
|
+
multiRegionProperties: smithy_client_1._json,
|
|
169
172
|
status: smithy_client_1.expectString,
|
|
170
173
|
});
|
|
171
174
|
Object.assign(contents, doc);
|
|
@@ -231,7 +234,9 @@ const de_GetClusterCommand = async (output, context) => {
|
|
|
231
234
|
deletionProtectionEnabled: smithy_client_1.expectBoolean,
|
|
232
235
|
identifier: smithy_client_1.expectString,
|
|
233
236
|
linkedClusterArns: smithy_client_1._json,
|
|
237
|
+
multiRegionProperties: smithy_client_1._json,
|
|
234
238
|
status: smithy_client_1.expectString,
|
|
239
|
+
tags: smithy_client_1._json,
|
|
235
240
|
witnessRegion: smithy_client_1.expectString,
|
|
236
241
|
});
|
|
237
242
|
Object.assign(contents, doc);
|
|
@@ -17,6 +17,10 @@ export const ClusterStatus = {
|
|
|
17
17
|
DELETED: "DELETED",
|
|
18
18
|
DELETING: "DELETING",
|
|
19
19
|
FAILED: "FAILED",
|
|
20
|
+
IDLE: "IDLE",
|
|
21
|
+
INACTIVE: "INACTIVE",
|
|
22
|
+
PENDING_DELETE: "PENDING_DELETE",
|
|
23
|
+
PENDING_SETUP: "PENDING_SETUP",
|
|
20
24
|
UPDATING: "UPDATING",
|
|
21
25
|
};
|
|
22
26
|
export class ConflictException extends __BaseException {
|
|
@@ -14,6 +14,7 @@ export const se_CreateClusterCommand = async (input, context) => {
|
|
|
14
14
|
body = JSON.stringify(take(input, {
|
|
15
15
|
clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
16
16
|
deletionProtectionEnabled: [],
|
|
17
|
+
multiRegionProperties: (_) => _json(_),
|
|
17
18
|
tags: (_) => _json(_),
|
|
18
19
|
}));
|
|
19
20
|
b.m("POST").h(headers).b(body);
|
|
@@ -135,6 +136,7 @@ export const se_UpdateClusterCommand = async (input, context) => {
|
|
|
135
136
|
body = JSON.stringify(take(input, {
|
|
136
137
|
clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
137
138
|
deletionProtectionEnabled: [],
|
|
139
|
+
multiRegionProperties: (_) => _json(_),
|
|
138
140
|
}));
|
|
139
141
|
b.m("POST").h(headers).b(body);
|
|
140
142
|
return b.build();
|
|
@@ -152,6 +154,7 @@ export const de_CreateClusterCommand = async (output, context) => {
|
|
|
152
154
|
creationTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
153
155
|
deletionProtectionEnabled: __expectBoolean,
|
|
154
156
|
identifier: __expectString,
|
|
157
|
+
multiRegionProperties: _json,
|
|
155
158
|
status: __expectString,
|
|
156
159
|
});
|
|
157
160
|
Object.assign(contents, doc);
|
|
@@ -213,7 +216,9 @@ export const de_GetClusterCommand = async (output, context) => {
|
|
|
213
216
|
deletionProtectionEnabled: __expectBoolean,
|
|
214
217
|
identifier: __expectString,
|
|
215
218
|
linkedClusterArns: _json,
|
|
219
|
+
multiRegionProperties: _json,
|
|
216
220
|
status: __expectString,
|
|
221
|
+
tags: _json,
|
|
217
222
|
witnessRegion: __expectString,
|
|
218
223
|
});
|
|
219
224
|
Object.assign(contents, doc);
|
package/dist-types/DSQL.d.ts
CHANGED
|
@@ -82,16 +82,12 @@ export interface DSQL {
|
|
|
82
82
|
updateCluster(args: UpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void;
|
|
83
83
|
}
|
|
84
84
|
/**
|
|
85
|
-
* <p>This is an interface reference for Amazon Aurora DSQL.
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
* so your clusters and databases are always available even if an
|
|
92
|
-
* Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL
|
|
93
|
-
* lets you focus on using your data to acquire new insights for your
|
|
94
|
-
* business and customers.</p>
|
|
85
|
+
* <p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the
|
|
86
|
+
* programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p>
|
|
87
|
+
* <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size.
|
|
88
|
+
* is available in both single-Region and multi-Region configurations, so your
|
|
89
|
+
* clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to
|
|
90
|
+
* acquire new insights for your business and customers.</p>
|
|
95
91
|
* @public
|
|
96
92
|
*/
|
|
97
93
|
export declare class DSQL extends DSQLClient implements DSQL {
|
|
@@ -180,16 +180,12 @@ export type DSQLClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpH
|
|
|
180
180
|
export interface DSQLClientResolvedConfig extends DSQLClientResolvedConfigType {
|
|
181
181
|
}
|
|
182
182
|
/**
|
|
183
|
-
* <p>This is an interface reference for Amazon Aurora DSQL.
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
* so your clusters and databases are always available even if an
|
|
190
|
-
* Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL
|
|
191
|
-
* lets you focus on using your data to acquire new insights for your
|
|
192
|
-
* business and customers.</p>
|
|
183
|
+
* <p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the
|
|
184
|
+
* programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p>
|
|
185
|
+
* <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size.
|
|
186
|
+
* is available in both single-Region and multi-Region configurations, so your
|
|
187
|
+
* clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to
|
|
188
|
+
* acquire new insights for your business and customers.</p>
|
|
193
189
|
* @public
|
|
194
190
|
*/
|
|
195
191
|
export declare class DSQLClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, DSQLClientResolvedConfig> {
|
|
@@ -27,7 +27,77 @@ declare const CreateClusterCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>This operation creates a cluster in Amazon Aurora DSQL. You need the following permissions to
|
|
31
|
+
* use this operation.</p>
|
|
32
|
+
* <p>Permission to create a cluster.</p>
|
|
33
|
+
* <dl>
|
|
34
|
+
* <dt>dsql:CreateCluster</dt>
|
|
35
|
+
* <dd>
|
|
36
|
+
* <p>Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p>
|
|
37
|
+
* </dd>
|
|
38
|
+
* </dl>
|
|
39
|
+
* <p> Permission to add tags to a resource.</p>
|
|
40
|
+
* <dl>
|
|
41
|
+
* <dt>dsql:TagResource</dt>
|
|
42
|
+
* <dd>
|
|
43
|
+
* <p>Resources:
|
|
44
|
+
* arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p>
|
|
45
|
+
* </dd>
|
|
46
|
+
* </dl>
|
|
47
|
+
* <p>Permission to configure multi-region properties for
|
|
48
|
+
* a cluster.</p>
|
|
49
|
+
* <dl>
|
|
50
|
+
* <dt>dsql:PutMultiRegionProperties</dt>
|
|
51
|
+
* <dd>
|
|
52
|
+
* <p>Resources:
|
|
53
|
+
* arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p>
|
|
54
|
+
* </dd>
|
|
55
|
+
* </dl>
|
|
56
|
+
* <p>When specifying multiRegionProperties.clusters.</p>
|
|
57
|
+
* <dl>
|
|
58
|
+
* <dt>dsql:AddPeerCluster</dt>
|
|
59
|
+
* <dd>
|
|
60
|
+
* <p>Permission to add peer clusters.</p>
|
|
61
|
+
* <p>Resources:</p>
|
|
62
|
+
* <ul>
|
|
63
|
+
* <li>
|
|
64
|
+
* <p>Local cluster: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p>
|
|
65
|
+
* </li>
|
|
66
|
+
* <li>
|
|
67
|
+
* <p>Each peer cluster: exact ARN of each specified peer cluster</p>
|
|
68
|
+
* </li>
|
|
69
|
+
* </ul>
|
|
70
|
+
* </dd>
|
|
71
|
+
* </dl>
|
|
72
|
+
* <p>When specifying multiRegionProperties.witnessRegion.</p>
|
|
73
|
+
* <dl>
|
|
74
|
+
* <dt>dsql:PutWitnessRegion</dt>
|
|
75
|
+
* <dd>
|
|
76
|
+
* <p>Permission to set a witness region.</p>
|
|
77
|
+
* <p>Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p>
|
|
78
|
+
* <p>Condition Keys: <code>dsql:WitnessRegion</code> (matching the specified
|
|
79
|
+
* witness region)</p>
|
|
80
|
+
* <note>
|
|
81
|
+
* <p>This permission is checked both in the cluster Region and in the witness
|
|
82
|
+
* Region.</p>
|
|
83
|
+
* </note>
|
|
84
|
+
* </dd>
|
|
85
|
+
* </dl>
|
|
86
|
+
* <important>
|
|
87
|
+
* <p>
|
|
88
|
+
* <b>Important Notes for Multi-Region Operations</b>
|
|
89
|
+
* </p>
|
|
90
|
+
* <ul>
|
|
91
|
+
* <li>
|
|
92
|
+
* <p>The witness region specified in
|
|
93
|
+
* <code>multiRegionProperties.witnessRegion</code> cannot be the same as the
|
|
94
|
+
* cluster's Region.</p>
|
|
95
|
+
* </li>
|
|
96
|
+
* <li>
|
|
97
|
+
* <p>When updating clusters with peer relationships, permissions are checked for both adding and removing peers.</p>
|
|
98
|
+
* </li>
|
|
99
|
+
* </ul>
|
|
100
|
+
* </important>
|
|
31
101
|
* @example
|
|
32
102
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
103
|
* ```javascript
|
|
@@ -40,14 +110,26 @@ declare const CreateClusterCommand_base: {
|
|
|
40
110
|
* "<keys>": "STRING_VALUE",
|
|
41
111
|
* },
|
|
42
112
|
* clientToken: "STRING_VALUE",
|
|
113
|
+
* multiRegionProperties: { // MultiRegionProperties
|
|
114
|
+
* witnessRegion: "STRING_VALUE",
|
|
115
|
+
* clusters: [ // ClusterArnList
|
|
116
|
+
* "STRING_VALUE",
|
|
117
|
+
* ],
|
|
118
|
+
* },
|
|
43
119
|
* };
|
|
44
120
|
* const command = new CreateClusterCommand(input);
|
|
45
121
|
* const response = await client.send(command);
|
|
46
122
|
* // { // CreateClusterOutput
|
|
47
123
|
* // identifier: "STRING_VALUE", // required
|
|
48
124
|
* // arn: "STRING_VALUE", // required
|
|
49
|
-
* // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED", // required
|
|
125
|
+
* // status: "CREATING" || "ACTIVE" || "IDLE" || "INACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED" || "PENDING_SETUP" || "PENDING_DELETE", // required
|
|
50
126
|
* // creationTime: new Date("TIMESTAMP"), // required
|
|
127
|
+
* // multiRegionProperties: { // MultiRegionProperties
|
|
128
|
+
* // witnessRegion: "STRING_VALUE",
|
|
129
|
+
* // clusters: [ // ClusterArnList
|
|
130
|
+
* // "STRING_VALUE",
|
|
131
|
+
* // ],
|
|
132
|
+
* // },
|
|
51
133
|
* // deletionProtectionEnabled: true || false, // required
|
|
52
134
|
* // };
|
|
53
135
|
*
|
|
@@ -65,19 +147,19 @@ declare const CreateClusterCommand_base: {
|
|
|
65
147
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
66
148
|
* <p>The service limit was exceeded.</p>
|
|
67
149
|
*
|
|
150
|
+
* @throws {@link ValidationException} (client fault)
|
|
151
|
+
* <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
152
|
+
*
|
|
68
153
|
* @throws {@link AccessDeniedException} (client fault)
|
|
69
154
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
70
155
|
*
|
|
71
156
|
* @throws {@link InternalServerException} (server fault)
|
|
72
|
-
* <p>The request processing has failed because of an unknown error,
|
|
73
|
-
*
|
|
157
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
158
|
+
* failure.</p>
|
|
74
159
|
*
|
|
75
160
|
* @throws {@link ThrottlingException} (client fault)
|
|
76
161
|
* <p>The request was denied due to request throttling.</p>
|
|
77
162
|
*
|
|
78
|
-
* @throws {@link ValidationException} (client fault)
|
|
79
|
-
* <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
80
|
-
*
|
|
81
163
|
* @throws {@link DSQLServiceException}
|
|
82
164
|
* <p>Base exception class for all service exceptions from DSQL service.</p>
|
|
83
165
|
*
|
|
@@ -27,10 +27,12 @@ declare const CreateMultiRegionClustersCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates multi-Region clusters in Amazon Aurora DSQL.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
30
|
+
* <p>Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked
|
|
31
|
+
* Region list, which is an array of the Regions in which you want to create linked clusters.
|
|
32
|
+
* Multi-Region clusters require a witness Region, which participates in quorum in failure
|
|
33
|
+
* scenarios.</p>
|
|
34
|
+
*
|
|
35
|
+
* @deprecated The CreateMultiRegionClusters API is deprecated. Use the CreateCluster API with multi-Region properties to create a multi-Region cluster.
|
|
34
36
|
* @example
|
|
35
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
38
|
* ```javascript
|
|
@@ -78,8 +80,8 @@ declare const CreateMultiRegionClustersCommand_base: {
|
|
|
78
80
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
79
81
|
*
|
|
80
82
|
* @throws {@link InternalServerException} (server fault)
|
|
81
|
-
* <p>The request processing has failed because of an unknown error,
|
|
82
|
-
*
|
|
83
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
84
|
+
* failure.</p>
|
|
83
85
|
*
|
|
84
86
|
* @throws {@link ThrottlingException} (client fault)
|
|
85
87
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -106,8 +108,8 @@ declare const CreateMultiRegionClustersCommand_base: {
|
|
|
106
108
|
* /* response is
|
|
107
109
|
* {
|
|
108
110
|
* linkedClusterArns: [
|
|
109
|
-
* "arn:aws:dsql:us-east-1:111122223333:cluster/
|
|
110
|
-
* "arn:aws:dsql:us-east-2:111122223333:cluster/
|
|
111
|
+
* "arn:aws:dsql:us-east-1:111122223333:cluster/abcdefghijklmnopqrstu12345",
|
|
112
|
+
* "arn:aws:dsql:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcde54321"
|
|
111
113
|
* ]
|
|
112
114
|
* }
|
|
113
115
|
* *\/
|
|
@@ -43,7 +43,7 @@ declare const DeleteClusterCommand_base: {
|
|
|
43
43
|
* // { // DeleteClusterOutput
|
|
44
44
|
* // identifier: "STRING_VALUE", // required
|
|
45
45
|
* // arn: "STRING_VALUE", // required
|
|
46
|
-
* // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED", // required
|
|
46
|
+
* // status: "CREATING" || "ACTIVE" || "IDLE" || "INACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED" || "PENDING_SETUP" || "PENDING_DELETE", // required
|
|
47
47
|
* // creationTime: new Date("TIMESTAMP"), // required
|
|
48
48
|
* // deletionProtectionEnabled: true || false, // required
|
|
49
49
|
* // };
|
|
@@ -66,8 +66,8 @@ declare const DeleteClusterCommand_base: {
|
|
|
66
66
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link InternalServerException} (server fault)
|
|
69
|
-
* <p>The request processing has failed because of an unknown error,
|
|
70
|
-
*
|
|
69
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
70
|
+
* failure.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link ThrottlingException} (client fault)
|
|
73
73
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -28,6 +28,8 @@ declare const DeleteMultiRegionClustersCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Deletes a multi-Region cluster in Amazon Aurora DSQL.</p>
|
|
31
|
+
*
|
|
32
|
+
* @deprecated The DeleteMultiRegionClusters API is deprecated. To delete a multi-Region cluster, use the DeleteCluster API instead.
|
|
31
33
|
* @example
|
|
32
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
35
|
* ```javascript
|
|
@@ -62,8 +64,8 @@ declare const DeleteMultiRegionClustersCommand_base: {
|
|
|
62
64
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
63
65
|
*
|
|
64
66
|
* @throws {@link InternalServerException} (server fault)
|
|
65
|
-
* <p>The request processing has failed because of an unknown error,
|
|
66
|
-
*
|
|
67
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
68
|
+
* failure.</p>
|
|
67
69
|
*
|
|
68
70
|
* @throws {@link ThrottlingException} (client fault)
|
|
69
71
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -80,8 +82,8 @@ declare const DeleteMultiRegionClustersCommand_base: {
|
|
|
80
82
|
* //
|
|
81
83
|
* const input = {
|
|
82
84
|
* linkedClusterArns: [
|
|
83
|
-
* "arn:aws:dsql:us-east-1:111122223333:cluster/
|
|
84
|
-
* "arn:aws:dsql:us-east-2:111122223333:cluster/
|
|
85
|
+
* "arn:aws:dsql:us-east-1:111122223333:cluster/abcdefghijklmnopqrstu12345",
|
|
86
|
+
* "arn:aws:dsql:us-east-2:111122223333:cluster/klmnopqrstuvwxyzabcde54321"
|
|
85
87
|
* ]
|
|
86
88
|
* };
|
|
87
89
|
* const command = new DeleteMultiRegionClustersCommand(input);
|
|
@@ -42,13 +42,22 @@ declare const GetClusterCommand_base: {
|
|
|
42
42
|
* // { // GetClusterOutput
|
|
43
43
|
* // identifier: "STRING_VALUE", // required
|
|
44
44
|
* // arn: "STRING_VALUE", // required
|
|
45
|
-
* // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED", // required
|
|
45
|
+
* // status: "CREATING" || "ACTIVE" || "IDLE" || "INACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED" || "PENDING_SETUP" || "PENDING_DELETE", // required
|
|
46
46
|
* // creationTime: new Date("TIMESTAMP"), // required
|
|
47
|
-
* // deletionProtectionEnabled: true || false, // required
|
|
48
47
|
* // witnessRegion: "STRING_VALUE",
|
|
49
48
|
* // linkedClusterArns: [ // ClusterArnList
|
|
50
49
|
* // "STRING_VALUE",
|
|
51
50
|
* // ],
|
|
51
|
+
* // deletionProtectionEnabled: true || false, // required
|
|
52
|
+
* // multiRegionProperties: { // MultiRegionProperties
|
|
53
|
+
* // witnessRegion: "STRING_VALUE",
|
|
54
|
+
* // clusters: [
|
|
55
|
+
* // "STRING_VALUE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // },
|
|
58
|
+
* // tags: { // TagMap
|
|
59
|
+
* // "<keys>": "STRING_VALUE",
|
|
60
|
+
* // },
|
|
52
61
|
* // };
|
|
53
62
|
*
|
|
54
63
|
* ```
|
|
@@ -66,8 +75,8 @@ declare const GetClusterCommand_base: {
|
|
|
66
75
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
67
76
|
*
|
|
68
77
|
* @throws {@link InternalServerException} (server fault)
|
|
69
|
-
* <p>The request processing has failed because of an unknown error,
|
|
70
|
-
*
|
|
78
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
79
|
+
* failure.</p>
|
|
71
80
|
*
|
|
72
81
|
* @throws {@link ThrottlingException} (client fault)
|
|
73
82
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -52,8 +52,8 @@ declare const GetVpcEndpointServiceNameCommand_base: {
|
|
|
52
52
|
* @see {@link DSQLClientResolvedConfig | config} for DSQLClient's `config` shape.
|
|
53
53
|
*
|
|
54
54
|
* @throws {@link InternalServerException} (server fault)
|
|
55
|
-
* <p>The request processing has failed because of an unknown error,
|
|
56
|
-
*
|
|
55
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
56
|
+
* failure.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
59
59
|
* <p>The resource could not be found.</p>
|
|
@@ -65,8 +65,8 @@ declare const ListClustersCommand_base: {
|
|
|
65
65
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link InternalServerException} (server fault)
|
|
68
|
-
* <p>The request processing has failed because of an unknown error,
|
|
69
|
-
*
|
|
68
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
69
|
+
* failure.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link ThrottlingException} (client fault)
|
|
72
72
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -60,8 +60,8 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
60
60
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link InternalServerException} (server fault)
|
|
63
|
-
* <p>The request processing has failed because of an unknown error,
|
|
64
|
-
*
|
|
63
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
64
|
+
* failure.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ThrottlingException} (client fault)
|
|
67
67
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -62,8 +62,8 @@ declare const TagResourceCommand_base: {
|
|
|
62
62
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link InternalServerException} (server fault)
|
|
65
|
-
* <p>The request processing has failed because of an unknown error,
|
|
66
|
-
*
|
|
65
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
66
|
+
* failure.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ThrottlingException} (client fault)
|
|
69
69
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -59,8 +59,8 @@ declare const UntagResourceCommand_base: {
|
|
|
59
59
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link InternalServerException} (server fault)
|
|
62
|
-
* <p>The request processing has failed because of an unknown error,
|
|
63
|
-
*
|
|
62
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
63
|
+
* failure.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link ThrottlingException} (client fault)
|
|
66
66
|
* <p>The request was denied due to request throttling.</p>
|
|
@@ -28,6 +28,29 @@ declare const UpdateClusterCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Updates a cluster.</p>
|
|
31
|
+
* <p>
|
|
32
|
+
* <b>Example IAM Policy for Multi-Region Operations</b>
|
|
33
|
+
* </p>
|
|
34
|
+
* <p>The following IAM policy grants permissions for multi-Region operations.</p>
|
|
35
|
+
* <p>The <code>dsql:RemovePeerCluster</code> permission uses a wildcard ARN pattern to simplify permission management during updates.</p>
|
|
36
|
+
* <important>
|
|
37
|
+
* <p>
|
|
38
|
+
* <b>Important Notes for Multi-Region Operations</b>
|
|
39
|
+
* </p>
|
|
40
|
+
* <ul>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>The witness region specified in
|
|
43
|
+
* <code>multiRegionProperties.witnessRegion</code> cannot be the same as the
|
|
44
|
+
* cluster's Region.</p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>When updating clusters with peer relationships, permissions are checked for both adding and removing peers.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>The <code>dsql:RemovePeerCluster</code> permission uses a wildcard ARN pattern to simplify permission management during updates.</p>
|
|
51
|
+
* </li>
|
|
52
|
+
* </ul>
|
|
53
|
+
* </important>
|
|
31
54
|
* @example
|
|
32
55
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
56
|
* ```javascript
|
|
@@ -38,19 +61,25 @@ declare const UpdateClusterCommand_base: {
|
|
|
38
61
|
* identifier: "STRING_VALUE", // required
|
|
39
62
|
* deletionProtectionEnabled: true || false,
|
|
40
63
|
* clientToken: "STRING_VALUE",
|
|
64
|
+
* multiRegionProperties: { // MultiRegionProperties
|
|
65
|
+
* witnessRegion: "STRING_VALUE",
|
|
66
|
+
* clusters: [ // ClusterArnList
|
|
67
|
+
* "STRING_VALUE",
|
|
68
|
+
* ],
|
|
69
|
+
* },
|
|
41
70
|
* };
|
|
42
71
|
* const command = new UpdateClusterCommand(input);
|
|
43
72
|
* const response = await client.send(command);
|
|
44
73
|
* // { // UpdateClusterOutput
|
|
45
74
|
* // identifier: "STRING_VALUE", // required
|
|
46
75
|
* // arn: "STRING_VALUE", // required
|
|
47
|
-
* // status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED", // required
|
|
76
|
+
* // status: "CREATING" || "ACTIVE" || "IDLE" || "INACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED" || "PENDING_SETUP" || "PENDING_DELETE", // required
|
|
48
77
|
* // creationTime: new Date("TIMESTAMP"), // required
|
|
49
|
-
* // deletionProtectionEnabled: true || false, // required
|
|
50
78
|
* // witnessRegion: "STRING_VALUE",
|
|
51
79
|
* // linkedClusterArns: [ // ClusterArnList
|
|
52
80
|
* // "STRING_VALUE",
|
|
53
81
|
* // ],
|
|
82
|
+
* // deletionProtectionEnabled: true || false, // required
|
|
54
83
|
* // };
|
|
55
84
|
*
|
|
56
85
|
* ```
|
|
@@ -67,19 +96,19 @@ declare const UpdateClusterCommand_base: {
|
|
|
67
96
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
68
97
|
* <p>The resource could not be found.</p>
|
|
69
98
|
*
|
|
99
|
+
* @throws {@link ValidationException} (client fault)
|
|
100
|
+
* <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
101
|
+
*
|
|
70
102
|
* @throws {@link AccessDeniedException} (client fault)
|
|
71
103
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
72
104
|
*
|
|
73
105
|
* @throws {@link InternalServerException} (server fault)
|
|
74
|
-
* <p>The request processing has failed because of an unknown error,
|
|
75
|
-
*
|
|
106
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
107
|
+
* failure.</p>
|
|
76
108
|
*
|
|
77
109
|
* @throws {@link ThrottlingException} (client fault)
|
|
78
110
|
* <p>The request was denied due to request throttling.</p>
|
|
79
111
|
*
|
|
80
|
-
* @throws {@link ValidationException} (client fault)
|
|
81
|
-
* <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
82
|
-
*
|
|
83
112
|
* @throws {@link DSQLServiceException}
|
|
84
113
|
* <p>Base exception class for all service exceptions from DSQL service.</p>
|
|
85
114
|
*
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,14 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>This is an interface reference for Amazon Aurora DSQL.
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* so your clusters and databases are always available even if an
|
|
9
|
-
* Availability Zone or an Amazon Web Services Region are unavailable. Aurora DSQL
|
|
10
|
-
* lets you focus on using your data to acquire new insights for your
|
|
11
|
-
* business and customers.</p>
|
|
2
|
+
* <p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the
|
|
3
|
+
* programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p>
|
|
4
|
+
* <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size.
|
|
5
|
+
* is available in both single-Region and multi-Region configurations, so your
|
|
6
|
+
* clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to
|
|
7
|
+
* acquire new insights for your business and customers.</p>
|
|
12
8
|
*
|
|
13
9
|
* @packageDocumentation
|
|
14
10
|
*/
|
|
@@ -22,6 +22,10 @@ export declare const ClusterStatus: {
|
|
|
22
22
|
readonly DELETED: "DELETED";
|
|
23
23
|
readonly DELETING: "DELETING";
|
|
24
24
|
readonly FAILED: "FAILED";
|
|
25
|
+
readonly IDLE: "IDLE";
|
|
26
|
+
readonly INACTIVE: "INACTIVE";
|
|
27
|
+
readonly PENDING_DELETE: "PENDING_DELETE";
|
|
28
|
+
readonly PENDING_SETUP: "PENDING_SETUP";
|
|
25
29
|
readonly UPDATING: "UPDATING";
|
|
26
30
|
};
|
|
27
31
|
/**
|
|
@@ -50,13 +54,29 @@ export declare class ConflictException extends __BaseException {
|
|
|
50
54
|
*/
|
|
51
55
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
52
56
|
}
|
|
57
|
+
/**
|
|
58
|
+
* <p>Defines the structure for multi-Region cluster configurations, containing the witness region and linked cluster settings.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
export interface MultiRegionProperties {
|
|
62
|
+
/**
|
|
63
|
+
* <p>The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum.</p>
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
witnessRegion?: string | undefined;
|
|
67
|
+
/**
|
|
68
|
+
* <p>The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region.</p>
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
clusters?: string[] | undefined;
|
|
72
|
+
}
|
|
53
73
|
/**
|
|
54
74
|
* @public
|
|
55
75
|
*/
|
|
56
76
|
export interface CreateClusterInput {
|
|
57
77
|
/**
|
|
58
|
-
* <p>If enabled, you can't delete your cluster. You must first
|
|
59
|
-
*
|
|
78
|
+
* <p>If enabled, you can't delete your cluster. You must first disable this property before
|
|
79
|
+
* you can delete your cluster.</p>
|
|
60
80
|
* @public
|
|
61
81
|
*/
|
|
62
82
|
deletionProtectionEnabled?: boolean | undefined;
|
|
@@ -66,20 +86,24 @@ export interface CreateClusterInput {
|
|
|
66
86
|
*/
|
|
67
87
|
tags?: Record<string, string> | undefined;
|
|
68
88
|
/**
|
|
69
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
* automatically generates one.</p>
|
|
89
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
90
|
+
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
91
|
+
* request, if the original request completes successfully, the subsequent retries with the
|
|
92
|
+
* same client token return the result from the original successful request and they have no
|
|
93
|
+
* additional effect.</p>
|
|
94
|
+
* <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates
|
|
95
|
+
* one.</p>
|
|
77
96
|
* @public
|
|
78
97
|
*/
|
|
79
98
|
clientToken?: string | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* <p>The configuration settings when creating a multi-Region cluster, including the witness region and linked cluster properties.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
80
104
|
}
|
|
81
105
|
/**
|
|
82
|
-
*
|
|
106
|
+
* <p>The output of a created cluster.</p>
|
|
83
107
|
* @public
|
|
84
108
|
*/
|
|
85
109
|
export interface CreateClusterOutput {
|
|
@@ -103,6 +127,11 @@ export interface CreateClusterOutput {
|
|
|
103
127
|
* @public
|
|
104
128
|
*/
|
|
105
129
|
creationTime: Date | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* <p>The multi-Region cluster configuration details that were set during cluster creation</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
106
135
|
/**
|
|
107
136
|
* <p>Whether deletion protection is enabled on this cluster.</p>
|
|
108
137
|
* @public
|
|
@@ -110,8 +139,8 @@ export interface CreateClusterOutput {
|
|
|
110
139
|
deletionProtectionEnabled: boolean | undefined;
|
|
111
140
|
}
|
|
112
141
|
/**
|
|
113
|
-
* <p>The request processing has failed because of an unknown error,
|
|
114
|
-
*
|
|
142
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
143
|
+
* failure.</p>
|
|
115
144
|
* @public
|
|
116
145
|
*/
|
|
117
146
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -136,22 +165,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
136
165
|
readonly name: "ServiceQuotaExceededException";
|
|
137
166
|
readonly $fault: "client";
|
|
138
167
|
/**
|
|
139
|
-
*
|
|
168
|
+
* <p>The resource ID exceeds a quota.</p>
|
|
140
169
|
* @public
|
|
141
170
|
*/
|
|
142
171
|
resourceId: string | undefined;
|
|
143
172
|
/**
|
|
144
|
-
*
|
|
173
|
+
* <p>The resource type exceeds a quota.</p>
|
|
145
174
|
* @public
|
|
146
175
|
*/
|
|
147
176
|
resourceType: string | undefined;
|
|
148
177
|
/**
|
|
149
|
-
*
|
|
178
|
+
* <p>The request exceeds a service quota.</p>
|
|
150
179
|
* @public
|
|
151
180
|
*/
|
|
152
181
|
serviceCode: string | undefined;
|
|
153
182
|
/**
|
|
154
|
-
*
|
|
183
|
+
* <p>The service exceeds a quota.</p>
|
|
155
184
|
* @public
|
|
156
185
|
*/
|
|
157
186
|
quotaCode: string | undefined;
|
|
@@ -171,17 +200,17 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
171
200
|
throttling: boolean;
|
|
172
201
|
};
|
|
173
202
|
/**
|
|
174
|
-
*
|
|
203
|
+
* <p>The request exceeds a service quota.</p>
|
|
175
204
|
* @public
|
|
176
205
|
*/
|
|
177
206
|
serviceCode?: string | undefined;
|
|
178
207
|
/**
|
|
179
|
-
*
|
|
208
|
+
* <p>The request exceeds a request rate quota.</p>
|
|
180
209
|
* @public
|
|
181
210
|
*/
|
|
182
211
|
quotaCode?: string | undefined;
|
|
183
212
|
/**
|
|
184
|
-
*
|
|
213
|
+
* <p>The request exceeds a request rate quota. Retry after seconds.</p>
|
|
185
214
|
* @public
|
|
186
215
|
*/
|
|
187
216
|
retryAfterSeconds?: number | undefined;
|
|
@@ -191,8 +220,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
191
220
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
192
221
|
}
|
|
193
222
|
/**
|
|
194
|
-
* <p>Stores information about a field passed inside a
|
|
195
|
-
*
|
|
223
|
+
* <p>Stores information about a field passed inside a request that resulted in an validation
|
|
224
|
+
* error.</p>
|
|
196
225
|
* @public
|
|
197
226
|
*/
|
|
198
227
|
export interface ValidationExceptionField {
|
|
@@ -230,12 +259,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
230
259
|
readonly name: "ValidationException";
|
|
231
260
|
readonly $fault: "client";
|
|
232
261
|
/**
|
|
233
|
-
*
|
|
262
|
+
* <p>The reason for the validation exception.</p>
|
|
234
263
|
* @public
|
|
235
264
|
*/
|
|
236
265
|
reason: ValidationExceptionReason | undefined;
|
|
237
266
|
/**
|
|
238
|
-
*
|
|
267
|
+
* <p>A list of fields that didn't validate.</p>
|
|
239
268
|
* @public
|
|
240
269
|
*/
|
|
241
270
|
fieldList?: ValidationExceptionField[] | undefined;
|
|
@@ -246,6 +275,8 @@ export declare class ValidationException extends __BaseException {
|
|
|
246
275
|
}
|
|
247
276
|
/**
|
|
248
277
|
* <p>Properties of linked clusters.</p>
|
|
278
|
+
*
|
|
279
|
+
* @deprecated The CreateMultiRegionClusters API is deprecated. To create a multi-Region cluster, use the CreateCluster API with multi-Region properties instead.
|
|
249
280
|
* @public
|
|
250
281
|
*/
|
|
251
282
|
export interface LinkedClusterProperties {
|
|
@@ -266,11 +297,15 @@ export interface LinkedClusterProperties {
|
|
|
266
297
|
export interface CreateMultiRegionClustersInput {
|
|
267
298
|
/**
|
|
268
299
|
* <p>An array of the Regions in which you want to create additional clusters.</p>
|
|
300
|
+
*
|
|
301
|
+
* @deprecated
|
|
269
302
|
* @public
|
|
270
303
|
*/
|
|
271
304
|
linkedRegionList: string[] | undefined;
|
|
272
305
|
/**
|
|
273
306
|
* <p>A mapping of properties to use when creating linked clusters.</p>
|
|
307
|
+
*
|
|
308
|
+
* @deprecated
|
|
274
309
|
* @public
|
|
275
310
|
*/
|
|
276
311
|
clusterProperties?: Record<string, LinkedClusterProperties> | undefined;
|
|
@@ -280,14 +315,13 @@ export interface CreateMultiRegionClustersInput {
|
|
|
280
315
|
*/
|
|
281
316
|
witnessRegion: string | undefined;
|
|
282
317
|
/**
|
|
283
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the
|
|
284
|
-
*
|
|
285
|
-
*
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
*
|
|
290
|
-
* automatically generates one.</p>
|
|
318
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
319
|
+
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
320
|
+
* request, if the original request completes successfully. The subsequent retries with the
|
|
321
|
+
* same client token return the result from the original successful request and they have no
|
|
322
|
+
* additional effect.</p>
|
|
323
|
+
* <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates
|
|
324
|
+
* one.</p>
|
|
291
325
|
* @public
|
|
292
326
|
*/
|
|
293
327
|
clientToken?: string | undefined;
|
|
@@ -312,20 +346,19 @@ export interface DeleteClusterInput {
|
|
|
312
346
|
*/
|
|
313
347
|
identifier: string | undefined;
|
|
314
348
|
/**
|
|
315
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the
|
|
316
|
-
*
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
322
|
-
* automatically generates one.</p>
|
|
349
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
350
|
+
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
351
|
+
* request, if the original request completes successfully. The subsequent retries with the
|
|
352
|
+
* same client token return the result from the original successful request and they have no
|
|
353
|
+
* additional effect.</p>
|
|
354
|
+
* <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates
|
|
355
|
+
* one.</p>
|
|
323
356
|
* @public
|
|
324
357
|
*/
|
|
325
358
|
clientToken?: string | undefined;
|
|
326
359
|
}
|
|
327
360
|
/**
|
|
328
|
-
*
|
|
361
|
+
* <p>The output from a deleted cluster.</p>
|
|
329
362
|
* @public
|
|
330
363
|
*/
|
|
331
364
|
export interface DeleteClusterOutput {
|
|
@@ -351,6 +384,8 @@ export interface DeleteClusterOutput {
|
|
|
351
384
|
creationTime: Date | undefined;
|
|
352
385
|
/**
|
|
353
386
|
* <p>Specifies whether deletion protection was enabled on the cluster.</p>
|
|
387
|
+
*
|
|
388
|
+
* @deprecated
|
|
354
389
|
* @public
|
|
355
390
|
*/
|
|
356
391
|
deletionProtectionEnabled: boolean | undefined;
|
|
@@ -363,12 +398,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
363
398
|
readonly name: "ResourceNotFoundException";
|
|
364
399
|
readonly $fault: "client";
|
|
365
400
|
/**
|
|
366
|
-
*
|
|
401
|
+
* <p>The resource ID could not be found.</p>
|
|
367
402
|
* @public
|
|
368
403
|
*/
|
|
369
404
|
resourceId: string | undefined;
|
|
370
405
|
/**
|
|
371
|
-
*
|
|
406
|
+
* <p>The resource type could not be found.</p>
|
|
372
407
|
* @public
|
|
373
408
|
*/
|
|
374
409
|
resourceType: string | undefined;
|
|
@@ -382,20 +417,19 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
382
417
|
*/
|
|
383
418
|
export interface DeleteMultiRegionClustersInput {
|
|
384
419
|
/**
|
|
385
|
-
* <p>The ARNs of the clusters linked to the cluster you want to delete.
|
|
386
|
-
*
|
|
420
|
+
* <p>The ARNs of the clusters linked to the cluster you want to delete. also deletes
|
|
421
|
+
* these clusters as part of the operation.</p>
|
|
387
422
|
* @public
|
|
388
423
|
*/
|
|
389
424
|
linkedClusterArns: string[] | undefined;
|
|
390
425
|
/**
|
|
391
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the
|
|
392
|
-
*
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
*
|
|
396
|
-
*
|
|
397
|
-
*
|
|
398
|
-
* automatically generates one.</p>
|
|
426
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
427
|
+
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
428
|
+
* request, if the original request completes successfully. The subsequent retries with the
|
|
429
|
+
* same client token return the result from the original successful request and they have no
|
|
430
|
+
* additional effect.</p>
|
|
431
|
+
* <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates
|
|
432
|
+
* one.</p>
|
|
399
433
|
* @public
|
|
400
434
|
*/
|
|
401
435
|
clientToken?: string | undefined;
|
|
@@ -411,7 +445,7 @@ export interface GetClusterInput {
|
|
|
411
445
|
identifier: string | undefined;
|
|
412
446
|
}
|
|
413
447
|
/**
|
|
414
|
-
*
|
|
448
|
+
* <p>The output of a cluster.</p>
|
|
415
449
|
* @public
|
|
416
450
|
*/
|
|
417
451
|
export interface GetClusterOutput {
|
|
@@ -435,22 +469,35 @@ export interface GetClusterOutput {
|
|
|
435
469
|
* @public
|
|
436
470
|
*/
|
|
437
471
|
creationTime: Date | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* <p>The witness Region of the cluster. Applicable only for multi-Region clusters.</p>
|
|
474
|
+
*
|
|
475
|
+
* @deprecated
|
|
476
|
+
* @public
|
|
477
|
+
*/
|
|
478
|
+
witnessRegion?: string | undefined;
|
|
479
|
+
/**
|
|
480
|
+
* <p>The ARNs of the clusters linked to the retrieved cluster.</p>
|
|
481
|
+
*
|
|
482
|
+
* @deprecated
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
linkedClusterArns?: string[] | undefined;
|
|
438
486
|
/**
|
|
439
487
|
* <p>Whether deletion protection is enabled in this cluster.</p>
|
|
440
488
|
* @public
|
|
441
489
|
*/
|
|
442
490
|
deletionProtectionEnabled: boolean | undefined;
|
|
443
491
|
/**
|
|
444
|
-
* <p>
|
|
445
|
-
* multi-Region clusters.</p>
|
|
492
|
+
* <p>Returns the current multi-Region cluster configuration, including witness region and linked cluster information.</p>
|
|
446
493
|
* @public
|
|
447
494
|
*/
|
|
448
|
-
|
|
495
|
+
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
449
496
|
/**
|
|
450
|
-
* <p>
|
|
497
|
+
* <p>Map of tags.</p>
|
|
451
498
|
* @public
|
|
452
499
|
*/
|
|
453
|
-
|
|
500
|
+
tags?: Record<string, string> | undefined;
|
|
454
501
|
}
|
|
455
502
|
/**
|
|
456
503
|
* @public
|
|
@@ -477,15 +524,15 @@ export interface GetVpcEndpointServiceNameOutput {
|
|
|
477
524
|
*/
|
|
478
525
|
export interface ListClustersInput {
|
|
479
526
|
/**
|
|
480
|
-
* <p>An optional parameter that specifies the maximum number of results to return.
|
|
481
|
-
*
|
|
527
|
+
* <p>An optional parameter that specifies the maximum number of results to return. You can
|
|
528
|
+
* use nextToken to display the next page of results.</p>
|
|
482
529
|
* @public
|
|
483
530
|
*/
|
|
484
531
|
maxResults?: number | undefined;
|
|
485
532
|
/**
|
|
486
|
-
* <p>If your initial ListClusters operation returns a nextToken,
|
|
487
|
-
*
|
|
488
|
-
*
|
|
533
|
+
* <p>If your initial ListClusters operation returns a nextToken, you can include the returned
|
|
534
|
+
* nextToken in following ListClusters operations, which returns results in the next
|
|
535
|
+
* page.</p>
|
|
489
536
|
* @public
|
|
490
537
|
*/
|
|
491
538
|
nextToken?: string | undefined;
|
|
@@ -511,9 +558,9 @@ export interface ClusterSummary {
|
|
|
511
558
|
*/
|
|
512
559
|
export interface ListClustersOutput {
|
|
513
560
|
/**
|
|
514
|
-
* <p>If nextToken is returned, there are more results available. The value of
|
|
515
|
-
*
|
|
516
|
-
*
|
|
561
|
+
* <p>If nextToken is returned, there are more results available. The value of nextToken is a
|
|
562
|
+
* unique pagination token for each page. To retrieve the next page, make the call again using
|
|
563
|
+
* the returned token.</p>
|
|
517
564
|
* @public
|
|
518
565
|
*/
|
|
519
566
|
nextToken?: string | undefined;
|
|
@@ -538,20 +585,24 @@ export interface UpdateClusterInput {
|
|
|
538
585
|
*/
|
|
539
586
|
deletionProtectionEnabled?: boolean | undefined;
|
|
540
587
|
/**
|
|
541
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the
|
|
542
|
-
*
|
|
543
|
-
*
|
|
544
|
-
*
|
|
545
|
-
*
|
|
546
|
-
*
|
|
547
|
-
*
|
|
548
|
-
* automatically generates one.</p>
|
|
588
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
589
|
+
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
590
|
+
* request, if the original request completes successfully. The subsequent retries with the
|
|
591
|
+
* same client token return the result from the original successful request and they have no
|
|
592
|
+
* additional effect.</p>
|
|
593
|
+
* <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates
|
|
594
|
+
* one.</p>
|
|
549
595
|
* @public
|
|
550
596
|
*/
|
|
551
597
|
clientToken?: string | undefined;
|
|
598
|
+
/**
|
|
599
|
+
* <p>The new multi-Region cluster configuration settings to be applied during an update operation.</p>
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
552
603
|
}
|
|
553
604
|
/**
|
|
554
|
-
*
|
|
605
|
+
* <p>The details of the cluster after it has been updated.</p>
|
|
555
606
|
* @public
|
|
556
607
|
*/
|
|
557
608
|
export interface UpdateClusterOutput {
|
|
@@ -575,22 +626,28 @@ export interface UpdateClusterOutput {
|
|
|
575
626
|
* @public
|
|
576
627
|
*/
|
|
577
628
|
creationTime: Date | undefined;
|
|
578
|
-
/**
|
|
579
|
-
* <p>Whether deletion protection is enabled for the updated cluster.</p>
|
|
580
|
-
* @public
|
|
581
|
-
*/
|
|
582
|
-
deletionProtectionEnabled: boolean | undefined;
|
|
583
629
|
/**
|
|
584
630
|
* <p>The Region that receives all data you write to linked clusters.</p>
|
|
631
|
+
*
|
|
632
|
+
* @deprecated
|
|
585
633
|
* @public
|
|
586
634
|
*/
|
|
587
635
|
witnessRegion?: string | undefined;
|
|
588
636
|
/**
|
|
589
|
-
* <p>The ARNs of the clusters linked to the updated cluster. Applicable
|
|
590
|
-
*
|
|
637
|
+
* <p>The ARNs of the clusters linked to the updated cluster. Applicable only for multi-Region
|
|
638
|
+
* clusters.</p>
|
|
639
|
+
*
|
|
640
|
+
* @deprecated
|
|
591
641
|
* @public
|
|
592
642
|
*/
|
|
593
643
|
linkedClusterArns?: string[] | undefined;
|
|
644
|
+
/**
|
|
645
|
+
* <p>Whether deletion protection is enabled for the updated cluster.</p>
|
|
646
|
+
*
|
|
647
|
+
* @deprecated
|
|
648
|
+
* @public
|
|
649
|
+
*/
|
|
650
|
+
deletionProtectionEnabled: boolean | undefined;
|
|
594
651
|
}
|
|
595
652
|
/**
|
|
596
653
|
* @public
|
|
@@ -13,6 +13,10 @@ export declare const ClusterStatus: {
|
|
|
13
13
|
readonly DELETED: "DELETED";
|
|
14
14
|
readonly DELETING: "DELETING";
|
|
15
15
|
readonly FAILED: "FAILED";
|
|
16
|
+
readonly IDLE: "IDLE";
|
|
17
|
+
readonly INACTIVE: "INACTIVE";
|
|
18
|
+
readonly PENDING_DELETE: "PENDING_DELETE";
|
|
19
|
+
readonly PENDING_SETUP: "PENDING_SETUP";
|
|
16
20
|
readonly UPDATING: "UPDATING";
|
|
17
21
|
};
|
|
18
22
|
export type ClusterStatus = (typeof ClusterStatus)[keyof typeof ClusterStatus];
|
|
@@ -23,16 +27,22 @@ export declare class ConflictException extends __BaseException {
|
|
|
23
27
|
resourceType?: string | undefined;
|
|
24
28
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
25
29
|
}
|
|
30
|
+
export interface MultiRegionProperties {
|
|
31
|
+
witnessRegion?: string | undefined;
|
|
32
|
+
clusters?: string[] | undefined;
|
|
33
|
+
}
|
|
26
34
|
export interface CreateClusterInput {
|
|
27
35
|
deletionProtectionEnabled?: boolean | undefined;
|
|
28
36
|
tags?: Record<string, string> | undefined;
|
|
29
37
|
clientToken?: string | undefined;
|
|
38
|
+
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
30
39
|
}
|
|
31
40
|
export interface CreateClusterOutput {
|
|
32
41
|
identifier: string | undefined;
|
|
33
42
|
arn: string | undefined;
|
|
34
43
|
status: ClusterStatus | undefined;
|
|
35
44
|
creationTime: Date | undefined;
|
|
45
|
+
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
36
46
|
deletionProtectionEnabled: boolean | undefined;
|
|
37
47
|
}
|
|
38
48
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -135,9 +145,11 @@ export interface GetClusterOutput {
|
|
|
135
145
|
arn: string | undefined;
|
|
136
146
|
status: ClusterStatus | undefined;
|
|
137
147
|
creationTime: Date | undefined;
|
|
138
|
-
deletionProtectionEnabled: boolean | undefined;
|
|
139
148
|
witnessRegion?: string | undefined;
|
|
140
149
|
linkedClusterArns?: string[] | undefined;
|
|
150
|
+
deletionProtectionEnabled: boolean | undefined;
|
|
151
|
+
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
152
|
+
tags?: Record<string, string> | undefined;
|
|
141
153
|
}
|
|
142
154
|
export interface GetVpcEndpointServiceNameInput {
|
|
143
155
|
identifier: string | undefined;
|
|
@@ -161,15 +173,16 @@ export interface UpdateClusterInput {
|
|
|
161
173
|
identifier: string | undefined;
|
|
162
174
|
deletionProtectionEnabled?: boolean | undefined;
|
|
163
175
|
clientToken?: string | undefined;
|
|
176
|
+
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
164
177
|
}
|
|
165
178
|
export interface UpdateClusterOutput {
|
|
166
179
|
identifier: string | undefined;
|
|
167
180
|
arn: string | undefined;
|
|
168
181
|
status: ClusterStatus | undefined;
|
|
169
182
|
creationTime: Date | undefined;
|
|
170
|
-
deletionProtectionEnabled: boolean | undefined;
|
|
171
183
|
witnessRegion?: string | undefined;
|
|
172
184
|
linkedClusterArns?: string[] | undefined;
|
|
185
|
+
deletionProtectionEnabled: boolean | undefined;
|
|
173
186
|
}
|
|
174
187
|
export interface ListTagsForResourceInput {
|
|
175
188
|
resourceArn: string | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-dsql",
|
|
3
3
|
"description": "AWS SDK for JavaScript Dsql Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.809.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -20,39 +20,39 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/core": "3.
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/core": "3.808.0",
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.808.0",
|
|
25
25
|
"@aws-sdk/middleware-host-header": "3.804.0",
|
|
26
26
|
"@aws-sdk/middleware-logger": "3.804.0",
|
|
27
27
|
"@aws-sdk/middleware-recursion-detection": "3.804.0",
|
|
28
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
28
|
+
"@aws-sdk/middleware-user-agent": "3.808.0",
|
|
29
|
+
"@aws-sdk/region-config-resolver": "3.808.0",
|
|
30
30
|
"@aws-sdk/types": "3.804.0",
|
|
31
|
-
"@aws-sdk/util-endpoints": "3.
|
|
31
|
+
"@aws-sdk/util-endpoints": "3.808.0",
|
|
32
32
|
"@aws-sdk/util-user-agent-browser": "3.804.0",
|
|
33
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
34
|
-
"@smithy/config-resolver": "^4.1.
|
|
33
|
+
"@aws-sdk/util-user-agent-node": "3.808.0",
|
|
34
|
+
"@smithy/config-resolver": "^4.1.2",
|
|
35
35
|
"@smithy/core": "^3.3.1",
|
|
36
36
|
"@smithy/fetch-http-handler": "^5.0.2",
|
|
37
37
|
"@smithy/hash-node": "^4.0.2",
|
|
38
38
|
"@smithy/invalid-dependency": "^4.0.2",
|
|
39
39
|
"@smithy/middleware-content-length": "^4.0.2",
|
|
40
|
-
"@smithy/middleware-endpoint": "^4.1.
|
|
41
|
-
"@smithy/middleware-retry": "^4.1.
|
|
40
|
+
"@smithy/middleware-endpoint": "^4.1.4",
|
|
41
|
+
"@smithy/middleware-retry": "^4.1.5",
|
|
42
42
|
"@smithy/middleware-serde": "^4.0.3",
|
|
43
43
|
"@smithy/middleware-stack": "^4.0.2",
|
|
44
|
-
"@smithy/node-config-provider": "^4.1.
|
|
44
|
+
"@smithy/node-config-provider": "^4.1.1",
|
|
45
45
|
"@smithy/node-http-handler": "^4.0.4",
|
|
46
46
|
"@smithy/protocol-http": "^5.1.0",
|
|
47
|
-
"@smithy/smithy-client": "^4.2.
|
|
47
|
+
"@smithy/smithy-client": "^4.2.4",
|
|
48
48
|
"@smithy/types": "^4.2.0",
|
|
49
49
|
"@smithy/url-parser": "^4.0.2",
|
|
50
50
|
"@smithy/util-base64": "^4.0.0",
|
|
51
51
|
"@smithy/util-body-length-browser": "^4.0.0",
|
|
52
52
|
"@smithy/util-body-length-node": "^4.0.0",
|
|
53
|
-
"@smithy/util-defaults-mode-browser": "^4.0.
|
|
54
|
-
"@smithy/util-defaults-mode-node": "^4.0.
|
|
55
|
-
"@smithy/util-endpoints": "^3.0.
|
|
53
|
+
"@smithy/util-defaults-mode-browser": "^4.0.12",
|
|
54
|
+
"@smithy/util-defaults-mode-node": "^4.0.12",
|
|
55
|
+
"@smithy/util-endpoints": "^3.0.4",
|
|
56
56
|
"@smithy/util-middleware": "^4.0.2",
|
|
57
57
|
"@smithy/util-retry": "^4.0.3",
|
|
58
58
|
"@smithy/util-utf8": "^4.0.0",
|