@aws-sdk/client-dsql 3.913.0 → 3.916.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 +24 -0
- package/dist-cjs/index.js +143 -0
- package/dist-es/DSQL.js +6 -0
- package/dist-es/commands/DeleteClusterPolicyCommand.js +22 -0
- package/dist-es/commands/GetClusterPolicyCommand.js +22 -0
- package/dist-es/commands/PutClusterPolicyCommand.js +22 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +86 -0
- package/dist-types/DSQL.d.ts +21 -0
- package/dist-types/DSQLClient.d.ts +5 -2
- package/dist-types/commands/CreateClusterCommand.d.ts +4 -2
- package/dist-types/commands/DeleteClusterPolicyCommand.d.ts +95 -0
- package/dist-types/commands/GetClusterPolicyCommand.d.ts +91 -0
- package/dist-types/commands/PutClusterPolicyCommand.d.ts +97 -0
- package/dist-types/commands/UpdateClusterCommand.d.ts +3 -1
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +107 -2
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/DSQL.d.ts +51 -0
- package/dist-types/ts3.4/DSQLClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeleteClusterPolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetClusterPolicyCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/PutClusterPolicyCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +27 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +34 -34
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DSQLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DSQLClient";
|
|
4
|
+
import { DeleteClusterPolicyInput, DeleteClusterPolicyOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteClusterPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteClusterPolicyCommandInput extends DeleteClusterPolicyInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteClusterPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteClusterPolicyCommandOutput extends DeleteClusterPolicyOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteClusterPolicyCommand_base: {
|
|
25
|
+
new (input: DeleteClusterPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteClusterPolicyCommandInput, DeleteClusterPolicyCommandOutput, DSQLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DeleteClusterPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteClusterPolicyCommandInput, DeleteClusterPolicyCommandOutput, DSQLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes the resource-based policy attached to a cluster. This removes all access permissions defined by the policy, reverting to default access controls.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { DSQLClient, DeleteClusterPolicyCommand } from "@aws-sdk/client-dsql"; // ES Modules import
|
|
35
|
+
* // const { DSQLClient, DeleteClusterPolicyCommand } = require("@aws-sdk/client-dsql"); // CommonJS import
|
|
36
|
+
* // import type { DSQLClientConfig } from "@aws-sdk/client-dsql";
|
|
37
|
+
* const config = {}; // type is DSQLClientConfig
|
|
38
|
+
* const client = new DSQLClient(config);
|
|
39
|
+
* const input = { // DeleteClusterPolicyInput
|
|
40
|
+
* identifier: "STRING_VALUE", // required
|
|
41
|
+
* expectedPolicyVersion: "STRING_VALUE",
|
|
42
|
+
* clientToken: "STRING_VALUE",
|
|
43
|
+
* };
|
|
44
|
+
* const command = new DeleteClusterPolicyCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // DeleteClusterPolicyOutput
|
|
47
|
+
* // policyVersion: "STRING_VALUE", // required
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param DeleteClusterPolicyCommandInput - {@link DeleteClusterPolicyCommandInput}
|
|
53
|
+
* @returns {@link DeleteClusterPolicyCommandOutput}
|
|
54
|
+
* @see {@link DeleteClusterPolicyCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link DeleteClusterPolicyCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link DSQLClientResolvedConfig | config} for DSQLClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ConflictException} (client fault)
|
|
59
|
+
* <p>The submitted action has conflicts.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
62
|
+
* <p>The resource could not be found.</p>
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ValidationException} (client fault)
|
|
65
|
+
* <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
68
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServerException} (server fault)
|
|
71
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
72
|
+
* failure.</p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
75
|
+
* <p>The request was denied due to request throttling.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link DSQLServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from DSQL service.</p>
|
|
79
|
+
*
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class DeleteClusterPolicyCommand extends DeleteClusterPolicyCommand_base {
|
|
84
|
+
/** @internal type navigation helper, not in runtime. */
|
|
85
|
+
protected static __types: {
|
|
86
|
+
api: {
|
|
87
|
+
input: DeleteClusterPolicyInput;
|
|
88
|
+
output: DeleteClusterPolicyOutput;
|
|
89
|
+
};
|
|
90
|
+
sdk: {
|
|
91
|
+
input: DeleteClusterPolicyCommandInput;
|
|
92
|
+
output: DeleteClusterPolicyCommandOutput;
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DSQLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DSQLClient";
|
|
4
|
+
import { GetClusterPolicyInput, GetClusterPolicyOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetClusterPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetClusterPolicyCommandInput extends GetClusterPolicyInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetClusterPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetClusterPolicyCommandOutput extends GetClusterPolicyOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetClusterPolicyCommand_base: {
|
|
25
|
+
new (input: GetClusterPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetClusterPolicyCommandInput, GetClusterPolicyCommandOutput, DSQLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetClusterPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetClusterPolicyCommandInput, GetClusterPolicyCommandOutput, DSQLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { DSQLClient, GetClusterPolicyCommand } from "@aws-sdk/client-dsql"; // ES Modules import
|
|
35
|
+
* // const { DSQLClient, GetClusterPolicyCommand } = require("@aws-sdk/client-dsql"); // CommonJS import
|
|
36
|
+
* // import type { DSQLClientConfig } from "@aws-sdk/client-dsql";
|
|
37
|
+
* const config = {}; // type is DSQLClientConfig
|
|
38
|
+
* const client = new DSQLClient(config);
|
|
39
|
+
* const input = { // GetClusterPolicyInput
|
|
40
|
+
* identifier: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetClusterPolicyCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetClusterPolicyOutput
|
|
45
|
+
* // policy: "STRING_VALUE", // required
|
|
46
|
+
* // policyVersion: "STRING_VALUE", // required
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param GetClusterPolicyCommandInput - {@link GetClusterPolicyCommandInput}
|
|
52
|
+
* @returns {@link GetClusterPolicyCommandOutput}
|
|
53
|
+
* @see {@link GetClusterPolicyCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link GetClusterPolicyCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link DSQLClientResolvedConfig | config} for DSQLClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
58
|
+
* <p>The resource could not be found.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ValidationException} (client fault)
|
|
61
|
+
* <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerException} (server fault)
|
|
67
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
68
|
+
* failure.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
71
|
+
* <p>The request was denied due to request throttling.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link DSQLServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from DSQL service.</p>
|
|
75
|
+
*
|
|
76
|
+
*
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
export declare class GetClusterPolicyCommand extends GetClusterPolicyCommand_base {
|
|
80
|
+
/** @internal type navigation helper, not in runtime. */
|
|
81
|
+
protected static __types: {
|
|
82
|
+
api: {
|
|
83
|
+
input: GetClusterPolicyInput;
|
|
84
|
+
output: GetClusterPolicyOutput;
|
|
85
|
+
};
|
|
86
|
+
sdk: {
|
|
87
|
+
input: GetClusterPolicyCommandInput;
|
|
88
|
+
output: GetClusterPolicyCommandOutput;
|
|
89
|
+
};
|
|
90
|
+
};
|
|
91
|
+
}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { DSQLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DSQLClient";
|
|
4
|
+
import { PutClusterPolicyInput, PutClusterPolicyOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PutClusterPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PutClusterPolicyCommandInput extends PutClusterPolicyInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PutClusterPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PutClusterPolicyCommandOutput extends PutClusterPolicyOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PutClusterPolicyCommand_base: {
|
|
25
|
+
new (input: PutClusterPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutClusterPolicyCommandInput, PutClusterPolicyCommandOutput, DSQLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: PutClusterPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<PutClusterPolicyCommandInput, PutClusterPolicyCommandOutput, DSQLClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Attaches a resource-based policy to a cluster. This policy defines access permissions and conditions for the cluster, allowing you to control which principals can perform actions on the cluster.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { DSQLClient, PutClusterPolicyCommand } from "@aws-sdk/client-dsql"; // ES Modules import
|
|
35
|
+
* // const { DSQLClient, PutClusterPolicyCommand } = require("@aws-sdk/client-dsql"); // CommonJS import
|
|
36
|
+
* // import type { DSQLClientConfig } from "@aws-sdk/client-dsql";
|
|
37
|
+
* const config = {}; // type is DSQLClientConfig
|
|
38
|
+
* const client = new DSQLClient(config);
|
|
39
|
+
* const input = { // PutClusterPolicyInput
|
|
40
|
+
* identifier: "STRING_VALUE", // required
|
|
41
|
+
* policy: "STRING_VALUE", // required
|
|
42
|
+
* bypassPolicyLockoutSafetyCheck: true || false,
|
|
43
|
+
* expectedPolicyVersion: "STRING_VALUE",
|
|
44
|
+
* clientToken: "STRING_VALUE",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new PutClusterPolicyCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // PutClusterPolicyOutput
|
|
49
|
+
* // policyVersion: "STRING_VALUE", // required
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param PutClusterPolicyCommandInput - {@link PutClusterPolicyCommandInput}
|
|
55
|
+
* @returns {@link PutClusterPolicyCommandOutput}
|
|
56
|
+
* @see {@link PutClusterPolicyCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link PutClusterPolicyCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link DSQLClientResolvedConfig | config} for DSQLClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ConflictException} (client fault)
|
|
61
|
+
* <p>The submitted action has conflicts.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
|
+
* <p>The resource could not be found.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ValidationException} (client fault)
|
|
67
|
+
* <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
70
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link InternalServerException} (server fault)
|
|
73
|
+
* <p>The request processing has failed because of an unknown error, exception or
|
|
74
|
+
* failure.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
77
|
+
* <p>The request was denied due to request throttling.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link DSQLServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from DSQL service.</p>
|
|
81
|
+
*
|
|
82
|
+
*
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
export declare class PutClusterPolicyCommand extends PutClusterPolicyCommand_base {
|
|
86
|
+
/** @internal type navigation helper, not in runtime. */
|
|
87
|
+
protected static __types: {
|
|
88
|
+
api: {
|
|
89
|
+
input: PutClusterPolicyInput;
|
|
90
|
+
output: PutClusterPolicyOutput;
|
|
91
|
+
};
|
|
92
|
+
sdk: {
|
|
93
|
+
input: PutClusterPolicyCommandInput;
|
|
94
|
+
output: PutClusterPolicyCommandOutput;
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
}
|
|
@@ -29,7 +29,9 @@ declare const UpdateClusterCommand_base: {
|
|
|
29
29
|
/**
|
|
30
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
31
|
* <note>
|
|
32
|
-
* <p>Note that updating multi-
|
|
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>
|
|
33
35
|
* </note>
|
|
34
36
|
* <p>
|
|
35
37
|
* <b>Required permissions</b>
|
|
@@ -1,9 +1,12 @@
|
|
|
1
1
|
export * from "./CreateClusterCommand";
|
|
2
2
|
export * from "./DeleteClusterCommand";
|
|
3
|
+
export * from "./DeleteClusterPolicyCommand";
|
|
3
4
|
export * from "./GetClusterCommand";
|
|
5
|
+
export * from "./GetClusterPolicyCommand";
|
|
4
6
|
export * from "./GetVpcEndpointServiceNameCommand";
|
|
5
7
|
export * from "./ListClustersCommand";
|
|
6
8
|
export * from "./ListTagsForResourceCommand";
|
|
9
|
+
export * from "./PutClusterPolicyCommand";
|
|
7
10
|
export * from "./TagResourceCommand";
|
|
8
11
|
export * from "./UntagResourceCommand";
|
|
9
12
|
export * from "./UpdateClusterCommand";
|
|
@@ -60,12 +60,12 @@ export declare class ConflictException extends __BaseException {
|
|
|
60
60
|
*/
|
|
61
61
|
export interface MultiRegionProperties {
|
|
62
62
|
/**
|
|
63
|
-
* <p>The that serves as the witness region for a multi-Region cluster. The witness
|
|
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
|
|
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;
|
|
@@ -106,6 +106,16 @@ export interface CreateClusterInput {
|
|
|
106
106
|
* @public
|
|
107
107
|
*/
|
|
108
108
|
multiRegionProperties?: MultiRegionProperties | undefined;
|
|
109
|
+
/**
|
|
110
|
+
* <p>An optional resource-based policy document in JSON format that defines access permissions for the cluster.</p>
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
policy?: string | undefined;
|
|
114
|
+
/**
|
|
115
|
+
* <p>An optional field that controls whether to bypass the lockout prevention check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.</p>
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
bypassPolicyLockoutSafetyCheck?: boolean | undefined;
|
|
109
119
|
}
|
|
110
120
|
/**
|
|
111
121
|
* @public
|
|
@@ -399,6 +409,36 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
399
409
|
*/
|
|
400
410
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
401
411
|
}
|
|
412
|
+
/**
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
export interface DeleteClusterPolicyInput {
|
|
416
|
+
/**
|
|
417
|
+
* <p>The ID of the cluster.</p>
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
identifier: string | undefined;
|
|
421
|
+
/**
|
|
422
|
+
* <p>The expected version of the policy to delete. This parameter ensures that you're deleting the correct version of the policy and helps prevent accidental deletions.</p>
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
expectedPolicyVersion?: string | undefined;
|
|
426
|
+
/**
|
|
427
|
+
* <p>Idempotency token so a request is only processed once.</p>
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
clientToken?: string | undefined;
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
export interface DeleteClusterPolicyOutput {
|
|
436
|
+
/**
|
|
437
|
+
* <p>The version of the policy that was deleted.</p>
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
policyVersion: string | undefined;
|
|
441
|
+
}
|
|
402
442
|
/**
|
|
403
443
|
* @public
|
|
404
444
|
*/
|
|
@@ -455,6 +495,31 @@ export interface GetClusterOutput {
|
|
|
455
495
|
*/
|
|
456
496
|
encryptionDetails?: EncryptionDetails | undefined;
|
|
457
497
|
}
|
|
498
|
+
/**
|
|
499
|
+
* @public
|
|
500
|
+
*/
|
|
501
|
+
export interface GetClusterPolicyInput {
|
|
502
|
+
/**
|
|
503
|
+
* <p>The ID of the cluster to retrieve the policy from.</p>
|
|
504
|
+
* @public
|
|
505
|
+
*/
|
|
506
|
+
identifier: string | undefined;
|
|
507
|
+
}
|
|
508
|
+
/**
|
|
509
|
+
* @public
|
|
510
|
+
*/
|
|
511
|
+
export interface GetClusterPolicyOutput {
|
|
512
|
+
/**
|
|
513
|
+
* <p>The resource-based policy document attached to the cluster, returned as a JSON string.</p>
|
|
514
|
+
* @public
|
|
515
|
+
*/
|
|
516
|
+
policy: string | undefined;
|
|
517
|
+
/**
|
|
518
|
+
* <p>The version of the policy document. This version number is incremented each time the policy is updated.</p>
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
policyVersion: string | undefined;
|
|
522
|
+
}
|
|
458
523
|
/**
|
|
459
524
|
* @public
|
|
460
525
|
*/
|
|
@@ -526,6 +591,46 @@ export interface ListClustersOutput {
|
|
|
526
591
|
*/
|
|
527
592
|
clusters: ClusterSummary[] | undefined;
|
|
528
593
|
}
|
|
594
|
+
/**
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
export interface PutClusterPolicyInput {
|
|
598
|
+
/**
|
|
599
|
+
* <p>The ID of the cluster.</p>
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
identifier: string | undefined;
|
|
603
|
+
/**
|
|
604
|
+
* <p>The resource-based policy document to attach to the cluster. This should be a valid JSON policy document that defines permissions and conditions.</p>
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
policy: string | undefined;
|
|
608
|
+
/**
|
|
609
|
+
* <p>A flag that allows you to bypass the policy lockout safety check. When set to true, this parameter allows you to apply a policy that might lock you out of the cluster. Use with caution.</p>
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
bypassPolicyLockoutSafetyCheck?: boolean | undefined;
|
|
613
|
+
/**
|
|
614
|
+
* <p>The expected version of the current policy. This parameter ensures that you're updating the correct version of the policy and helps prevent concurrent modification conflicts.</p>
|
|
615
|
+
* @public
|
|
616
|
+
*/
|
|
617
|
+
expectedPolicyVersion?: string | undefined;
|
|
618
|
+
/**
|
|
619
|
+
* <p>Idempotency token so a request is only processed once.</p>
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
clientToken?: string | undefined;
|
|
623
|
+
}
|
|
624
|
+
/**
|
|
625
|
+
* @public
|
|
626
|
+
*/
|
|
627
|
+
export interface PutClusterPolicyOutput {
|
|
628
|
+
/**
|
|
629
|
+
* <p>The version of the policy after it has been updated or created.</p>
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
632
|
+
policyVersion: string | undefined;
|
|
633
|
+
}
|
|
529
634
|
/**
|
|
530
635
|
* @public
|
|
531
636
|
*/
|
|
@@ -2,10 +2,13 @@ import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@s
|
|
|
2
2
|
import { SerdeContext as __SerdeContext } from "@smithy/types";
|
|
3
3
|
import { CreateClusterCommandInput, CreateClusterCommandOutput } from "../commands/CreateClusterCommand";
|
|
4
4
|
import { DeleteClusterCommandInput, DeleteClusterCommandOutput } from "../commands/DeleteClusterCommand";
|
|
5
|
+
import { DeleteClusterPolicyCommandInput, DeleteClusterPolicyCommandOutput } from "../commands/DeleteClusterPolicyCommand";
|
|
5
6
|
import { GetClusterCommandInput, GetClusterCommandOutput } from "../commands/GetClusterCommand";
|
|
7
|
+
import { GetClusterPolicyCommandInput, GetClusterPolicyCommandOutput } from "../commands/GetClusterPolicyCommand";
|
|
6
8
|
import { GetVpcEndpointServiceNameCommandInput, GetVpcEndpointServiceNameCommandOutput } from "../commands/GetVpcEndpointServiceNameCommand";
|
|
7
9
|
import { ListClustersCommandInput, ListClustersCommandOutput } from "../commands/ListClustersCommand";
|
|
8
10
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
|
|
11
|
+
import { PutClusterPolicyCommandInput, PutClusterPolicyCommandOutput } from "../commands/PutClusterPolicyCommand";
|
|
9
12
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
10
13
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
11
14
|
import { UpdateClusterCommandInput, UpdateClusterCommandOutput } from "../commands/UpdateClusterCommand";
|
|
@@ -17,10 +20,18 @@ export declare const se_CreateClusterCommand: (input: CreateClusterCommandInput,
|
|
|
17
20
|
* serializeAws_restJson1DeleteClusterCommand
|
|
18
21
|
*/
|
|
19
22
|
export declare const se_DeleteClusterCommand: (input: DeleteClusterCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
23
|
+
/**
|
|
24
|
+
* serializeAws_restJson1DeleteClusterPolicyCommand
|
|
25
|
+
*/
|
|
26
|
+
export declare const se_DeleteClusterPolicyCommand: (input: DeleteClusterPolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
20
27
|
/**
|
|
21
28
|
* serializeAws_restJson1GetClusterCommand
|
|
22
29
|
*/
|
|
23
30
|
export declare const se_GetClusterCommand: (input: GetClusterCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
31
|
+
/**
|
|
32
|
+
* serializeAws_restJson1GetClusterPolicyCommand
|
|
33
|
+
*/
|
|
34
|
+
export declare const se_GetClusterPolicyCommand: (input: GetClusterPolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
24
35
|
/**
|
|
25
36
|
* serializeAws_restJson1GetVpcEndpointServiceNameCommand
|
|
26
37
|
*/
|
|
@@ -33,6 +44,10 @@ export declare const se_ListClustersCommand: (input: ListClustersCommandInput, c
|
|
|
33
44
|
* serializeAws_restJson1ListTagsForResourceCommand
|
|
34
45
|
*/
|
|
35
46
|
export declare const se_ListTagsForResourceCommand: (input: ListTagsForResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
47
|
+
/**
|
|
48
|
+
* serializeAws_restJson1PutClusterPolicyCommand
|
|
49
|
+
*/
|
|
50
|
+
export declare const se_PutClusterPolicyCommand: (input: PutClusterPolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
36
51
|
/**
|
|
37
52
|
* serializeAws_restJson1TagResourceCommand
|
|
38
53
|
*/
|
|
@@ -53,10 +68,18 @@ export declare const de_CreateClusterCommand: (output: __HttpResponse, context:
|
|
|
53
68
|
* deserializeAws_restJson1DeleteClusterCommand
|
|
54
69
|
*/
|
|
55
70
|
export declare const de_DeleteClusterCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteClusterCommandOutput>;
|
|
71
|
+
/**
|
|
72
|
+
* deserializeAws_restJson1DeleteClusterPolicyCommand
|
|
73
|
+
*/
|
|
74
|
+
export declare const de_DeleteClusterPolicyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeleteClusterPolicyCommandOutput>;
|
|
56
75
|
/**
|
|
57
76
|
* deserializeAws_restJson1GetClusterCommand
|
|
58
77
|
*/
|
|
59
78
|
export declare const de_GetClusterCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetClusterCommandOutput>;
|
|
79
|
+
/**
|
|
80
|
+
* deserializeAws_restJson1GetClusterPolicyCommand
|
|
81
|
+
*/
|
|
82
|
+
export declare const de_GetClusterPolicyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetClusterPolicyCommandOutput>;
|
|
60
83
|
/**
|
|
61
84
|
* deserializeAws_restJson1GetVpcEndpointServiceNameCommand
|
|
62
85
|
*/
|
|
@@ -69,6 +92,10 @@ export declare const de_ListClustersCommand: (output: __HttpResponse, context: _
|
|
|
69
92
|
* deserializeAws_restJson1ListTagsForResourceCommand
|
|
70
93
|
*/
|
|
71
94
|
export declare const de_ListTagsForResourceCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListTagsForResourceCommandOutput>;
|
|
95
|
+
/**
|
|
96
|
+
* deserializeAws_restJson1PutClusterPolicyCommand
|
|
97
|
+
*/
|
|
98
|
+
export declare const de_PutClusterPolicyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutClusterPolicyCommandOutput>;
|
|
72
99
|
/**
|
|
73
100
|
* deserializeAws_restJson1TagResourceCommand
|
|
74
101
|
*/
|
|
@@ -7,10 +7,18 @@ import {
|
|
|
7
7
|
DeleteClusterCommandInput,
|
|
8
8
|
DeleteClusterCommandOutput,
|
|
9
9
|
} from "./commands/DeleteClusterCommand";
|
|
10
|
+
import {
|
|
11
|
+
DeleteClusterPolicyCommandInput,
|
|
12
|
+
DeleteClusterPolicyCommandOutput,
|
|
13
|
+
} from "./commands/DeleteClusterPolicyCommand";
|
|
10
14
|
import {
|
|
11
15
|
GetClusterCommandInput,
|
|
12
16
|
GetClusterCommandOutput,
|
|
13
17
|
} from "./commands/GetClusterCommand";
|
|
18
|
+
import {
|
|
19
|
+
GetClusterPolicyCommandInput,
|
|
20
|
+
GetClusterPolicyCommandOutput,
|
|
21
|
+
} from "./commands/GetClusterPolicyCommand";
|
|
14
22
|
import {
|
|
15
23
|
GetVpcEndpointServiceNameCommandInput,
|
|
16
24
|
GetVpcEndpointServiceNameCommandOutput,
|
|
@@ -23,6 +31,10 @@ import {
|
|
|
23
31
|
ListTagsForResourceCommandInput,
|
|
24
32
|
ListTagsForResourceCommandOutput,
|
|
25
33
|
} from "./commands/ListTagsForResourceCommand";
|
|
34
|
+
import {
|
|
35
|
+
PutClusterPolicyCommandInput,
|
|
36
|
+
PutClusterPolicyCommandOutput,
|
|
37
|
+
} from "./commands/PutClusterPolicyCommand";
|
|
26
38
|
import {
|
|
27
39
|
TagResourceCommandInput,
|
|
28
40
|
TagResourceCommandOutput,
|
|
@@ -64,6 +76,19 @@ export interface DSQL {
|
|
|
64
76
|
options: __HttpHandlerOptions,
|
|
65
77
|
cb: (err: any, data?: DeleteClusterCommandOutput) => void
|
|
66
78
|
): void;
|
|
79
|
+
deleteClusterPolicy(
|
|
80
|
+
args: DeleteClusterPolicyCommandInput,
|
|
81
|
+
options?: __HttpHandlerOptions
|
|
82
|
+
): Promise<DeleteClusterPolicyCommandOutput>;
|
|
83
|
+
deleteClusterPolicy(
|
|
84
|
+
args: DeleteClusterPolicyCommandInput,
|
|
85
|
+
cb: (err: any, data?: DeleteClusterPolicyCommandOutput) => void
|
|
86
|
+
): void;
|
|
87
|
+
deleteClusterPolicy(
|
|
88
|
+
args: DeleteClusterPolicyCommandInput,
|
|
89
|
+
options: __HttpHandlerOptions,
|
|
90
|
+
cb: (err: any, data?: DeleteClusterPolicyCommandOutput) => void
|
|
91
|
+
): void;
|
|
67
92
|
getCluster(
|
|
68
93
|
args: GetClusterCommandInput,
|
|
69
94
|
options?: __HttpHandlerOptions
|
|
@@ -77,6 +102,19 @@ export interface DSQL {
|
|
|
77
102
|
options: __HttpHandlerOptions,
|
|
78
103
|
cb: (err: any, data?: GetClusterCommandOutput) => void
|
|
79
104
|
): void;
|
|
105
|
+
getClusterPolicy(
|
|
106
|
+
args: GetClusterPolicyCommandInput,
|
|
107
|
+
options?: __HttpHandlerOptions
|
|
108
|
+
): Promise<GetClusterPolicyCommandOutput>;
|
|
109
|
+
getClusterPolicy(
|
|
110
|
+
args: GetClusterPolicyCommandInput,
|
|
111
|
+
cb: (err: any, data?: GetClusterPolicyCommandOutput) => void
|
|
112
|
+
): void;
|
|
113
|
+
getClusterPolicy(
|
|
114
|
+
args: GetClusterPolicyCommandInput,
|
|
115
|
+
options: __HttpHandlerOptions,
|
|
116
|
+
cb: (err: any, data?: GetClusterPolicyCommandOutput) => void
|
|
117
|
+
): void;
|
|
80
118
|
getVpcEndpointServiceName(
|
|
81
119
|
args: GetVpcEndpointServiceNameCommandInput,
|
|
82
120
|
options?: __HttpHandlerOptions
|
|
@@ -117,6 +155,19 @@ export interface DSQL {
|
|
|
117
155
|
options: __HttpHandlerOptions,
|
|
118
156
|
cb: (err: any, data?: ListTagsForResourceCommandOutput) => void
|
|
119
157
|
): void;
|
|
158
|
+
putClusterPolicy(
|
|
159
|
+
args: PutClusterPolicyCommandInput,
|
|
160
|
+
options?: __HttpHandlerOptions
|
|
161
|
+
): Promise<PutClusterPolicyCommandOutput>;
|
|
162
|
+
putClusterPolicy(
|
|
163
|
+
args: PutClusterPolicyCommandInput,
|
|
164
|
+
cb: (err: any, data?: PutClusterPolicyCommandOutput) => void
|
|
165
|
+
): void;
|
|
166
|
+
putClusterPolicy(
|
|
167
|
+
args: PutClusterPolicyCommandInput,
|
|
168
|
+
options: __HttpHandlerOptions,
|
|
169
|
+
cb: (err: any, data?: PutClusterPolicyCommandOutput) => void
|
|
170
|
+
): void;
|
|
120
171
|
tagResource(
|
|
121
172
|
args: TagResourceCommandInput,
|
|
122
173
|
options?: __HttpHandlerOptions
|
|
@@ -53,10 +53,18 @@ import {
|
|
|
53
53
|
DeleteClusterCommandInput,
|
|
54
54
|
DeleteClusterCommandOutput,
|
|
55
55
|
} from "./commands/DeleteClusterCommand";
|
|
56
|
+
import {
|
|
57
|
+
DeleteClusterPolicyCommandInput,
|
|
58
|
+
DeleteClusterPolicyCommandOutput,
|
|
59
|
+
} from "./commands/DeleteClusterPolicyCommand";
|
|
56
60
|
import {
|
|
57
61
|
GetClusterCommandInput,
|
|
58
62
|
GetClusterCommandOutput,
|
|
59
63
|
} from "./commands/GetClusterCommand";
|
|
64
|
+
import {
|
|
65
|
+
GetClusterPolicyCommandInput,
|
|
66
|
+
GetClusterPolicyCommandOutput,
|
|
67
|
+
} from "./commands/GetClusterPolicyCommand";
|
|
60
68
|
import {
|
|
61
69
|
GetVpcEndpointServiceNameCommandInput,
|
|
62
70
|
GetVpcEndpointServiceNameCommandOutput,
|
|
@@ -69,6 +77,10 @@ import {
|
|
|
69
77
|
ListTagsForResourceCommandInput,
|
|
70
78
|
ListTagsForResourceCommandOutput,
|
|
71
79
|
} from "./commands/ListTagsForResourceCommand";
|
|
80
|
+
import {
|
|
81
|
+
PutClusterPolicyCommandInput,
|
|
82
|
+
PutClusterPolicyCommandOutput,
|
|
83
|
+
} from "./commands/PutClusterPolicyCommand";
|
|
72
84
|
import {
|
|
73
85
|
TagResourceCommandInput,
|
|
74
86
|
TagResourceCommandOutput,
|
|
@@ -91,20 +103,26 @@ export { __Client };
|
|
|
91
103
|
export type ServiceInputTypes =
|
|
92
104
|
| CreateClusterCommandInput
|
|
93
105
|
| DeleteClusterCommandInput
|
|
106
|
+
| DeleteClusterPolicyCommandInput
|
|
94
107
|
| GetClusterCommandInput
|
|
108
|
+
| GetClusterPolicyCommandInput
|
|
95
109
|
| GetVpcEndpointServiceNameCommandInput
|
|
96
110
|
| ListClustersCommandInput
|
|
97
111
|
| ListTagsForResourceCommandInput
|
|
112
|
+
| PutClusterPolicyCommandInput
|
|
98
113
|
| TagResourceCommandInput
|
|
99
114
|
| UntagResourceCommandInput
|
|
100
115
|
| UpdateClusterCommandInput;
|
|
101
116
|
export type ServiceOutputTypes =
|
|
102
117
|
| CreateClusterCommandOutput
|
|
103
118
|
| DeleteClusterCommandOutput
|
|
119
|
+
| DeleteClusterPolicyCommandOutput
|
|
104
120
|
| GetClusterCommandOutput
|
|
121
|
+
| GetClusterPolicyCommandOutput
|
|
105
122
|
| GetVpcEndpointServiceNameCommandOutput
|
|
106
123
|
| ListClustersCommandOutput
|
|
107
124
|
| ListTagsForResourceCommandOutput
|
|
125
|
+
| PutClusterPolicyCommandOutput
|
|
108
126
|
| TagResourceCommandOutput
|
|
109
127
|
| UntagResourceCommandOutput
|
|
110
128
|
| UpdateClusterCommandOutput;
|