Skip to content

Commit 647406d

Browse files
author
awstools
committed
feat(client-dsql): Cluster endpoint added to CreateCluster and GetCluster API responses
1 parent 78a69dc commit 647406d

19 files changed

+2178
-2355
lines changed

clients/client-dsql/README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,7 @@
66

77
AWS SDK for JavaScript DSQL Client for Node.js, Browser and React Native.
88

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>
9+
<p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p> <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. is available in both single-Region and multi-Region configurations, so your 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 acquire new insights for your business and customers.</p>
1510

1611
## Installing
1712

clients/client-dsql/src/DSQL.ts

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -238,12 +238,7 @@ export interface DSQL {
238238
}
239239

240240
/**
241-
* <p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the
242-
* programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p>
243-
* <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size.
244-
* is available in both single-Region and multi-Region configurations, so your
245-
* 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
246-
* acquire new insights for your business and customers.</p>
241+
* <p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p> <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. is available in both single-Region and multi-Region configurations, so your 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 acquire new insights for your business and customers.</p>
247242
* @public
248243
*/
249244
export class DSQL extends DSQLClient implements DSQL {}

clients/client-dsql/src/DSQLClient.ts

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -310,12 +310,7 @@ export type DSQLClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpH
310310
export interface DSQLClientResolvedConfig extends DSQLClientResolvedConfigType {}
311311

312312
/**
313-
* <p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the
314-
* programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p>
315-
* <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size.
316-
* is available in both single-Region and multi-Region configurations, so your
317-
* 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
318-
* acquire new insights for your business and customers.</p>
313+
* <p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p> <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. is available in both single-Region and multi-Region configurations, so your 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 acquire new insights for your business and customers.</p>
319314
* @public
320315
*/
321316
export class DSQLClient extends __Client<

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

Lines changed: 3 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -28,71 +28,7 @@ export interface CreateClusterCommandInput extends CreateClusterInput {}
2828
export interface CreateClusterCommandOutput extends CreateClusterOutput, __MetadataBearer {}
2929

3030
/**
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>
43-
* <dl>
44-
* <dt>dsql:CreateCluster</dt>
45-
* <dd>
46-
* <p>Required to create a cluster.</p>
47-
* <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code>
48-
* </p>
49-
* </dd>
50-
* <dt>dsql:TagResource</dt>
51-
* <dd>
52-
* <p>Permission to add tags to a resource.</p>
53-
* <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code>
54-
* </p>
55-
* </dd>
56-
* <dt>dsql:PutMultiRegionProperties</dt>
57-
* <dd>
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>
61-
* </dd>
62-
* <dt>dsql:AddPeerCluster</dt>
63-
* <dd>
64-
* <p>When specifying <code>multiRegionProperties.clusters</code>, permission to
65-
* add peer clusters.</p>
66-
* <p>Resources:</p>
67-
* <ul>
68-
* <li>
69-
* <p>Local cluster: <code>arn:aws:dsql:region:account-id:cluster/*</code>
70-
* </p>
71-
* </li>
72-
* <li>
73-
* <p>Each peer cluster: exact ARN of each specified peer cluster</p>
74-
* </li>
75-
* </ul>
76-
* </dd>
77-
* <dt>dsql:PutWitnessRegion</dt>
78-
* <dd>
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>
85-
* </dd>
86-
* </dl>
87-
* <important>
88-
* <ul>
89-
* <li>
90-
* <p>The witness Region specified in
91-
* <code>multiRegionProperties.witnessRegion</code> cannot be the same as the
92-
* cluster's Region.</p>
93-
* </li>
94-
* </ul>
95-
* </important>
31+
* <p>The CreateCluster API allows you to create both single-Region clusters and multi-Region clusters. With the addition of the <i>multiRegionProperties</i> parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation.</p> <note> <p>Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the <b>Required permissions</b> section below.</p> </note> <p> <b>Required permissions</b> </p> <dl> <dt>dsql:CreateCluster</dt> <dd> <p>Required to create a cluster.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </dd> <dt>dsql:TagResource</dt> <dd> <p>Permission to add tags to a resource.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </dd> <dt>dsql:PutMultiRegionProperties</dt> <dd> <p>Permission to configure multi-Region properties for a cluster.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </dd> <dt>dsql:AddPeerCluster</dt> <dd> <p>When specifying <code>multiRegionProperties.clusters</code>, permission to add peer clusters.</p> <p>Resources:</p> <ul> <li> <p>Local cluster: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </li> <li> <p>Each peer cluster: exact ARN of each specified peer cluster</p> </li> </ul> </dd> <dt>dsql:PutWitnessRegion</dt> <dd> <p>When specifying <code>multiRegionProperties.witnessRegion</code>, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> <p>Condition Keys: <code>dsql:WitnessRegion</code> (matching the specified witness region)</p> </dd> </dl> <important> <ul> <li> <p>The witness Region specified in <code>multiRegionProperties.witnessRegion</code> cannot be the same as the cluster's Region.</p> </li> </ul> </important>
9632
* @example
9733
* Use a bare-bones client and the command you need to make an API call.
9834
* ```javascript
@@ -136,6 +72,7 @@ export interface CreateClusterCommandOutput extends CreateClusterOutput, __Metad
13672
* // encryptionStatus: "ENABLED" || "UPDATING" || "KMS_KEY_INACCESSIBLE" || "ENABLING", // required
13773
* // },
13874
* // deletionProtectionEnabled: true || false, // required
75+
* // endpoint: "STRING_VALUE",
13976
* // };
14077
*
14178
* ```
@@ -159,8 +96,7 @@ export interface CreateClusterCommandOutput extends CreateClusterOutput, __Metad
15996
* <p>You do not have sufficient access to perform this action.</p>
16097
*
16198
* @throws {@link InternalServerException} (server fault)
162-
* <p>The request processing has failed because of an unknown error, exception or
163-
* failure.</p>
99+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
164100
*
165101
* @throws {@link ThrottlingException} (client fault)
166102
* <p>The request was denied due to request throttling.</p>

clients/client-dsql/src/commands/DeleteClusterCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ export interface DeleteClusterCommandOutput extends DeleteClusterOutput, __Metad
6868
* <p>You do not have sufficient access to perform this action.</p>
6969
*
7070
* @throws {@link InternalServerException} (server fault)
71-
* <p>The request processing has failed because of an unknown error, exception or
72-
* failure.</p>
71+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
7372
*
7473
* @throws {@link ThrottlingException} (client fault)
7574
* <p>The request was denied due to request throttling.</p>

clients/client-dsql/src/commands/DeleteClusterPolicyCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ export interface DeleteClusterPolicyCommandOutput extends DeleteClusterPolicyOut
6969
* <p>You do not have sufficient access to perform this action.</p>
7070
*
7171
* @throws {@link InternalServerException} (server fault)
72-
* <p>The request processing has failed because of an unknown error, exception or
73-
* failure.</p>
72+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
7473
*
7574
* @throws {@link ThrottlingException} (client fault)
7675
* <p>The request was denied due to request throttling.</p>

clients/client-dsql/src/commands/GetClusterCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ export interface GetClusterCommandOutput extends GetClusterOutput, __MetadataBea
6262
* // kmsKeyArn: "STRING_VALUE",
6363
* // encryptionStatus: "ENABLED" || "UPDATING" || "KMS_KEY_INACCESSIBLE" || "ENABLING", // required
6464
* // },
65+
* // endpoint: "STRING_VALUE",
6566
* // };
6667
*
6768
* ```
@@ -79,8 +80,7 @@ export interface GetClusterCommandOutput extends GetClusterOutput, __MetadataBea
7980
* <p>You do not have sufficient access to perform this action.</p>
8081
*
8182
* @throws {@link InternalServerException} (server fault)
82-
* <p>The request processing has failed because of an unknown error, exception or
83-
* failure.</p>
83+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
8484
*
8585
* @throws {@link ThrottlingException} (client fault)
8686
* <p>The request was denied due to request throttling.</p>

clients/client-dsql/src/commands/GetClusterPolicyCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,7 @@ export interface GetClusterPolicyCommandOutput extends GetClusterPolicyOutput, _
6565
* <p>You do not have sufficient access to perform this action.</p>
6666
*
6767
* @throws {@link InternalServerException} (server fault)
68-
* <p>The request processing has failed because of an unknown error, exception or
69-
* failure.</p>
68+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
7069
*
7170
* @throws {@link ThrottlingException} (client fault)
7271
* <p>The request was denied due to request throttling.</p>

clients/client-dsql/src/commands/GetVpcEndpointServiceNameCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,7 @@ export interface GetVpcEndpointServiceNameCommandOutput extends GetVpcEndpointSe
5555
* @see {@link DSQLClientResolvedConfig | config} for DSQLClient's `config` shape.
5656
*
5757
* @throws {@link InternalServerException} (server fault)
58-
* <p>The request processing has failed because of an unknown error, exception or
59-
* failure.</p>
58+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
6059
*
6160
* @throws {@link ResourceNotFoundException} (client fault)
6261
* <p>The resource could not be found.</p>

clients/client-dsql/src/commands/ListClustersCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ export interface ListClustersCommandOutput extends ListClustersOutput, __Metadat
6868
* <p>You do not have sufficient access to perform this action.</p>
6969
*
7070
* @throws {@link InternalServerException} (server fault)
71-
* <p>The request processing has failed because of an unknown error, exception or
72-
* failure.</p>
71+
* <p>The request processing has failed because of an unknown error, exception or failure.</p>
7372
*
7473
* @throws {@link ThrottlingException} (client fault)
7574
* <p>The request was denied due to request throttling.</p>

0 commit comments

Comments
 (0)