@aws-sdk/client-secrets-manager 3.235.0 → 3.237.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 +2 -5
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/SecretsManager.d.ts +12 -48
- package/dist-types/SecretsManagerClient.d.ts +2 -19
- package/dist-types/commands/CreateSecretCommand.d.ts +3 -0
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetSecretValueCommand.d.ts +0 -1
- package/dist-types/commands/RotateSecretCommand.d.ts +3 -22
- package/dist-types/commands/TagResourceCommand.d.ts +2 -3
- package/dist-types/commands/UpdateSecretCommand.d.ts +1 -2
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +7 -8
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -12,23 +12,20 @@ AWS SDK for JavaScript SecretsManager Client for Node.js, Browser and React Nati
|
|
|
12
12
|
<fullname>Amazon Web Services Secrets Manager</fullname>
|
|
13
13
|
|
|
14
14
|
<p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
|
|
15
|
-
|
|
16
15
|
<p>This guide provides descriptions of the Secrets Manager API. For more information about using this
|
|
17
16
|
service, see the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html">Amazon Web Services Secrets Manager User Guide</a>.</p>
|
|
18
|
-
|
|
19
17
|
<p>
|
|
20
18
|
<b>API Version</b>
|
|
21
19
|
</p>
|
|
22
|
-
|
|
23
20
|
<p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
|
|
24
|
-
|
|
21
|
+
<p>For a list of endpoints, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints">Amazon Web Services Secrets Manager
|
|
22
|
+
endpoints</a>.</p>
|
|
25
23
|
<p>
|
|
26
24
|
<b>Support and Feedback for Amazon Web Services Secrets Manager</b>
|
|
27
25
|
</p>
|
|
28
26
|
<p>We welcome your feedback. Send your comments to <a href="mailto:awssecretsmanager-feedback@amazon.com">awssecretsmanager-feedback@amazon.com</a>, or post your feedback and questions in the <a href="http://forums.aws.amazon.com/forum.jspa?forumID=296">Amazon Web Services Secrets Manager Discussion Forum</a>. For more
|
|
29
27
|
information about the Amazon Web Services Discussion Forums, see <a href="http://forums.aws.amazon.com/help.jspa">Forums
|
|
30
28
|
Help</a>.</p>
|
|
31
|
-
|
|
32
29
|
<p>
|
|
33
30
|
<b>Logging API Requests</b>
|
|
34
31
|
</p>
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a =
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region: {
|
|
4
|
+
const q = "fn", r = "argv", s = "ref";
|
|
5
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = { "required": true, "default": false, "type": "Boolean" }, i = { [s]: "Endpoint" }, j = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, k = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, l = {}, m = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsFIPS"] }] }, n = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsDualStack"] }] }, o = [j], p = [k];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: h, UseFIPS: h, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: d }], type: e, rules: [{ conditions: [{ [q]: "isSet", [r]: [i] }], type: e, rules: [{ conditions: o, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: p, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: i, properties: l, headers: l }, type: g }] }] }, { conditions: [j, k], type: e, rules: [{ conditions: [m, n], type: e, rules: [{ endpoint: { url: "https://secretsmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: o, type: e, rules: [{ conditions: [m], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://secretsmanager-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: p, type: e, rules: [{ conditions: [n], type: e, rules: [{ endpoint: { url: "https://secretsmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { endpoint: { url: "https://secretsmanager.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a =
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region: {
|
|
1
|
+
const q = "fn", r = "argv", s = "ref";
|
|
2
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = { "required": true, "default": false, "type": "Boolean" }, i = { [s]: "Endpoint" }, j = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, k = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, l = {}, m = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsFIPS"] }] }, n = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsDualStack"] }] }, o = [j], p = [k];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: h, UseFIPS: h, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: d }], type: e, rules: [{ conditions: [{ [q]: "isSet", [r]: [i] }], type: e, rules: [{ conditions: o, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: p, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: i, properties: l, headers: l }, type: g }] }] }, { conditions: [j, k], type: e, rules: [{ conditions: [m, n], type: e, rules: [{ endpoint: { url: "https://secretsmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: o, type: e, rules: [{ conditions: [m], type: e, rules: [{ type: e, rules: [{ endpoint: { url: "https://secretsmanager-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: p, type: e, rules: [{ conditions: [n], type: e, rules: [{ endpoint: { url: "https://secretsmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { endpoint: { url: "https://secretsmanager.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -25,37 +25,20 @@ import { SecretsManagerClient } from "./SecretsManagerClient";
|
|
|
25
25
|
/**
|
|
26
26
|
* <fullname>Amazon Web Services Secrets Manager</fullname>
|
|
27
27
|
* <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
|
|
28
|
-
*
|
|
29
28
|
* <p>This guide provides descriptions of the Secrets Manager API. For more information about using this
|
|
30
29
|
* service, see the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html">Amazon Web Services Secrets Manager User Guide</a>.</p>
|
|
31
|
-
*
|
|
32
30
|
* <p>
|
|
33
31
|
* <b>API Version</b>
|
|
34
32
|
* </p>
|
|
35
|
-
*
|
|
36
33
|
* <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
34
|
+
* <p>For a list of endpoints, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints">Amazon Web Services Secrets Manager
|
|
35
|
+
* endpoints</a>.</p>
|
|
52
36
|
* <p>
|
|
53
37
|
* <b>Support and Feedback for Amazon Web Services Secrets Manager</b>
|
|
54
38
|
* </p>
|
|
55
39
|
* <p>We welcome your feedback. Send your comments to <a href="mailto:awssecretsmanager-feedback@amazon.com">awssecretsmanager-feedback@amazon.com</a>, or post your feedback and questions in the <a href="http://forums.aws.amazon.com/forum.jspa?forumID=296">Amazon Web Services Secrets Manager Discussion Forum</a>. For more
|
|
56
40
|
* information about the Amazon Web Services Discussion Forums, see <a href="http://forums.aws.amazon.com/help.jspa">Forums
|
|
57
41
|
* Help</a>.</p>
|
|
58
|
-
*
|
|
59
42
|
* <p>
|
|
60
43
|
* <b>Logging API Requests</b>
|
|
61
44
|
* </p>
|
|
@@ -99,6 +82,9 @@ export declare class SecretsManager extends SecretsManagerClient {
|
|
|
99
82
|
* includes the connection information to access a database or other service, which Secrets Manager
|
|
100
83
|
* doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the
|
|
101
84
|
* important information needed to manage the secret.</p>
|
|
85
|
+
* <p>For secrets that use <i>managed rotation</i>, you need to create the secret through the managing service. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.
|
|
86
|
+
*
|
|
87
|
+
* </p>
|
|
102
88
|
* <p>For information about creating a secret in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html">Create a secret</a>.</p>
|
|
103
89
|
* <p>To create a secret, you can provide the secret value to be encrypted in either the
|
|
104
90
|
* <code>SecretString</code> parameter or the <code>SecretBinary</code> parameter, but not both.
|
|
@@ -212,7 +198,7 @@ export declare class SecretsManager extends SecretsManagerClient {
|
|
|
212
198
|
* secret. For more information about permissions policies attached to a secret, see
|
|
213
199
|
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html">Permissions
|
|
214
200
|
* policies attached to a secret</a>.</p>
|
|
215
|
-
*
|
|
201
|
+
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
216
202
|
* <p>
|
|
217
203
|
* <b>Required permissions: </b>
|
|
218
204
|
* <code>secretsmanager:GetResourcePolicy</code>.
|
|
@@ -232,7 +218,6 @@ export declare class SecretsManager extends SecretsManagerClient {
|
|
|
232
218
|
* your applications</a>.</p>
|
|
233
219
|
* <p>To retrieve the previous version of a secret, use <code>VersionStage</code> and specify
|
|
234
220
|
* AWSPREVIOUS. To revert to the previous version of a secret, call <a href="https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html">UpdateSecretVersionStage</a>.</p>
|
|
235
|
-
*
|
|
236
221
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
237
222
|
* <p>
|
|
238
223
|
* <b>Required permissions: </b>
|
|
@@ -373,32 +358,13 @@ export declare class SecretsManager extends SecretsManagerClient {
|
|
|
373
358
|
restoreSecret(args: RestoreSecretCommandInput, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
|
|
374
359
|
restoreSecret(args: RestoreSecretCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreSecretCommandOutput) => void): void;
|
|
375
360
|
/**
|
|
376
|
-
* <p>Configures and starts the asynchronous process of rotating the secret. For
|
|
377
|
-
* see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a
|
|
378
|
-
* <p>If you include the
|
|
379
|
-
* configuration parameters, the operation sets the values for the secret and then immediately
|
|
380
|
-
* starts a rotation. If you don't include the configuration parameters, the operation starts a
|
|
381
|
-
* rotation with the values already stored in the secret. </p>
|
|
382
|
-
* <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must
|
|
383
|
-
* make sure the secret value is in the
|
|
384
|
-
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html"> JSON structure
|
|
385
|
-
* of a database secret</a>. In particular, if you want to use the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users"> alternating users strategy</a>, your secret must contain the ARN of a superuser
|
|
386
|
-
* secret.</p>
|
|
387
|
-
*
|
|
388
|
-
* <p>To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule
|
|
389
|
-
* for the rotation. The Lambda rotation function creates a new
|
|
390
|
-
* version of the secret and creates or updates the credentials on the database or service to
|
|
391
|
-
* match. After testing the new credentials, the function marks the new secret version with the staging
|
|
392
|
-
* label <code>AWSCURRENT</code>. Then anyone who retrieves the secret gets the new version. For more
|
|
393
|
-
* information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
|
|
394
|
-
* <p>You can create the Lambda rotation function based on the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html">rotation function templates</a> that Secrets Manager provides. Choose
|
|
395
|
-
* a template that matches your <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html">Rotation strategy</a>.</p>
|
|
361
|
+
* <p>Configures and starts the asynchronous process of rotating the secret. For information about rotation,
|
|
362
|
+
* see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a> in the <i>Secrets Manager User Guide</i>. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. </p>
|
|
396
363
|
* <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached
|
|
397
364
|
* to the same version as the <code>AWSCURRENT</code> version, or it might not be attached to any
|
|
398
365
|
* version. If the <code>AWSPENDING</code> staging label is present but not attached to the same
|
|
399
366
|
* version as <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code>
|
|
400
|
-
* assumes that a previous rotation request is still in progress and returns an error
|
|
401
|
-
* <p>When rotation is unsuccessful, the <code>AWSPENDING</code> staging label might be attached to an empty secret version. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
|
|
367
|
+
* assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the <code>AWSPENDING</code> staging label might be attached to an empty secret version. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
|
|
402
368
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
403
369
|
* <p>
|
|
404
370
|
* <b>Required permissions: </b>
|
|
@@ -429,8 +395,8 @@ export declare class SecretsManager extends SecretsManagerClient {
|
|
|
429
395
|
/**
|
|
430
396
|
* <p>Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the
|
|
431
397
|
* secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.</p>
|
|
432
|
-
*
|
|
433
|
-
*
|
|
398
|
+
* <p>The following restrictions apply to tags:</p>
|
|
399
|
+
* <ul>
|
|
434
400
|
* <li>
|
|
435
401
|
* <p>Maximum number of tags per secret: 50</p>
|
|
436
402
|
* </li>
|
|
@@ -455,7 +421,6 @@ export declare class SecretsManager extends SecretsManagerClient {
|
|
|
455
421
|
* following special characters: + - = . _ : / @.</p>
|
|
456
422
|
* </li>
|
|
457
423
|
* </ul>
|
|
458
|
-
*
|
|
459
424
|
* <important>
|
|
460
425
|
* <p>If you use tags as part of your security strategy, then adding or removing a tag can
|
|
461
426
|
* change permissions. If successfully completing this operation would result in you losing
|
|
@@ -497,7 +462,7 @@ export declare class SecretsManager extends SecretsManagerClient {
|
|
|
497
462
|
/**
|
|
498
463
|
* <p>Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use <a>PutSecretValue</a>.</p>
|
|
499
464
|
* <p>To change the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p>
|
|
500
|
-
*
|
|
465
|
+
* <p>To change a secret so that it is managed by another service, you need to recreate the secret in that service. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.</p>
|
|
501
466
|
* <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more than
|
|
502
467
|
* once every 10 minutes. When you call <code>UpdateSecret</code> to update the secret value, Secrets Manager creates a new version
|
|
503
468
|
* of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
|
|
@@ -508,7 +473,6 @@ export declare class SecretsManager extends SecretsManagerClient {
|
|
|
508
473
|
* secret version, Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to the new
|
|
509
474
|
* version. Then it attaches the label <code>AWSPREVIOUS</code>
|
|
510
475
|
* to the version that <code>AWSCURRENT</code> was removed from.</p>
|
|
511
|
-
*
|
|
512
476
|
* <p>If you call this operation with a <code>ClientRequestToken</code> that matches an existing version's
|
|
513
477
|
* <code>VersionId</code>, the operation results in an error. You can't modify an existing
|
|
514
478
|
* version, you can only create a new version. To remove a version, remove all staging labels from it. See
|
|
@@ -147,37 +147,20 @@ export interface SecretsManagerClientResolvedConfig extends SecretsManagerClient
|
|
|
147
147
|
/**
|
|
148
148
|
* <fullname>Amazon Web Services Secrets Manager</fullname>
|
|
149
149
|
* <p>Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p>
|
|
150
|
-
*
|
|
151
150
|
* <p>This guide provides descriptions of the Secrets Manager API. For more information about using this
|
|
152
151
|
* service, see the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html">Amazon Web Services Secrets Manager User Guide</a>.</p>
|
|
153
|
-
*
|
|
154
152
|
* <p>
|
|
155
153
|
* <b>API Version</b>
|
|
156
154
|
* </p>
|
|
157
|
-
*
|
|
158
155
|
* <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p>
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
156
|
+
* <p>For a list of endpoints, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/asm_access.html#endpoints">Amazon Web Services Secrets Manager
|
|
157
|
+
* endpoints</a>.</p>
|
|
174
158
|
* <p>
|
|
175
159
|
* <b>Support and Feedback for Amazon Web Services Secrets Manager</b>
|
|
176
160
|
* </p>
|
|
177
161
|
* <p>We welcome your feedback. Send your comments to <a href="mailto:awssecretsmanager-feedback@amazon.com">awssecretsmanager-feedback@amazon.com</a>, or post your feedback and questions in the <a href="http://forums.aws.amazon.com/forum.jspa?forumID=296">Amazon Web Services Secrets Manager Discussion Forum</a>. For more
|
|
178
162
|
* information about the Amazon Web Services Discussion Forums, see <a href="http://forums.aws.amazon.com/help.jspa">Forums
|
|
179
163
|
* Help</a>.</p>
|
|
180
|
-
*
|
|
181
164
|
* <p>
|
|
182
165
|
* <b>Logging API Requests</b>
|
|
183
166
|
* </p>
|
|
@@ -14,6 +14,9 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
|
|
|
14
14
|
* includes the connection information to access a database or other service, which Secrets Manager
|
|
15
15
|
* doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the
|
|
16
16
|
* important information needed to manage the secret.</p>
|
|
17
|
+
* <p>For secrets that use <i>managed rotation</i>, you need to create the secret through the managing service. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.
|
|
18
|
+
*
|
|
19
|
+
* </p>
|
|
17
20
|
* <p>For information about creating a secret in the console, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html">Create a secret</a>.</p>
|
|
18
21
|
* <p>To create a secret, you can provide the secret value to be encrypted in either the
|
|
19
22
|
* <code>SecretString</code> parameter or the <code>SecretBinary</code> parameter, but not both.
|
|
@@ -12,7 +12,7 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyRespons
|
|
|
12
12
|
* secret. For more information about permissions policies attached to a secret, see
|
|
13
13
|
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html">Permissions
|
|
14
14
|
* policies attached to a secret</a>.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
16
16
|
* <p>
|
|
17
17
|
* <b>Required permissions: </b>
|
|
18
18
|
* <code>secretsmanager:GetResourcePolicy</code>.
|
|
@@ -16,7 +16,6 @@ export interface GetSecretValueCommandOutput extends GetSecretValueResponse, __M
|
|
|
16
16
|
* your applications</a>.</p>
|
|
17
17
|
* <p>To retrieve the previous version of a secret, use <code>VersionStage</code> and specify
|
|
18
18
|
* AWSPREVIOUS. To revert to the previous version of a secret, call <a href="https://docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html">UpdateSecretVersionStage</a>.</p>
|
|
19
|
-
*
|
|
20
19
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
21
20
|
* <p>
|
|
22
21
|
* <b>Required permissions: </b>
|
|
@@ -8,32 +8,13 @@ export interface RotateSecretCommandInput extends RotateSecretRequest {
|
|
|
8
8
|
export interface RotateSecretCommandOutput extends RotateSecretResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Configures and starts the asynchronous process of rotating the secret. For
|
|
12
|
-
* see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a
|
|
13
|
-
* <p>If you include the
|
|
14
|
-
* configuration parameters, the operation sets the values for the secret and then immediately
|
|
15
|
-
* starts a rotation. If you don't include the configuration parameters, the operation starts a
|
|
16
|
-
* rotation with the values already stored in the secret. </p>
|
|
17
|
-
* <p>For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must
|
|
18
|
-
* make sure the secret value is in the
|
|
19
|
-
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html"> JSON structure
|
|
20
|
-
* of a database secret</a>. In particular, if you want to use the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users"> alternating users strategy</a>, your secret must contain the ARN of a superuser
|
|
21
|
-
* secret.</p>
|
|
22
|
-
*
|
|
23
|
-
* <p>To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule
|
|
24
|
-
* for the rotation. The Lambda rotation function creates a new
|
|
25
|
-
* version of the secret and creates or updates the credentials on the database or service to
|
|
26
|
-
* match. After testing the new credentials, the function marks the new secret version with the staging
|
|
27
|
-
* label <code>AWSCURRENT</code>. Then anyone who retrieves the secret gets the new version. For more
|
|
28
|
-
* information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
|
|
29
|
-
* <p>You can create the Lambda rotation function based on the <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html">rotation function templates</a> that Secrets Manager provides. Choose
|
|
30
|
-
* a template that matches your <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html">Rotation strategy</a>.</p>
|
|
11
|
+
* <p>Configures and starts the asynchronous process of rotating the secret. For information about rotation,
|
|
12
|
+
* see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a> in the <i>Secrets Manager User Guide</i>. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. </p>
|
|
31
13
|
* <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached
|
|
32
14
|
* to the same version as the <code>AWSCURRENT</code> version, or it might not be attached to any
|
|
33
15
|
* version. If the <code>AWSPENDING</code> staging label is present but not attached to the same
|
|
34
16
|
* version as <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code>
|
|
35
|
-
* assumes that a previous rotation request is still in progress and returns an error
|
|
36
|
-
* <p>When rotation is unsuccessful, the <code>AWSPENDING</code> staging label might be attached to an empty secret version. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
|
|
17
|
+
* assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the <code>AWSPENDING</code> staging label might be attached to an empty secret version. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html">Troubleshoot rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
|
|
37
18
|
* <p>Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p>
|
|
38
19
|
* <p>
|
|
39
20
|
* <b>Required permissions: </b>
|
|
@@ -10,8 +10,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the
|
|
12
12
|
* secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.</p>
|
|
13
|
-
*
|
|
14
|
-
*
|
|
13
|
+
* <p>The following restrictions apply to tags:</p>
|
|
14
|
+
* <ul>
|
|
15
15
|
* <li>
|
|
16
16
|
* <p>Maximum number of tags per secret: 50</p>
|
|
17
17
|
* </li>
|
|
@@ -36,7 +36,6 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
36
36
|
* following special characters: + - = . _ : / @.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* </ul>
|
|
39
|
-
*
|
|
40
39
|
* <important>
|
|
41
40
|
* <p>If you use tags as part of your security strategy, then adding or removing a tag can
|
|
42
41
|
* change permissions. If successfully completing this operation would result in you losing
|
|
@@ -10,7 +10,7 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use <a>PutSecretValue</a>.</p>
|
|
12
12
|
* <p>To change the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>To change a secret so that it is managed by another service, you need to recreate the secret in that service. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets Manager secrets managed by other Amazon Web Services services</a>.</p>
|
|
14
14
|
* <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more than
|
|
15
15
|
* once every 10 minutes. When you call <code>UpdateSecret</code> to update the secret value, Secrets Manager creates a new version
|
|
16
16
|
* of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
|
|
@@ -21,7 +21,6 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
|
|
|
21
21
|
* secret version, Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to the new
|
|
22
22
|
* version. Then it attaches the label <code>AWSPREVIOUS</code>
|
|
23
23
|
* to the version that <code>AWSCURRENT</code> was removed from.</p>
|
|
24
|
-
*
|
|
25
24
|
* <p>If you call this operation with a <code>ClientRequestToken</code> that matches an existing version's
|
|
26
25
|
* <code>VersionId</code>, the operation results in an error. You can't modify an existing
|
|
27
26
|
* version, you can only create a new version. To remove a version, remove all staging labels from it. See
|
|
@@ -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;
|
|
@@ -120,7 +120,6 @@ export interface CreateSecretRequest {
|
|
|
120
120
|
* <p>The name of the new secret.</p>
|
|
121
121
|
* <p>The secret name can contain ASCII letters, numbers, and the following characters:
|
|
122
122
|
* /_+=.@-</p>
|
|
123
|
-
*
|
|
124
123
|
* <p>Do not end your secret name with a hyphen followed by six characters. If you do so, you
|
|
125
124
|
* risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager
|
|
126
125
|
* automatically adds a hyphen and six random characters after the secret name at the end of the ARN.</p>
|
|
@@ -216,8 +215,8 @@ export interface CreateSecretRequest {
|
|
|
216
215
|
* JSON parameter for the various command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json">Using JSON for
|
|
217
216
|
* Parameters</a>. If your command-line tool or SDK requires quotation marks around the parameter, you should
|
|
218
217
|
* use single quotes to avoid confusion with the double quotes required in the JSON text.</p>
|
|
219
|
-
*
|
|
220
|
-
*
|
|
218
|
+
* <p>The following restrictions apply to tags:</p>
|
|
219
|
+
* <ul>
|
|
221
220
|
* <li>
|
|
222
221
|
* <p>Maximum number of tags per secret: 50</p>
|
|
223
222
|
* </li>
|
|
@@ -1261,7 +1260,8 @@ export interface RotateSecretRequest {
|
|
|
1261
1260
|
*/
|
|
1262
1261
|
ClientRequestToken?: string;
|
|
1263
1262
|
/**
|
|
1264
|
-
* <p>
|
|
1263
|
+
* <p>For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function. </p>
|
|
1264
|
+
* <p>For secrets that use <i>managed rotation</i>, omit this field. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html">Managed rotation</a> in the <i>Secrets Manager User Guide</i>.</p>
|
|
1265
1265
|
*/
|
|
1266
1266
|
RotationLambdaARN?: string;
|
|
1267
1267
|
/**
|
|
@@ -1271,7 +1271,7 @@ export interface RotateSecretRequest {
|
|
|
1271
1271
|
/**
|
|
1272
1272
|
* <p>Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
|
|
1273
1273
|
* The rotation schedule is defined in <a>RotateSecretRequest$RotationRules</a>.</p>
|
|
1274
|
-
* <p>
|
|
1274
|
+
* <p>For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the
|
|
1275
1275
|
* <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">
|
|
1276
1276
|
* <code>testSecret</code>
|
|
1277
1277
|
* step</a> of the Lambda rotation function. The test creates an <code>AWSPENDING</code> version of the secret and then removes it.</p>
|
|
@@ -1316,7 +1316,6 @@ export interface TagResourceRequest {
|
|
|
1316
1316
|
/**
|
|
1317
1317
|
* <p>The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a <code>Key</code>
|
|
1318
1318
|
* and a <code>Value</code>.</p>
|
|
1319
|
-
*
|
|
1320
1319
|
* <p>For storing multiple values, we recommend that you use a JSON text
|
|
1321
1320
|
* string argument and specify key/value pairs. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html">Specifying parameter values for the Amazon Web Services CLI</a>
|
|
1322
1321
|
* in the Amazon Web Services CLI User Guide.</p>
|
|
@@ -1371,9 +1370,9 @@ export interface UpdateSecretRequest {
|
|
|
1371
1370
|
* uses to encrypt new secret versions as well as any existing versions with the staging labels
|
|
1372
1371
|
* <code>AWSCURRENT</code>, <code>AWSPENDING</code>, or <code>AWSPREVIOUS</code>.
|
|
1373
1372
|
* For more information about versions and staging labels, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">Concepts: Version</a>.</p>
|
|
1374
|
-
*
|
|
1373
|
+
* <p>A key alias is always prefixed by <code>alias/</code>, for example <code>alias/aws/secretsmanager</code>.
|
|
1375
1374
|
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html">About aliases</a>.</p>
|
|
1376
|
-
*
|
|
1375
|
+
* <p>If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key
|
|
1377
1376
|
* <code>aws/secretsmanager</code>. If this key doesn't already exist in your account, then Secrets Manager
|
|
1378
1377
|
* creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access
|
|
1379
1378
|
* to use <code>aws/secretsmanager</code>. Creating <code>aws/secretsmanager</code> can result in a one-time
|
|
@@ -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.237.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",
|
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
"dependencies": {
|
|
20
20
|
"@aws-crypto/sha256-browser": "2.0.0",
|
|
21
21
|
"@aws-crypto/sha256-js": "2.0.0",
|
|
22
|
-
"@aws-sdk/client-sts": "3.
|
|
22
|
+
"@aws-sdk/client-sts": "3.236.0",
|
|
23
23
|
"@aws-sdk/config-resolver": "3.234.0",
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.236.0",
|
|
25
25
|
"@aws-sdk/fetch-http-handler": "3.226.0",
|
|
26
26
|
"@aws-sdk/hash-node": "3.226.0",
|
|
27
27
|
"@aws-sdk/invalid-dependency": "3.226.0",
|