@aws-sdk/client-dsql 3.926.0 → 3.928.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 CHANGED
@@ -6,12 +6,7 @@
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. 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>
15
10
 
16
11
  ## Installing
17
12
 
package/dist-cjs/index.js CHANGED
@@ -428,6 +428,7 @@ const de_CreateClusterCommand = async (output, context) => {
428
428
  creationTime: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
429
429
  deletionProtectionEnabled: smithyClient.expectBoolean,
430
430
  encryptionDetails: smithyClient._json,
431
+ endpoint: smithyClient.expectString,
431
432
  identifier: smithyClient.expectString,
432
433
  multiRegionProperties: smithyClient._json,
433
434
  status: smithyClient.expectString,
@@ -479,6 +480,7 @@ const de_GetClusterCommand = async (output, context) => {
479
480
  creationTime: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
480
481
  deletionProtectionEnabled: smithyClient.expectBoolean,
481
482
  encryptionDetails: smithyClient._json,
483
+ endpoint: smithyClient.expectString,
482
484
  identifier: smithyClient.expectString,
483
485
  multiRegionProperties: smithyClient._json,
484
486
  status: smithyClient.expectString,
@@ -169,6 +169,7 @@ export const de_CreateClusterCommand = async (output, context) => {
169
169
  creationTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
170
170
  deletionProtectionEnabled: __expectBoolean,
171
171
  encryptionDetails: _json,
172
+ endpoint: __expectString,
172
173
  identifier: __expectString,
173
174
  multiRegionProperties: _json,
174
175
  status: __expectString,
@@ -220,6 +221,7 @@ export const de_GetClusterCommand = async (output, context) => {
220
221
  creationTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
221
222
  deletionProtectionEnabled: __expectBoolean,
222
223
  encryptionDetails: _json,
224
+ endpoint: __expectString,
223
225
  identifier: __expectString,
224
226
  multiRegionProperties: _json,
225
227
  status: __expectString,
@@ -89,12 +89,7 @@ export interface DSQL {
89
89
  updateCluster(args: UpdateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateClusterCommandOutput) => void): void;
90
90
  }
91
91
  /**
92
- * <p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the
93
- * programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p>
94
- * <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size.
95
- * is available in both single-Region and multi-Region configurations, so your
96
- * 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
97
- * acquire new insights for your business and customers.</p>
92
+ * <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>
98
93
  * @public
99
94
  */
100
95
  export declare class DSQL extends DSQLClient implements DSQL {
@@ -181,12 +181,7 @@ export type DSQLClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpH
181
181
  export interface DSQLClientResolvedConfig extends DSQLClientResolvedConfigType {
182
182
  }
183
183
  /**
184
- * <p>This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the
185
- * programming or command line interfaces you can use to manage Amazon Aurora DSQL.</p>
186
- * <p>Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size.
187
- * is available in both single-Region and multi-Region configurations, so your
188
- * 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
189
- * acquire new insights for your business and customers.</p>
184
+ * <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>
190
185
  * @public
191
186
  */
192
187
  export declare class DSQLClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, DSQLClientResolvedConfig> {
@@ -27,71 +27,7 @@ declare const CreateClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>The CreateCluster API allows you to create both single-Region clusters and multi-Region
31
- * clusters. With the addition of the <i>multiRegionProperties</i> parameter,
32
- * you can create a cluster with witness Region support and establish peer relationships with
33
- * clusters in other Regions during creation.</p>
34
- * <note>
35
- * <p>Creating multi-Region clusters requires additional IAM permissions beyond those
36
- * needed for single-Region clusters, as detailed in the <b>Required permissions</b> section
37
- * below.</p>
38
- * </note>
39
- * <p>
40
- * <b>Required permissions</b>
41
- * </p>
42
- * <dl>
43
- * <dt>dsql:CreateCluster</dt>
44
- * <dd>
45
- * <p>Required to create a cluster.</p>
46
- * <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code>
47
- * </p>
48
- * </dd>
49
- * <dt>dsql:TagResource</dt>
50
- * <dd>
51
- * <p>Permission to add tags to a resource.</p>
52
- * <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code>
53
- * </p>
54
- * </dd>
55
- * <dt>dsql:PutMultiRegionProperties</dt>
56
- * <dd>
57
- * <p>Permission to configure multi-Region properties for a cluster.</p>
58
- * <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code>
59
- * </p>
60
- * </dd>
61
- * <dt>dsql:AddPeerCluster</dt>
62
- * <dd>
63
- * <p>When specifying <code>multiRegionProperties.clusters</code>, permission to
64
- * add peer clusters.</p>
65
- * <p>Resources:</p>
66
- * <ul>
67
- * <li>
68
- * <p>Local cluster: <code>arn:aws:dsql:region:account-id:cluster/*</code>
69
- * </p>
70
- * </li>
71
- * <li>
72
- * <p>Each peer cluster: exact ARN of each specified peer cluster</p>
73
- * </li>
74
- * </ul>
75
- * </dd>
76
- * <dt>dsql:PutWitnessRegion</dt>
77
- * <dd>
78
- * <p>When specifying <code>multiRegionProperties.witnessRegion</code>, permission
79
- * to set a witness Region. This permission is checked both in the cluster Region and
80
- * in the witness Region.</p>
81
- * <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code>
82
- * </p>
83
- * <p>Condition Keys: <code>dsql:WitnessRegion</code> (matching the specified witness region)</p>
84
- * </dd>
85
- * </dl>
86
- * <important>
87
- * <ul>
88
- * <li>
89
- * <p>The witness Region specified in
90
- * <code>multiRegionProperties.witnessRegion</code> cannot be the same as the
91
- * cluster's Region.</p>
92
- * </li>
93
- * </ul>
94
- * </important>
30
+ * <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>
95
31
  * @example
96
32
  * Use a bare-bones client and the command you need to make an API call.
97
33
  * ```javascript
@@ -135,6 +71,7 @@ declare const CreateClusterCommand_base: {
135
71
  * // encryptionStatus: "ENABLED" || "UPDATING" || "KMS_KEY_INACCESSIBLE" || "ENABLING", // required
136
72
  * // },
137
73
  * // deletionProtectionEnabled: true || false, // required
74
+ * // endpoint: "STRING_VALUE",
138
75
  * // };
139
76
  *
140
77
  * ```
@@ -158,8 +95,7 @@ declare const CreateClusterCommand_base: {
158
95
  * <p>You do not have sufficient access to perform this action.</p>
159
96
  *
160
97
  * @throws {@link InternalServerException} (server fault)
161
- * <p>The request processing has failed because of an unknown error, exception or
162
- * failure.</p>
98
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
163
99
  *
164
100
  * @throws {@link ThrottlingException} (client fault)
165
101
  * <p>The request was denied due to request throttling.</p>
@@ -67,8 +67,7 @@ declare const DeleteClusterCommand_base: {
67
67
  * <p>You do not have sufficient access to perform this action.</p>
68
68
  *
69
69
  * @throws {@link InternalServerException} (server fault)
70
- * <p>The request processing has failed because of an unknown error, exception or
71
- * failure.</p>
70
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
72
71
  *
73
72
  * @throws {@link ThrottlingException} (client fault)
74
73
  * <p>The request was denied due to request throttling.</p>
@@ -68,8 +68,7 @@ declare const DeleteClusterPolicyCommand_base: {
68
68
  * <p>You do not have sufficient access to perform this action.</p>
69
69
  *
70
70
  * @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>
73
72
  *
74
73
  * @throws {@link ThrottlingException} (client fault)
75
74
  * <p>The request was denied due to request throttling.</p>
@@ -61,6 +61,7 @@ declare const GetClusterCommand_base: {
61
61
  * // kmsKeyArn: "STRING_VALUE",
62
62
  * // encryptionStatus: "ENABLED" || "UPDATING" || "KMS_KEY_INACCESSIBLE" || "ENABLING", // required
63
63
  * // },
64
+ * // endpoint: "STRING_VALUE",
64
65
  * // };
65
66
  *
66
67
  * ```
@@ -78,8 +79,7 @@ declare const GetClusterCommand_base: {
78
79
  * <p>You do not have sufficient access to perform this action.</p>
79
80
  *
80
81
  * @throws {@link InternalServerException} (server fault)
81
- * <p>The request processing has failed because of an unknown error, exception or
82
- * failure.</p>
82
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
83
83
  *
84
84
  * @throws {@link ThrottlingException} (client fault)
85
85
  * <p>The request was denied due to request throttling.</p>
@@ -64,8 +64,7 @@ declare const GetClusterPolicyCommand_base: {
64
64
  * <p>You do not have sufficient access to perform this action.</p>
65
65
  *
66
66
  * @throws {@link InternalServerException} (server fault)
67
- * <p>The request processing has failed because of an unknown error, exception or
68
- * failure.</p>
67
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
69
68
  *
70
69
  * @throws {@link ThrottlingException} (client fault)
71
70
  * <p>The request was denied due to request throttling.</p>
@@ -54,8 +54,7 @@ declare const GetVpcEndpointServiceNameCommand_base: {
54
54
  * @see {@link DSQLClientResolvedConfig | config} for DSQLClient's `config` shape.
55
55
  *
56
56
  * @throws {@link InternalServerException} (server fault)
57
- * <p>The request processing has failed because of an unknown error, exception or
58
- * failure.</p>
57
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
59
58
  *
60
59
  * @throws {@link ResourceNotFoundException} (client fault)
61
60
  * <p>The resource could not be found.</p>
@@ -67,8 +67,7 @@ declare const ListClustersCommand_base: {
67
67
  * <p>You do not have sufficient access to perform this action.</p>
68
68
  *
69
69
  * @throws {@link InternalServerException} (server fault)
70
- * <p>The request processing has failed because of an unknown error, exception or
71
- * failure.</p>
70
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
72
71
  *
73
72
  * @throws {@link ThrottlingException} (client fault)
74
73
  * <p>The request was denied due to request throttling.</p>
@@ -62,8 +62,7 @@ declare const ListTagsForResourceCommand_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, exception or
66
- * failure.</p>
65
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
67
66
  *
68
67
  * @throws {@link ThrottlingException} (client fault)
69
68
  * <p>The request was denied due to request throttling.</p>
@@ -70,8 +70,7 @@ declare const PutClusterPolicyCommand_base: {
70
70
  * <p>You do not have sufficient access to perform this action.</p>
71
71
  *
72
72
  * @throws {@link InternalServerException} (server fault)
73
- * <p>The request processing has failed because of an unknown error, exception or
74
- * failure.</p>
73
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
75
74
  *
76
75
  * @throws {@link ThrottlingException} (client fault)
77
76
  * <p>The request was denied due to request throttling.</p>
@@ -64,8 +64,7 @@ declare const TagResourceCommand_base: {
64
64
  * <p>You do not have sufficient access to perform this action.</p>
65
65
  *
66
66
  * @throws {@link InternalServerException} (server fault)
67
- * <p>The request processing has failed because of an unknown error, exception or
68
- * failure.</p>
67
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
69
68
  *
70
69
  * @throws {@link ThrottlingException} (client fault)
71
70
  * <p>The request was denied due to request throttling.</p>
@@ -61,8 +61,7 @@ declare const UntagResourceCommand_base: {
61
61
  * <p>You do not have sufficient access to perform this action.</p>
62
62
  *
63
63
  * @throws {@link InternalServerException} (server fault)
64
- * <p>The request processing has failed because of an unknown error, exception or
65
- * failure.</p>
64
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
66
65
  *
67
66
  * @throws {@link ThrottlingException} (client fault)
68
67
  * <p>The request was denied due to request throttling.</p>
@@ -27,95 +27,7 @@ declare const UpdateClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
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
33
- * beyond those needed for standard cluster updates, as detailed in the Permissions
34
- * section.</p>
35
- * </note>
36
- * <p>
37
- * <b>Required permissions</b>
38
- * </p>
39
- * <dl>
40
- * <dt>dsql:UpdateCluster</dt>
41
- * <dd>
42
- * <p>Permission to update a DSQL cluster.</p>
43
- * <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i>
44
- * </code>
45
- * </p>
46
- * </dd>
47
- * </dl>
48
- * <dl>
49
- * <dt>dsql:PutMultiRegionProperties</dt>
50
- * <dd>
51
- * <p>Permission to configure multi-Region properties for a cluster.</p>
52
- * <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i>
53
- * </code>
54
- * </p>
55
- * </dd>
56
- * </dl>
57
- * <dl>
58
- * <dt>dsql:GetCluster</dt>
59
- * <dd>
60
- * <p>Permission to retrieve cluster information.</p>
61
- * <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i>
62
- * </code>
63
- * </p>
64
- * </dd>
65
- * <dt>dsql:AddPeerCluster</dt>
66
- * <dd>
67
- * <p>Permission to add peer clusters.</p>
68
- * <p>Resources:</p>
69
- * <ul>
70
- * <li>
71
- * <p>Local cluster: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i>
72
- * </code>
73
- * </p>
74
- * </li>
75
- * <li>
76
- * <p>Each peer cluster: exact ARN of each specified peer cluster</p>
77
- * </li>
78
- * </ul>
79
- * </dd>
80
- * <dt>dsql:RemovePeerCluster</dt>
81
- * <dd>
82
- * <p>Permission to remove peer clusters. The <i>dsql:RemovePeerCluster</i> permission
83
- * uses a wildcard ARN pattern to simplify permission management during updates.</p>
84
- * <p>Resources:
85
- * <code>arn:aws:dsql:*:<i>account-id</i>:cluster/*</code>
86
- * </p>
87
- * </dd>
88
- * </dl>
89
- * <dl>
90
- * <dt>dsql:PutWitnessRegion</dt>
91
- * <dd>
92
- * <p>Permission to set a witness Region.</p>
93
- * <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i>
94
- * </code>
95
- * </p>
96
- * <p>Condition Keys: dsql:WitnessRegion (matching the specified witness
97
- * Region)</p>
98
- * <p>
99
- * <b>This permission is checked both in the cluster Region and in the witness
100
- * Region.</b>
101
- * </p>
102
- * </dd>
103
- * </dl>
104
- * <important>
105
- * <ul>
106
- * <li>
107
- * <p>The witness region specified in
108
- * <code>multiRegionProperties.witnessRegion</code> cannot be the same as the
109
- * cluster's Region.</p>
110
- * </li>
111
- * <li>
112
- * <p>When updating clusters with peer relationships, permissions are checked for both adding and removing peers.</p>
113
- * </li>
114
- * <li>
115
- * <p>The <code>dsql:RemovePeerCluster</code> permission uses a wildcard ARN pattern to simplify permission management during updates.</p>
116
- * </li>
117
- * </ul>
118
- * </important>
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> <note> <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> </note> <p> <b>Required permissions</b> </p> <dl> <dt>dsql:UpdateCluster</dt> <dd> <p>Permission to update a DSQL cluster.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </dd> </dl> <dl> <dt>dsql:PutMultiRegionProperties</dt> <dd> <p>Permission to configure multi-Region properties for a cluster.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </dd> </dl> <dl> <dt>dsql:GetCluster</dt> <dd> <p>Permission to retrieve cluster information.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </dd> <dt>dsql:AddPeerCluster</dt> <dd> <p>Permission to add peer clusters.</p> <p>Resources:</p> <ul> <li> <p>Local cluster: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </li> <li> <p>Each peer cluster: exact ARN of each specified peer cluster</p> </li> </ul> </dd> <dt>dsql:RemovePeerCluster</dt> <dd> <p>Permission to remove peer clusters. The <i>dsql:RemovePeerCluster</i> permission uses a wildcard ARN pattern to simplify permission management during updates.</p> <p>Resources: <code>arn:aws:dsql:*:<i>account-id</i>:cluster/*</code> </p> </dd> </dl> <dl> <dt>dsql:PutWitnessRegion</dt> <dd> <p>Permission to set a witness Region.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> <p>Condition Keys: dsql:WitnessRegion (matching the specified witness Region)</p> <p> <b>This permission is checked both in the cluster Region and in the witness Region.</b> </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> <li> <p>When updating clusters with peer relationships, permissions are checked for both adding and removing peers.</p> </li> <li> <p>The <code>dsql:RemovePeerCluster</code> permission uses a wildcard ARN pattern to simplify permission management during updates.</p> </li> </ul> </important>
119
31
  * @example
120
32
  * Use a bare-bones client and the command you need to make an API call.
121
33
  * ```javascript
@@ -166,8 +78,7 @@ declare const UpdateClusterCommand_base: {
166
78
  * <p>You do not have sufficient access to perform this action.</p>
167
79
  *
168
80
  * @throws {@link InternalServerException} (server fault)
169
- * <p>The request processing has failed because of an unknown error, exception or
170
- * failure.</p>
81
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
171
82
  *
172
83
  * @throws {@link ThrottlingException} (client fault)
173
84
  * <p>The request was denied due to request throttling.</p>
@@ -1,10 +1,5 @@
1
1
  /**
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>
2
+ * <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>
8
3
  *
9
4
  * @packageDocumentation
10
5
  */
@@ -60,12 +60,12 @@ export declare class ConflictException extends __BaseException {
60
60
  */
61
61
  export interface MultiRegionProperties {
62
62
  /**
63
- * <p>The Region that serves as the witness region for a multi-Region cluster. The witness Region helps maintain cluster consistency and quorum.</p>
63
+ * <p>The Region that serves as the witness region for a multi-Region cluster. The witness Region helps maintain cluster consistency and quorum.</p>
64
64
  * @public
65
65
  */
66
66
  witnessRegion?: string | undefined;
67
67
  /**
68
- * <p>The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.</p>
68
+ * <p>The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.</p>
69
69
  * @public
70
70
  */
71
71
  clusters?: string[] | undefined;
@@ -75,8 +75,7 @@ export interface MultiRegionProperties {
75
75
  */
76
76
  export interface CreateClusterInput {
77
77
  /**
78
- * <p>If enabled, you can't delete your cluster. You must first disable this property before
79
- * you can delete your cluster.</p>
78
+ * <p>If enabled, you can't delete your cluster. You must first disable this property before you can delete your cluster.</p>
80
79
  * @public
81
80
  */
82
81
  deletionProtectionEnabled?: boolean | undefined;
@@ -91,13 +90,7 @@ export interface CreateClusterInput {
91
90
  */
92
91
  tags?: Record<string, string> | undefined;
93
92
  /**
94
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
95
- * request. Idempotency ensures that an API request completes only once. With an idempotent
96
- * request, if the original request completes successfully, the subsequent retries with the
97
- * same client token return the result from the original successful request and they have no
98
- * additional effect.</p>
99
- * <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates
100
- * one.</p>
93
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>
101
94
  * @public
102
95
  */
103
96
  clientToken?: string | undefined;
@@ -185,7 +178,7 @@ export interface CreateClusterOutput {
185
178
  */
186
179
  status: ClusterStatus | undefined;
187
180
  /**
188
- * <p>The time of when created the cluster.</p>
181
+ * <p>The time of when created the cluster.</p>
189
182
  * @public
190
183
  */
191
184
  creationTime: Date | undefined;
@@ -204,10 +197,14 @@ export interface CreateClusterOutput {
204
197
  * @public
205
198
  */
206
199
  deletionProtectionEnabled: boolean | undefined;
200
+ /**
201
+ * <p>The connection endpoint for the created cluster.</p>
202
+ * @public
203
+ */
204
+ endpoint?: string | undefined;
207
205
  }
208
206
  /**
209
- * <p>The request processing has failed because of an unknown error, exception or
210
- * failure.</p>
207
+ * <p>The request processing has failed because of an unknown error, exception or failure.</p>
211
208
  * @public
212
209
  */
213
210
  export declare class InternalServerException extends __BaseException {
@@ -287,8 +284,7 @@ export declare class ThrottlingException extends __BaseException {
287
284
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
288
285
  }
289
286
  /**
290
- * <p>Stores information about a field passed inside a request that resulted in an validation
291
- * error.</p>
287
+ * <p>Stores information about a field passed inside a request that resulted in an validation error.</p>
292
288
  * @public
293
289
  */
294
290
  export interface ValidationExceptionField {
@@ -350,13 +346,7 @@ export interface DeleteClusterInput {
350
346
  */
351
347
  identifier: string | undefined;
352
348
  /**
353
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
354
- * request. Idempotency ensures that an API request completes only once. With an idempotent
355
- * request, if the original request completes successfully. The subsequent retries with the
356
- * same client token return the result from the original successful request and they have no
357
- * additional effect.</p>
358
- * <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates
359
- * one.</p>
349
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>
360
350
  * @public
361
351
  */
362
352
  clientToken?: string | undefined;
@@ -494,6 +484,11 @@ export interface GetClusterOutput {
494
484
  * @public
495
485
  */
496
486
  encryptionDetails?: EncryptionDetails | undefined;
487
+ /**
488
+ * <p>The connection endpoint for the cluster.</p>
489
+ * @public
490
+ */
491
+ endpoint?: string | undefined;
497
492
  }
498
493
  /**
499
494
  * @public
@@ -545,15 +540,12 @@ export interface GetVpcEndpointServiceNameOutput {
545
540
  */
546
541
  export interface ListClustersInput {
547
542
  /**
548
- * <p>An optional parameter that specifies the maximum number of results to return. You can
549
- * use nextToken to display the next page of results.</p>
543
+ * <p>An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.</p>
550
544
  * @public
551
545
  */
552
546
  maxResults?: number | undefined;
553
547
  /**
554
- * <p>If your initial ListClusters operation returns a nextToken, you can include the returned
555
- * nextToken in following ListClusters operations, which returns results in the next
556
- * page.</p>
548
+ * <p>If your initial ListClusters operation returns a nextToken, you can include the returned nextToken in following ListClusters operations, which returns results in the next page.</p>
557
549
  * @public
558
550
  */
559
551
  nextToken?: string | undefined;
@@ -579,9 +571,7 @@ export interface ClusterSummary {
579
571
  */
580
572
  export interface ListClustersOutput {
581
573
  /**
582
- * <p>If nextToken is returned, there are more results available. The value of nextToken is a
583
- * unique pagination token for each page. To retrieve the next page, make the call again using
584
- * the returned token.</p>
574
+ * <p>If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.</p>
585
575
  * @public
586
576
  */
587
577
  nextToken?: string | undefined;
@@ -651,13 +641,7 @@ export interface UpdateClusterInput {
651
641
  */
652
642
  kmsEncryptionKey?: string | undefined;
653
643
  /**
654
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
655
- * request. Idempotency ensures that an API request completes only once. With an idempotent
656
- * request, if the original request completes successfully. The subsequent retries with the
657
- * same client token return the result from the original successful request and they have no
658
- * additional effect.</p>
659
- * <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates
660
- * one.</p>
644
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>
661
645
  * @public
662
646
  */
663
647
  clientToken?: string | undefined;
@@ -67,6 +67,7 @@ export interface CreateClusterOutput {
67
67
  multiRegionProperties?: MultiRegionProperties | undefined;
68
68
  encryptionDetails?: EncryptionDetails | undefined;
69
69
  deletionProtectionEnabled: boolean | undefined;
70
+ endpoint?: string | undefined;
70
71
  }
71
72
  export declare class InternalServerException extends __BaseException {
72
73
  readonly name: "InternalServerException";
@@ -162,6 +163,7 @@ export interface GetClusterOutput {
162
163
  multiRegionProperties?: MultiRegionProperties | undefined;
163
164
  tags?: Record<string, string> | undefined;
164
165
  encryptionDetails?: EncryptionDetails | undefined;
166
+ endpoint?: string | undefined;
165
167
  }
166
168
  export interface GetClusterPolicyInput {
167
169
  identifier: 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.926.0",
4
+ "version": "3.928.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-dsql",
@@ -20,17 +20,17 @@
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.926.0",
24
- "@aws-sdk/credential-provider-node": "3.926.0",
23
+ "@aws-sdk/core": "3.928.0",
24
+ "@aws-sdk/credential-provider-node": "3.928.0",
25
25
  "@aws-sdk/middleware-host-header": "3.922.0",
26
26
  "@aws-sdk/middleware-logger": "3.922.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.922.0",
28
- "@aws-sdk/middleware-user-agent": "3.926.0",
28
+ "@aws-sdk/middleware-user-agent": "3.928.0",
29
29
  "@aws-sdk/region-config-resolver": "3.925.0",
30
30
  "@aws-sdk/types": "3.922.0",
31
31
  "@aws-sdk/util-endpoints": "3.922.0",
32
32
  "@aws-sdk/util-user-agent-browser": "3.922.0",
33
- "@aws-sdk/util-user-agent-node": "3.926.0",
33
+ "@aws-sdk/util-user-agent-node": "3.928.0",
34
34
  "@smithy/config-resolver": "^4.4.2",
35
35
  "@smithy/core": "^3.17.2",
36
36
  "@smithy/fetch-http-handler": "^5.3.5",