You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.SecretsManager

Inherits:
AWS.Service show all
Identifier:
secretsmanager
API Version:
2017-10-17
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.

API Version

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

Support and Feedback for Amazon Web Services Secrets Manager

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.

Logging API Requests

Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.

Sending a Request Using SecretsManager

var secretsmanager = new AWS.SecretsManager();
secretsmanager.cancelRotateSecret(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SecretsManager object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var secretsmanager = new AWS.SecretsManager({apiVersion: '2017-10-17'});

You can also set the API version globally in AWS.config.apiVersions using the secretsmanager service identifier:

AWS.config.apiVersions = {
  secretsmanager: '2017-10-17',
  // other service API versions
};

var secretsmanager = new AWS.SecretsManager();

Version:

  • 2017-10-17

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SecretsManager(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SecretsManager object

var secretsmanager = new AWS.SecretsManager({apiVersion: '2017-10-17'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.SecretsManager.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.SecretsManager.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.SecretsManager.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelRotateSecret(params = {}, callback) ⇒ AWS.Request

Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.

If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. You might need to remove the staging label AWSPENDING from the partially created version. You also need to determine whether to roll back to the previous version of the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING. To determine which version has a specific staging label, call ListSecretVersionIds. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation works.

To turn on automatic rotation again, call RotateSecret.

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:CancelRotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To cancel scheduled rotation for a secret


/* The following example shows how to cancel rotation for a secret. The operation sets the RotationEnabled field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the rotate-secret operation. */

 var params = {
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.cancelRotateSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "Name"
   }
   */
 });

Calling the cancelRotateSecret operation

var params = {
  SecretId: 'STRING_VALUE' /* required */
};
secretsmanager.cancelRotateSecret(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret.

      • Name — (String)

        The name of the secret.

      • VersionId — (String)

        The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage value AWSPENDING from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSecret(params = {}, callback) ⇒ AWS.Request

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 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.

Service Reference:

Examples:

To create a basic secret


/* 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. */

 var params = {
  ClientRequestToken: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
  Description: "My test database secret created with the CLI", 
  Name: "MyTestDatabaseSecret", 
  SecretString: "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}"
 };
 secretsmanager.createSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret", 
    VersionId: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1"
   }
   */
 });

Calling the createSecret operation

var params = {
  Name: 'STRING_VALUE', /* required */
  AddReplicaRegions: [
    {
      KmsKeyId: 'STRING_VALUE',
      Region: 'STRING_VALUE'
    },
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ForceOverwriteReplicaSecret: true || false,
  KmsKeyId: 'STRING_VALUE',
  SecretBinary: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SecretString: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
secretsmanager.createSecret(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the new secret.

      The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-

      Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.

    • ClientRequestToken — (String)

      If you include SecretString or SecretBinary, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.

      Note: 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 don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for the new version and include the value in the request.

      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.

      • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

      • If a version with this value already exists and the version SecretString and SecretBinary values are the same as those in the request, then the request is ignored.

      • If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.

      This value becomes the VersionId of the new version.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Description — (String)

      The description of the secret.

    • KmsKeyId — (String)

      The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About aliases.

      To use a KMS key in a different account, use the key ARN or the alias ARN.

      If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.

      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.

    • SecretBinary — (Buffer, Typed Array, Blob, String)

      The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

      Either SecretString or SecretBinary must have a value, but not both.

      This parameter is not available in the Secrets Manager console.

    • SecretString — (String)

      The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.

      Either SecretString or SecretBinary must have a value, but not both.

      If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.

    • Tags — (Array<map>)

      A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:

      [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

      Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".

      If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.

      For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

      The following restrictions apply to tags:

      • Maximum number of tags per secret: 50

      • Maximum key length: 127 Unicode characters in UTF-8

      • Maximum value length: 255 Unicode characters in UTF-8

      • Tag keys and values are case sensitive.

      • Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.

      • If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

      • Key — (String)

        The key identifier, or name, of the tag.

      • Value — (String)

        The string value associated with the key of the tag.

    • AddReplicaRegions — (Array<map>)

      A list of Regions and KMS keys to replicate secrets.

      • Region — (String)

        A Region code. For a list of Region codes, see Name and code of Regions.

      • KmsKeyId — (String)

        The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.

    • ForceOverwriteReplicaSecret — (Boolean)

      Specifies whether to overwrite a secret with the same name in the destination Region.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.

      • Name — (String)

        The name of the new secret.

      • VersionId — (String)

        The unique identifier associated with the version of the new secret.

      • ReplicationStatus — (Array<map>)

        A list of the replicas of this secret and their status:

        • Failed, which indicates that the replica was not created.

        • InProgress, which indicates that Secrets Manager is in the process of creating the replica.

        • InSync, which indicates that the replica was created.

        • Region — (String)

          The Region where replication occurs.

        • KmsKeyId — (String)

          Can be an ARN, Key ID, or Alias.

        • Status — (String)

          The status can be InProgress, Failed, or InSync.

          Possible values include:
          • "InSync"
          • "Failed"
          • "InProgress"
        • StatusMessage — (String)

          Status message such as "Secret with this name already exists in this region".

        • LastAccessedDate — (Date)

          The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request

Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.

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:DeleteResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To delete the resource-based policy attached to a secret


/* The following example shows how to delete the resource-based policy that is attached to a secret. */

 var params = {
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.deleteResourcePolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseMasterSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret"
   }
   */
 });

Calling the deleteResourcePolicy operation

var params = {
  SecretId: 'STRING_VALUE' /* required */
};
secretsmanager.deleteResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret to delete the attached resource-based policy for.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret that the resource-based policy was deleted for.

      • Name — (String)

        The name of the secret that the resource-based policy was deleted for.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSecret(params = {}, callback) ⇒ AWS.Request

Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.

You can't delete a primary secret that is replicated to other Regions. You must first delete the replicas using RemoveRegionsFromReplication, and then delete the primary secret. When you delete a replica, it is deleted immediately.

You can't directly delete a version of a secret. Instead, you remove all staging labels from the version using UpdateSecretVersionStage. This marks the version as deprecated, and then Secrets Manager can automatically delete the version in the background.

To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during the recovery window. For more information, see Monitor secrets scheduled for deletion.

Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.

At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.

When a secret is scheduled for deletion, you cannot retrieve the secret value. You must first cancel the deletion with RestoreSecret and then you can retrieve the secret.

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:DeleteSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To delete a secret


/* The following example shows how to delete a secret. The secret stays in your account in a deprecated and inaccessible state until the recovery window ends. After the date and time in the DeletionDate response field has passed, you can no longer recover this secret with restore-secret. */

 var params = {
  RecoveryWindowInDays: 7, 
  SecretId: "MyTestDatabaseSecret1"
 };
 secretsmanager.deleteSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    DeletionDate: <Date Representation>, 
    Name: "MyTestDatabaseSecret"
   }
   */
 });

Calling the deleteSecret operation

var params = {
  SecretId: 'STRING_VALUE', /* required */
  ForceDeleteWithoutRecovery: true || false,
  RecoveryWindowInDays: 'NUMBER_VALUE'
};
secretsmanager.deleteSecret(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret to delete.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • RecoveryWindowInDays — (Integer)

      The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret. You can't use both this parameter and ForceDeleteWithoutRecovery in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.

    • ForceDeleteWithoutRecovery — (Boolean)

      Specifies whether to delete the secret without any recovery window. You can't use both this parameter and RecoveryWindowInDays in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.

      Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.

      Use this parameter with caution. This parameter causes the operation to skip the normal recovery window before the permanent deletion that Secrets Manager would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithoutRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret.

      • Name — (String)

        The name of the secret.

      • DeletionDate — (Date)

        The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeSecret(params = {}, callback) ⇒ AWS.Request

Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.

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:DescribeSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To retrieve the details of a secret


/* The following example shows how to get the details about a secret. */

 var params = {
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.describeSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Description: "My test database secret", 
    KmsKeyId: "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987KMSKEY1", 
    LastAccessedDate: <Date Representation>, 
    LastChangedDate: <Date Representation>, 
    LastRotatedDate: <Date Representation>, 
    Name: "MyTestDatabaseSecret", 
    RotationEnabled: true, 
    RotationLambdaARN: "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda", 
    RotationRules: {
     AutomaticallyAfterDays: 14, 
     Duration: "2h", 
     ScheduleExpression: "cron(0 16 1,15 * ? *)"
    }, 
    Tags: [
       {
      Key: "SecondTag", 
      Value: "AnotherValue"
     }, 
       {
      Key: "FirstTag", 
      Value: "SomeValue"
     }
    ], 
    VersionIdsToStages: {
     "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [
         "AWSPREVIOUS"
      ], 
     "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [
         "AWSCURRENT"
      ]
    }
   }
   */
 });

Calling the describeSecret operation

var params = {
  SecretId: 'STRING_VALUE' /* required */
};
secretsmanager.describeSecret(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret.

      • Name — (String)

        The name of the secret.

      • Description — (String)

        The description of the secret.

      • KmsKeyId — (String)

        The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted. Secrets created using the console use an KMS key ID.

      • RotationEnabled — (Boolean)

        Specifies whether automatic rotation is turned on for this secret.

        To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.

      • RotationLambdaARN — (String)

        The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.

      • RotationRules — (map)

        The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.

        • AutomaticallyAfterDays — (Integer)

          The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.

          In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation schedule in hours, use ScheduleExpression.

        • Duration — (String)

          The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide.

        • ScheduleExpression — (String)

          A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.

          Secrets Manager rate() expressions represent the interval in hours or days that you want to rotate your secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as often as every four hours. If you use a rate() expression, the rotation window starts at midnight. For a rate in hours, the default rotation window closes after one hour. For a rate in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

          You can use a cron() expression to create a rotation schedule that is more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression that represents a schedule in hours, the default rotation window closes after one hour. For a cron expression that represents a schedule in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

      • LastRotatedDate — (Date)

        The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.

      • LastChangedDate — (Date)

        The last date and time that this secret was modified in any way.

      • LastAccessedDate — (Date)

        The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

      • DeletedDate — (Date)

        The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.

        If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.

      • Tags — (Array<map>)

        The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

        • Key — (String)

          The key identifier, or name, of the tag.

        • Value — (String)

          The string value associated with the key of the tag.

      • VersionIdsToStages — (map<Array<String>>)

        A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.

        Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:

        • AWSCURRENT, which indicates the current version of the secret.

        • AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.

          During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.

        • AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.

        For more information about rotation and staging labels, see How rotation works.

      • OwningService — (String)

        The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.

      • CreatedDate — (Date)

        The date the secret was created.

      • PrimaryRegion — (String)

        The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.

      • ReplicationStatus — (Array<map>)

        A list of the replicas of this secret and their status:

        • Failed, which indicates that the replica was not created.

        • InProgress, which indicates that Secrets Manager is in the process of creating the replica.

        • InSync, which indicates that the replica was created.

        • Region — (String)

          The Region where replication occurs.

        • KmsKeyId — (String)

          Can be an ARN, Key ID, or Alias.

        • Status — (String)

          The status can be InProgress, Failed, or InSync.

          Possible values include:
          • "InSync"
          • "Failed"
          • "InProgress"
        • StatusMessage — (String)

          Status message such as "Secret with this name already exists in this region".

        • LastAccessedDate — (Date)

          The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRandomPassword(params = {}, callback) ⇒ AWS.Request

Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

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:GetRandomPassword. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To generate a random password


/* The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters. */

 var params = {
  IncludeSpace: true, 
  PasswordLength: 20, 
  RequireEachIncludedType: true
 };
 secretsmanager.getRandomPassword(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    RandomPassword: "EXAMPLE-PASSWORD"
   }
   */
 });

Calling the getRandomPassword operation

var params = {
  ExcludeCharacters: 'STRING_VALUE',
  ExcludeLowercase: true || false,
  ExcludeNumbers: true || false,
  ExcludePunctuation: true || false,
  ExcludeUppercase: true || false,
  IncludeSpace: true || false,
  PasswordLength: 'NUMBER_VALUE',
  RequireEachIncludedType: true || false
};
secretsmanager.getRandomPassword(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • PasswordLength — (Integer)

      The length of the password. If you don't include this parameter, the default length is 32 characters.

    • ExcludeCharacters — (String)

      A string of the characters that you don't want in the password.

    • ExcludeNumbers — (Boolean)

      Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

    • ExcludePunctuation — (Boolean)

      Specifies whether to exclude the following punctuation characters from the password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ~. If you don't include this switch, the password can contain punctuation.

    • ExcludeUppercase — (Boolean)

      Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

    • ExcludeLowercase — (Boolean)

      Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

    • IncludeSpace — (Boolean)

      Specifies whether to include the space character. If you include this switch, the password can contain space characters.

    • RequireEachIncludedType — (Boolean)

      Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RandomPassword — (String)

        A string with the password.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getResourcePolicy(params = {}, callback) ⇒ AWS.Request

Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.

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:GetResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To retrieve the resource-based policy attached to a secret


/* The following example shows how to retrieve the resource-based policy that is attached to a secret. */

 var params = {
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.getResourcePolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret", 
    ResourcePolicy: "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}"
   }
   */
 });

Calling the getResourcePolicy operation

var params = {
  SecretId: 'STRING_VALUE' /* required */
};
secretsmanager.getResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret to retrieve the attached resource-based policy for.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret that the resource-based policy was retrieved for.

      • Name — (String)

        The name of the secret that the resource-based policy was retrieved for.

      • ResourcePolicy — (String)

        A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSecretValue(params = {}, callback) ⇒ AWS.Request

Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.

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.

Service Reference:

Examples:

To retrieve the encrypted secret value of a secret


/* The following example shows how to retrieve a secret string value. */

 var params = {
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.getSecretValue(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    CreatedDate: <Date Representation>, 
    Name: "MyTestDatabaseSecret", 
    SecretString: "{\n  \"username\":\"david\",\n  \"password\":\"EXAMPLE-PASSWORD\"\n}\n", 
    VersionId: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
    VersionStages: [
       "AWSPREVIOUS"
    ]
   }
   */
 });

Calling the getSecretValue operation

var params = {
  SecretId: 'STRING_VALUE', /* required */
  VersionId: 'STRING_VALUE',
  VersionStage: 'STRING_VALUE'
};
secretsmanager.getSecretValue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret to retrieve.

      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 — (String)

      The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT version.

      This value is typically a UUID-type value with 32 hexadecimal digits.

    • VersionStage — (String)

      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 VersionId, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, Secrets Manager returns the AWSCURRENT version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret.

      • Name — (String)

        The friendly name of the secret.

      • VersionId — (String)

        The unique identifier of this version of the secret.

      • SecretBinary — (Buffer(Node.js), Typed Array(Browser))

        The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.

        If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.

      • SecretString — (String)

        The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.

        If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.

      • VersionStages — (Array<String>)

        A list of all of the staging labels currently attached to this version of the secret.

      • CreatedDate — (Date)

        The date and time that this version of the secret was created. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSecrets(params = {}, callback) ⇒ AWS.Request

Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.

ListSecrets is eventually consistent, however it might not reflect changes from the last five minutes. To get the latest information for a specific secret, use DescribeSecret.

To list the versions of a secret, use ListSecretVersionIds.

To get the secret value from SecretString or SecretBinary, call GetSecretValue.

For information about finding secrets in the console, see Find secrets in Secrets Manager.

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:ListSecrets. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To list the secrets in your account


/* The following example shows how to list all of the secrets in your account. */

 var params = {
 };
 secretsmanager.listSecrets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SecretList: [
       {
      ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
      Description: "My test database secret", 
      LastChangedDate: <Date Representation>, 
      Name: "MyTestDatabaseSecret", 
      SecretVersionsToStages: {
       "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [
           "AWSCURRENT"
        ]
      }
     }, 
       {
      ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret1-d4e5f6", 
      Description: "Another secret created for a different database", 
      LastChangedDate: <Date Representation>, 
      Name: "MyTestDatabaseSecret1", 
      SecretVersionsToStages: {
       "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [
           "AWSCURRENT"
        ]
      }
     }
    ]
   }
   */
 });

Calling the listSecrets operation

var params = {
  Filters: [
    {
      Key: description | name | tag-key | tag-value | primary-region | all,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortOrder: asc | desc
};
secretsmanager.listSecrets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The number of results to include in the response.

      If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.

    • NextToken — (String)

      A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.

    • Filters — (Array<map>)

      The filters to apply to the list of secrets.

      • Key — (String)

        The following are keys you can use:

        • description: Prefix match, not case-sensitive.

        • name: Prefix match, case-sensitive.

        • tag-key: Prefix match, case-sensitive.

        • tag-value: Prefix match, case-sensitive.

        • primary-region: Prefix match, case-sensitive.

        • all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.

        Possible values include:
        • "description"
        • "name"
        • "tag-key"
        • "tag-value"
        • "primary-region"
        • "all"
      • Values — (Array<String>)

        The keyword to filter for.

        You can prefix your search value with an exclamation mark (!) in order to perform negation filters.

    • SortOrder — (String)

      Secrets are listed by CreatedDate.

      Possible values include:
      • "asc"
      • "desc"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SecretList — (Array<map>)

        A list of the secrets in the account.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the secret.

        • Name — (String)

          The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod.

        • Description — (String)

          The user-provided description of the secret.

        • KmsKeyId — (String)

          The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

        • RotationEnabled — (Boolean)

          Indicates whether automatic, scheduled rotation is enabled for this secret.

        • RotationLambdaARN — (String)

          The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .

        • RotationRules — (map)

          A structure that defines the rotation configuration for the secret.

          • AutomaticallyAfterDays — (Integer)

            The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.

            In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation schedule in hours, use ScheduleExpression.

          • Duration — (String)

            The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide.

          • ScheduleExpression — (String)

            A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.

            Secrets Manager rate() expressions represent the interval in hours or days that you want to rotate your secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as often as every four hours. If you use a rate() expression, the rotation window starts at midnight. For a rate in hours, the default rotation window closes after one hour. For a rate in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

            You can use a cron() expression to create a rotation schedule that is more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression that represents a schedule in hours, the default rotation window closes after one hour. For a cron expression that represents a schedule in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

        • LastRotatedDate — (Date)

          The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.

        • LastChangedDate — (Date)

          The last date and time that this secret was modified in any way.

        • LastAccessedDate — (Date)

          The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

        • DeletedDate — (Date)

          The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

        • Tags — (Array<map>)

          The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

          • Key — (String)

            The key identifier, or name, of the tag.

          • Value — (String)

            The string value associated with the key of the tag.

        • SecretVersionsToStages — (map<Array<String>>)

          A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.

          Note: A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.
        • OwningService — (String)

          Returns the name of the service that created the secret.

        • CreatedDate — (Date)

          The date and time when a secret was created.

        • PrimaryRegion — (String)

          The Region where Secrets Manager originated the secret.

      • NextToken — (String)

        Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets again with this value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSecretVersionIds(params = {}, callback) ⇒ AWS.Request

Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions.

To list the secrets in the account, use ListSecrets.

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:ListSecretVersionIds. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To list all of the secret versions associated with a secret


/* The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels. */

 var params = {
  IncludeDeprecated: true, 
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.listSecretVersionIds(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret", 
    Versions: [
       {
      CreatedDate: <Date Representation>, 
      VersionId: "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", 
      VersionStages: [
         "AWSPREVIOUS"
      ]
     }, 
       {
      CreatedDate: <Date Representation>, 
      VersionId: "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", 
      VersionStages: [
         "AWSCURRENT"
      ]
     }, 
       {
      CreatedDate: <Date Representation>, 
      VersionId: "EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;"
     }
    ]
   }
   */
 });

Calling the listSecretVersionIds operation

var params = {
  SecretId: 'STRING_VALUE', /* required */
  IncludeDeprecated: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
secretsmanager.listSecretVersionIds(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret whose versions you want to list.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • MaxResults — (Integer)

      The number of results to include in the response.

      If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecretVersionIds again with the value from NextToken.

    • NextToken — (String)

      A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds again with this value.

    • IncludeDeprecated — (Boolean)

      Specifies whether to include versions of secrets that don't have any staging labels attached to them. Versions without staging labels are considered deprecated and are subject to deletion by Secrets Manager.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Versions — (Array<map>)

        A list of the versions of the secret.

        • VersionId — (String)

          The unique version identifier of this version of the secret.

        • VersionStages — (Array<String>)

          An array of staging labels that are currently associated with this version of the secret.

        • LastAccessedDate — (Date)

          The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.

        • CreatedDate — (Date)

          The date and time this version of the secret was created.

        • KmsKeyIds — (Array<String>)

          The KMS keys used to encrypt the secret version.

      • NextToken — (String)

        Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds again with this value.

      • ARN — (String)

        The ARN of the secret.

      • Name — (String)

        The name of the secret.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putResourcePolicy(params = {}, callback) ⇒ AWS.Request

Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager

For information about attaching a policy in the console, see Attach a permissions policy to a secret.

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:PutResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To add a resource-based policy to a secret


/* The following example shows how to add a resource-based policy to a secret. */

 var params = {
  ResourcePolicy: "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}", 
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.putResourcePolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret"
   }
   */
 });

Calling the putResourcePolicy operation

var params = {
  ResourcePolicy: 'STRING_VALUE', /* required */
  SecretId: 'STRING_VALUE', /* required */
  BlockPublicPolicy: true || false
};
secretsmanager.putResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret to attach the resource-based policy.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • ResourcePolicy — (String)

      A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.

    • BlockPublicPolicy — (Boolean)

      Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret.

      • Name — (String)

        The name of the secret.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putSecretValue(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To store a secret value in a new version of a secret


/* The following example shows how to create a new version of the secret. Alternatively, you can use the update-secret command. */

 var params = {
  ClientRequestToken: "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", 
  SecretId: "MyTestDatabaseSecret", 
  SecretString: "{\"username\":\"david\",\"password\":\"EXAMPLE-PASSWORD\"}"
 };
 secretsmanager.putSecretValue(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret", 
    VersionId: "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", 
    VersionStages: [
       "AWSCURRENT"
    ]
   }
   */
 });

Calling the putSecretValue operation

var params = {
  SecretId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  SecretBinary: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SecretString: 'STRING_VALUE',
  VersionStages: [
    'STRING_VALUE',
    /* more items */
  ]
};
secretsmanager.putSecretValue(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      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 CreateSecret instead.

    • ClientRequestToken — (String)

      A unique identifier for the new version of the secret.

      Note: 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 because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

      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 the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

      • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

      • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored. The operation is idempotent.

      • If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.

      This value becomes the VersionId of the new version.

      If a token is not provided, the SDK will use a version 4 UUID.
    • SecretBinary — (Buffer, Typed Array, Blob, String)

      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 SecretBinary or SecretString, but not both.

      You can't access this value from the Secrets Manager console.

    • SecretString — (String)

      The text to encrypt and store in the new version of the secret.

      You must include SecretBinary or SecretString, but not both.

      We recommend you create the secret string as JSON key/value pairs, as shown in the example.

    • VersionStages — (Array<String>)

      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 AWSCURRENT, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

      If you don't include VersionStages, then Secrets Manager automatically moves the staging label AWSCURRENT to this version.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret.

      • Name — (String)

        The name of the secret.

      • VersionId — (String)

        The unique identifier of the version of the secret.

      • VersionStages — (Array<String>)

        The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

removeRegionsFromReplication(params = {}, callback) ⇒ AWS.Request

For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.

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:RemoveRegionsFromReplication. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

Calling the removeRegionsFromReplication operation

var params = {
  RemoveReplicaRegions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  SecretId: 'STRING_VALUE' /* required */
};
secretsmanager.removeRegionsFromReplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret.

    • RemoveReplicaRegions — (Array<String>)

      The Regions of the replicas to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the primary secret.

      • ReplicationStatus — (Array<map>)

        The status of replicas for this secret after you remove Regions.

        • Region — (String)

          The Region where replication occurs.

        • KmsKeyId — (String)

          Can be an ARN, Key ID, or Alias.

        • Status — (String)

          The status can be InProgress, Failed, or InSync.

          Possible values include:
          • "InSync"
          • "Failed"
          • "InProgress"
        • StatusMessage — (String)

          Status message such as "Secret with this name already exists in this region".

        • LastAccessedDate — (Date)

          The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

replicateSecretToRegions(params = {}, callback) ⇒ AWS.Request

Replicates the secret to a new Regions. See Multi-Region secrets.

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:ReplicateSecretToRegions. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

Calling the replicateSecretToRegions operation

var params = {
  AddReplicaRegions: [ /* required */
    {
      KmsKeyId: 'STRING_VALUE',
      Region: 'STRING_VALUE'
    },
    /* more items */
  ],
  SecretId: 'STRING_VALUE', /* required */
  ForceOverwriteReplicaSecret: true || false
};
secretsmanager.replicateSecretToRegions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret to replicate.

    • AddReplicaRegions — (Array<map>)

      A list of Regions in which to replicate the secret.

      • Region — (String)

        A Region code. For a list of Region codes, see Name and code of Regions.

      • KmsKeyId — (String)

        The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.

    • ForceOverwriteReplicaSecret — (Boolean)

      Specifies whether to overwrite a secret with the same name in the destination Region.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the primary secret.

      • ReplicationStatus — (Array<map>)

        The status of replication.

        • Region — (String)

          The Region where replication occurs.

        • KmsKeyId — (String)

          Can be an ARN, Key ID, or Alias.

        • Status — (String)

          The status can be InProgress, Failed, or InSync.

          Possible values include:
          • "InSync"
          • "Failed"
          • "InProgress"
        • StatusMessage — (String)

          Status message such as "Secret with this name already exists in this region".

        • LastAccessedDate — (Date)

          The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

restoreSecret(params = {}, callback) ⇒ AWS.Request

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.

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:RestoreSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To restore a previously deleted secret


/* The following example shows how to restore a secret that you previously scheduled for deletion. */

 var params = {
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.restoreSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret"
   }
   */
 });

Calling the restoreSecret operation

var params = {
  SecretId: 'STRING_VALUE' /* required */
};
secretsmanager.restoreSecret(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret to restore.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret that was restored.

      • Name — (String)

        The name of the secret that was restored.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

rotateSecret(params = {}, callback) ⇒ AWS.Request

Configures and starts the asynchronous process of rotating the secret. For more information about rotation, see Rotate secrets.

If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret.

For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the secret value is in the JSON structure of a database secret. In particular, if you want to use the alternating users strategy, your secret must contain the ARN of a superuser secret.

To configure rotation, you also need the ARN of an Amazon Web Services Lambda function and the schedule for the rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the database or service to match. After testing the new credentials, the function marks the new secret version with the staging label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more information, see How rotation works.

You can create the Lambda rotation function based on the rotation function templates that Secrets Manager provides. Choose a template that matches your Rotation strategy.

When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT, then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error.

When rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret version. For more information, see Troubleshoot rotation in the Secrets Manager User Guide.

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:RotateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. For more information, see Permissions for rotation.

Service Reference:

Examples:

To configure rotation for a secret


/* The following example configures rotation for a secret using a cron expression. The first rotation happens immediately after the changes are stored in the secret. The rotation schedule is the first and 15th day of every month. The rotation window begins at 4:00 PM UTC and ends at 6:00 PM. */

 var params = {
  RotationLambdaARN: "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda", 
  RotationRules: {
   Duration: "2h", 
   ScheduleExpression: "cron(0 16 1,15 * ? *)"
  }, 
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.rotateSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret", 
    VersionId: "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
   }
   */
 });

To request an immediate rotation for a secret


/* The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background. */

 var params = {
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.rotateSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret", 
    VersionId: "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2"
   }
   */
 });

Calling the rotateSecret operation

var params = {
  SecretId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  RotateImmediately: true || false,
  RotationLambdaARN: 'STRING_VALUE',
  RotationRules: {
    AutomaticallyAfterDays: 'NUMBER_VALUE',
    Duration: 'STRING_VALUE',
    ScheduleExpression: 'STRING_VALUE'
  }
};
secretsmanager.rotateSecret(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret to rotate.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • ClientRequestToken — (String)

      A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId of the new version.

      If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

      You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

      If a token is not provided, the SDK will use a version 4 UUID.
    • RotationLambdaARN — (String)

      The ARN of the Lambda rotation function that can rotate the secret.

    • RotationRules — (map)

      A structure that defines the rotation configuration for this secret.

      • AutomaticallyAfterDays — (Integer)

        The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.

        In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule after every successful rotation. In RotateSecret, you can set the rotation schedule in RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not both. To set a rotation schedule in hours, use ScheduleExpression.

      • Duration — (String)

        The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager rotates your secret at any time during this window. The window must not extend into the next rotation window or the next UTC day. The window starts according to the ScheduleExpression. If you don't specify a Duration, for a ScheduleExpression in hours, the window automatically closes after one hour. For a ScheduleExpression in days, the window automatically closes at the end of the UTC day. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide.

      • ScheduleExpression — (String)

        A cron() or rate() expression that defines the schedule for rotating your secret. Secrets Manager rotation schedules use UTC time zone. Secrets Manager rotates your secret any time during a rotation window.

        Secrets Manager rate() expressions represent the interval in hours or days that you want to rotate your secret, for example rate(12 hours) or rate(10 days). You can rotate a secret as often as every four hours. If you use a rate() expression, the rotation window starts at midnight. For a rate in hours, the default rotation window closes after one hour. For a rate in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

        You can use a cron() expression to create a rotation schedule that is more detailed than a rotation interval. For more information, including examples, see Schedule expressions in Secrets Manager rotation in the Secrets Manager Users Guide. For a cron expression that represents a schedule in hours, the default rotation window closes after one hour. For a cron expression that represents a schedule in days, the default rotation window closes at the end of the day. You can set the Duration to change the rotation window. The rotation window must not extend into the next UTC day or into the next rotation window.

    • RotateImmediately — (Boolean)

      Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.

      If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

      If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret.

      • Name — (String)

        The name of the secret.

      • VersionId — (String)

        The ID of the new version of the secret.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopReplicationToReplica(params = {}, callback) ⇒ AWS.Request

Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.

You must call this operation from the Region in which you want to promote the replica to a primary secret.

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:StopReplicationToReplica. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

Calling the stopReplicationToReplica operation

var params = {
  SecretId: 'STRING_VALUE' /* required */
};
secretsmanager.stopReplicationToReplica(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN of the primary secret.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.

The following restrictions apply to tags:

  • Maximum number of tags per secret: 50

  • Maximum key length: 127 Unicode characters in UTF-8

  • Maximum value length: 255 Unicode characters in UTF-8

  • Tag keys and values are case sensitive.

  • Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.

  • If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

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:TagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To add tags to a secret


/* The following example shows how to attach two tags each with a Key and Value to a secret. There is no output from this API. To see the result, use the DescribeSecret operation. */

 var params = {
  SecretId: "MyExampleSecret", 
  Tags: [
     {
    Key: "FirstTag", 
    Value: "SomeValue"
   }, 
     {
    Key: "SecondTag", 
    Value: "AnotherValue"
   }
  ]
 };
 secretsmanager.tagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the tagResource operation

var params = {
  SecretId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
secretsmanager.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • Tags — (Array<map>)

      The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key and a Value.

      For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

      • Key — (String)

        The key identifier, or name, of the tag.

      • Value — (String)

        The string value associated with the key of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes specific tags from a secret.

This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.

If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

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:UntagResource. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To remove tags from a secret


/* The following example shows how to remove two tags from a secret's metadata. For each, both the tag and the associated value are removed. There is no output from this API. To see the result, use the DescribeSecret operation. */

 var params = {
  SecretId: "MyTestDatabaseSecret", 
  TagKeys: [
     "FirstTag", 
     "SecondTag"
  ]
 };
 secretsmanager.untagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the untagResource operation

var params = {
  SecretId: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
secretsmanager.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • TagKeys — (Array<String>)

      A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.

      This parameter requires a JSON text string argument.

      For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSecret(params = {}, callback) ⇒ AWS.Request

Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.

To change the rotation configuration of a secret, use RotateSecret instead.

We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to 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 update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.

If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new version. Then it attaches the label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If you call this operation with a ClientRequestToken that matches an existing version's VersionId, the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage.

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:UpdateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. If you use a customer managed key, you must also have kms:GenerateDataKey and kms:Decrypt permissions on the key. For more information, see Secret encryption and decryption.

Service Reference:

Examples:

To update the description of a secret


/* The following example shows how to modify the description of a secret. */

 var params = {
  ClientRequestToken: "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", 
  Description: "This is a new description for the secret.", 
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.updateSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret"
   }
   */
 });

To update the KMS key associated with a secret


/* This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret. */

 var params = {
  KmsKeyId: "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", 
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.updateSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret"
   }
   */
 });

To create a new version of the encrypted secret value


/* The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation. */

 var params = {
  SecretId: "MyTestDatabaseSecret", 
  SecretString: "{JSON STRING WITH CREDENTIALS}"
 };
 secretsmanager.updateSecret(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret", 
    VersionId: "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE"
   }
   */
 });

Calling the updateSecret operation

var params = {
  SecretId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  SecretBinary: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  SecretString: 'STRING_VALUE'
};
secretsmanager.updateSecret(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or name of the secret.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • ClientRequestToken — (String)

      If you include SecretString or SecretBinary, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.

      Note: 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 don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for the new version and include the value in the request.

      This value becomes the VersionId of the new version.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Description — (String)

      The description of the secret.

    • KmsKeyId — (String)

      The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions with the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about versions and staging labels, see Concepts: Version.

      A key alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more information, see About aliases.

      If you set this to an empty string, 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.

      You can only use the Amazon Web Services managed key aws/secretsmanager if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.

    • SecretBinary — (Buffer, Typed Array, Blob, String)

      The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

      Either SecretBinary or SecretString must have a value, but not both.

      You can't access this parameter in the Secrets Manager console.

    • SecretString — (String)

      The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.

      Either SecretBinary or SecretString must have a value, but not both.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret that was updated.

      • Name — (String)

        The name of the secret that was updated.

      • VersionId — (String)

        If Secrets Manager created a new version of the secret during this operation, then VersionId contains the unique identifier of the new version.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSecretVersionStage(params = {}, callback) ⇒ AWS.Request

Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.

The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version.

You can move the AWSCURRENT staging label to this version by including it in this call.

Note: Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.

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:UpdateSecretVersionStage. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To add a staging label attached to a version of a secret


/* The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version. */

 var params = {
  MoveToVersionId: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
  SecretId: "MyTestDatabaseSecret", 
  VersionStage: "STAGINGLABEL1"
 };
 secretsmanager.updateSecretVersionStage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret"
   }
   */
 });

To delete a staging label attached to a version of a secret


/* The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version. */

 var params = {
  RemoveFromVersionId: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
  SecretId: "MyTestDatabaseSecret", 
  VersionStage: "STAGINGLABEL1"
 };
 secretsmanager.updateSecretVersionStage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret"
   }
   */
 });

To move a staging label from one version of a secret to another


/* The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version. */

 var params = {
  MoveToVersionId: "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2", 
  RemoveFromVersionId: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
  SecretId: "MyTestDatabaseSecret", 
  VersionStage: "AWSCURRENT"
 };
 secretsmanager.updateSecretVersionStage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ARN: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
    Name: "MyTestDatabaseSecret"
   }
   */
 });

Calling the updateSecretVersionStage operation

var params = {
  SecretId: 'STRING_VALUE', /* required */
  VersionStage: 'STRING_VALUE', /* required */
  MoveToVersionId: 'STRING_VALUE',
  RemoveFromVersionId: 'STRING_VALUE'
};
secretsmanager.updateSecretVersionStage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      The ARN or the name of the secret with the version and staging labelsto modify.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • VersionStage — (String)

      The staging label to add to this version.

    • RemoveFromVersionId — (String)

      The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

    • MoveToVersionId — (String)

      The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.

      If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ARN — (String)

        The ARN of the secret that was updated.

      • Name — (String)

        The name of the secret that was updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

validateResourcePolicy(params = {}, callback) ⇒ AWS.Request

Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets.

The API performs three checks when validating the policy:

  • Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal.

  • Checks for correct syntax in a policy.

  • Verifies the policy does not lock out a caller.

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:ValidateResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Service Reference:

Examples:

To validate a resource-based policy to a secret


/* The following example shows how to validate a resource-based policy to a secret. */

 var params = {
  ResourcePolicy: "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n\"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\":\"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}", 
  SecretId: "MyTestDatabaseSecret"
 };
 secretsmanager.validateResourcePolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    PolicyValidationPassed: true, 
    ValidationErrors: [
    ]
   }
   */
 });

Calling the validateResourcePolicy operation

var params = {
  ResourcePolicy: 'STRING_VALUE', /* required */
  SecretId: 'STRING_VALUE'
};
secretsmanager.validateResourcePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SecretId — (String)

      This field is reserved for internal use.

    • ResourcePolicy — (String)

      A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PolicyValidationPassed — (Boolean)

        True if your policy passes validation, otherwise false.

      • ValidationErrors — (Array<map>)

        Validation errors if your policy didn't pass validation.

        • CheckName — (String)

          Checks the name of the policy.

        • ErrorMessage — (String)

          Displays error messages if validation encounters problems during validation of the resource policy.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.