Skip to content

Commit 38ba363

Browse files
author
awstools
committed
feat(client-dsql): CreateMultiRegionCluster and DeleteMultiRegionCluster APIs removed
1 parent 374726f commit 38ba363

13 files changed

+106
-965
lines changed

‎clients/client-dsql/README.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -215,14 +215,6 @@ CreateCluster
215215

216216
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dsql/command/CreateClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/CreateClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/CreateClusterCommandOutput/)
217217

218-
</details>
219-
<details>
220-
<summary>
221-
CreateMultiRegionClusters
222-
</summary>
223-
224-
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dsql/command/CreateMultiRegionClustersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/CreateMultiRegionClustersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/CreateMultiRegionClustersCommandOutput/)
225-
226218
</details>
227219
<details>
228220
<summary>
@@ -231,14 +223,6 @@ DeleteCluster
231223

232224
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dsql/command/DeleteClusterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/DeleteClusterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/DeleteClusterCommandOutput/)
233225

234-
</details>
235-
<details>
236-
<summary>
237-
DeleteMultiRegionClusters
238-
</summary>
239-
240-
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dsql/command/DeleteMultiRegionClustersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/DeleteMultiRegionClustersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-dsql/Interface/DeleteMultiRegionClustersCommandOutput/)
241-
242226
</details>
243227
<details>
244228
<summary>

‎clients/client-dsql/src/DSQL.ts

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,11 @@ import {
77
CreateClusterCommandInput,
88
CreateClusterCommandOutput,
99
} from "./commands/CreateClusterCommand";
10-
import {
11-
CreateMultiRegionClustersCommand,
12-
CreateMultiRegionClustersCommandInput,
13-
CreateMultiRegionClustersCommandOutput,
14-
} from "./commands/CreateMultiRegionClustersCommand";
1510
import {
1611
DeleteClusterCommand,
1712
DeleteClusterCommandInput,
1813
DeleteClusterCommandOutput,
1914
} from "./commands/DeleteClusterCommand";
20-
import {
21-
DeleteMultiRegionClustersCommand,
22-
DeleteMultiRegionClustersCommandInput,
23-
DeleteMultiRegionClustersCommandOutput,
24-
} from "./commands/DeleteMultiRegionClustersCommand";
2515
import { GetClusterCommand, GetClusterCommandInput, GetClusterCommandOutput } from "./commands/GetClusterCommand";
2616
import {
2717
GetVpcEndpointServiceNameCommand,
@@ -53,9 +43,7 @@ import { DSQLClient, DSQLClientConfig } from "./DSQLClient";
5343

5444
const commands = {
5545
CreateClusterCommand,
56-
CreateMultiRegionClustersCommand,
5746
DeleteClusterCommand,
58-
DeleteMultiRegionClustersCommand,
5947
GetClusterCommand,
6048
GetVpcEndpointServiceNameCommand,
6149
ListClustersCommand,
@@ -78,23 +66,6 @@ export interface DSQL {
7866
cb: (err: any, data?: CreateClusterCommandOutput) => void
7967
): void;
8068

81-
/**
82-
* @see {@link CreateMultiRegionClustersCommand}
83-
*/
84-
createMultiRegionClusters(
85-
args: CreateMultiRegionClustersCommandInput,
86-
options?: __HttpHandlerOptions
87-
): Promise<CreateMultiRegionClustersCommandOutput>;
88-
createMultiRegionClusters(
89-
args: CreateMultiRegionClustersCommandInput,
90-
cb: (err: any, data?: CreateMultiRegionClustersCommandOutput) => void
91-
): void;
92-
createMultiRegionClusters(
93-
args: CreateMultiRegionClustersCommandInput,
94-
options: __HttpHandlerOptions,
95-
cb: (err: any, data?: CreateMultiRegionClustersCommandOutput) => void
96-
): void;
97-
9869
/**
9970
* @see {@link DeleteClusterCommand}
10071
*/
@@ -106,23 +77,6 @@ export interface DSQL {
10677
cb: (err: any, data?: DeleteClusterCommandOutput) => void
10778
): void;
10879

109-
/**
110-
* @see {@link DeleteMultiRegionClustersCommand}
111-
*/
112-
deleteMultiRegionClusters(
113-
args: DeleteMultiRegionClustersCommandInput,
114-
options?: __HttpHandlerOptions
115-
): Promise<DeleteMultiRegionClustersCommandOutput>;
116-
deleteMultiRegionClusters(
117-
args: DeleteMultiRegionClustersCommandInput,
118-
cb: (err: any, data?: DeleteMultiRegionClustersCommandOutput) => void
119-
): void;
120-
deleteMultiRegionClusters(
121-
args: DeleteMultiRegionClustersCommandInput,
122-
options: __HttpHandlerOptions,
123-
cb: (err: any, data?: DeleteMultiRegionClustersCommandOutput) => void
124-
): void;
125-
12680
/**
12781
* @see {@link GetClusterCommand}
12882
*/

‎clients/client-dsql/src/DSQLClient.ts

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,7 @@ import {
5454
resolveHttpAuthSchemeConfig,
5555
} from "./auth/httpAuthSchemeProvider";
5656
import { CreateClusterCommandInput, CreateClusterCommandOutput } from "./commands/CreateClusterCommand";
57-
import {
58-
CreateMultiRegionClustersCommandInput,
59-
CreateMultiRegionClustersCommandOutput,
60-
} from "./commands/CreateMultiRegionClustersCommand";
6157
import { DeleteClusterCommandInput, DeleteClusterCommandOutput } from "./commands/DeleteClusterCommand";
62-
import {
63-
DeleteMultiRegionClustersCommandInput,
64-
DeleteMultiRegionClustersCommandOutput,
65-
} from "./commands/DeleteMultiRegionClustersCommand";
6658
import { GetClusterCommandInput, GetClusterCommandOutput } from "./commands/GetClusterCommand";
6759
import {
6860
GetVpcEndpointServiceNameCommandInput,
@@ -92,9 +84,7 @@ export { __Client };
9284
*/
9385
export type ServiceInputTypes =
9486
| CreateClusterCommandInput
95-
| CreateMultiRegionClustersCommandInput
9687
| DeleteClusterCommandInput
97-
| DeleteMultiRegionClustersCommandInput
9888
| GetClusterCommandInput
9989
| GetVpcEndpointServiceNameCommandInput
10090
| ListClustersCommandInput
@@ -108,9 +98,7 @@ export type ServiceInputTypes =
10898
*/
10999
export type ServiceOutputTypes =
110100
| CreateClusterCommandOutput
111-
| CreateMultiRegionClustersCommandOutput
112101
| DeleteClusterCommandOutput
113-
| DeleteMultiRegionClustersCommandOutput
114102
| GetClusterCommandOutput
115103
| GetVpcEndpointServiceNameCommandOutput
116104
| ListClustersCommandOutput

‎clients/client-dsql/src/commands/CreateClusterCommand.ts

Lines changed: 33 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -28,75 +28,69 @@ export interface CreateClusterCommandInput extends CreateClusterInput {}
2828
export interface CreateClusterCommandOutput extends CreateClusterOutput, __MetadataBearer {}
2929

3030
/**
31-
* <p>This operation creates a cluster in Amazon Aurora DSQL. You need the following permissions to
32-
* use this operation.</p>
33-
* <p>Permission to create a cluster.</p>
31+
* <p>The CreateCluster API allows you to create both single-region clusters and multi-Region
32+
* clusters. With the addition of the <i>multiRegionProperties</i> parameter,
33+
* you can create a cluster with witness Region support and establish peer relationships with
34+
* clusters in other Regions during creation.</p>
35+
* <note>
36+
* <p>Creating multi-Region clusters requires additional IAM permissions beyond those
37+
* needed for single-Region clusters, as detailed in the <b>Required permissions</b> section
38+
* below.</p>
39+
* </note>
40+
* <p>
41+
* <b>Required permissions</b>
42+
* </p>
3443
* <dl>
3544
* <dt>dsql:CreateCluster</dt>
3645
* <dd>
37-
* <p>Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p>
46+
* <p>Required to create a cluster.</p>
47+
* <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code>
48+
* </p>
3849
* </dd>
39-
* </dl>
40-
* <p> Permission to add tags to a resource.</p>
41-
* <dl>
4250
* <dt>dsql:TagResource</dt>
4351
* <dd>
44-
* <p>Resources:
45-
* arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p>
52+
* <p>Permission to add tags to a resource.</p>
53+
* <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code>
54+
* </p>
4655
* </dd>
47-
* </dl>
48-
* <p>Permission to configure multi-region properties for
49-
* a cluster.</p>
50-
* <dl>
5156
* <dt>dsql:PutMultiRegionProperties</dt>
5257
* <dd>
53-
* <p>Resources:
54-
* arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p>
58+
* <p>Permission to configure multi-region properties for a cluster.</p>
59+
* <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code>
60+
* </p>
5561
* </dd>
56-
* </dl>
57-
* <p>When specifying multiRegionProperties.clusters.</p>
58-
* <dl>
5962
* <dt>dsql:AddPeerCluster</dt>
6063
* <dd>
61-
* <p>Permission to add peer clusters.</p>
64+
* <p>When specifying <code>multiRegionProperties.clusters</code>, permission to
65+
* add peer clusters.</p>
6266
* <p>Resources:</p>
6367
* <ul>
6468
* <li>
65-
* <p>Local cluster: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p>
69+
* <p>Local cluster: <code>arn:aws:dsql:region:account-id:cluster/*</code>
70+
* </p>
6671
* </li>
6772
* <li>
6873
* <p>Each peer cluster: exact ARN of each specified peer cluster</p>
6974
* </li>
7075
* </ul>
7176
* </dd>
72-
* </dl>
73-
* <p>When specifying multiRegionProperties.witnessRegion.</p>
74-
* <dl>
7577
* <dt>dsql:PutWitnessRegion</dt>
7678
* <dd>
77-
* <p>Permission to set a witness region.</p>
78-
* <p>Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p>
79-
* <p>Condition Keys: <code>dsql:WitnessRegion</code> (matching the specified
80-
* witness region)</p>
81-
* <note>
82-
* <p>This permission is checked both in the cluster Region and in the witness
83-
* Region.</p>
84-
* </note>
79+
* <p>When specifying <code>multiRegionProperties.witnessRegion</code>, permission
80+
* to set a witness Region. This permission is checked both in the cluster Region and
81+
* in the witness Region.</p>
82+
* <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code>
83+
* </p>
84+
* <p>Condition Keys: <code>dsql:WitnessRegion</code> (matching the specified witness region)</p>
8585
* </dd>
8686
* </dl>
8787
* <important>
88-
* <p>
89-
* <b>Important Notes for Multi-Region Operations</b>
90-
* </p>
9188
* <ul>
9289
* <li>
93-
* <p>The witness region specified in
94-
* <code>multiRegionProperties.witnessRegion</code> cannot be the same as the
90+
* <p>The witness Region specified in
91+
* <code>multiRegionProperties.witnessRegion</code> cannot be the same as the
9592
* cluster's Region.</p>
9693
* </li>
97-
* <li>
98-
* <p>When updating clusters with peer relationships, permissions are checked for both adding and removing peers.</p>
99-
* </li>
10094
* </ul>
10195
* </important>
10296
* @example

0 commit comments

Comments
 (0)