Container for the parameters to the GetSecretValue operation.
Retrieves the contents of the encrypted fields SecretString or SecretBinary
from the specified version of a secret, whichever contains content.
To retrieve the values for a group of secrets, call BatchGetSecretValue.
We recommend that you cache your secret values by using client-side caching. Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications.
To retrieve the previous version of a secret, use VersionStage and specify
AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.
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 Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:GetSecretValue. If the secret
is encrypted using a customer-managed key instead of the Amazon Web Services managed
key aws/secretsmanager, then you also need kms:Decrypt permissions for
that key. For more information, see
IAM policy actions for Secrets Manager and Authentication
and access control in Secrets Manager.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SecretsManager.AmazonSecretsManagerRequest
Amazon.SecretsManager.Model.GetSecretValueRequest
Namespace: Amazon.SecretsManager.Model
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z
Syntax
public class GetSecretValueRequest : AmazonSecretsManagerRequest IAmazonWebServiceRequest
The GetSecretValueRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
GetSecretValueRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
SecretId | System.String |
Gets and sets the property SecretId. The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN. |
|
|
VersionId | System.String |
Gets and sets the property VersionId.
The unique identifier of the version of the secret to retrieve. If you include both
this parameter and This value is typically a UUID-type value with 32 hexadecimal digits. |
|
|
VersionStage | System.String |
Gets and sets the property VersionStage. The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the
rotation process. If you include both this parameter and |
Examples
The following example shows how to retrieve a secret string value.
To retrieve the encrypted secret value of a secret
var client = new AmazonSecretsManagerClient();
var response = client.GetSecretValue(new GetSecretValueRequest
{
SecretId = "MyTestDatabaseSecret"
});
string arn = response.ARN;
DateTime createdDate = response.CreatedDate;
string name = response.Name;
string secretString = response.SecretString;
string versionId = response.VersionId;
List<string> versionStages = response.VersionStages;
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5