@aws-sdk/client-secrets-manager 3.288.0 → 3.289.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/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/commands/CancelRotateSecretCommand.d.ts +17 -0
- package/dist-types/commands/CreateSecretCommand.d.ts +21 -0
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +17 -0
- package/dist-types/commands/DeleteSecretCommand.d.ts +19 -0
- package/dist-types/commands/DescribeSecretCommand.d.ts +48 -0
- package/dist-types/commands/GetRandomPasswordCommand.d.ts +18 -0
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +18 -0
- package/dist-types/commands/GetSecretValueCommand.d.ts +23 -0
- package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +38 -0
- package/dist-types/commands/ListSecretsCommand.d.ts +37 -0
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +18 -0
- package/dist-types/commands/PutSecretValueCommand.d.ts +23 -0
- package/dist-types/commands/RestoreSecretCommand.d.ts +17 -0
- package/dist-types/commands/RotateSecretCommand.d.ts +41 -0
- package/dist-types/commands/TagResourceCommand.d.ts +21 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +15 -0
- package/dist-types/commands/UpdateSecretCommand.d.ts +56 -0
- package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +58 -0
- package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +18 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +29 -29
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const q = "
|
|
5
|
-
const a =
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://secretsmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://secretsmanager-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://secretsmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://secretsmanager.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const q = "
|
|
2
|
-
const a =
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://secretsmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://secretsmanager-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://secretsmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://secretsmanager.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -47,6 +47,23 @@ export interface CancelRotateSecretCommandOutput extends CancelRotateSecretRespo
|
|
|
47
47
|
* @see {@link CancelRotateSecretCommandOutput} for command's `response` shape.
|
|
48
48
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
49
49
|
*
|
|
50
|
+
* @example To cancel scheduled rotation for a secret
|
|
51
|
+
* ```javascript
|
|
52
|
+
* // The following example shows how to cancel rotation for a secret. The operation sets the RotationEnabled field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the rotate-secret operation.
|
|
53
|
+
* const input = {
|
|
54
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
55
|
+
* };
|
|
56
|
+
* const command = new CancelRotateSecretCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* /* response ==
|
|
59
|
+
* {
|
|
60
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
61
|
+
* "Name": "Name"
|
|
62
|
+
* }
|
|
63
|
+
* *\/
|
|
64
|
+
* // example id: to-cancel-scheduled-rotation-for-a-secret-1523996016032
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
50
67
|
*/
|
|
51
68
|
export declare class CancelRotateSecretCommand extends $Command<CancelRotateSecretCommandInput, CancelRotateSecretCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
52
69
|
readonly input: CancelRotateSecretCommandInput;
|
|
@@ -64,6 +64,27 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
|
|
|
64
64
|
* @see {@link CreateSecretCommandOutput} for command's `response` shape.
|
|
65
65
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
66
66
|
*
|
|
67
|
+
* @example To create a basic secret
|
|
68
|
+
* ```javascript
|
|
69
|
+
* // The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named mycreds.json.
|
|
70
|
+
* const input = {
|
|
71
|
+
* "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
|
|
72
|
+
* "Description": "My test database secret created with the CLI",
|
|
73
|
+
* "Name": "MyTestDatabaseSecret",
|
|
74
|
+
* "SecretString": "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}"
|
|
75
|
+
* };
|
|
76
|
+
* const command = new CreateSecretCommand(input);
|
|
77
|
+
* const response = await client.send(command);
|
|
78
|
+
* /* response ==
|
|
79
|
+
* {
|
|
80
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
81
|
+
* "Name": "MyTestDatabaseSecret",
|
|
82
|
+
* "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1"
|
|
83
|
+
* }
|
|
84
|
+
* *\/
|
|
85
|
+
* // example id: to-create-a-basic-secret-1523996473658
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
67
88
|
*/
|
|
68
89
|
export declare class CreateSecretCommand extends $Command<CreateSecretCommandInput, CreateSecretCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
69
90
|
readonly input: CreateSecretCommandInput;
|
|
@@ -37,6 +37,23 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
|
|
|
37
37
|
* @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @example To delete the resource-based policy attached to a secret
|
|
41
|
+
* ```javascript
|
|
42
|
+
* // The following example shows how to delete the resource-based policy that is attached to a secret.
|
|
43
|
+
* const input = {
|
|
44
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
45
|
+
* };
|
|
46
|
+
* const command = new DeleteResourcePolicyCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* /* response ==
|
|
49
|
+
* {
|
|
50
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseMasterSecret-a1b2c3",
|
|
51
|
+
* "Name": "MyTestDatabaseSecret"
|
|
52
|
+
* }
|
|
53
|
+
* *\/
|
|
54
|
+
* // example id: to-delete-the-resource-based-policy-attached-to-a-secret-1530209419204
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
40
57
|
*/
|
|
41
58
|
export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
42
59
|
readonly input: DeleteResourcePolicyCommandInput;
|
|
@@ -57,6 +57,25 @@ export interface DeleteSecretCommandOutput extends DeleteSecretResponse, __Metad
|
|
|
57
57
|
* @see {@link DeleteSecretCommandOutput} for command's `response` shape.
|
|
58
58
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
59
59
|
*
|
|
60
|
+
* @example To delete a secret
|
|
61
|
+
* ```javascript
|
|
62
|
+
* // The following example shows how to delete a secret. The secret stays in your account in a deprecated and inaccessible state until the recovery window ends. After the date and time in the DeletionDate response field has passed, you can no longer recover this secret with restore-secret.
|
|
63
|
+
* const input = {
|
|
64
|
+
* "RecoveryWindowInDays": 7,
|
|
65
|
+
* "SecretId": "MyTestDatabaseSecret1"
|
|
66
|
+
* };
|
|
67
|
+
* const command = new DeleteSecretCommand(input);
|
|
68
|
+
* const response = await client.send(command);
|
|
69
|
+
* /* response ==
|
|
70
|
+
* {
|
|
71
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
72
|
+
* "DeletionDate": "1524085349.095",
|
|
73
|
+
* "Name": "MyTestDatabaseSecret"
|
|
74
|
+
* }
|
|
75
|
+
* *\/
|
|
76
|
+
* // example id: to-delete-a-secret-1523996905092
|
|
77
|
+
* ```
|
|
78
|
+
*
|
|
60
79
|
*/
|
|
61
80
|
export declare class DeleteSecretCommand extends $Command<DeleteSecretCommandInput, DeleteSecretCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
62
81
|
readonly input: DeleteSecretCommandInput;
|
|
@@ -37,6 +37,54 @@ export interface DescribeSecretCommandOutput extends DescribeSecretResponse, __M
|
|
|
37
37
|
* @see {@link DescribeSecretCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @example To retrieve the details of a secret
|
|
41
|
+
* ```javascript
|
|
42
|
+
* // The following example shows how to get the details about a secret.
|
|
43
|
+
* const input = {
|
|
44
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
45
|
+
* };
|
|
46
|
+
* const command = new DescribeSecretCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* /* response ==
|
|
49
|
+
* {
|
|
50
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
51
|
+
* "Description": "My test database secret",
|
|
52
|
+
* "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987KMSKEY1",
|
|
53
|
+
* "LastAccessedDate": "1523923200",
|
|
54
|
+
* "LastChangedDate": 1523477145.729,
|
|
55
|
+
* "LastRotatedDate": 1525747253.72,
|
|
56
|
+
* "Name": "MyTestDatabaseSecret",
|
|
57
|
+
* "NextRotationDate": "1665165599",
|
|
58
|
+
* "RotationEnabled": true,
|
|
59
|
+
* "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda",
|
|
60
|
+
* "RotationRules": {
|
|
61
|
+
* "AutomaticallyAfterDays": 14,
|
|
62
|
+
* "Duration": "2h",
|
|
63
|
+
* "ScheduleExpression": "cron(0 16 1,15 * ? *)"
|
|
64
|
+
* },
|
|
65
|
+
* "Tags": [
|
|
66
|
+
* {
|
|
67
|
+
* "Key": "SecondTag",
|
|
68
|
+
* "Value": "AnotherValue"
|
|
69
|
+
* },
|
|
70
|
+
* {
|
|
71
|
+
* "Key": "FirstTag",
|
|
72
|
+
* "Value": "SomeValue"
|
|
73
|
+
* }
|
|
74
|
+
* ],
|
|
75
|
+
* "VersionIdsToStages": {
|
|
76
|
+
* "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [
|
|
77
|
+
* "AWSPREVIOUS"
|
|
78
|
+
* ],
|
|
79
|
+
* "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [
|
|
80
|
+
* "AWSCURRENT"
|
|
81
|
+
* ]
|
|
82
|
+
* }
|
|
83
|
+
* }
|
|
84
|
+
* *\/
|
|
85
|
+
* // example id: to-retrieve-the-details-of-a-secret-1524000138629
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
40
88
|
*/
|
|
41
89
|
export declare class DescribeSecretCommand extends $Command<DescribeSecretCommandInput, DescribeSecretCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
42
90
|
readonly input: DescribeSecretCommandInput;
|
|
@@ -38,6 +38,24 @@ export interface GetRandomPasswordCommandOutput extends GetRandomPasswordRespons
|
|
|
38
38
|
* @see {@link GetRandomPasswordCommandOutput} for command's `response` shape.
|
|
39
39
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
40
40
|
*
|
|
41
|
+
* @example To generate a random password
|
|
42
|
+
* ```javascript
|
|
43
|
+
* // The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters.
|
|
44
|
+
* const input = {
|
|
45
|
+
* "IncludeSpace": true,
|
|
46
|
+
* "PasswordLength": 20,
|
|
47
|
+
* "RequireEachIncludedType": true
|
|
48
|
+
* };
|
|
49
|
+
* const command = new GetRandomPasswordCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* /* response ==
|
|
52
|
+
* {
|
|
53
|
+
* "RandomPassword": "EXAMPLE-PASSWORD"
|
|
54
|
+
* }
|
|
55
|
+
* *\/
|
|
56
|
+
* // example id: to-generate-a-random-password-1524000546092
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
41
59
|
*/
|
|
42
60
|
export declare class GetRandomPasswordCommand extends $Command<GetRandomPasswordCommandInput, GetRandomPasswordCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
43
61
|
readonly input: GetRandomPasswordCommandInput;
|
|
@@ -39,6 +39,24 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons
|
|
|
39
39
|
* @see {@link GetResourcePolicyCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @example To retrieve the resource-based policy attached to a secret
|
|
43
|
+
* ```javascript
|
|
44
|
+
* // The following example shows how to retrieve the resource-based policy that is attached to a secret.
|
|
45
|
+
* const input = {
|
|
46
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
47
|
+
* };
|
|
48
|
+
* const command = new GetResourcePolicyCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* /* response ==
|
|
51
|
+
* {
|
|
52
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
53
|
+
* "Name": "MyTestDatabaseSecret",
|
|
54
|
+
* "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}"
|
|
55
|
+
* }
|
|
56
|
+
* *\/
|
|
57
|
+
* // example id: to-retrieve-the-resource-based-policy-attached-to-a-secret-1530209677536
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
42
60
|
*/
|
|
43
61
|
export declare class GetResourcePolicyCommand extends $Command<GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
44
62
|
readonly input: GetResourcePolicyCommandInput;
|
|
@@ -45,6 +45,29 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
|
|
|
45
45
|
* @see {@link GetSecretValueCommandOutput} for command's `response` shape.
|
|
46
46
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
47
47
|
*
|
|
48
|
+
* @example To retrieve the encrypted secret value of a secret
|
|
49
|
+
* ```javascript
|
|
50
|
+
* // The following example shows how to retrieve a secret string value.
|
|
51
|
+
* const input = {
|
|
52
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
53
|
+
* };
|
|
54
|
+
* const command = new GetSecretValueCommand(input);
|
|
55
|
+
* const response = await client.send(command);
|
|
56
|
+
* /* response ==
|
|
57
|
+
* {
|
|
58
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
59
|
+
* "CreatedDate": 1523477145.713,
|
|
60
|
+
* "Name": "MyTestDatabaseSecret",
|
|
61
|
+
* "SecretString": "{\n \"username\":\"david\",\n \"password\":\"EXAMPLE-PASSWORD\"\n}\n",
|
|
62
|
+
* "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
|
|
63
|
+
* "VersionStages": [
|
|
64
|
+
* "AWSPREVIOUS"
|
|
65
|
+
* ]
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: to-retrieve-the-encrypted-secret-value-of-a-secret-1524000702484
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
48
71
|
*/
|
|
49
72
|
export declare class GetSecretValueCommand extends $Command<GetSecretValueCommandInput, GetSecretValueCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
50
73
|
readonly input: GetSecretValueCommandInput;
|
|
@@ -39,6 +39,44 @@ export interface ListSecretVersionIdsCommandOutput extends ListSecretVersionIdsR
|
|
|
39
39
|
* @see {@link ListSecretVersionIdsCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @example To list all of the secret versions associated with a secret
|
|
43
|
+
* ```javascript
|
|
44
|
+
* // The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels.
|
|
45
|
+
* const input = {
|
|
46
|
+
* "IncludeDeprecated": true,
|
|
47
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
48
|
+
* };
|
|
49
|
+
* const command = new ListSecretVersionIdsCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* /* response ==
|
|
52
|
+
* {
|
|
53
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
54
|
+
* "Name": "MyTestDatabaseSecret",
|
|
55
|
+
* "Versions": [
|
|
56
|
+
* {
|
|
57
|
+
* "CreatedDate": 1523477145.713,
|
|
58
|
+
* "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE",
|
|
59
|
+
* "VersionStages": [
|
|
60
|
+
* "AWSPREVIOUS"
|
|
61
|
+
* ]
|
|
62
|
+
* },
|
|
63
|
+
* {
|
|
64
|
+
* "CreatedDate": 1523486221.391,
|
|
65
|
+
* "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE",
|
|
66
|
+
* "VersionStages": [
|
|
67
|
+
* "AWSCURRENT"
|
|
68
|
+
* ]
|
|
69
|
+
* },
|
|
70
|
+
* {
|
|
71
|
+
* "CreatedDate": 1511974462.36,
|
|
72
|
+
* "VersionId": "EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;"
|
|
73
|
+
* }
|
|
74
|
+
* ]
|
|
75
|
+
* }
|
|
76
|
+
* *\/
|
|
77
|
+
* // example id: to-list-all-of-the-secret-versions-associated-with-a-secret-1524000999164
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
42
80
|
*/
|
|
43
81
|
export declare class ListSecretVersionIdsCommand extends $Command<ListSecretVersionIdsCommandInput, ListSecretVersionIdsCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
44
82
|
readonly input: ListSecretVersionIdsCommandInput;
|
|
@@ -43,6 +43,43 @@ export interface ListSecretsCommandOutput extends ListSecretsResponse, __Metadat
|
|
|
43
43
|
* @see {@link ListSecretsCommandOutput} for command's `response` shape.
|
|
44
44
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
45
45
|
*
|
|
46
|
+
* @example To list the secrets in your account
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // The following example shows how to list all of the secrets in your account.
|
|
49
|
+
* const input = {};
|
|
50
|
+
* const command = new ListSecretsCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* /* response ==
|
|
53
|
+
* {
|
|
54
|
+
* "SecretList": [
|
|
55
|
+
* {
|
|
56
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
57
|
+
* "Description": "My test database secret",
|
|
58
|
+
* "LastChangedDate": 1523477145.729,
|
|
59
|
+
* "Name": "MyTestDatabaseSecret",
|
|
60
|
+
* "SecretVersionsToStages": {
|
|
61
|
+
* "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [
|
|
62
|
+
* "AWSCURRENT"
|
|
63
|
+
* ]
|
|
64
|
+
* }
|
|
65
|
+
* },
|
|
66
|
+
* {
|
|
67
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret1-d4e5f6",
|
|
68
|
+
* "Description": "Another secret created for a different database",
|
|
69
|
+
* "LastChangedDate": 1523482025.685,
|
|
70
|
+
* "Name": "MyTestDatabaseSecret1",
|
|
71
|
+
* "SecretVersionsToStages": {
|
|
72
|
+
* "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [
|
|
73
|
+
* "AWSCURRENT"
|
|
74
|
+
* ]
|
|
75
|
+
* }
|
|
76
|
+
* }
|
|
77
|
+
* ]
|
|
78
|
+
* }
|
|
79
|
+
* *\/
|
|
80
|
+
* // example id: to-list-the-secrets-in-your-account-1524001246087
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
46
83
|
*/
|
|
47
84
|
export declare class ListSecretsCommand extends $Command<ListSecretsCommandInput, ListSecretsCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
48
85
|
readonly input: ListSecretsCommandInput;
|
|
@@ -40,6 +40,24 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
|
|
|
40
40
|
* @see {@link PutResourcePolicyCommandOutput} for command's `response` shape.
|
|
41
41
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
42
42
|
*
|
|
43
|
+
* @example To add a resource-based policy to a secret
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // The following example shows how to add a resource-based policy to a secret.
|
|
46
|
+
* const input = {
|
|
47
|
+
* "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}",
|
|
48
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
49
|
+
* };
|
|
50
|
+
* const command = new PutResourcePolicyCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* /* response ==
|
|
53
|
+
* {
|
|
54
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
55
|
+
* "Name": "MyTestDatabaseSecret"
|
|
56
|
+
* }
|
|
57
|
+
* *\/
|
|
58
|
+
* // example id: to-add-a-resource-based-policy-to-a-secret-1530209881839
|
|
59
|
+
* ```
|
|
60
|
+
*
|
|
43
61
|
*/
|
|
44
62
|
export declare class PutResourcePolicyCommand extends $Command<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
45
63
|
readonly input: PutResourcePolicyCommandInput;
|
|
@@ -56,6 +56,29 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M
|
|
|
56
56
|
* @see {@link PutSecretValueCommandOutput} for command's `response` shape.
|
|
57
57
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
58
58
|
*
|
|
59
|
+
* @example To store a secret value in a new version of a secret
|
|
60
|
+
* ```javascript
|
|
61
|
+
* // The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command.
|
|
62
|
+
* const input = {
|
|
63
|
+
* "ClientRequestToken": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE",
|
|
64
|
+
* "SecretId": "MyTestDatabaseSecret",
|
|
65
|
+
* "SecretString": "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}"
|
|
66
|
+
* };
|
|
67
|
+
* const command = new PutSecretValueCommand(input);
|
|
68
|
+
* const response = await client.send(command);
|
|
69
|
+
* /* response ==
|
|
70
|
+
* {
|
|
71
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
72
|
+
* "Name": "MyTestDatabaseSecret",
|
|
73
|
+
* "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE",
|
|
74
|
+
* "VersionStages": [
|
|
75
|
+
* "AWSCURRENT"
|
|
76
|
+
* ]
|
|
77
|
+
* }
|
|
78
|
+
* *\/
|
|
79
|
+
* // example id: to-store-a-secret-value-in-a-new-version-of-a-secret-1524001393971
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
59
82
|
*/
|
|
60
83
|
export declare class PutSecretValueCommand extends $Command<PutSecretValueCommandInput, PutSecretValueCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
61
84
|
readonly input: PutSecretValueCommandInput;
|
|
@@ -37,6 +37,23 @@ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __Met
|
|
|
37
37
|
* @see {@link RestoreSecretCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @example To restore a previously deleted secret
|
|
41
|
+
* ```javascript
|
|
42
|
+
* // The following example shows how to restore a secret that you previously scheduled for deletion.
|
|
43
|
+
* const input = {
|
|
44
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
45
|
+
* };
|
|
46
|
+
* const command = new RestoreSecretCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* /* response ==
|
|
49
|
+
* {
|
|
50
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
51
|
+
* "Name": "MyTestDatabaseSecret"
|
|
52
|
+
* }
|
|
53
|
+
* *\/
|
|
54
|
+
* // example id: to-restore-a-previously-deleted-secret-1524001513930
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
40
57
|
*/
|
|
41
58
|
export declare class RestoreSecretCommand extends $Command<RestoreSecretCommandInput, RestoreSecretCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
42
59
|
readonly input: RestoreSecretCommandInput;
|
|
@@ -44,6 +44,47 @@ export interface RotateSecretCommandOutput extends RotateSecretResponse, __Metad
|
|
|
44
44
|
* @see {@link RotateSecretCommandOutput} for command's `response` shape.
|
|
45
45
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
46
46
|
*
|
|
47
|
+
* @example To configure rotation for a secret
|
|
48
|
+
* ```javascript
|
|
49
|
+
* // The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM.
|
|
50
|
+
* const input = {
|
|
51
|
+
* "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda",
|
|
52
|
+
* "RotationRules": {
|
|
53
|
+
* "Duration": "2h",
|
|
54
|
+
* "ScheduleExpression": "cron(0 16 1,15 * ? *)"
|
|
55
|
+
* },
|
|
56
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
57
|
+
* };
|
|
58
|
+
* const command = new RotateSecretCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* /* response ==
|
|
61
|
+
* {
|
|
62
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
63
|
+
* "Name": "MyTestDatabaseSecret",
|
|
64
|
+
* "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
|
|
65
|
+
* }
|
|
66
|
+
* *\/
|
|
67
|
+
* // example id: to-configure-rotation-for-a-secret-1524001629475
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @example To request an immediate rotation for a secret
|
|
71
|
+
* ```javascript
|
|
72
|
+
* // The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background.
|
|
73
|
+
* const input = {
|
|
74
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
75
|
+
* };
|
|
76
|
+
* const command = new RotateSecretCommand(input);
|
|
77
|
+
* const response = await client.send(command);
|
|
78
|
+
* /* response ==
|
|
79
|
+
* {
|
|
80
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
81
|
+
* "Name": "MyTestDatabaseSecret",
|
|
82
|
+
* "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
|
|
83
|
+
* }
|
|
84
|
+
* *\/
|
|
85
|
+
* // example id: to-request-an-immediate-rotation-for-a-secret-1524001949004
|
|
86
|
+
* ```
|
|
87
|
+
*
|
|
47
88
|
*/
|
|
48
89
|
export declare class RotateSecretCommand extends $Command<RotateSecretCommandInput, RotateSecretCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
49
90
|
readonly input: RotateSecretCommandInput;
|
|
@@ -69,6 +69,27 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
69
69
|
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
70
70
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
71
71
|
*
|
|
72
|
+
* @example To add tags to a secret
|
|
73
|
+
* ```javascript
|
|
74
|
+
* // The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation.
|
|
75
|
+
* const input = {
|
|
76
|
+
* "SecretId": "MyExampleSecret",
|
|
77
|
+
* "Tags": [
|
|
78
|
+
* {
|
|
79
|
+
* "Key": "FirstTag",
|
|
80
|
+
* "Value": "SomeValue"
|
|
81
|
+
* },
|
|
82
|
+
* {
|
|
83
|
+
* "Key": "SecondTag",
|
|
84
|
+
* "Value": "AnotherValue"
|
|
85
|
+
* }
|
|
86
|
+
* ]
|
|
87
|
+
* };
|
|
88
|
+
* const command = new TagResourceCommand(input);
|
|
89
|
+
* await client.send(command);
|
|
90
|
+
* // example id: to-add-tags-to-a-secret-1524002106718
|
|
91
|
+
* ```
|
|
92
|
+
*
|
|
72
93
|
*/
|
|
73
94
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
74
95
|
readonly input: TagResourceCommandInput;
|
|
@@ -44,6 +44,21 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
44
44
|
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
45
45
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
46
46
|
*
|
|
47
|
+
* @example To remove tags from a secret
|
|
48
|
+
* ```javascript
|
|
49
|
+
* // The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation.
|
|
50
|
+
* const input = {
|
|
51
|
+
* "SecretId": "MyTestDatabaseSecret",
|
|
52
|
+
* "TagKeys": [
|
|
53
|
+
* "FirstTag",
|
|
54
|
+
* "SecondTag"
|
|
55
|
+
* ]
|
|
56
|
+
* };
|
|
57
|
+
* const command = new UntagResourceCommand(input);
|
|
58
|
+
* await client.send(command);
|
|
59
|
+
* // example id: to-remove-tags-from-a-secret-1524002239065
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
47
62
|
*/
|
|
48
63
|
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
49
64
|
readonly input: UntagResourceCommandInput;
|
|
@@ -55,6 +55,62 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
|
|
|
55
55
|
* @see {@link UpdateSecretCommandOutput} for command's `response` shape.
|
|
56
56
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
57
57
|
*
|
|
58
|
+
* @example To update the description of a secret
|
|
59
|
+
* ```javascript
|
|
60
|
+
* // The following example shows how to modify the description of a secret.
|
|
61
|
+
* const input = {
|
|
62
|
+
* "ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE",
|
|
63
|
+
* "Description": "This is a new description for the secret.",
|
|
64
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
65
|
+
* };
|
|
66
|
+
* const command = new UpdateSecretCommand(input);
|
|
67
|
+
* const response = await client.send(command);
|
|
68
|
+
* /* response ==
|
|
69
|
+
* {
|
|
70
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
71
|
+
* "Name": "MyTestDatabaseSecret"
|
|
72
|
+
* }
|
|
73
|
+
* *\/
|
|
74
|
+
* // example id: to-update-the-description-of-a-secret-1524002349094
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @example To update the KMS key associated with a secret
|
|
78
|
+
* ```javascript
|
|
79
|
+
* // This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret.
|
|
80
|
+
* const input = {
|
|
81
|
+
* "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE",
|
|
82
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
83
|
+
* };
|
|
84
|
+
* const command = new UpdateSecretCommand(input);
|
|
85
|
+
* const response = await client.send(command);
|
|
86
|
+
* /* response ==
|
|
87
|
+
* {
|
|
88
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
89
|
+
* "Name": "MyTestDatabaseSecret"
|
|
90
|
+
* }
|
|
91
|
+
* *\/
|
|
92
|
+
* // example id: to-update-the-kms-key-associated-with-a-secret-1524002421563
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
95
|
+
* @example To create a new version of the encrypted secret value
|
|
96
|
+
* ```javascript
|
|
97
|
+
* // The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation.
|
|
98
|
+
* const input = {
|
|
99
|
+
* "SecretId": "MyTestDatabaseSecret",
|
|
100
|
+
* "SecretString": "{JSON STRING WITH CREDENTIALS}"
|
|
101
|
+
* };
|
|
102
|
+
* const command = new UpdateSecretCommand(input);
|
|
103
|
+
* const response = await client.send(command);
|
|
104
|
+
* /* response ==
|
|
105
|
+
* {
|
|
106
|
+
* "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
107
|
+
* "Name": "MyTestDatabaseSecret",
|
|
108
|
+
* "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE"
|
|
109
|
+
* }
|
|
110
|
+
* *\/
|
|
111
|
+
* // example id: to-create-a-new-version-of-the-encrypted-secret-value-1524004651836
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
58
114
|
*/
|
|
59
115
|
export declare class UpdateSecretCommand extends $Command<UpdateSecretCommandInput, UpdateSecretCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
60
116
|
readonly input: UpdateSecretCommandInput;
|
|
@@ -50,6 +50,64 @@ export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersi
|
|
|
50
50
|
* @see {@link UpdateSecretVersionStageCommandOutput} for command's `response` shape.
|
|
51
51
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
52
52
|
*
|
|
53
|
+
* @example To add a staging label attached to a version of a secret
|
|
54
|
+
* ```javascript
|
|
55
|
+
* // The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.
|
|
56
|
+
* const input = {
|
|
57
|
+
* "MoveToVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
|
|
58
|
+
* "SecretId": "MyTestDatabaseSecret",
|
|
59
|
+
* "VersionStage": "STAGINGLABEL1"
|
|
60
|
+
* };
|
|
61
|
+
* const command = new UpdateSecretVersionStageCommand(input);
|
|
62
|
+
* const response = await client.send(command);
|
|
63
|
+
* /* response ==
|
|
64
|
+
* {
|
|
65
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
66
|
+
* "Name": "MyTestDatabaseSecret"
|
|
67
|
+
* }
|
|
68
|
+
* *\/
|
|
69
|
+
* // example id: to-add-a-staging-label-attached-to-a-version-of-a-secret-1524004783841
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @example To delete a staging label attached to a version of a secret
|
|
73
|
+
* ```javascript
|
|
74
|
+
* // The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.
|
|
75
|
+
* const input = {
|
|
76
|
+
* "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
|
|
77
|
+
* "SecretId": "MyTestDatabaseSecret",
|
|
78
|
+
* "VersionStage": "STAGINGLABEL1"
|
|
79
|
+
* };
|
|
80
|
+
* const command = new UpdateSecretVersionStageCommand(input);
|
|
81
|
+
* const response = await client.send(command);
|
|
82
|
+
* /* response ==
|
|
83
|
+
* {
|
|
84
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
85
|
+
* "Name": "MyTestDatabaseSecret"
|
|
86
|
+
* }
|
|
87
|
+
* *\/
|
|
88
|
+
* // example id: to-delete-a-staging-label-attached-to-a-version-of-a-secret-1524004862181
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
91
|
+
* @example To move a staging label from one version of a secret to another
|
|
92
|
+
* ```javascript
|
|
93
|
+
* // The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.
|
|
94
|
+
* const input = {
|
|
95
|
+
* "MoveToVersionId": "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2",
|
|
96
|
+
* "RemoveFromVersionId": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
|
|
97
|
+
* "SecretId": "MyTestDatabaseSecret",
|
|
98
|
+
* "VersionStage": "AWSCURRENT"
|
|
99
|
+
* };
|
|
100
|
+
* const command = new UpdateSecretVersionStageCommand(input);
|
|
101
|
+
* const response = await client.send(command);
|
|
102
|
+
* /* response ==
|
|
103
|
+
* {
|
|
104
|
+
* "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
|
|
105
|
+
* "Name": "MyTestDatabaseSecret"
|
|
106
|
+
* }
|
|
107
|
+
* *\/
|
|
108
|
+
* // example id: to-move-a-staging-label-from-one-version-of-a-secret-to-another-1524004963841
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
53
111
|
*/
|
|
54
112
|
export declare class UpdateSecretVersionStageCommand extends $Command<UpdateSecretVersionStageCommandInput, UpdateSecretVersionStageCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
55
113
|
readonly input: UpdateSecretVersionStageCommandInput;
|
|
@@ -50,6 +50,24 @@ export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePol
|
|
|
50
50
|
* @see {@link ValidateResourcePolicyCommandOutput} for command's `response` shape.
|
|
51
51
|
* @see {@link SecretsManagerClientResolvedConfig | config} for SecretsManagerClient's `config` shape.
|
|
52
52
|
*
|
|
53
|
+
* @example To validate a resource-based policy to a secret
|
|
54
|
+
* ```javascript
|
|
55
|
+
* // The following example shows how to validate a resource-based policy to a secret.
|
|
56
|
+
* const input = {
|
|
57
|
+
* "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}",
|
|
58
|
+
* "SecretId": "MyTestDatabaseSecret"
|
|
59
|
+
* };
|
|
60
|
+
* const command = new ValidateResourcePolicyCommand(input);
|
|
61
|
+
* const response = await client.send(command);
|
|
62
|
+
* /* response ==
|
|
63
|
+
* {
|
|
64
|
+
* "PolicyValidationPassed": true,
|
|
65
|
+
* "ValidationErrors": []
|
|
66
|
+
* }
|
|
67
|
+
* *\/
|
|
68
|
+
* // example id: to-validate-the-resource-policy-of-a-secret-1524000138629
|
|
69
|
+
* ```
|
|
70
|
+
*
|
|
53
71
|
*/
|
|
54
72
|
export declare class ValidateResourcePolicyCommand extends $Command<ValidateResourcePolicyCommandInput, ValidateResourcePolicyCommandOutput, SecretsManagerClientResolvedConfig> {
|
|
55
73
|
readonly input: ValidateResourcePolicyCommandInput;
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region?: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|
|
@@ -27,7 +27,7 @@ export declare const resolveClientEndpointParameters: <T>(
|
|
|
27
27
|
defaultSigningName: string;
|
|
28
28
|
};
|
|
29
29
|
export interface EndpointParameters extends __EndpointParameters {
|
|
30
|
-
Region
|
|
30
|
+
Region?: string;
|
|
31
31
|
UseDualStack?: boolean;
|
|
32
32
|
UseFIPS?: boolean;
|
|
33
33
|
Endpoint?: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-secrets-manager",
|
|
3
3
|
"description": "AWS SDK for JavaScript Secrets Manager Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.289.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -20,37 +20,37 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
-
"@aws-sdk/config-resolver": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
27
|
-
"@aws-sdk/hash-node": "3.
|
|
28
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
29
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
30
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
31
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
32
|
-
"@aws-sdk/middleware-logger": "3.
|
|
33
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
34
|
-
"@aws-sdk/middleware-retry": "3.
|
|
35
|
-
"@aws-sdk/middleware-serde": "3.
|
|
36
|
-
"@aws-sdk/middleware-signing": "3.
|
|
37
|
-
"@aws-sdk/middleware-stack": "3.
|
|
38
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
39
|
-
"@aws-sdk/node-config-provider": "3.
|
|
40
|
-
"@aws-sdk/node-http-handler": "3.
|
|
41
|
-
"@aws-sdk/protocol-http": "3.
|
|
42
|
-
"@aws-sdk/smithy-client": "3.
|
|
43
|
-
"@aws-sdk/types": "3.
|
|
44
|
-
"@aws-sdk/url-parser": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.289.0",
|
|
24
|
+
"@aws-sdk/config-resolver": "3.289.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.289.0",
|
|
26
|
+
"@aws-sdk/fetch-http-handler": "3.289.0",
|
|
27
|
+
"@aws-sdk/hash-node": "3.289.0",
|
|
28
|
+
"@aws-sdk/invalid-dependency": "3.289.0",
|
|
29
|
+
"@aws-sdk/middleware-content-length": "3.289.0",
|
|
30
|
+
"@aws-sdk/middleware-endpoint": "3.289.0",
|
|
31
|
+
"@aws-sdk/middleware-host-header": "3.289.0",
|
|
32
|
+
"@aws-sdk/middleware-logger": "3.289.0",
|
|
33
|
+
"@aws-sdk/middleware-recursion-detection": "3.289.0",
|
|
34
|
+
"@aws-sdk/middleware-retry": "3.289.0",
|
|
35
|
+
"@aws-sdk/middleware-serde": "3.289.0",
|
|
36
|
+
"@aws-sdk/middleware-signing": "3.289.0",
|
|
37
|
+
"@aws-sdk/middleware-stack": "3.289.0",
|
|
38
|
+
"@aws-sdk/middleware-user-agent": "3.289.0",
|
|
39
|
+
"@aws-sdk/node-config-provider": "3.289.0",
|
|
40
|
+
"@aws-sdk/node-http-handler": "3.289.0",
|
|
41
|
+
"@aws-sdk/protocol-http": "3.289.0",
|
|
42
|
+
"@aws-sdk/smithy-client": "3.289.0",
|
|
43
|
+
"@aws-sdk/types": "3.289.0",
|
|
44
|
+
"@aws-sdk/url-parser": "3.289.0",
|
|
45
45
|
"@aws-sdk/util-base64": "3.208.0",
|
|
46
46
|
"@aws-sdk/util-body-length-browser": "3.188.0",
|
|
47
47
|
"@aws-sdk/util-body-length-node": "3.208.0",
|
|
48
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
49
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
50
|
-
"@aws-sdk/util-endpoints": "3.
|
|
51
|
-
"@aws-sdk/util-retry": "3.
|
|
52
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
53
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
48
|
+
"@aws-sdk/util-defaults-mode-browser": "3.289.0",
|
|
49
|
+
"@aws-sdk/util-defaults-mode-node": "3.289.0",
|
|
50
|
+
"@aws-sdk/util-endpoints": "3.289.0",
|
|
51
|
+
"@aws-sdk/util-retry": "3.289.0",
|
|
52
|
+
"@aws-sdk/util-user-agent-browser": "3.289.0",
|
|
53
|
+
"@aws-sdk/util-user-agent-node": "3.289.0",
|
|
54
54
|
"@aws-sdk/util-utf8": "3.254.0",
|
|
55
55
|
"tslib": "^2.3.1",
|
|
56
56
|
"uuid": "^8.3.2"
|