AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the PutSecretValue operation.
Creates a new version with a new encrypted secret value and attaches it to the secret.
The version can contain a new SecretString
value or a new SecretBinary
value.
We recommend you avoid calling PutSecretValue
at a sustained rate of more than
once every 10 minutes. When you update the secret value, Secrets Manager creates a
new version of the secret. Secrets Manager removes outdated versions when there are
more than 100, but it does not remove versions created less than 24 hours ago. If
you call PutSecretValue
more than once every 10 minutes, you create more versions
than Secrets Manager removes, and you will reach the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages
.
If you don't include VersionStages
, then Secrets Manager automatically moves
the staging label AWSCURRENT
to this version. If this operation creates the
first version for the secret, then Secrets Manager automatically attaches the staging
label AWSCURRENT
to it. If this operation moves the staging label AWSCURRENT
from another version to this version, then Secrets Manager also automatically moves
the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed
from.
This operation is idempotent. If you call this operation with a ClientRequestToken
that matches an existing version's VersionId, and you specify the same secret data,
the operation succeeds but does nothing. However, if the secret data is different,
then the operation fails because you can't modify an existing version; you can only
create new ones.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not
include sensitive information in request parameters except SecretBinary
or
SecretString
because it might be logged. For more information, see Logging
Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutSecretValue
. For more information,
see
IAM policy actions for Secrets Manager and Authentication
and access control in Secrets Manager.
Namespace: Amazon.SecretsManager.Model
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z
public class PutSecretValueRequest : AmazonSecretsManagerRequest IAmazonWebServiceRequest
The PutSecretValueRequest type exposes the following members
Name | Description | |
---|---|---|
PutSecretValueRequest() |
Name | Type | Description | |
---|---|---|---|
ClientRequestToken | System.String |
Gets and sets the property ClientRequestToken. A unique identifier for the new version of the secret. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you
must generate a This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
This value becomes the |
|
SecretBinary | System.IO.MemoryStream |
Gets and sets the property SecretBinary. The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include You can't access this value from the Secrets Manager console. |
|
SecretId | System.String |
Gets and sets the property SecretId. The ARN or name of the secret to add a new version to. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
If the secret doesn't already exist, use |
|
SecretString | System.String |
Gets and sets the property SecretString. The text to encrypt and store in the new version of the secret.
You must include We recommend you create the secret string as JSON key/value pairs, as shown in the example. |
|
VersionStages | System.Collections.Generic.List<System.String> |
Gets and sets the property VersionStages. A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version
of the same secret, then Secrets Manager removes the label from the other version
and attaches it to this version. If you specify
If you don't include |
The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command.
var client = new AmazonSecretsManagerClient(); var response = client.PutSecretValue(new PutSecretValueRequest { ClientRequestToken = "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", SecretId = "MyTestDatabaseSecret", SecretString = "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}" }); string arn = response.ARN; string name = response.Name; string versionId = response.VersionId; List<string> versionStages = response.VersionStages;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5