You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecretsManager::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS Secrets Manager. To construct a client, you need to configure a :region and :credentials.

secretsmanager = Aws::SecretsManager::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::SecretsManager::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::SecretsManager::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#cancel_rotate_secret(options = {}) ⇒ Types::CancelRotateSecretResponse

Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.

To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.

If you cancel a rotation that is in progress, it can leave the VersionStage labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's VersionStage field.

To successfully start a rotation, the staging label AWSPENDING must be in one of the following states:

  • Not be attached to any version at all

  • Attached to the same version as the staging label AWSCURRENT

If the staging label AWSPENDING is attached to a different version than the version with AWSCURRENT then the attempt to rotate fails.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:CancelRotateSecret

Related operations

  • To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.

  • To get the rotation configuration details for a secret, use DescribeSecret.

  • To list all of the currently available secrets, use ListSecrets.

  • To list all of the versions currently associated with a secret, use ListSecretVersionIds.

Examples:

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

resp = client.cancel_rotate_secret({
  secret_id: "MyTestDatabaseSecret", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "Name", 
}

Request syntax with placeholder values


resp = client.cancel_rotate_secret({
  secret_id: "SecretIdType", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version_id #=> String

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

Returns:

See Also:

#create_secret(options = {}) ⇒ Types::CreateSecretResponse

Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.

Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more "staging labels" that identify where the version is in the rotation cycle. The SecretVersionsToStages field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and are not included in the list.

You provide the secret data to be encrypted by putting text in either the SecretString parameter or binary data in the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT to the new version.

  • If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias 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 same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

  • If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:CreateSecret

  • kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

  • kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

  • secretsmanager:TagResource - needed only if you include the Tags parameter.

Related operations

  • To delete a secret, use DeleteSecret.

  • To modify an existing secret, use UpdateSecret.

  • To create a new version of a secret, use PutSecretValue.

  • To retrieve the encrypted secure string and secure binary values, use GetSecretValue.

  • To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values.

  • To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response value.

Examples:

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

resp = client.create_secret({
  client_request_token: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
  description: "My test database secret created with the CLI", 
  name: "MyTestDatabaseSecret", 
  secret_string: "{\"username\":\"david\",\"password\":\"BnQw!XDWgaEeT9XGTT29\"}", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
  version_id: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
}

Request syntax with placeholder values


resp = client.create_secret({
  name: "NameType", # required
  client_request_token: "ClientRequestTokenType",
  description: "DescriptionType",
  kms_key_id: "KmsKeyIdType",
  secret_binary: "data",
  secret_string: "SecretStringType",
  tags: [
    {
      key: "TagKeyType",
      value: "TagValueType",
    },
  ],
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version_id #=> String

Options Hash (options):

  • :name (required, String)

    Specifies the friendly name of the new secret.

    The secret name must be ASCII letters, digits, or the following characters : /_+=.@-

    Don\'t 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. This is because Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.

  • :client_request_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. (Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

    If you use the AWS CLI or one of the AWS SDK 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 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 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 that version\'s SecretString and 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 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.

  • :description (String) — default: Optional

    Specifies a user-provided description of the secret.

  • :kms_key_id (String) — default: Optional

    Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

    You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

    If you don\'t specify this value, then Secrets Manager defaults to using the AWS account\'s default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn\'t yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version\'s SecretString or SecretBinary fields.

    You can use the account\'s default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field.

  • :secret_binary (IO, String) — default: Optional

    Specifies binary data that you want 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 use the appropriate technique for your tool to pass the contents of the file as a parameter.

    Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

    This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.

  • :secret_string (String) — default: Optional

    Specifies text data that you want to encrypt and store in this new version of the secret.

    Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

    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 the Lambda rotation function knows how to parse.

    For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

    [`{"username":"bob"},{"password":"abc123xyz456"}`]

    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.

  • :tags (Array<Types::Tag>) — default: Optional

    Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

    * 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 IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

    This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

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

    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 basic 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 it is reserved for AWS 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 your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

Returns:

See Also:

#delete_resource_policy(options = {}) ⇒ Types::DeleteResourcePolicyResponse

Deletes the resource-based permission policy that's attached to the secret.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:DeleteResourcePolicy

Related operations

  • To attach a resource policy to a secret, use PutResourcePolicy.

  • To retrieve the current resource-based policy that's attached to a secret, use GetResourcePolicy.

  • To list all of the currently available secrets, use ListSecrets.

Examples:

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

resp = client.delete_resource_policy({
  secret_id: "MyTestDatabaseSecret", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseMasterSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
}

Request syntax with placeholder values


resp = client.delete_resource_policy({
  secret_id: "SecretIdType", # required
})

Response structure


resp.arn #=> String
resp.name #=> String

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

Returns:

See Also:

#delete_secret(options = {}) ⇒ Types::DeleteSecretResponse

Deletes an entire secret and all of its versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 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.

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

You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.

  • There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the VersionStage field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions that do not have any staging labels do not show up in ListSecretVersionIds unless you specify IncludeDeprecated.

  • The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:DeleteSecret

Related operations

  • To create a secret, use CreateSecret.

  • To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret.

Examples:

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

resp = client.delete_secret({
  recovery_window_in_days: 7, 
  secret_id: "MyTestDatabaseSecret1", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  deletion_date: Time.parse("1524085349.095"), 
  name: "MyTestDatabaseSecret", 
}

Request syntax with placeholder values


resp = client.delete_secret({
  secret_id: "SecretIdType", # required
  recovery_window_in_days: 1,
  force_delete_without_recovery: false,
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.deletion_date #=> Time

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

  • :recovery_window_in_days (Integer) — default: Optional

    Specifies the number of days that Secrets Manager waits before it can delete the secret. You can\'t use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.

    This value can range from 7 to 30 days. The default value is 30.

  • :force_delete_without_recovery (Boolean) — default: Optional

    Specifies that the secret is to be deleted without any recovery window. You can\'t use both this parameter and the RecoveryWindowInDays parameter in the same API call.

    An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.

    Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that AWS would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. It is permanently lost.

Returns:

See Also:

#describe_secret(options = {}) ⇒ Types::DescribeSecretResponse

Retrieves the details of a secret. It does not include the encrypted fields. Only those fields that are populated with a value are returned in the response.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:DescribeSecret

Related operations

Examples:

Example: To retrieve the details of a secret


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

resp = client.describe_secret({
  secret_id: "MyTestDatabaseSecret", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  description: "My test database secret", 
  kms_key_id: "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987KMSKEY1", 
  last_accessed_date: Time.parse("1523923200"), 
  last_changed_date: Time.parse(1523477145.729), 
  last_rotated_date: Time.parse(1525747253.72), 
  name: "MyTestDatabaseSecret", 
  rotation_enabled: true, 
  rotation_lambda_arn: "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda", 
  rotation_rules: {
    automatically_after_days: 30, 
  }, 
  tags: [
    {
      key: "SecondTag", 
      value: "AnotherValue", 
    }, 
    {
      key: "FirstTag", 
      value: "SomeValue", 
    }, 
  ], 
  version_ids_to_stages: {
    "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" => [
      "AWSPREVIOUS", 
    ], 
    "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE" => [
      "AWSCURRENT", 
    ], 
  }, 
}

Request syntax with placeholder values


resp = client.describe_secret({
  secret_id: "SecretIdType", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.description #=> String
resp.kms_key_id #=> String
resp.rotation_enabled #=> true/false
resp.rotation_lambda_arn #=> String
resp.rotation_rules.automatically_after_days #=> Integer
resp.last_rotated_date #=> Time
resp.last_changed_date #=> Time
resp.last_accessed_date #=> Time
resp.deleted_date #=> Time
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.version_ids_to_stages #=> Hash
resp.version_ids_to_stages["SecretVersionIdType"] #=> Array
resp.version_ids_to_stages["SecretVersionIdType"][0] #=> String
resp.owning_service #=> String

Options Hash (options):

  • :secret_id (required, String)

    The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

Returns:

See Also:

#get_random_password(options = {}) ⇒ Types::GetRandomPasswordResponse

Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:GetRandomPassword

Examples:

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

resp = client.get_random_password({
  include_space: true, 
  password_length: 20, 
  require_each_included_type: true, 
})

# resp.to_h outputs the following:
{
  random_password: "N+Z43a,>vx7j O8^*<8i3", 
}

Request syntax with placeholder values


resp = client.get_random_password({
  password_length: 1,
  exclude_characters: "ExcludeCharactersType",
  exclude_numbers: false,
  exclude_punctuation: false,
  exclude_uppercase: false,
  exclude_lowercase: false,
  include_space: false,
  require_each_included_type: false,
})

Response structure


resp.random_password #=> String

Options Hash (options):

  • :password_length (Integer)

    The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

  • :exclude_characters (String)

    A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.

  • :exclude_numbers (Boolean)

    Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.

  • :exclude_punctuation (Boolean)

    Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.

    The following are the punctuation characters that can be included in the generated password if you don\'t explicitly exclude them with ExcludeCharacters or ExcludePunctuation:

    ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

  • :exclude_uppercase (Boolean)

    Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.

  • :exclude_lowercase (Boolean)

    Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.

  • :include_space (Boolean)

    Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.

  • :require_each_included_type (Boolean)

    A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.

Returns:

See Also:

#get_resource_policy(options = {}) ⇒ Types::GetResourcePolicyResponse

Retrieves the JSON text of the resource-based policy document that's attached to the specified secret. The JSON request string input and response output are shown formatted with white space and line breaks for better readability. Submit your input as a single line JSON string.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:GetResourcePolicy

Related operations

Examples:

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

resp = client.get_resource_policy({
  secret_id: "MyTestDatabaseSecret", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
  resource_policy: "{\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}", 
}

Request syntax with placeholder values


resp = client.get_resource_policy({
  secret_id: "SecretIdType", # required
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.resource_policy #=> String

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

Returns:

See Also:

#get_secret_value(options = {}) ⇒ Types::GetSecretValueResponse

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

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:GetSecretValue

  • kms:Decrypt - required only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

Related operations

  • To create a new version of the secret with different encrypted information, use PutSecretValue.

  • To retrieve the non-encrypted details for the secret, use DescribeSecret.

Examples:

Example: To retrieve the encrypted secret value of a secret


# The following example shows how to retrieve the secret string value from the version of the secret that has the AWSPREVIOUS staging label attached. If you want to retrieve the AWSCURRENT version of the secret, then you can omit the VersionStage parameter because it defaults to AWSCURRENT.

resp = client.get_secret_value({
  secret_id: "MyTestDatabaseSecret", 
  version_stage: "AWSPREVIOUS", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  created_date: Time.parse(1523477145.713), 
  name: "MyTestDatabaseSecret", 
  secret_string: "{\n  \"username\":\"david\",\n  \"password\":\"BnQw&XDWgaEeT9XGTT29\"\n}\n", 
  version_id: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
  version_stages: [
    "AWSPREVIOUS", 
  ], 
}

Request syntax with placeholder values


resp = client.get_secret_value({
  secret_id: "SecretIdType", # required
  version_id: "SecretVersionIdType",
  version_stage: "SecretVersionStageType",
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version_id #=> String
resp.secret_binary #=> IO
resp.secret_string #=> String
resp.version_stages #=> Array
resp.version_stages[0] #=> String
resp.created_date #=> Time

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

  • :version_id (String)

    Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don\'t specify VersionStage. If you don\'t specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

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

  • :version_stage (String)

    Specifies the secret version that you want to retrieve by the staging label attached to the version.

    Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don\'t specify VersionId. If you don\'t specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Returns:

See Also:

#list_secret_version_ids(options = {}) ⇒ Types::ListSecretVersionIdsResponse

Lists all of the versions attached to the specified secret. The output does not include the SecretString or SecretBinary fields. By default, the list includes only versions that have at least one staging label in VersionStage attached.

Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:ListSecretVersionIds

Related operations

Examples:

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

resp = client.list_secret_version_ids({
  include_deprecated: true, 
  secret_id: "MyTestDatabaseSecret", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
  versions: [
    {
      created_date: Time.parse(1523477145.713), 
      version_id: "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", 
      version_stages: [
        "AWSPREVIOUS", 
      ], 
    }, 
    {
      created_date: Time.parse(1523486221.391), 
      version_id: "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", 
      version_stages: [
        "AWSCURRENT", 
      ], 
    }, 
    {
      created_date: Time.parse(1511974462.36), 
      version_id: "EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_secret_version_ids({
  secret_id: "SecretIdType", # required
  max_results: 1,
  next_token: "NextTokenType",
  include_deprecated: false,
})

Response structure


resp.versions #=> Array
resp.versions[0].version_id #=> String
resp.versions[0].version_stages #=> Array
resp.versions[0].version_stages[0] #=> String
resp.versions[0].last_accessed_date #=> Time
resp.versions[0].created_date #=> Time
resp.next_token #=> String
resp.arn #=> String
resp.name #=> String

Options Hash (options):

  • :secret_id (required, String)

    The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

  • :max_results (Integer) — default: Optional

    Limits the number of results that you want to include in the response. If you don\'t include this parameter, it defaults to a value that\'s specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn\'t null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • :next_token (String) — default: Optional

    Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there\'s more output available. In a subsequent call, set it to the value of the previous call\'s NextToken response to indicate where the output should continue from.

  • :include_deprecated (Boolean) — default: Optional

    Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.

Returns:

See Also:

#list_secrets(options = {}) ⇒ Types::ListSecretsResponse

Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString and SecretBinary are not included in the output. To get that information, call the GetSecretValue operation.

Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:ListSecrets

Related operations

Examples:

Example: To list the secrets in your account


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

resp = client.list_secrets({
})

# resp.to_h outputs the following:
{
  secret_list: [
    {
      arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
      description: "My test database secret", 
      last_changed_date: Time.parse(1523477145.729), 
      name: "MyTestDatabaseSecret", 
      secret_versions_to_stages: {
        "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", 
      last_changed_date: Time.parse(1523482025.685), 
      name: "MyTestDatabaseSecret1", 
      secret_versions_to_stages: {
        "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE" => [
          "AWSCURRENT", 
        ], 
      }, 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_secrets({
  max_results: 1,
  next_token: "NextTokenType",
})

Response structure


resp.secret_list #=> Array
resp.secret_list[0].arn #=> String
resp.secret_list[0].name #=> String
resp.secret_list[0].description #=> String
resp.secret_list[0].kms_key_id #=> String
resp.secret_list[0].rotation_enabled #=> true/false
resp.secret_list[0].rotation_lambda_arn #=> String
resp.secret_list[0].rotation_rules.automatically_after_days #=> Integer
resp.secret_list[0].last_rotated_date #=> Time
resp.secret_list[0].last_changed_date #=> Time
resp.secret_list[0].last_accessed_date #=> Time
resp.secret_list[0].deleted_date #=> Time
resp.secret_list[0].tags #=> Array
resp.secret_list[0].tags[0].key #=> String
resp.secret_list[0].tags[0].value #=> String
resp.secret_list[0].secret_versions_to_stages #=> Hash
resp.secret_list[0].secret_versions_to_stages["SecretVersionIdType"] #=> Array
resp.secret_list[0].secret_versions_to_stages["SecretVersionIdType"][0] #=> String
resp.secret_list[0].owning_service #=> String
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer) — default: Optional

    Limits the number of results that you want to include in the response. If you don\'t include this parameter, it defaults to a value that\'s specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn\'t null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • :next_token (String) — default: Optional

    Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there\'s more output available. In a subsequent call, set it to the value of the previous call\'s NextToken response to indicate where the output should continue from.

Returns:

See Also:

#put_resource_policy(options = {}) ⇒ Types::PutResourcePolicyResponse

Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for AWS Secrets Manager. For the complete description of the AWS policy syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:PutResourcePolicy

Related operations

  • To retrieve the resource policy that's attached to a secret, use GetResourcePolicy.

  • To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy.

  • To list all of the currently available secrets, use ListSecrets.

Examples:

Example: To add a resource-based policy to a secret


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

resp = client.put_resource_policy({
  resource_policy: "{\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}", 
  secret_id: "MyTestDatabaseSecret", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
}

Request syntax with placeholder values


resp = client.put_resource_policy({
  secret_id: "SecretIdType", # required
  resource_policy: "NonEmptyResourcePolicyType", # required
})

Response structure


resp.arn #=> String
resp.name #=> String

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret that you want to attach the resource-based policy to. You can specify either the ARN or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

  • :resource_policy (required, String)

    A JSON-formatted string that\'s constructed according to the grammar and syntax for an AWS resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

Returns:

See Also:

#put_secret_value(options = {}) ⇒ Types::PutSecretValueResponse

Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. You can also specify the staging labels that are initially attached to the new version.

The Secrets Manager console uses only the SecretString field. To add binary data to a secret with the SecretBinary field you must use the AWS CLI or one of the AWS SDKs.

  • If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

  • If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the VersionStages parameter.

  • If this operation moves the staging label AWSCURRENT from another version to this version (because you included it in the StagingLabels parameter) then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

  • This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists 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 cannot modify an existing version; you can only create new ones.

  • If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias 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 same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

  • If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:PutSecretValue

  • kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

Related operations

Examples:

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

resp = client.put_secret_value({
  client_request_token: "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", 
  secret_id: "MyTestDatabaseSecret", 
  secret_string: "{\"username\":\"david\",\"password\":\"BnQw!XDWgaEeT9XGTT29\"}", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
  version_id: "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", 
  version_stages: [
    "AWSCURRENT", 
  ], 
}

Request syntax with placeholder values


resp = client.put_secret_value({
  secret_id: "SecretIdType", # required
  client_request_token: "ClientRequestTokenType",
  secret_binary: "data",
  secret_string: "SecretStringType",
  version_stages: ["SecretVersionStageType"],
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version_id #=> String
resp.version_stages #=> Array
resp.version_stages[0] #=> String

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

  • :client_request_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. (Optional) Specifies a unique identifier for the new version of the secret.

    If you use the AWS CLI or one of the AWS 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. 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\'s 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 that version\'s SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

    This value becomes the VersionId of the new version.

  • :secret_binary (IO, String) — default: Optional

    Specifies binary data that you want 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 use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

    This parameter is not accessible if the secret using the Secrets Manager console.

  • :secret_string (String) — default: Optional

    Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

    If you create this 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 the default Lambda rotation function knows how to parse.

    For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

    For example:

    [`{"username":"bob"},{"password":"abc123xyz456"}`]

    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.

  • :version_stages (Array<String>) — default: Optional

    Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

    A staging label must be unique to a single version of the secret. If you specify a staging label that\'s already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

    If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

Returns:

See Also:

#restore_secret(options = {}) ⇒ Types::RestoreSecretResponse

Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. This makes the secret accessible to query once again.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:RestoreSecret

Related operations

Examples:

Example: To restore a previously deleted secret


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

resp = client.restore_secret({
  secret_id: "MyTestDatabaseSecret", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
}

Request syntax with placeholder values


resp = client.restore_secret({
  secret_id: "SecretIdType", # required
})

Response structure


resp.arn #=> String
resp.name #=> String

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

Returns:

See Also:

#rotate_secret(options = {}) ⇒ Types::RotateSecretResponse

Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret.

This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in AWS Secrets Manager in the AWS Secrets Manager User Guide.

Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.

The rotation function must end with the versions of the secret in one of two states:

  • The AWSPENDING and AWSCURRENT staging labels are attached to the same version of the secret, or

  • The AWSPENDING staging label is not attached to any version of the secret.

If instead the AWSPENDING staging label is present but is 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.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:RotateSecret

  • lambda:InvokeFunction (on the function specified in the secret's metadata)

Related operations

Examples:

Example: To configure rotation for a secret


# The following example configures rotation for a secret by providing the ARN of a Lambda rotation function (which must already exist) and the number of days between rotation. The first rotation happens immediately upon completion of this command. The rotation function runs asynchronously in the background.

resp = client.rotate_secret({
  rotation_lambda_arn: "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda", 
  rotation_rules: {
    automatically_after_days: 30, 
  }, 
  secret_id: "MyTestDatabaseSecret", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
  version_id: "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2", 
}

Request syntax with placeholder values


resp = client.rotate_secret({
  secret_id: "SecretIdType", # required
  client_request_token: "ClientRequestTokenType",
  rotation_lambda_arn: "RotationLambdaARNType",
  rotation_rules: {
    automatically_after_days: 1,
  },
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version_id #=> String

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

  • :client_request_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

    If you use the AWS CLI or one of the AWS 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 your own value if you are implementing your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

    Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function\'s processing. This value becomes the VersionId of the new version.

  • :rotation_lambda_arn (String) — default: Optional

    Specifies the ARN of the Lambda function that can rotate the secret.

  • :rotation_rules (Types::RotationRulesType)

    A structure that defines the rotation configuration for this secret.

Returns:

See Also:

#tag_resource(options = {}) ⇒ Struct

Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

The following basic 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 it is reserved for AWS 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 your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: 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.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:TagResource

Related operations

  • To remove one or more tags from the collection attached to a secret, use UntagResource.

  • To view the list of tags attached to a secret, use DescribeSecret.

Examples:

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

resp = client.tag_resource({
  secret_id: "MyExampleSecret", 
  tags: [
    {
      key: "FirstTag", 
      value: "SomeValue", 
    }, 
    {
      key: "SecondTag", 
      value: "AnotherValue", 
    }, 
  ], 
})

Request syntax with placeholder values


resp = client.tag_resource({
  secret_id: "SecretIdType", # required
  tags: [ # required
    {
      key: "TagKeyType",
      value: "TagValueType",
    },
  ],
})

Options Hash (options):

  • :secret_id (required, String)

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

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

  • :tags (required, Array<Types::Tag>)

    The tags to attach to the secret. Each element in the list consists of a Key and a Value.

    This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For the AWS CLI, you can also use the syntax: --Tags Key="Key1",Value="Value1",Key="Key2",Value="Value2"[,…]

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes one or more tags from the specified 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.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:UntagResource

Related operations

  • To add one or more tags to the collection attached to a secret, use TagResource.

  • To view the list of tags attached to a secret, use DescribeSecret.

Examples:

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

resp = client.untag_resource({
  secret_id: "MyTestDatabaseSecret", 
  tag_keys: [
    "FirstTag", 
    "SecondTag", 
  ], 
})

Request syntax with placeholder values


resp = client.untag_resource({
  secret_id: "SecretIdType", # required
  tag_keys: ["TagKeyType"], # required
})

Options Hash (options):

  • :secret_id (required, String)

    The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

  • :tag_keys (required, 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 to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_secret(options = {}) ⇒ Types::UpdateSecretResponse

Modifies many of the details of the specified secret. If you include a ClientRequestToken and either SecretString or SecretBinary then it also creates a new version attached to the secret.

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

The Secrets Manager console uses only the SecretString parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs.

  • If a version with a VersionId with the same value as the ClientRequestToken parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.

  • If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

  • If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias 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 same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

  • If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:UpdateSecret

  • kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

  • kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

Related operations

Examples:

Example: To update the description of a secret


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

resp = client.update_secret({
  client_request_token: "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", 
  description: "This is a new description for the secret.", 
  secret_id: "MyTestDatabaseSecret", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
}

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

resp = client.update_secret({
  kms_key_id: "arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", 
  secret_id: "MyTestDatabaseSecret", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
}

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

resp = client.update_secret({
  secret_id: "MyTestDatabaseSecret", 
  secret_string: "{JSON STRING WITH CREDENTIALS}", 
})

# resp.to_h outputs the following:
{
  arn: "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
  version_id: "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", 
}

Request syntax with placeholder values


resp = client.update_secret({
  secret_id: "SecretIdType", # required
  client_request_token: "ClientRequestTokenType",
  description: "DescriptionType",
  kms_key_id: "KmsKeyIdType",
  secret_binary: "data",
  secret_string: "SecretStringType",
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version_id #=> String

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

  • :client_request_token (String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. (Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.

    If you use the AWS CLI or one of the AWS 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. 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 typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

    Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function\'s processing.

    • 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 and 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 that version\'s SecretString and SecretBinary values are different from the request then an error occurs because you cannot modify an existing secret value.

    This value becomes the VersionId of the new version.

  • :description (String) — default: Optional

    Specifies an updated user-provided description of the secret.

  • :kms_key_id (String) — default: Optional

    Specifies an updated ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the protected text in new versions of this secret.

    You can only use the account\'s default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.

  • :secret_binary (IO, String) — default: Optional

    Specifies updated binary data that you want 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 use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

    This parameter is not accessible using the Secrets Manager console.

  • :secret_string (String) — default: Optional

    Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

    If you create this 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 the default Lambda rotation function knows how to parse.

    For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

    [`{"username":"bob"},{"password":"abc123xyz456"}`]

    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. You can also \'escape\' the double quote character in the embedded JSON text by prefacing each with a backslash. For example, the following string is surrounded by double-quotes. All of the embedded double quotes are escaped:

    "[`{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}`]"

Returns:

See Also:

#update_secret_version_stage(options = {}) ⇒ Types::UpdateSecretVersionStageResponse

Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the AWS Secrets Manager User Guide.

The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels--they don't replace it.

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

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.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:UpdateSecretVersionStage

Related operations

  • To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret and examine the SecretVersionsToStages response value.

Examples:

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

resp = client.update_secret_version_stage({
  move_to_version_id: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
  secret_id: "MyTestDatabaseSecret", 
  version_stage: "STAGINGLABEL1", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
}

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

resp = client.update_secret_version_stage({
  remove_from_version_id: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
  secret_id: "MyTestDatabaseSecret", 
  version_stage: "STAGINGLABEL1", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
}

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

resp = client.update_secret_version_stage({
  move_to_version_id: "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2", 
  remove_from_version_id: "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1", 
  secret_id: "MyTestDatabaseSecret", 
  version_stage: "AWSCURRENT", 
})

# resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", 
  name: "MyTestDatabaseSecret", 
}

Request syntax with placeholder values


resp = client.update_secret_version_stage({
  secret_id: "SecretIdType", # required
  version_stage: "SecretVersionStageType", # required
  remove_from_version_id: "SecretVersionIdType",
  move_to_version_id: "SecretVersionIdType",
})

Response structure


resp.arn #=> String
resp.name #=> String

Options Hash (options):

  • :secret_id (required, String)

    Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

  • :version_stage (required, String)

    The staging label to add to this version.

  • :remove_from_version_id (String)

    Specifies the secret version 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.

  • :move_to_version_id (String) — default: Optional

    The secret version ID that you want to add the staging label to. If you want 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.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.