AmazonSecretsManagerClient.CreateSecret Method (CreateSecretRequest)

Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.

For secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services.

For information about creating a secret in the console, see Create a secret.

To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it.

For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the JSON you store in the SecretString matches the JSON structure of a database secret.

If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time significant delay in returning the result.

If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.

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:CreateSecret. If you include tags in the secret, you also need secretsmanager:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

To encrypt the secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Decrypt permission to the key.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateSecretAsync.

Namespace: Amazon.SecretsManager
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z

Syntax

public virtual CreateSecretResponse CreateSecret(
         CreateSecretRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.CreateSecretRequest

Container for the necessary parameters to execute the CreateSecret service method.

Return Value

Type: CreateSecretResponse

The response from the CreateSecret service method, as returned by SecretsManager.

Exceptions

Exception	Condition
DecryptionFailureException	Secrets Manager can't decrypt the protected secret text using the provided KMS key.
EncryptionFailureException	Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
InternalServiceErrorException	An error occurred on the server side.
InvalidParameterException	The parameter name or value is invalid.
InvalidRequestException	A parameter value is not valid for the current state of the resource. Possible causes: The secret is scheduled for deletion. You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call. The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.
LimitExceededException	The request failed because it would exceed one of the Secrets Manager quotas.
MalformedPolicyDocumentException	The resource policy has syntax errors.
PreconditionNotMetException	The request failed because you did not complete all the prerequisite steps.
ResourceExistsException	A resource with the ID you requested already exists.
ResourceNotFoundException	Secrets Manager can't find the resource that you asked for.

Examples

The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named mycreds.json.

To create a basic secret


var client = new AmazonSecretsManagerClient();
var response = client.CreateSecret(new CreateSecretRequest 
{
    ClientRequestToken = "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
    Description = "My test database secret created with the CLI",
    Name = "MyTestDatabaseSecret",
    SecretString = "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}"
});

string arn = response.ARN;
string name = response.Name;
string versionId = response.VersionId;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonSecretsManagerClient.CreateSecret (CreateSecretRequest)

Method