@aws-sdk/client-secrets-manager 3.41.0 → 3.46.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/CHANGELOG.md +44 -0
- package/README.md +1 -1
- package/dist-cjs/endpoints.js +1 -0
- package/dist-cjs/runtimeConfig.js +0 -2
- package/dist-es/endpoints.js +1 -0
- package/dist-es/runtimeConfig.js +0 -2
- package/dist-types/SecretsManager.d.ts +142 -727
- package/dist-types/SecretsManagerClient.d.ts +1 -1
- package/dist-types/commands/CancelRotateSecretCommand.d.ts +7 -49
- package/dist-types/commands/CreateSecretCommand.d.ts +19 -87
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +2 -24
- package/dist-types/commands/DeleteSecretCommand.d.ts +9 -42
- package/dist-types/commands/DescribeSecretCommand.d.ts +2 -28
- package/dist-types/commands/GetRandomPasswordCommand.d.ts +1 -11
- package/dist-types/commands/GetResourcePolicyCommand.d.ts +4 -27
- package/dist-types/commands/GetSecretValueCommand.d.ts +4 -25
- package/dist-types/commands/ListSecretVersionIdsCommand.d.ts +6 -25
- package/dist-types/commands/ListSecretsCommand.d.ts +7 -26
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +4 -31
- package/dist-types/commands/PutSecretValueCommand.d.ts +15 -83
- package/dist-types/commands/RemoveRegionsFromReplicationCommand.d.ts +1 -1
- package/dist-types/commands/ReplicateSecretToRegionsCommand.d.ts +1 -2
- package/dist-types/commands/RestoreSecretCommand.d.ts +1 -18
- package/dist-types/commands/RotateSecretCommand.d.ts +17 -60
- package/dist-types/commands/StopReplicationToReplicaCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +8 -29
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -21
- package/dist-types/commands/UpdateSecretCommand.d.ts +19 -83
- package/dist-types/commands/UpdateSecretVersionStageCommand.d.ts +6 -28
- package/dist-types/commands/ValidateResourcePolicyCommand.d.ts +5 -25
- package/dist-types/models/models_0.d.ts +400 -479
- package/package.json +36 -43
|
@@ -7,95 +7,27 @@ export interface PutSecretValueCommandInput extends PutSecretValueRequest {
|
|
|
7
7
|
export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
*
|
|
12
|
-
* <code>SecretString</code> value or a new <code>SecretBinary</code> value. You can also
|
|
13
|
-
* specify the staging labels that are initially attached to the new version.</p>
|
|
10
|
+
* <p>Creates a new version with a new encrypted secret value and attaches it to the secret. The
|
|
11
|
+
* version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. </p>
|
|
14
12
|
* <p>We recommend you avoid calling <code>PutSecretValue</code> at a sustained rate of more than
|
|
15
13
|
* once every 10 minutes. When you update the secret value, Secrets Manager creates a new version
|
|
16
14
|
* of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not
|
|
17
15
|
* remove versions created less than 24 hours ago. If you call <code>PutSecretValue</code> more
|
|
18
16
|
* than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
|
|
19
17
|
* the quota for secret versions.</p>
|
|
20
|
-
* <
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* </li>
|
|
34
|
-
* <li>
|
|
35
|
-
* <p>This operation is idempotent. If a version with a <code>VersionId</code> with the same
|
|
36
|
-
* value as the <code>ClientRequestToken</code> parameter already exists and you specify the
|
|
37
|
-
* same secret data, the operation succeeds but does nothing. However, if the secret data is
|
|
38
|
-
* different, then the operation fails because you cannot modify an existing version; you can
|
|
39
|
-
* only create new ones.</p>
|
|
40
|
-
* </li>
|
|
41
|
-
* </ul>
|
|
42
|
-
* <note>
|
|
43
|
-
* <ul>
|
|
44
|
-
* <li>
|
|
45
|
-
* <p>If you call an operation to encrypt or decrypt the <code>SecretString</code>
|
|
46
|
-
* or <code>SecretBinary</code> for a secret in the same account as the calling user and that
|
|
47
|
-
* secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default
|
|
48
|
-
* Amazon Web Services managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key
|
|
49
|
-
* doesn't already exist in your account then Secrets Manager creates it for you automatically. All
|
|
50
|
-
* users and roles in the same Amazon Web Services account automatically have access to use the default CMK.
|
|
51
|
-
* Note that if an Secrets Manager API call results in Amazon Web Services creating the account's
|
|
52
|
-
* Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the
|
|
53
|
-
* result.</p>
|
|
54
|
-
* </li>
|
|
55
|
-
* <li>
|
|
56
|
-
* <p>If the secret resides in a different Amazon Web Services account from the credentials calling an API that
|
|
57
|
-
* requires encryption or decryption of the secret value then you must create and use a custom
|
|
58
|
-
* Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials
|
|
59
|
-
* from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the
|
|
60
|
-
* secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an
|
|
61
|
-
* API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code>
|
|
62
|
-
* using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account
|
|
63
|
-
* access to that other account's user or role for both the kms:GenerateDataKey and
|
|
64
|
-
* kms:Decrypt operations.</p>
|
|
65
|
-
* </li>
|
|
66
|
-
* </ul>
|
|
67
|
-
* </note>
|
|
68
|
-
* <p>
|
|
69
|
-
* <b>Minimum permissions</b>
|
|
70
|
-
* </p>
|
|
71
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
72
|
-
* <ul>
|
|
73
|
-
* <li>
|
|
74
|
-
* <p>secretsmanager:PutSecretValue</p>
|
|
75
|
-
* </li>
|
|
76
|
-
* <li>
|
|
77
|
-
* <p>kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt
|
|
78
|
-
* the secret. You do not need this permission to use the account's default Amazon Web Services managed CMK
|
|
79
|
-
* for Secrets Manager.</p>
|
|
80
|
-
* </li>
|
|
81
|
-
* </ul>
|
|
82
|
-
* <p>
|
|
83
|
-
* <b>Related operations</b>
|
|
84
|
-
* </p>
|
|
85
|
-
* <ul>
|
|
86
|
-
* <li>
|
|
87
|
-
* <p>To retrieve the encrypted value you store in the version of a secret, use <a>GetSecretValue</a>.</p>
|
|
88
|
-
* </li>
|
|
89
|
-
* <li>
|
|
90
|
-
* <p>To create a secret, use <a>CreateSecret</a>.</p>
|
|
91
|
-
* </li>
|
|
92
|
-
* <li>
|
|
93
|
-
* <p>To get the details for a secret, use <a>DescribeSecret</a>.</p>
|
|
94
|
-
* </li>
|
|
95
|
-
* <li>
|
|
96
|
-
* <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p>
|
|
97
|
-
* </li>
|
|
98
|
-
* </ul>
|
|
18
|
+
* <p>You can specify the staging labels to attach to the new version in <code>VersionStages</code>.
|
|
19
|
+
* If you don't include <code>VersionStages</code>, then Secrets Manager automatically
|
|
20
|
+
* moves the staging label <code>AWSCURRENT</code> to this version. If this operation creates
|
|
21
|
+
* the first version for the secret, then Secrets Manager
|
|
22
|
+
* automatically attaches the staging label <code>AWSCURRENT</code> to it .</p>
|
|
23
|
+
* <p>If this operation moves the staging label <code>AWSCURRENT</code> from another version to this
|
|
24
|
+
* version, then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to
|
|
25
|
+
* the version that <code>AWSCURRENT</code> was removed from.</p>
|
|
26
|
+
* <p>This operation is idempotent. If a version with a <code>VersionId</code> with the same
|
|
27
|
+
* value as the <code>ClientRequestToken</code> parameter already exists, and you specify the
|
|
28
|
+
* same secret data, the operation succeeds but does nothing. However, if the secret data is
|
|
29
|
+
* different, then the operation fails because you can't modify an existing version; you can
|
|
30
|
+
* only create new ones.</p>
|
|
99
31
|
* @example
|
|
100
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
101
33
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface RemoveRegionsFromReplicationCommandInput extends RemoveRegionsF
|
|
|
7
7
|
export interface RemoveRegionsFromReplicationCommandOutput extends RemoveRegionsFromReplicationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
10
|
+
* <p>For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,8 +7,7 @@ export interface ReplicateSecretToRegionsCommandInput extends ReplicateSecretToR
|
|
|
7
7
|
export interface ReplicateSecretToRegionsCommandOutput extends ReplicateSecretToRegionsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>
|
|
11
|
-
* list of new regions. </p>
|
|
10
|
+
* <p>Replicates the secret to a new Regions. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html">Multi-Region secrets</a>.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -8,24 +8,7 @@ export interface RestoreSecretCommandOutput extends RestoreSecretResponse, __Met
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code> time
|
|
11
|
-
* stamp.
|
|
12
|
-
* <p>
|
|
13
|
-
* <b>Minimum permissions</b>
|
|
14
|
-
* </p>
|
|
15
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
16
|
-
* <ul>
|
|
17
|
-
* <li>
|
|
18
|
-
* <p>secretsmanager:RestoreSecret</p>
|
|
19
|
-
* </li>
|
|
20
|
-
* </ul>
|
|
21
|
-
* <p>
|
|
22
|
-
* <b>Related operations</b>
|
|
23
|
-
* </p>
|
|
24
|
-
* <ul>
|
|
25
|
-
* <li>
|
|
26
|
-
* <p>To delete a secret, use <a>DeleteSecret</a>.</p>
|
|
27
|
-
* </li>
|
|
28
|
-
* </ul>
|
|
11
|
+
* stamp. You can access a secret again after it has been restored.</p>
|
|
29
12
|
* @example
|
|
30
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
14
|
* ```javascript
|
|
@@ -7,68 +7,25 @@ export interface RotateSecretCommandInput extends RotateSecretRequest {
|
|
|
7
7
|
export interface RotateSecretCommandOutput extends RotateSecretResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Configures and starts the asynchronous process of rotating
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
* one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the
|
|
25
|
-
* actual date of the last rotation. The service chooses the hour within that 24-hour date window
|
|
26
|
-
* randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour
|
|
27
|
-
* and influenced by a variety of factors that help distribute load.</p>
|
|
28
|
-
* <p>The
|
|
29
|
-
* rotation function must end with the versions of the secret in one of two states:</p>
|
|
30
|
-
* <ul>
|
|
31
|
-
* <li>
|
|
32
|
-
* <p>The <code>AWSPENDING</code> and <code>AWSCURRENT</code> staging labels are attached to the same version of
|
|
33
|
-
* the secret, or</p>
|
|
34
|
-
* </li>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>The <code>AWSPENDING</code> staging label is not attached to any version of the secret.</p>
|
|
37
|
-
* </li>
|
|
38
|
-
* </ul>
|
|
10
|
+
* <p>Configures and starts the asynchronous process of rotating the secret.</p>
|
|
11
|
+
* <p>If you include the
|
|
12
|
+
* configuration parameters, the operation sets the values for the secret and then immediately
|
|
13
|
+
* starts a rotation. If you don't include the configuration parameters, the operation starts a
|
|
14
|
+
* rotation with the values already stored in the secret. For more information about rotation,
|
|
15
|
+
* see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotate secrets</a>.</p>
|
|
16
|
+
* <p>To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule
|
|
17
|
+
* for the rotation. The Lambda rotation function creates a new
|
|
18
|
+
* version of the secret and creates or updates the credentials on the database or service to
|
|
19
|
+
* match. After testing the new credentials, the function marks the new secret version with the staging
|
|
20
|
+
* label <code>AWSCURRENT</code>. Then anyone who retrieves the secret gets the new version. For more
|
|
21
|
+
* information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html">How rotation works</a>.</p>
|
|
22
|
+
* <p>When rotation is successful, the <code>AWSPENDING</code> staging label might be attached to the same
|
|
23
|
+
* version as the <code>AWSCURRENT</code> version, or it might not be attached to any version.</p>
|
|
39
24
|
* <p>If the <code>AWSPENDING</code> staging label is present but not attached to the same version as
|
|
40
|
-
* <code>AWSCURRENT</code
|
|
25
|
+
* <code>AWSCURRENT</code>, then any later invocation of <code>RotateSecret</code> assumes that a previous
|
|
41
26
|
* rotation request is still in progress and returns an error.</p>
|
|
42
|
-
* <p>
|
|
43
|
-
*
|
|
44
|
-
* </p>
|
|
45
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
46
|
-
* <ul>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>secretsmanager:RotateSecret</p>
|
|
49
|
-
* </li>
|
|
50
|
-
* <li>
|
|
51
|
-
* <p>lambda:InvokeFunction (on the function specified in the secret's metadata)</p>
|
|
52
|
-
* </li>
|
|
53
|
-
* </ul>
|
|
54
|
-
* <p>
|
|
55
|
-
* <b>Related operations</b>
|
|
56
|
-
* </p>
|
|
57
|
-
* <ul>
|
|
58
|
-
* <li>
|
|
59
|
-
* <p>To list the secrets in your account, use <a>ListSecrets</a>.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* <li>
|
|
62
|
-
* <p>To get the details for a version of a secret, use <a>DescribeSecret</a>.</p>
|
|
63
|
-
* </li>
|
|
64
|
-
* <li>
|
|
65
|
-
* <p>To create a new version of a secret, use <a>CreateSecret</a>.</p>
|
|
66
|
-
* </li>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>To attach staging labels to or remove staging labels from a version of a secret, use
|
|
69
|
-
* <a>UpdateSecretVersionStage</a>.</p>
|
|
70
|
-
* </li>
|
|
71
|
-
* </ul>
|
|
27
|
+
* <p>To run this command, you must have <code>secretsmanager:RotateSecret</code> permissions and
|
|
28
|
+
* <code>lambda:InvokeFunction</code> permissions on the function specified in the secret's metadata.</p>
|
|
72
29
|
* @example
|
|
73
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
74
31
|
* ```javascript
|
|
@@ -7,7 +7,8 @@ export interface StopReplicationToReplicaCommandInput extends StopReplicationToR
|
|
|
7
7
|
export interface StopReplicationToReplicaCommandOutput extends StopReplicationToReplicaResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Removes the secret
|
|
10
|
+
* <p>Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.</p>
|
|
11
|
+
* <p>You must call this operation from the Region in which you want to promote the replica to a primary secret.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -7,20 +7,18 @@ export interface TagResourceCommandInput extends TagResourceRequest {
|
|
|
7
7
|
export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Attaches
|
|
11
|
-
* secret.
|
|
12
|
-
*
|
|
13
|
-
* To remove tags, you must use <a>UntagResource</a>.</p>
|
|
14
|
-
* <p>The following basic restrictions apply to tags:</p>
|
|
10
|
+
* <p>Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the
|
|
11
|
+
* secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.</p>
|
|
12
|
+
* <p>The following restrictions apply to tags:</p>
|
|
15
13
|
* <ul>
|
|
16
14
|
* <li>
|
|
17
|
-
* <p>Maximum number of tags per secret
|
|
15
|
+
* <p>Maximum number of tags per secret: 50</p>
|
|
18
16
|
* </li>
|
|
19
17
|
* <li>
|
|
20
|
-
* <p>Maximum key length
|
|
18
|
+
* <p>Maximum key length: 127 Unicode characters in UTF-8</p>
|
|
21
19
|
* </li>
|
|
22
20
|
* <li>
|
|
23
|
-
* <p>Maximum value length
|
|
21
|
+
* <p>Maximum value length: 255 Unicode characters in UTF-8</p>
|
|
24
22
|
* </li>
|
|
25
23
|
* <li>
|
|
26
24
|
* <p>Tag keys and values are case sensitive.</p>
|
|
@@ -32,37 +30,18 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
32
30
|
* </li>
|
|
33
31
|
* <li>
|
|
34
32
|
* <p>If you use your tagging schema across multiple services and resources,
|
|
35
|
-
*
|
|
33
|
+
* other services might have restrictions on allowed characters. Generally
|
|
36
34
|
* allowed characters: letters, spaces, and numbers representable in UTF-8, plus the
|
|
37
35
|
* following special characters: + - = . _ : / @.</p>
|
|
38
36
|
* </li>
|
|
39
37
|
* </ul>
|
|
38
|
+
*
|
|
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
|
|
43
42
|
* your permissions for this secret, then the operation is blocked and returns an Access Denied
|
|
44
43
|
* error.</p>
|
|
45
44
|
* </important>
|
|
46
|
-
* <p>
|
|
47
|
-
* <b>Minimum permissions</b>
|
|
48
|
-
* </p>
|
|
49
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
50
|
-
* <ul>
|
|
51
|
-
* <li>
|
|
52
|
-
* <p>secretsmanager:TagResource</p>
|
|
53
|
-
* </li>
|
|
54
|
-
* </ul>
|
|
55
|
-
* <p>
|
|
56
|
-
* <b>Related operations</b>
|
|
57
|
-
* </p>
|
|
58
|
-
* <ul>
|
|
59
|
-
* <li>
|
|
60
|
-
* <p>To remove one or more tags from the collection attached to a secret, use <a>UntagResource</a>.</p>
|
|
61
|
-
* </li>
|
|
62
|
-
* <li>
|
|
63
|
-
* <p>To view the list of tags attached to a secret, use <a>DescribeSecret</a>.</p>
|
|
64
|
-
* </li>
|
|
65
|
-
* </ul>
|
|
66
45
|
* @example
|
|
67
46
|
* Use a bare-bones client and the command you need to make an API call.
|
|
68
47
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {
|
|
|
7
7
|
export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Removes
|
|
10
|
+
* <p>Removes specific tags from a secret.</p>
|
|
11
11
|
* <p>This operation is idempotent. If a requested tag is not attached to the secret, no error
|
|
12
12
|
* is returned and the secret metadata is unchanged.</p>
|
|
13
13
|
* <important>
|
|
@@ -16,26 +16,6 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
16
16
|
* permissions for this secret, then the operation is blocked and returns an Access Denied
|
|
17
17
|
* error.</p>
|
|
18
18
|
* </important>
|
|
19
|
-
* <p>
|
|
20
|
-
* <b>Minimum permissions</b>
|
|
21
|
-
* </p>
|
|
22
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
23
|
-
* <ul>
|
|
24
|
-
* <li>
|
|
25
|
-
* <p>secretsmanager:UntagResource</p>
|
|
26
|
-
* </li>
|
|
27
|
-
* </ul>
|
|
28
|
-
* <p>
|
|
29
|
-
* <b>Related operations</b>
|
|
30
|
-
* </p>
|
|
31
|
-
* <ul>
|
|
32
|
-
* <li>
|
|
33
|
-
* <p>To add one or more tags to the collection attached to a secret, use <a>TagResource</a>.</p>
|
|
34
|
-
* </li>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>To view the list of tags attached to a secret, use <a>DescribeSecret</a>.</p>
|
|
37
|
-
* </li>
|
|
38
|
-
* </ul>
|
|
39
19
|
* @example
|
|
40
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
21
|
* ```javascript
|
|
@@ -7,10 +7,8 @@ export interface UpdateSecretCommandInput extends UpdateSecretRequest {
|
|
|
7
7
|
export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Modifies
|
|
11
|
-
* <p>To change the
|
|
12
|
-
* <p>To change the rotation configuration of a secret, use <a>RotateSecret</a>
|
|
13
|
-
* instead.</p>
|
|
10
|
+
* <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>
|
|
11
|
+
* <p>To change the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p>
|
|
14
12
|
*
|
|
15
13
|
* <p>We recommend you avoid calling <code>UpdateSecret</code> at a sustained rate of more than
|
|
16
14
|
* once every 10 minutes. When you call <code>UpdateSecret</code> to update the secret value, Secrets Manager creates a new version
|
|
@@ -18,85 +16,23 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
|
|
|
18
16
|
* remove versions created less than 24 hours ago. If you update the secret value more
|
|
19
17
|
* than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach
|
|
20
18
|
* the quota for secret versions.</p>
|
|
21
|
-
* <
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* </ul>
|
|
39
|
-
* <note>
|
|
40
|
-
* <ul>
|
|
41
|
-
* <li>
|
|
42
|
-
* <p>If you call an operation to encrypt or decrypt the <code>SecretString</code>
|
|
43
|
-
* or <code>SecretBinary</code> for a secret in the same account as the calling user and that
|
|
44
|
-
* secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default
|
|
45
|
-
* Amazon Web Services managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key
|
|
46
|
-
* doesn't already exist in your account then Secrets Manager creates it for you automatically. All
|
|
47
|
-
* users and roles in the same Amazon Web Services account automatically have access to use the default CMK.
|
|
48
|
-
* Note that if an Secrets Manager API call results in Amazon Web Services creating the account's
|
|
49
|
-
* Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the
|
|
50
|
-
* result.</p>
|
|
51
|
-
* </li>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>If the secret resides in a different Amazon Web Services account from the credentials calling an API that
|
|
54
|
-
* requires encryption or decryption of the secret value then you must create and use a custom
|
|
55
|
-
* Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials
|
|
56
|
-
* from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the
|
|
57
|
-
* secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an
|
|
58
|
-
* API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code>
|
|
59
|
-
* using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account
|
|
60
|
-
* access to that other account's user or role for both the kms:GenerateDataKey and
|
|
61
|
-
* kms:Decrypt operations.</p>
|
|
62
|
-
* </li>
|
|
63
|
-
* </ul>
|
|
64
|
-
* </note>
|
|
65
|
-
* <p>
|
|
66
|
-
* <b>Minimum permissions</b>
|
|
67
|
-
* </p>
|
|
68
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
69
|
-
* <ul>
|
|
70
|
-
* <li>
|
|
71
|
-
* <p>secretsmanager:UpdateSecret</p>
|
|
72
|
-
* </li>
|
|
73
|
-
* <li>
|
|
74
|
-
* <p>kms:GenerateDataKey - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret.
|
|
75
|
-
* You do not need this permission to use the account's Amazon Web Services managed CMK for
|
|
76
|
-
* Secrets Manager.</p>
|
|
77
|
-
* </li>
|
|
78
|
-
* <li>
|
|
79
|
-
* <p>kms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do
|
|
80
|
-
* not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager.</p>
|
|
81
|
-
* </li>
|
|
82
|
-
* </ul>
|
|
83
|
-
* <p>
|
|
84
|
-
* <b>Related operations</b>
|
|
85
|
-
* </p>
|
|
86
|
-
* <ul>
|
|
87
|
-
* <li>
|
|
88
|
-
* <p>To create a new secret, use <a>CreateSecret</a>.</p>
|
|
89
|
-
* </li>
|
|
90
|
-
* <li>
|
|
91
|
-
* <p>To add only a new version to an existing secret, use <a>PutSecretValue</a>.</p>
|
|
92
|
-
* </li>
|
|
93
|
-
* <li>
|
|
94
|
-
* <p>To get the details for a secret, use <a>DescribeSecret</a>.</p>
|
|
95
|
-
* </li>
|
|
96
|
-
* <li>
|
|
97
|
-
* <p>To list the versions contained in a secret, use <a>ListSecretVersionIds</a>.</p>
|
|
98
|
-
* </li>
|
|
99
|
-
* </ul>
|
|
19
|
+
* <p>If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new
|
|
20
|
+
* secret version, Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new
|
|
21
|
+
* version. </p>
|
|
22
|
+
* <p>If you call this operation with a <code>VersionId</code> that matches an existing version's
|
|
23
|
+
* <code>ClientRequestToken</code>, the operation results in an error. You can't modify an existing
|
|
24
|
+
* version, you can only create a new version. To remove a version, remove all staging labels from it. See
|
|
25
|
+
* <a>UpdateSecretVersionStage</a>.</p>
|
|
26
|
+
* <p>If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
|
|
27
|
+
* <code>aws/secretsmanager</code>. If this key doesn't already exist in your account, then Secrets Manager
|
|
28
|
+
* creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access
|
|
29
|
+
* to use <code>aws/secretsmanager</code>. Creating <code>aws/secretsmanager</code> can result in a one-time
|
|
30
|
+
* significant delay in returning the result. </p>
|
|
31
|
+
* <p>If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
|
|
32
|
+
* use <code>aws/secretsmanager</code> to encrypt the secret, and you must create and use a customer managed key. </p>
|
|
33
|
+
*
|
|
34
|
+
* <p>To run this command, you must have <code>secretsmanager:UpdateSecret</code> permissions. If you use a
|
|
35
|
+
* customer managed key, you must also have <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions .</p>
|
|
100
36
|
* @example
|
|
101
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
102
38
|
* ```javascript
|
|
@@ -7,14 +7,13 @@ export interface UpdateSecretVersionStageCommandInput extends UpdateSecretVersio
|
|
|
7
7
|
export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersionStageResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Modifies the staging labels attached to a version of a secret.
|
|
11
|
-
* track a version as it progresses through the secret rotation process.
|
|
12
|
-
*
|
|
13
|
-
* attached to another version,
|
|
14
|
-
* then
|
|
15
|
-
* Labels</a> in the <i>Amazon Web Services Secrets Manager User Guide</i>. </p>
|
|
10
|
+
* <p>Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to
|
|
11
|
+
* track a version as it progresses through the secret rotation process. Each staging label can be
|
|
12
|
+
* attached to only one version at a time. To add a staging label to a version when it is already
|
|
13
|
+
* attached to another version, Secrets Manager first removes it from the other version first and
|
|
14
|
+
* then attaches it to this one. 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>
|
|
16
15
|
* <p>The staging labels that you specify in the <code>VersionStage</code> parameter are added
|
|
17
|
-
* to the existing list of staging labels
|
|
16
|
+
* to the existing list of staging labels for the version. </p>
|
|
18
17
|
* <p>You can move the <code>AWSCURRENT</code> staging label to this version by including it in this
|
|
19
18
|
* call.</p>
|
|
20
19
|
* <note>
|
|
@@ -23,27 +22,6 @@ export interface UpdateSecretVersionStageCommandOutput extends UpdateSecretVersi
|
|
|
23
22
|
* </note>
|
|
24
23
|
* <p>If this action results in the last label being removed from a version, then the version is
|
|
25
24
|
* considered to be 'deprecated' and can be deleted by Secrets Manager.</p>
|
|
26
|
-
* <p>
|
|
27
|
-
* <b>Minimum permissions</b>
|
|
28
|
-
* </p>
|
|
29
|
-
* <p>To run this command, you must have the following permissions:</p>
|
|
30
|
-
* <ul>
|
|
31
|
-
* <li>
|
|
32
|
-
* <p>secretsmanager:UpdateSecretVersionStage</p>
|
|
33
|
-
* </li>
|
|
34
|
-
* </ul>
|
|
35
|
-
* <p>
|
|
36
|
-
* <b>Related operations</b>
|
|
37
|
-
* </p>
|
|
38
|
-
* <ul>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>To get the list of staging labels that are currently associated with a version of a
|
|
41
|
-
* secret, use <code>
|
|
42
|
-
* <a>DescribeSecret</a>
|
|
43
|
-
* </code> and examine the
|
|
44
|
-
* <code>SecretVersionsToStages</code> response value. </p>
|
|
45
|
-
* </li>
|
|
46
|
-
* </ul>
|
|
47
25
|
* @example
|
|
48
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
49
27
|
* ```javascript
|
|
@@ -7,15 +7,13 @@ export interface ValidateResourcePolicyCommandInput extends ValidateResourcePoli
|
|
|
7
7
|
export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePolicyResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Validates that
|
|
11
|
-
* your secret.
|
|
12
|
-
*
|
|
13
|
-
* JSON string. A resource-based policy is optional for secrets.</p>
|
|
14
|
-
* <p>The API performs three checks when validating the secret:</p>
|
|
10
|
+
* <p>Validates that a resource policy does not grant a wide range of principals access to
|
|
11
|
+
* your secret. A resource-based policy is optional for secrets.</p>
|
|
12
|
+
* <p>The API performs three checks when validating the policy:</p>
|
|
15
13
|
* <ul>
|
|
16
14
|
* <li>
|
|
17
|
-
* <p>Sends a call to <a href="https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/">Zelkova</a>, an automated reasoning engine, to ensure your
|
|
18
|
-
* allow broad access to your secret.</p>
|
|
15
|
+
* <p>Sends a call to <a href="https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/">Zelkova</a>, an automated reasoning engine, to ensure your resource policy does not
|
|
16
|
+
* allow broad access to your secret, for example policies that use a wildcard for the principal.</p>
|
|
19
17
|
* </li>
|
|
20
18
|
* <li>
|
|
21
19
|
* <p>Checks for correct syntax in a policy.</p>
|
|
@@ -24,24 +22,6 @@ export interface ValidateResourcePolicyCommandOutput extends ValidateResourcePol
|
|
|
24
22
|
* <p>Verifies the policy does not lock out a caller.</p>
|
|
25
23
|
* </li>
|
|
26
24
|
* </ul>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* <p>
|
|
30
|
-
* <b>Minimum Permissions</b>
|
|
31
|
-
* </p>
|
|
32
|
-
* <p>You must have the permissions required to access the following APIs:</p>
|
|
33
|
-
* <ul>
|
|
34
|
-
* <li>
|
|
35
|
-
* <p>
|
|
36
|
-
* <code>secretsmanager:PutResourcePolicy</code>
|
|
37
|
-
* </p>
|
|
38
|
-
* </li>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>
|
|
41
|
-
* <code>secretsmanager:ValidateResourcePolicy</code>
|
|
42
|
-
* </p>
|
|
43
|
-
* </li>
|
|
44
|
-
* </ul>
|
|
45
25
|
* @example
|
|
46
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
47
27
|
* ```javascript
|