Skip to content

Commit 3f9a4c4

Browse files
author
awstools
committed
docs(client-secrets-manager): Doc only update for Secrets Manager
1 parent e17e8ba commit 3f9a4c4

File tree

6 files changed

+29
-20
lines changed

6 files changed

+29
-20
lines changed

clients/client-secrets-manager/src/auth/httpAuthSchemeProvider.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: SecretsManagerHttpAuth
6060
name: "secretsmanager",
6161
region: authParameters.region,
6262
},
63-
propertiesExtractor: (config: SecretsManagerClientConfig, context) => ({
63+
propertiesExtractor: (config: Partial<SecretsManagerClientConfig>, context) => ({
6464
/**
6565
* @internal
6666
*/

clients/client-secrets-manager/src/commands/CreateSecretCommand.ts

+3
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,9 @@ export interface CreateSecretCommandOutput extends CreateSecretResponse, __Metad
6464
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
6565
* and access control in Secrets Manager</a>. </p>
6666
* <p>To encrypt the secret with a KMS key other than <code>aws/secretsmanager</code>, you need <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permission to the key. </p>
67+
* <important>
68+
* <p>When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/security_cli-exposure-risks.html">Mitigate the risks of using command-line tools to store Secrets Manager secrets</a>.</p>
69+
* </important>
6770
* @example
6871
* Use a bare-bones client and the command you need to make an API call.
6972
* ```javascript

clients/client-secrets-manager/src/commands/PutSecretValueCommand.ts

+3
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ export interface PutSecretValueCommandOutput extends PutSecretValueResponse, __M
6060
* For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions">
6161
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
6262
* and access control in Secrets Manager</a>. </p>
63+
* <important>
64+
* <p>When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/security_cli-exposure-risks.html">Mitigate the risks of using command-line tools to store Secrets Manager secrets</a>.</p>
65+
* </important>
6366
* @example
6467
* Use a bare-bones client and the command you need to make an API call.
6568
* ```javascript

clients/client-secrets-manager/src/commands/UpdateSecretCommand.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,11 @@ export interface UpdateSecretCommandOutput extends UpdateSecretResponse, __Metad
5353
* IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication
5454
* and access control in Secrets Manager</a>.
5555
* If you use a customer managed key, you must also have <code>kms:GenerateDataKey</code>, <code>kms:Encrypt</code>, and
56-
* <code>kms:Decrypt</code> permissions on the key. If you change the KMS key and you don't have <code>kms:Encrypt</code> permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html">
56+
* <code>kms:Decrypt</code> permissions on the key. If you change the KMS key and you don't have <code>kms:Encrypt</code> permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html">
5757
* Secret encryption and decryption</a>.</p>
58+
* <important>
59+
* <p>When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/security_cli-exposure-risks.html">Mitigate the risks of using command-line tools to store Secrets Manager secrets</a>.</p>
60+
* </important>
5861
* @example
5962
* Use a bare-bones client and the command you need to make an API call.
6063
* ```javascript

clients/client-secrets-manager/src/models/models_0.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -2095,7 +2095,7 @@ export interface UpdateSecretRequest {
20952095
/**
20962096
* <p>The ARN, key ID, or alias of the KMS key that Secrets Manager
20972097
* uses to encrypt new secret versions as well as any existing versions with the staging labels
2098-
* <code>AWSCURRENT</code>, <code>AWSPENDING</code>, or <code>AWSPREVIOUS</code>. If you don't have <code>kms:Encrypt</code> permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. 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>
2098+
* <code>AWSCURRENT</code>, <code>AWSPENDING</code>, or <code>AWSPREVIOUS</code>. If you don't have <code>kms:Encrypt</code> permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. 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>
20992099
* <p>A key alias is always prefixed by <code>alias/</code>, for example <code>alias/aws/secretsmanager</code>.
21002100
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html">About aliases</a>.</p>
21012101
* <p>If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key

0 commit comments

Comments
 (0)