@aws-sdk/client-dsql 3.812.0 → 3.816.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 +0 -16
- package/dist-cjs/DSQL.js +0 -4
- package/dist-cjs/commands/index.js +0 -2
- package/dist-cjs/models/models_0.js +11 -1
- package/dist-cjs/protocols/Aws_restJson1.js +5 -65
- package/dist-es/DSQL.js +0 -4
- package/dist-es/commands/index.js +0 -2
- package/dist-es/models/models_0.js +10 -0
- package/dist-es/protocols/Aws_restJson1.js +4 -60
- package/dist-types/DSQL.d.ts +0 -14
- package/dist-types/DSQLClient.d.ts +2 -4
- package/dist-types/commands/CreateClusterCommand.d.ts +39 -39
- package/dist-types/commands/DeleteClusterCommand.d.ts +0 -1
- package/dist-types/commands/GetClusterCommand.d.ts +6 -5
- package/dist-types/commands/UpdateClusterCommand.d.ts +71 -12
- package/dist-types/commands/index.d.ts +0 -2
- package/dist-types/models/models_0.d.ts +67 -128
- package/dist-types/protocols/Aws_restJson1.d.ts +0 -18
- package/dist-types/ts3.4/DSQL.d.ts +0 -34
- package/dist-types/ts3.4/DSQLClient.d.ts +0 -12
- package/dist-types/ts3.4/commands/index.d.ts +0 -2
- package/dist-types/ts3.4/models/models_0.d.ts +23 -23
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +0 -24
- package/package.json +5 -5
- package/dist-cjs/commands/CreateMultiRegionClustersCommand.js +0 -26
- package/dist-cjs/commands/DeleteMultiRegionClustersCommand.js +0 -26
- package/dist-es/commands/CreateMultiRegionClustersCommand.js +0 -22
- package/dist-es/commands/DeleteMultiRegionClustersCommand.js +0 -22
- package/dist-types/commands/CreateMultiRegionClustersCommand.d.ts +0 -132
- package/dist-types/commands/DeleteMultiRegionClustersCommand.d.ts +0 -110
- package/dist-types/ts3.4/commands/CreateMultiRegionClustersCommand.d.ts +0 -51
- package/dist-types/ts3.4/commands/DeleteMultiRegionClustersCommand.d.ts +0 -47
|
@@ -44,20 +44,21 @@ declare const GetClusterCommand_base: {
|
|
|
44
44
|
* // arn: "STRING_VALUE", // required
|
|
45
45
|
* // status: "CREATING" || "ACTIVE" || "IDLE" || "INACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED" || "PENDING_SETUP" || "PENDING_DELETE", // required
|
|
46
46
|
* // creationTime: new Date("TIMESTAMP"), // required
|
|
47
|
-
* // witnessRegion: "STRING_VALUE",
|
|
48
|
-
* // linkedClusterArns: [ // ClusterArnList
|
|
49
|
-
* // "STRING_VALUE",
|
|
50
|
-
* // ],
|
|
51
47
|
* // deletionProtectionEnabled: true || false, // required
|
|
52
48
|
* // multiRegionProperties: { // MultiRegionProperties
|
|
53
49
|
* // witnessRegion: "STRING_VALUE",
|
|
54
|
-
* // clusters: [
|
|
50
|
+
* // clusters: [ // ClusterArnList
|
|
55
51
|
* // "STRING_VALUE",
|
|
56
52
|
* // ],
|
|
57
53
|
* // },
|
|
58
54
|
* // tags: { // TagMap
|
|
59
55
|
* // "<keys>": "STRING_VALUE",
|
|
60
56
|
* // },
|
|
57
|
+
* // encryptionDetails: { // EncryptionDetails
|
|
58
|
+
* // encryptionType: "AWS_OWNED_KMS_KEY" || "CUSTOMER_MANAGED_KMS_KEY", // required
|
|
59
|
+
* // kmsKeyArn: "STRING_VALUE",
|
|
60
|
+
* // encryptionStatus: "ENABLED" || "UPDATING" || "KMS_KEY_INACCESSIBLE" || "ENABLING", // required
|
|
61
|
+
* // },
|
|
61
62
|
* // };
|
|
62
63
|
*
|
|
63
64
|
* ```
|
|
@@ -27,16 +27,79 @@ declare const UpdateClusterCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>The <i>UpdateCluster</i> API allows you to modify both single-Region and multi-Region cluster configurations. With the <i>multiRegionProperties</i> parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.</p>
|
|
31
|
+
* <note>
|
|
32
|
+
* <p>Note that updating multi-region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.</p>
|
|
33
|
+
* </note>
|
|
31
34
|
* <p>
|
|
32
|
-
* <b>
|
|
35
|
+
* <b>Required permissions</b>
|
|
33
36
|
* </p>
|
|
34
|
-
* <
|
|
35
|
-
*
|
|
37
|
+
* <dl>
|
|
38
|
+
* <dt>dsql:UpdateCluster</dt>
|
|
39
|
+
* <dd>
|
|
40
|
+
* <p>Permission to update a DSQL cluster.</p>
|
|
41
|
+
* <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i>
|
|
42
|
+
* </code>
|
|
43
|
+
* </p>
|
|
44
|
+
* </dd>
|
|
45
|
+
* </dl>
|
|
46
|
+
* <dl>
|
|
47
|
+
* <dt>dsql:PutMultiRegionProperties</dt>
|
|
48
|
+
* <dd>
|
|
49
|
+
* <p>Permission to configure multi-Region properties for a cluster.</p>
|
|
50
|
+
* <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i>
|
|
51
|
+
* </code>
|
|
52
|
+
* </p>
|
|
53
|
+
* </dd>
|
|
54
|
+
* </dl>
|
|
55
|
+
* <dl>
|
|
56
|
+
* <dt>dsql:GetCluster</dt>
|
|
57
|
+
* <dd>
|
|
58
|
+
* <p>Permission to retrieve cluster information.</p>
|
|
59
|
+
* <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i>
|
|
60
|
+
* </code>
|
|
61
|
+
* </p>
|
|
62
|
+
* </dd>
|
|
63
|
+
* <dt>dsql:AddPeerCluster</dt>
|
|
64
|
+
* <dd>
|
|
65
|
+
* <p>Permission to add peer clusters.</p>
|
|
66
|
+
* <p>Resources:</p>
|
|
67
|
+
* <ul>
|
|
68
|
+
* <li>
|
|
69
|
+
* <p>Local cluster: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i>
|
|
70
|
+
* </code>
|
|
71
|
+
* </p>
|
|
72
|
+
* </li>
|
|
73
|
+
* <li>
|
|
74
|
+
* <p>Each peer cluster: exact ARN of each specified peer cluster</p>
|
|
75
|
+
* </li>
|
|
76
|
+
* </ul>
|
|
77
|
+
* </dd>
|
|
78
|
+
* <dt>dsql:RemovePeerCluster</dt>
|
|
79
|
+
* <dd>
|
|
80
|
+
* <p>Permission to remove peer clusters. The <i>dsql:RemovePeerCluster</i> permission
|
|
81
|
+
* uses a wildcard ARN pattern to simplify permission management during updates.</p>
|
|
82
|
+
* <p>Resources:
|
|
83
|
+
* <code>arn:aws:dsql:*:<i>account-id</i>:cluster/*</code>
|
|
84
|
+
* </p>
|
|
85
|
+
* </dd>
|
|
86
|
+
* </dl>
|
|
87
|
+
* <dl>
|
|
88
|
+
* <dt>dsql:PutWitnessRegion</dt>
|
|
89
|
+
* <dd>
|
|
90
|
+
* <p>Permission to set a witness Region.</p>
|
|
91
|
+
* <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i>
|
|
92
|
+
* </code>
|
|
93
|
+
* </p>
|
|
94
|
+
* <p>Condition Keys: dsql:WitnessRegion (matching the specified witness
|
|
95
|
+
* Region)</p>
|
|
96
|
+
* <p>
|
|
97
|
+
* <b>This permission is checked both in the cluster Region and in the witness
|
|
98
|
+
* Region.</b>
|
|
99
|
+
* </p>
|
|
100
|
+
* </dd>
|
|
101
|
+
* </dl>
|
|
36
102
|
* <important>
|
|
37
|
-
* <p>
|
|
38
|
-
* <b>Important Notes for Multi-Region Operations</b>
|
|
39
|
-
* </p>
|
|
40
103
|
* <ul>
|
|
41
104
|
* <li>
|
|
42
105
|
* <p>The witness region specified in
|
|
@@ -60,6 +123,7 @@ declare const UpdateClusterCommand_base: {
|
|
|
60
123
|
* const input = { // UpdateClusterInput
|
|
61
124
|
* identifier: "STRING_VALUE", // required
|
|
62
125
|
* deletionProtectionEnabled: true || false,
|
|
126
|
+
* kmsEncryptionKey: "STRING_VALUE",
|
|
63
127
|
* clientToken: "STRING_VALUE",
|
|
64
128
|
* multiRegionProperties: { // MultiRegionProperties
|
|
65
129
|
* witnessRegion: "STRING_VALUE",
|
|
@@ -75,11 +139,6 @@ declare const UpdateClusterCommand_base: {
|
|
|
75
139
|
* // arn: "STRING_VALUE", // required
|
|
76
140
|
* // status: "CREATING" || "ACTIVE" || "IDLE" || "INACTIVE" || "UPDATING" || "DELETING" || "DELETED" || "FAILED" || "PENDING_SETUP" || "PENDING_DELETE", // required
|
|
77
141
|
* // creationTime: new Date("TIMESTAMP"), // required
|
|
78
|
-
* // witnessRegion: "STRING_VALUE",
|
|
79
|
-
* // linkedClusterArns: [ // ClusterArnList
|
|
80
|
-
* // "STRING_VALUE",
|
|
81
|
-
* // ],
|
|
82
|
-
* // deletionProtectionEnabled: true || false, // required
|
|
83
142
|
* // };
|
|
84
143
|
*
|
|
85
144
|
* ```
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
export * from "./CreateClusterCommand";
|
|
2
|
-
export * from "./CreateMultiRegionClustersCommand";
|
|
3
2
|
export * from "./DeleteClusterCommand";
|
|
4
|
-
export * from "./DeleteMultiRegionClustersCommand";
|
|
5
3
|
export * from "./GetClusterCommand";
|
|
6
4
|
export * from "./GetVpcEndpointServiceNameCommand";
|
|
7
5
|
export * from "./ListClustersCommand";
|
|
@@ -80,6 +80,11 @@ export interface CreateClusterInput {
|
|
|
80
80
|
* @public
|
|
81
81
|
*/
|
|
82
82
|
deletionProtectionEnabled?: boolean | undefined;
|
|
83
|
+
/**
|
|
84
|
+
* <p>The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
kmsEncryptionKey?: string | undefined;
|
|
83
88
|
/**
|
|
84
89
|
* <p>A map of key and value pairs to use to tag your cluster.</p>
|
|
85
90
|
* @public
|
|
@@ -102,6 +107,53 @@ export interface CreateClusterInput {
|
|
|
102
107
|
*/
|
|
103
108
|
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
104
109
|
}
|
|
110
|
+
/**
|
|
111
|
+
* @public
|
|
112
|
+
* @enum
|
|
113
|
+
*/
|
|
114
|
+
export declare const EncryptionStatus: {
|
|
115
|
+
readonly ENABLED: "ENABLED";
|
|
116
|
+
readonly ENABLING: "ENABLING";
|
|
117
|
+
readonly KMS_KEY_INACCESSIBLE: "KMS_KEY_INACCESSIBLE";
|
|
118
|
+
readonly UPDATING: "UPDATING";
|
|
119
|
+
};
|
|
120
|
+
/**
|
|
121
|
+
* @public
|
|
122
|
+
*/
|
|
123
|
+
export type EncryptionStatus = (typeof EncryptionStatus)[keyof typeof EncryptionStatus];
|
|
124
|
+
/**
|
|
125
|
+
* @public
|
|
126
|
+
* @enum
|
|
127
|
+
*/
|
|
128
|
+
export declare const EncryptionType: {
|
|
129
|
+
readonly AWS_OWNED_KMS_KEY: "AWS_OWNED_KMS_KEY";
|
|
130
|
+
readonly CUSTOMER_MANAGED_KMS_KEY: "CUSTOMER_MANAGED_KMS_KEY";
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
|
|
136
|
+
/**
|
|
137
|
+
* <p>Configuration details about encryption for the cluster including the KMS key ARN, encryption type, and encryption status.</p>
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
export interface EncryptionDetails {
|
|
141
|
+
/**
|
|
142
|
+
* <p>The type of encryption that protects the data on your cluster.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
encryptionType: EncryptionType | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* <p>The ARN of the KMS key that encrypts data in the cluster.</p>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
kmsKeyArn?: string | undefined;
|
|
151
|
+
/**
|
|
152
|
+
* <p>The status of encryption for the cluster.</p>
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
encryptionStatus: EncryptionStatus | undefined;
|
|
156
|
+
}
|
|
105
157
|
/**
|
|
106
158
|
* <p>The output of a created cluster.</p>
|
|
107
159
|
* @public
|
|
@@ -132,6 +184,11 @@ export interface CreateClusterOutput {
|
|
|
132
184
|
* @public
|
|
133
185
|
*/
|
|
134
186
|
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
187
|
+
/**
|
|
188
|
+
* <p>The encryption configuration for the cluster that was specified during the creation process, including the KMS key identifier and encryption state.</p>
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
191
|
+
encryptionDetails?: EncryptionDetails | undefined;
|
|
135
192
|
/**
|
|
136
193
|
* <p>Whether deletion protection is enabled on this cluster.</p>
|
|
137
194
|
* @public
|
|
@@ -273,69 +330,6 @@ export declare class ValidationException extends __BaseException {
|
|
|
273
330
|
*/
|
|
274
331
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
275
332
|
}
|
|
276
|
-
/**
|
|
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.
|
|
280
|
-
* @public
|
|
281
|
-
*/
|
|
282
|
-
export interface LinkedClusterProperties {
|
|
283
|
-
/**
|
|
284
|
-
* <p>Whether deletion protection is enabled.</p>
|
|
285
|
-
* @public
|
|
286
|
-
*/
|
|
287
|
-
deletionProtectionEnabled?: boolean | undefined;
|
|
288
|
-
/**
|
|
289
|
-
* <p>A map of key and value pairs the linked cluster is tagged with.</p>
|
|
290
|
-
* @public
|
|
291
|
-
*/
|
|
292
|
-
tags?: Record<string, string> | undefined;
|
|
293
|
-
}
|
|
294
|
-
/**
|
|
295
|
-
* @public
|
|
296
|
-
*/
|
|
297
|
-
export interface CreateMultiRegionClustersInput {
|
|
298
|
-
/**
|
|
299
|
-
* <p>An array of the Regions in which you want to create additional clusters.</p>
|
|
300
|
-
*
|
|
301
|
-
* @deprecated
|
|
302
|
-
* @public
|
|
303
|
-
*/
|
|
304
|
-
linkedRegionList: string[] | undefined;
|
|
305
|
-
/**
|
|
306
|
-
* <p>A mapping of properties to use when creating linked clusters.</p>
|
|
307
|
-
*
|
|
308
|
-
* @deprecated
|
|
309
|
-
* @public
|
|
310
|
-
*/
|
|
311
|
-
clusterProperties?: Record<string, LinkedClusterProperties> | undefined;
|
|
312
|
-
/**
|
|
313
|
-
* <p>The witness Region of multi-Region clusters.</p>
|
|
314
|
-
* @public
|
|
315
|
-
*/
|
|
316
|
-
witnessRegion: string | undefined;
|
|
317
|
-
/**
|
|
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>
|
|
325
|
-
* @public
|
|
326
|
-
*/
|
|
327
|
-
clientToken?: string | undefined;
|
|
328
|
-
}
|
|
329
|
-
/**
|
|
330
|
-
* @public
|
|
331
|
-
*/
|
|
332
|
-
export interface CreateMultiRegionClustersOutput {
|
|
333
|
-
/**
|
|
334
|
-
* <p>An array that contains the ARNs of all linked clusters.</p>
|
|
335
|
-
* @public
|
|
336
|
-
*/
|
|
337
|
-
linkedClusterArns: string[] | undefined;
|
|
338
|
-
}
|
|
339
333
|
/**
|
|
340
334
|
* @public
|
|
341
335
|
*/
|
|
@@ -382,13 +376,6 @@ export interface DeleteClusterOutput {
|
|
|
382
376
|
* @public
|
|
383
377
|
*/
|
|
384
378
|
creationTime: Date | undefined;
|
|
385
|
-
/**
|
|
386
|
-
* <p>Specifies whether deletion protection was enabled on the cluster.</p>
|
|
387
|
-
*
|
|
388
|
-
* @deprecated
|
|
389
|
-
* @public
|
|
390
|
-
*/
|
|
391
|
-
deletionProtectionEnabled: boolean | undefined;
|
|
392
379
|
}
|
|
393
380
|
/**
|
|
394
381
|
* <p>The resource could not be found.</p>
|
|
@@ -412,28 +399,6 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
412
399
|
*/
|
|
413
400
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
414
401
|
}
|
|
415
|
-
/**
|
|
416
|
-
* @public
|
|
417
|
-
*/
|
|
418
|
-
export interface DeleteMultiRegionClustersInput {
|
|
419
|
-
/**
|
|
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>
|
|
422
|
-
* @public
|
|
423
|
-
*/
|
|
424
|
-
linkedClusterArns: string[] | undefined;
|
|
425
|
-
/**
|
|
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>
|
|
433
|
-
* @public
|
|
434
|
-
*/
|
|
435
|
-
clientToken?: string | undefined;
|
|
436
|
-
}
|
|
437
402
|
/**
|
|
438
403
|
* @public
|
|
439
404
|
*/
|
|
@@ -469,20 +434,6 @@ export interface GetClusterOutput {
|
|
|
469
434
|
* @public
|
|
470
435
|
*/
|
|
471
436
|
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;
|
|
486
437
|
/**
|
|
487
438
|
* <p>Whether deletion protection is enabled in this cluster.</p>
|
|
488
439
|
* @public
|
|
@@ -498,6 +449,11 @@ export interface GetClusterOutput {
|
|
|
498
449
|
* @public
|
|
499
450
|
*/
|
|
500
451
|
tags?: Record<string, string> | undefined;
|
|
452
|
+
/**
|
|
453
|
+
* <p>The current encryption configuration details for the cluster.</p>
|
|
454
|
+
* @public
|
|
455
|
+
*/
|
|
456
|
+
encryptionDetails?: EncryptionDetails | undefined;
|
|
501
457
|
}
|
|
502
458
|
/**
|
|
503
459
|
* @public
|
|
@@ -584,6 +540,11 @@ export interface UpdateClusterInput {
|
|
|
584
540
|
* @public
|
|
585
541
|
*/
|
|
586
542
|
deletionProtectionEnabled?: boolean | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p>The KMS key that encrypts and protects the data on your cluster. You can specify the ARN, ID, or alias of an existing key or have Amazon Web Services create a default key for you.</p>
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
547
|
+
kmsEncryptionKey?: string | undefined;
|
|
587
548
|
/**
|
|
588
549
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
589
550
|
* request. Idempotency ensures that an API request completes only once. With an idempotent
|
|
@@ -626,28 +587,6 @@ export interface UpdateClusterOutput {
|
|
|
626
587
|
* @public
|
|
627
588
|
*/
|
|
628
589
|
creationTime: Date | undefined;
|
|
629
|
-
/**
|
|
630
|
-
* <p>The Region that receives all data you write to linked clusters.</p>
|
|
631
|
-
*
|
|
632
|
-
* @deprecated
|
|
633
|
-
* @public
|
|
634
|
-
*/
|
|
635
|
-
witnessRegion?: string | undefined;
|
|
636
|
-
/**
|
|
637
|
-
* <p>The ARNs of the clusters linked to the updated cluster. Applicable only for multi-Region
|
|
638
|
-
* clusters.</p>
|
|
639
|
-
*
|
|
640
|
-
* @deprecated
|
|
641
|
-
* @public
|
|
642
|
-
*/
|
|
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;
|
|
651
590
|
}
|
|
652
591
|
/**
|
|
653
592
|
* @public
|
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
|
|
2
2
|
import { SerdeContext as __SerdeContext } from "@smithy/types";
|
|
3
3
|
import { CreateClusterCommandInput, CreateClusterCommandOutput } from "../commands/CreateClusterCommand";
|
|
4
|
-
import { CreateMultiRegionClustersCommandInput, CreateMultiRegionClustersCommandOutput } from "../commands/CreateMultiRegionClustersCommand";
|
|
5
4
|
import { DeleteClusterCommandInput, DeleteClusterCommandOutput } from "../commands/DeleteClusterCommand";
|
|
6
|
-
import { DeleteMultiRegionClustersCommandInput, DeleteMultiRegionClustersCommandOutput } from "../commands/DeleteMultiRegionClustersCommand";
|
|
7
5
|
import { GetClusterCommandInput, GetClusterCommandOutput } from "../commands/GetClusterCommand";
|
|
8
6
|
import { GetVpcEndpointServiceNameCommandInput, GetVpcEndpointServiceNameCommandOutput } from "../commands/GetVpcEndpointServiceNameCommand";
|
|
9
7
|
import { ListClustersCommandInput, ListClustersCommandOutput } from "../commands/ListClustersCommand";
|
|
@@ -15,18 +13,10 @@ import { UpdateClusterCommandInput, UpdateClusterCommandOutput } from "../comman
|
|
|
15
13
|
* serializeAws_restJson1CreateClusterCommand
|
|
16
14
|
*/
|
|
17
15
|
export declare const se_CreateClusterCommand: (input: CreateClusterCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
18
|
-
/**
|
|
19
|
-
* serializeAws_restJson1CreateMultiRegionClustersCommand
|
|
20
|
-
*/
|
|
21
|
-
export declare const se_CreateMultiRegionClustersCommand: (input: CreateMultiRegionClustersCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
22
16
|
/**
|
|
23
17
|
* serializeAws_restJson1DeleteClusterCommand
|
|
24
18
|
*/
|
|
25
19
|
export declare const se_DeleteClusterCommand: (input: DeleteClusterCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
26
|
-
/**
|
|
27
|
-
* serializeAws_restJson1DeleteMultiRegionClustersCommand
|
|
28
|
-
*/
|
|
29
|
-
export declare const se_DeleteMultiRegionClustersCommand: (input: DeleteMultiRegionClustersCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
30
20
|
/**
|
|
31
21
|
* serializeAws_restJson1GetClusterCommand
|
|
32
22
|
*/
|
|
@@ -59,18 +49,10 @@ export declare const se_UpdateClusterCommand: (input: UpdateClusterCommandInput,
|
|
|
59
49
|
* deserializeAws_restJson1CreateClusterCommand
|
|
60
50
|
*/
|
|
61
51
|
export declare const de_CreateClusterCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateClusterCommandOutput>;
|
|
62
|
-
/**
|
|
63
|
-
* deserializeAws_restJson1CreateMultiRegionClustersCommand
|
|
64
|
-
*/
|
|
65
|
-
export declare const de_CreateMultiRegionClustersCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateMultiRegionClustersCommandOutput>;
|
|
66
52
|
/**
|
|
67
53
|
* deserializeAws_restJson1DeleteClusterCommand
|
|
68
54
|
*/
|
|
69
55
|
export declare const de_DeleteClusterCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteClusterCommandOutput>;
|
|
70
|
-
/**
|
|
71
|
-
* deserializeAws_restJson1DeleteMultiRegionClustersCommand
|
|
72
|
-
*/
|
|
73
|
-
export declare const de_DeleteMultiRegionClustersCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteMultiRegionClustersCommandOutput>;
|
|
74
56
|
/**
|
|
75
57
|
* deserializeAws_restJson1GetClusterCommand
|
|
76
58
|
*/
|
|
@@ -3,18 +3,10 @@ import {
|
|
|
3
3
|
CreateClusterCommandInput,
|
|
4
4
|
CreateClusterCommandOutput,
|
|
5
5
|
} from "./commands/CreateClusterCommand";
|
|
6
|
-
import {
|
|
7
|
-
CreateMultiRegionClustersCommandInput,
|
|
8
|
-
CreateMultiRegionClustersCommandOutput,
|
|
9
|
-
} from "./commands/CreateMultiRegionClustersCommand";
|
|
10
6
|
import {
|
|
11
7
|
DeleteClusterCommandInput,
|
|
12
8
|
DeleteClusterCommandOutput,
|
|
13
9
|
} from "./commands/DeleteClusterCommand";
|
|
14
|
-
import {
|
|
15
|
-
DeleteMultiRegionClustersCommandInput,
|
|
16
|
-
DeleteMultiRegionClustersCommandOutput,
|
|
17
|
-
} from "./commands/DeleteMultiRegionClustersCommand";
|
|
18
10
|
import {
|
|
19
11
|
GetClusterCommandInput,
|
|
20
12
|
GetClusterCommandOutput,
|
|
@@ -59,19 +51,6 @@ export interface DSQL {
|
|
|
59
51
|
options: __HttpHandlerOptions,
|
|
60
52
|
cb: (err: any, data?: CreateClusterCommandOutput) => void
|
|
61
53
|
): void;
|
|
62
|
-
createMultiRegionClusters(
|
|
63
|
-
args: CreateMultiRegionClustersCommandInput,
|
|
64
|
-
options?: __HttpHandlerOptions
|
|
65
|
-
): Promise<CreateMultiRegionClustersCommandOutput>;
|
|
66
|
-
createMultiRegionClusters(
|
|
67
|
-
args: CreateMultiRegionClustersCommandInput,
|
|
68
|
-
cb: (err: any, data?: CreateMultiRegionClustersCommandOutput) => void
|
|
69
|
-
): void;
|
|
70
|
-
createMultiRegionClusters(
|
|
71
|
-
args: CreateMultiRegionClustersCommandInput,
|
|
72
|
-
options: __HttpHandlerOptions,
|
|
73
|
-
cb: (err: any, data?: CreateMultiRegionClustersCommandOutput) => void
|
|
74
|
-
): void;
|
|
75
54
|
deleteCluster(
|
|
76
55
|
args: DeleteClusterCommandInput,
|
|
77
56
|
options?: __HttpHandlerOptions
|
|
@@ -85,19 +64,6 @@ export interface DSQL {
|
|
|
85
64
|
options: __HttpHandlerOptions,
|
|
86
65
|
cb: (err: any, data?: DeleteClusterCommandOutput) => void
|
|
87
66
|
): void;
|
|
88
|
-
deleteMultiRegionClusters(
|
|
89
|
-
args: DeleteMultiRegionClustersCommandInput,
|
|
90
|
-
options?: __HttpHandlerOptions
|
|
91
|
-
): Promise<DeleteMultiRegionClustersCommandOutput>;
|
|
92
|
-
deleteMultiRegionClusters(
|
|
93
|
-
args: DeleteMultiRegionClustersCommandInput,
|
|
94
|
-
cb: (err: any, data?: DeleteMultiRegionClustersCommandOutput) => void
|
|
95
|
-
): void;
|
|
96
|
-
deleteMultiRegionClusters(
|
|
97
|
-
args: DeleteMultiRegionClustersCommandInput,
|
|
98
|
-
options: __HttpHandlerOptions,
|
|
99
|
-
cb: (err: any, data?: DeleteMultiRegionClustersCommandOutput) => void
|
|
100
|
-
): void;
|
|
101
67
|
getCluster(
|
|
102
68
|
args: GetClusterCommandInput,
|
|
103
69
|
options?: __HttpHandlerOptions
|
|
@@ -49,18 +49,10 @@ import {
|
|
|
49
49
|
CreateClusterCommandInput,
|
|
50
50
|
CreateClusterCommandOutput,
|
|
51
51
|
} from "./commands/CreateClusterCommand";
|
|
52
|
-
import {
|
|
53
|
-
CreateMultiRegionClustersCommandInput,
|
|
54
|
-
CreateMultiRegionClustersCommandOutput,
|
|
55
|
-
} from "./commands/CreateMultiRegionClustersCommand";
|
|
56
52
|
import {
|
|
57
53
|
DeleteClusterCommandInput,
|
|
58
54
|
DeleteClusterCommandOutput,
|
|
59
55
|
} from "./commands/DeleteClusterCommand";
|
|
60
|
-
import {
|
|
61
|
-
DeleteMultiRegionClustersCommandInput,
|
|
62
|
-
DeleteMultiRegionClustersCommandOutput,
|
|
63
|
-
} from "./commands/DeleteMultiRegionClustersCommand";
|
|
64
56
|
import {
|
|
65
57
|
GetClusterCommandInput,
|
|
66
58
|
GetClusterCommandOutput,
|
|
@@ -98,9 +90,7 @@ import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
|
98
90
|
export { __Client };
|
|
99
91
|
export type ServiceInputTypes =
|
|
100
92
|
| CreateClusterCommandInput
|
|
101
|
-
| CreateMultiRegionClustersCommandInput
|
|
102
93
|
| DeleteClusterCommandInput
|
|
103
|
-
| DeleteMultiRegionClustersCommandInput
|
|
104
94
|
| GetClusterCommandInput
|
|
105
95
|
| GetVpcEndpointServiceNameCommandInput
|
|
106
96
|
| ListClustersCommandInput
|
|
@@ -110,9 +100,7 @@ export type ServiceInputTypes =
|
|
|
110
100
|
| UpdateClusterCommandInput;
|
|
111
101
|
export type ServiceOutputTypes =
|
|
112
102
|
| CreateClusterCommandOutput
|
|
113
|
-
| CreateMultiRegionClustersCommandOutput
|
|
114
103
|
| DeleteClusterCommandOutput
|
|
115
|
-
| DeleteMultiRegionClustersCommandOutput
|
|
116
104
|
| GetClusterCommandOutput
|
|
117
105
|
| GetVpcEndpointServiceNameCommandOutput
|
|
118
106
|
| ListClustersCommandOutput
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
export * from "./CreateClusterCommand";
|
|
2
|
-
export * from "./CreateMultiRegionClustersCommand";
|
|
3
2
|
export * from "./DeleteClusterCommand";
|
|
4
|
-
export * from "./DeleteMultiRegionClustersCommand";
|
|
5
3
|
export * from "./GetClusterCommand";
|
|
6
4
|
export * from "./GetVpcEndpointServiceNameCommand";
|
|
7
5
|
export * from "./ListClustersCommand";
|
|
@@ -33,16 +33,37 @@ export interface MultiRegionProperties {
|
|
|
33
33
|
}
|
|
34
34
|
export interface CreateClusterInput {
|
|
35
35
|
deletionProtectionEnabled?: boolean | undefined;
|
|
36
|
+
kmsEncryptionKey?: string | undefined;
|
|
36
37
|
tags?: Record<string, string> | undefined;
|
|
37
38
|
clientToken?: string | undefined;
|
|
38
39
|
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
39
40
|
}
|
|
41
|
+
export declare const EncryptionStatus: {
|
|
42
|
+
readonly ENABLED: "ENABLED";
|
|
43
|
+
readonly ENABLING: "ENABLING";
|
|
44
|
+
readonly KMS_KEY_INACCESSIBLE: "KMS_KEY_INACCESSIBLE";
|
|
45
|
+
readonly UPDATING: "UPDATING";
|
|
46
|
+
};
|
|
47
|
+
export type EncryptionStatus =
|
|
48
|
+
(typeof EncryptionStatus)[keyof typeof EncryptionStatus];
|
|
49
|
+
export declare const EncryptionType: {
|
|
50
|
+
readonly AWS_OWNED_KMS_KEY: "AWS_OWNED_KMS_KEY";
|
|
51
|
+
readonly CUSTOMER_MANAGED_KMS_KEY: "CUSTOMER_MANAGED_KMS_KEY";
|
|
52
|
+
};
|
|
53
|
+
export type EncryptionType =
|
|
54
|
+
(typeof EncryptionType)[keyof typeof EncryptionType];
|
|
55
|
+
export interface EncryptionDetails {
|
|
56
|
+
encryptionType: EncryptionType | undefined;
|
|
57
|
+
kmsKeyArn?: string | undefined;
|
|
58
|
+
encryptionStatus: EncryptionStatus | undefined;
|
|
59
|
+
}
|
|
40
60
|
export interface CreateClusterOutput {
|
|
41
61
|
identifier: string | undefined;
|
|
42
62
|
arn: string | undefined;
|
|
43
63
|
status: ClusterStatus | undefined;
|
|
44
64
|
creationTime: Date | undefined;
|
|
45
65
|
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
66
|
+
encryptionDetails?: EncryptionDetails | undefined;
|
|
46
67
|
deletionProtectionEnabled: boolean | undefined;
|
|
47
68
|
}
|
|
48
69
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -100,19 +121,6 @@ export declare class ValidationException extends __BaseException {
|
|
|
100
121
|
opts: __ExceptionOptionType<ValidationException, __BaseException>
|
|
101
122
|
);
|
|
102
123
|
}
|
|
103
|
-
export interface LinkedClusterProperties {
|
|
104
|
-
deletionProtectionEnabled?: boolean | undefined;
|
|
105
|
-
tags?: Record<string, string> | undefined;
|
|
106
|
-
}
|
|
107
|
-
export interface CreateMultiRegionClustersInput {
|
|
108
|
-
linkedRegionList: string[] | undefined;
|
|
109
|
-
clusterProperties?: Record<string, LinkedClusterProperties> | undefined;
|
|
110
|
-
witnessRegion: string | undefined;
|
|
111
|
-
clientToken?: string | undefined;
|
|
112
|
-
}
|
|
113
|
-
export interface CreateMultiRegionClustersOutput {
|
|
114
|
-
linkedClusterArns: string[] | undefined;
|
|
115
|
-
}
|
|
116
124
|
export interface DeleteClusterInput {
|
|
117
125
|
identifier: string | undefined;
|
|
118
126
|
clientToken?: string | undefined;
|
|
@@ -122,7 +130,6 @@ export interface DeleteClusterOutput {
|
|
|
122
130
|
arn: string | undefined;
|
|
123
131
|
status: ClusterStatus | undefined;
|
|
124
132
|
creationTime: Date | undefined;
|
|
125
|
-
deletionProtectionEnabled: boolean | undefined;
|
|
126
133
|
}
|
|
127
134
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
128
135
|
readonly name: "ResourceNotFoundException";
|
|
@@ -133,10 +140,6 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
133
140
|
opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
|
|
134
141
|
);
|
|
135
142
|
}
|
|
136
|
-
export interface DeleteMultiRegionClustersInput {
|
|
137
|
-
linkedClusterArns: string[] | undefined;
|
|
138
|
-
clientToken?: string | undefined;
|
|
139
|
-
}
|
|
140
143
|
export interface GetClusterInput {
|
|
141
144
|
identifier: string | undefined;
|
|
142
145
|
}
|
|
@@ -145,11 +148,10 @@ export interface GetClusterOutput {
|
|
|
145
148
|
arn: string | undefined;
|
|
146
149
|
status: ClusterStatus | undefined;
|
|
147
150
|
creationTime: Date | undefined;
|
|
148
|
-
witnessRegion?: string | undefined;
|
|
149
|
-
linkedClusterArns?: string[] | undefined;
|
|
150
151
|
deletionProtectionEnabled: boolean | undefined;
|
|
151
152
|
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
152
153
|
tags?: Record<string, string> | undefined;
|
|
154
|
+
encryptionDetails?: EncryptionDetails | undefined;
|
|
153
155
|
}
|
|
154
156
|
export interface GetVpcEndpointServiceNameInput {
|
|
155
157
|
identifier: string | undefined;
|
|
@@ -172,6 +174,7 @@ export interface ListClustersOutput {
|
|
|
172
174
|
export interface UpdateClusterInput {
|
|
173
175
|
identifier: string | undefined;
|
|
174
176
|
deletionProtectionEnabled?: boolean | undefined;
|
|
177
|
+
kmsEncryptionKey?: string | undefined;
|
|
175
178
|
clientToken?: string | undefined;
|
|
176
179
|
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
177
180
|
}
|
|
@@ -180,9 +183,6 @@ export interface UpdateClusterOutput {
|
|
|
180
183
|
arn: string | undefined;
|
|
181
184
|
status: ClusterStatus | undefined;
|
|
182
185
|
creationTime: Date | undefined;
|
|
183
|
-
witnessRegion?: string | undefined;
|
|
184
|
-
linkedClusterArns?: string[] | undefined;
|
|
185
|
-
deletionProtectionEnabled: boolean | undefined;
|
|
186
186
|
}
|
|
187
187
|
export interface ListTagsForResourceInput {
|
|
188
188
|
resourceArn: string | undefined;
|