Class: Aws::SecretsManager::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-secretsmanager/client.rb

Overview

An API client for SecretsManager. To construct a client, you need to configure a ‘:region` and `:credentials`.

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::SecretsManager::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SecretsManager::EndpointParameters`

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



441
442
443
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 441

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



3401
3402
3403
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 3401

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



3404
3405
3406
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 3404

def errors_module
  Errors
end

Instance Method Details

#batch_get_secret_value(params = {}) ⇒ Types::BatchGetSecretValueResponse

Retrieves the contents of the encrypted fields ‘SecretString` or `SecretBinary` for up to 20 secrets. To retrieve a single secret, call GetSecretValue.

To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as ‘AccessDeniedException` while attempting to retrieve any of the secrets, you can see the errors in `Errors` in the response.

Secrets Manager generates CloudTrail ‘GetSecretValue` log entries for each secret you request when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:BatchGetSecretValue`, and you must have `secretsmanager:GetSecretValue` for each secret. If you use filters, you must also have `secretsmanager:ListSecrets`. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed key `aws/secretsmanager`, then you also need `kms:Decrypt` permissions for the keys. For more information, see

IAM policy actions for Secrets Manager][2

and [Authentication and

access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Example: To retrieve the secret values for a group of secrets listed by name


# The following example gets the values for three secrets.

resp = client.batch_get_secret_value({
  secret_id_list: [
    "MySecret1", 
    "MySecret2", 
    "MySecret3", 
  ], 
})

resp.to_h outputs the following:
{
  errors: [
  ], 
  secret_values: [
    {
      arn: "&region-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret1-a1b2c3", 
      created_date: Time.parse(1700591229.801), 
      name: "MySecret1", 
      secret_string: "{\"username\":\"diego_ramirez\",\"password\":\"EXAMPLE-PASSWORD\",\"engine\":\"mysql\",\"host\":\"secretsmanagertutorial.cluster.us-west-2.rds.amazonaws.com\",\"port\":3306,\"dbClusterIdentifier\":\"secretsmanagertutorial\"}", 
      version_id: "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", 
      version_stages: [
        "AWSCURRENT", 
      ], 
    }, 
    {
      arn: "&region-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret2-a1b2c3", 
      created_date: Time.parse(1699911394.105), 
      name: "MySecret2", 
      secret_string: "{\"username\":\"akua_mansa\",\"password\":\"EXAMPLE-PASSWORD\"", 
      version_id: "a1b2c3d4-5678-90ab-cdef-EXAMPLEbbbbb", 
      version_stages: [
        "AWSCURRENT", 
      ], 
    }, 
    {
      arn: "&region-arn;&asm-service-name;:us-west-2:&ExampleAccountId;:secret:MySecret3-a1b2c3", 
      created_date: Time.parse(1699911394.105), 
      name: "MySecret3", 
      secret_string: "{\"username\":\"jie_liu\",\"password\":\"EXAMPLE-PASSWORD\"", 
      version_id: "a1b2c3d4-5678-90ab-cdef-EXAMPLEccccc", 
      version_stages: [
        "AWSCURRENT", 
      ], 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.batch_get_secret_value({
  secret_id_list: ["SecretIdType"],
  filters: [
    {
      key: "description", # accepts description, name, tag-key, tag-value, primary-region, owning-service, all
      values: ["FilterValueStringType"],
    },
  ],
  max_results: 1,
  next_token: "NextTokenType",
})

Response structure


resp.secret_values #=> Array
resp.secret_values[0].arn #=> String
resp.secret_values[0].name #=> String
resp.secret_values[0].version_id #=> String
resp.secret_values[0].secret_binary #=> String
resp.secret_values[0].secret_string #=> String
resp.secret_values[0].version_stages #=> Array
resp.secret_values[0].version_stages[0] #=> String
resp.secret_values[0].created_date #=> Time
resp.next_token #=> String
resp.errors #=> Array
resp.errors[0].secret_id #=> String
resp.errors[0].error_code #=> String
resp.errors[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id_list (Array<String>) —

    The ARN or names of the secrets to retrieve. You must include ‘Filters` or `SecretIdList`, but not both.

  • :filters (Array<Types::Filter>) —

    The filters to choose which secrets to retrieve. You must include ‘Filters` or `SecretIdList`, but not both.

  • :max_results (Integer) —

    The number of results to include in the response.

    If there are more results available, in the response, Secrets Manager includes ‘NextToken`. To get the next results, call `BatchGetSecretValue` again with the value from `NextToken`. To use this parameter, you must also use the `Filters` parameter.

  • :next_token (String) —

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

Returns:

See Also:



593
594
595
596
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 593

def batch_get_secret_value(params = {}, options = {})
  req = build_request(:batch_get_secret_value, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 3374

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::SecretsManager')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-secretsmanager'
  context[:gem_version] = '1.103.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

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

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

To turn on automatic rotation again, call RotateSecret.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:CancelRotateSecret`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



678
679
680
681
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 678

def cancel_rotate_secret(params = {}, options = {})
  req = build_request(:cancel_rotate_secret, params)
  req.send_request(options)
end

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

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

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

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

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

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

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

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except ‘SecretBinary` or `SecretString` because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:CreateSecret`. If you include tags in the secret, you also need `secretsmanager:TagResource`. To add replica Regions, you must also have `secretsmanager:ReplicateSecretToRegions`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

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

When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to [Mitigate the risks of using command-line tools to store Secrets Manager secrets].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_secret_json_structure.html [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [5]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [6]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html [7]: docs.aws.amazon.com/secretsmanager/latest/userguide/security_cli-exposure-risks.html

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\":\"EXAMPLE-PASSWORD\"}", 
})

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",
    },
  ],
  add_replica_regions: [
    {
      region: "RegionType",
      kms_key_id: "KmsKeyIdType",
    },
  ],
  force_overwrite_replica_secret: false,
})

Response structure


resp.arn #=> String
resp.name #=> String
resp.version_id #=> String
resp.replication_status #=> Array
resp.replication_status[0].region #=> String
resp.replication_status[0].kms_key_id #=> String
resp.replication_status[0].status #=> String, one of "InSync", "Failed", "InProgress"
resp.replication_status[0].status_message #=> String
resp.replication_status[0].last_accessed_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the new secret.

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

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

  • :client_request_token (String) —

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

    <note markdown=“1”> If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

    </note>

    If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ‘ClientRequestToken` and include it in the request.

    This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a [UUID-type] value to ensure uniqueness of your versions within the specified secret.

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

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

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

    This value becomes the ‘VersionId` of the new version.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: wikipedia.org/wiki/Universally_unique_identifier

  • :description (String) —

    The description of the secret.

  • :kms_key_id (String) —

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

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

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

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

    [1]: docs.aws.amazon.com/kms/latest/developerguide/alias-about.html

  • :secret_binary (String, StringIO, File) —

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

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

    This parameter is not available in the Secrets Manager console.

    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

  • :secret_string (String) —

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

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

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

    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

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

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

    ‘[“Key”:“CostCenter”,“Value”:“12345”,“Key”:“environment”,“Value”:“production”]`

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

    If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ‘Access Denied` error. For more information, see

    Control access to secrets using tags][1

    and [Limit access to

    identities with tags that match secrets’ tags].

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

    For tag quotas and naming restrictions, see [Service quotas for Tagging] in the *Amazon Web Services General Reference guide*.

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2 [3]: docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json [4]: docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas

  • :add_replica_regions (Array<Types::ReplicaRegionType>) —

    A list of Regions and KMS keys to replicate secrets.

  • :force_overwrite_replica_secret (Boolean) —

    Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren’t overwritten.

Returns:

See Also:



978
979
980
981
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 978

def create_secret(params = {}, options = {})
  req = build_request(:create_secret, params)
  req.send_request(options)
end

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

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:DeleteResourcePolicy`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

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:MyTestDatabaseSecret-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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1047
1048
1049
1050
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 1047

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

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

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

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

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

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

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

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

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:DeleteSecret`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring_cloudwatch_deleted-secrets.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

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

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

    The ARN or name of the secret to delete.

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

  • :recovery_window_in_days (Integer) —

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

  • :force_delete_without_recovery (Boolean) —

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

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

    If you forcibly delete an already deleted or nonexistent secret, the operation does not return ‘ResourceNotFoundException`.

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

Returns:

See Also:



1183
1184
1185
1186
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 1183

def delete_secret(params = {}, options = {})
  req = build_request(:delete_secret, params)
  req.send_request(options)
end

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

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:DescribeSecret`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

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", 
  next_rotation_date: Time.parse("1665165599"), 
  rotation_enabled: true, 
  rotation_lambda_arn: "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda", 
  rotation_rules: {
    automatically_after_days: 14, 
    duration: "2h", 
    schedule_expression: "cron(0 16 1,15 * ? *)", 
  }, 
  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 #=> Boolean
resp.rotation_lambda_arn #=> String
resp.rotation_rules.automatically_after_days #=> Integer
resp.rotation_rules.duration #=> String
resp.rotation_rules.schedule_expression #=> String
resp.last_rotated_date #=> Time
resp.last_changed_date #=> Time
resp.last_accessed_date #=> Time
resp.deleted_date #=> Time
resp.next_rotation_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
resp.created_date #=> Time
resp.primary_region #=> String
resp.replication_status #=> Array
resp.replication_status[0].region #=> String
resp.replication_status[0].kms_key_id #=> String
resp.replication_status[0].status #=> String, one of "InSync", "Failed", "InProgress"
resp.replication_status[0].status_message #=> String
resp.replication_status[0].last_accessed_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1326
1327
1328
1329
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 1326

def describe_secret(params = {}, options = {})
  req = build_request(:describe_secret, params)
  req.send_request(options)
end

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

Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: “ !“#$%&‘()*+,-./:;<=>?@[\]^_`{|}~ “

Secrets Manager generates a CloudTrail log entry when you call this action.

Required permissions: ‘secretsmanager:GetRandomPassword`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

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: "EXAMPLE-PASSWORD", 
}

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

Parameters:

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

    ({})

Options Hash (params):

  • :password_length (Integer) —

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

  • :exclude_characters (String) —

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

  • :exclude_numbers (Boolean) —

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

  • :exclude_punctuation (Boolean) —

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

  • :exclude_uppercase (Boolean) —

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

  • :exclude_lowercase (Boolean) —

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

  • :include_space (Boolean) —

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

  • :require_each_included_type (Boolean) —

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

Returns:

See Also:



1427
1428
1429
1430
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 1427

def get_random_password(params = {}, options = {})
  req = build_request(:get_random_password, params)
  req.send_request(options)
end

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

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:GetResourcePolicy`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-policies.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1502
1503
1504
1505
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 1502

def get_resource_policy(params = {}, options = {})
  req = build_request(:get_resource_policy, params)
  req.send_request(options)
end

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

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

To retrieve the values for a group of secrets, call BatchGetSecretValue.

We recommend that you cache your secret values by using client-side caching. Caching secrets improves speed and reduces your costs. For more information, see [Cache secrets for your applications].

To retrieve the previous version of a secret, use ‘VersionStage` and specify AWSPREVIOUS. To revert to the previous version of a secret, call [UpdateSecretVersionStage].

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:GetSecretValue`. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key `aws/secretsmanager`, then you also need `kms:Decrypt` permissions for that key. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html [2]: docs.aws.amazon.com/cli/latest/reference/secretsmanager/update-secret-version-stage.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [5]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

Examples:

Example: To retrieve the encrypted secret value of a secret


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

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

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\":\"EXAMPLE-PASSWORD\"\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 #=> String
resp.secret_string #=> String
resp.version_stages #=> Array
resp.version_stages[0] #=> String
resp.created_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

    The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

  • :version_id (String) —

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

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

    [1]: wikipedia.org/wiki/Universally_unique_identifier

  • :version_stage (String) —

    The staging label of the version of the secret to retrieve.

    Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and ‘VersionId`, the two parameters must refer to the same secret version. If you don’t specify either a ‘VersionStage` or `VersionId`, Secrets Manager returns the `AWSCURRENT` version.

Returns:

See Also:



1630
1631
1632
1633
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 1630

def get_secret_value(params = {}, options = {})
  req = build_request(:get_secret_value, params)
  req.send_request(options)
end

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

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

To list the secrets in the account, use ListSecrets.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:ListSecretVersionIds`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.versions[0].kms_key_ids #=> Array
resp.versions[0].kms_key_ids[0] #=> String
resp.next_token #=> String
resp.arn #=> String
resp.name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

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

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

  • :max_results (Integer) —

    The number of results to include in the response.

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

  • :next_token (String) —

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

  • :include_deprecated (Boolean) —

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

Returns:

See Also:



1758
1759
1760
1761
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 1758

def list_secret_version_ids(params = {}, options = {})
  req = build_request(:list_secret_version_ids, params)
  req.send_request(options)
end

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

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

All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.

To list the versions of a secret, use ListSecretVersionIds.

To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:ListSecrets`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/manage_search-secret.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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({
  include_planned_deletion: false,
  max_results: 1,
  next_token: "NextTokenType",
  filters: [
    {
      key: "description", # accepts description, name, tag-key, tag-value, primary-region, owning-service, all
      values: ["FilterValueStringType"],
    },
  ],
  sort_order: "asc", # accepts asc, desc
})

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 #=> Boolean
resp.secret_list[0].rotation_lambda_arn #=> String
resp.secret_list[0].rotation_rules.automatically_after_days #=> Integer
resp.secret_list[0].rotation_rules.duration #=> String
resp.secret_list[0].rotation_rules.schedule_expression #=> String
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].next_rotation_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.secret_list[0].created_date #=> Time
resp.secret_list[0].primary_region #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :include_planned_deletion (Boolean) —

    Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren’t included.

  • :max_results (Integer) —

    The number of results to include in the response.

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

  • :next_token (String) —

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

  • :filters (Array<Types::Filter>) —

    The filters to apply to the list of secrets.

  • :sort_order (String) —

    Secrets are listed by ‘CreatedDate`.

Returns:

See Also:



1907
1908
1909
1910
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 1907

def list_secrets(params = {}, options = {})
  req = build_request(:list_secrets, params)
  req.send_request(options)
end

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

Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see

Authentication and access control for Secrets Manager][1

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:PutResourcePolicy`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions

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
  block_public_policy: false,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

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

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

  • :resource_policy (required, String) —

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html

  • :block_public_policy (Boolean) —

    Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal. By default, public policies aren’t blocked.

    Resource policy validation and the BlockPublicPolicy parameter help protect your resources by preventing public access from being granted through the resource policies that are directly attached to your secrets. In addition to using these features, carefully inspect the following policies to confirm that they do not grant public access:

    * Identity-based policies attached to associated Amazon Web Services
 principals (for example, IAM roles)

    • Resource-based policies attached to associated Amazon Web Services resources (for example, Key Management Service (KMS) keys)

    To review permissions to your secrets, see [Determine who has

    permissions to your secrets].

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html

Returns:

See Also:



2015
2016
2017
2018
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 2015

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

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

Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new ‘SecretString` value or a new `SecretBinary` value.

We recommend you avoid calling ‘PutSecretValue` at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call `PutSecretValue` more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.

You can specify the staging labels to attach to the new version in ‘VersionStages`. If you don’t include ‘VersionStages`, then Secrets Manager automatically moves the staging label `AWSCURRENT` to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label `AWSCURRENT` to it. If this operation moves the staging label `AWSCURRENT` from another version to this version, then Secrets Manager also automatically moves the staging label `AWSPREVIOUS` to the version that `AWSCURRENT` was removed from.

This operation is idempotent. If you call this operation with a ‘ClientRequestToken` that matches an existing version’s VersionId, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can’t modify an existing version; you can only create new ones.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except ‘SecretBinary`, `SecretString`, or `RotationToken` because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:PutSecretValue`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to [Mitigate the risks of using command-line tools to store Secrets Manager secrets].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/security_cli-exposure-risks.html

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\":\"EXAMPLE-PASSWORD\"}", 
})

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"],
  rotation_token: "RotationTokenType",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

    The ARN or name of the secret to add a new version to.

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

    If the secret doesn’t already exist, use ‘CreateSecret` instead.

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

  • :client_request_token (String) —

    A unique identifier for the new version of the secret.

    <note markdown=“1”> If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

    </note>

    If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ‘ClientRequestToken` and include it 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` or `SecretBinary` values are the same as those in the request then the request is ignored. The operation is idempotent.

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

    This value becomes the ‘VersionId` of the new version.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: wikipedia.org/wiki/Universally_unique_identifier

  • :secret_binary (String, StringIO, File) —

    The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.

    You must include ‘SecretBinary` or `SecretString`, but not both.

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

    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

  • :secret_string (String) —

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

    You must include ‘SecretBinary` or `SecretString`, but not both.

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

    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

  • :version_stages (Array<String>) —

    A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.

    If you specify a staging label that’s already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify ‘AWSCURRENT`, and it is already attached to another version, then Secrets Manager also moves the staging label `AWSPREVIOUS` to the version that `AWSCURRENT` was removed from.

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

  • :rotation_token (String) —

    A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see [How rotation works].

    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html

Returns:

See Also:



2239
2240
2241
2242
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 2239

def put_secret_value(params = {}, options = {})
  req = build_request(:put_secret_value, params)
  req.send_request(options)
end

#remove_regions_from_replication(params = {}) ⇒ Types::RemoveRegionsFromReplicationResponse

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:RemoveRegionsFromReplication`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

Examples:

Request syntax with placeholder values


resp = client.remove_regions_from_replication({
  secret_id: "SecretIdType", # required
  remove_replica_regions: ["RegionType"], # required
})

Response structure


resp.arn #=> String
resp.replication_status #=> Array
resp.replication_status[0].region #=> String
resp.replication_status[0].kms_key_id #=> String
resp.replication_status[0].status #=> String, one of "InSync", "Failed", "InProgress"
resp.replication_status[0].status_message #=> String
resp.replication_status[0].last_accessed_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

    The ARN or name of the secret.

  • :remove_replica_regions (required, Array<String>) —

    The Regions of the replicas to remove.

Returns:

See Also:



2295
2296
2297
2298
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 2295

def remove_regions_from_replication(params = {}, options = {})
  req = build_request(:remove_regions_from_replication, params)
  req.send_request(options)
end

#replicate_secret_to_regions(params = {}) ⇒ Types::ReplicateSecretToRegionsResponse

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:ReplicateSecretToRegions`. If the primary secret is encrypted with a KMS key other than `aws/secretsmanager`, you also need `kms:Decrypt` permission to the key. To encrypt the replicated secret with a KMS key other than `aws/secretsmanager`, you need `kms:GenerateDataKey` and `kms:Encrypt` to the key. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/create-manage-multi-region-secrets.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

Examples:

Example: Example


# The following example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key
# aws/secretsmanager.

resp = client.replicate_secret_to_regions({
  add_replica_regions: [
    {
      region: "eu-west-3", 
    }, 
  ], 
  force_overwrite_replica_secret: true, 
  secret_id: "MyTestSecret", 
})

resp.to_h outputs the following:
{
  arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c", 
  replication_status: [
    {
      kms_key_id: "alias/aws/secretsmanager", 
      region: "eu-west-3", 
      status: "InProgress", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.replicate_secret_to_regions({
  secret_id: "SecretIdType", # required
  add_replica_regions: [ # required
    {
      region: "RegionType",
      kms_key_id: "KmsKeyIdType",
    },
  ],
  force_overwrite_replica_secret: false,
})

Response structure


resp.arn #=> String
resp.replication_status #=> Array
resp.replication_status[0].region #=> String
resp.replication_status[0].kms_key_id #=> String
resp.replication_status[0].status #=> String, one of "InSync", "Failed", "InProgress"
resp.replication_status[0].status_message #=> String
resp.replication_status[0].last_accessed_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

    The ARN or name of the secret to replicate.

  • :add_replica_regions (required, Array<Types::ReplicaRegionType>) —

    A list of Regions in which to replicate the secret.

  • :force_overwrite_replica_secret (Boolean) —

    Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren’t overwritten.

Returns:

See Also:



2393
2394
2395
2396
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 2393

def replicate_secret_to_regions(params = {}, options = {})
  req = build_request(:replicate_secret_to_regions, params)
  req.send_request(options)
end

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

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:RestoreSecret`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



2462
2463
2464
2465
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 2462

def restore_secret(params = {}, options = {})
  req = build_request(:restore_secret, params)
  req.send_request(options)
end

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

Configures and starts the asynchronous process of rotating the secret. For information about rotation, see [Rotate secrets] in the *Secrets Manager User Guide*. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don’t include the configuration parameters, the operation starts a rotation with the values already stored in the secret.

When rotation is successful, the ‘AWSPENDING` staging label might be attached to the same version as the `AWSCURRENT` version, or it might not be attached to any version. If the `AWSPENDING` staging label is present but not attached to the same version as `AWSCURRENT`, then any later invocation of `RotateSecret` assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the `AWSPENDING` staging label might be attached to an empty secret version. For more information, see [Troubleshoot rotation] in the *Secrets Manager User Guide*.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:RotateSecret`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager]. You also need `lambda:InvokeFunction` permissions on the rotation function. For more information, see [ Permissions for rotation].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot_rotation.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [5]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html [6]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets-required-permissions-function.html

Examples:

Example: To configure rotation for a secret


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

resp = client.rotate_secret({
  rotation_lambda_arn: "arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda", 
  rotation_rules: {
    duration: "2h", 
    schedule_expression: "cron(0 16 1,15 * ? *)", 
  }, 
  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", 
}

Example: To request an immediate rotation for a secret


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

resp = client.rotate_secret({
  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,
    duration: "DurationType",
    schedule_expression: "ScheduleExpressionType",
  },
  rotate_immediately: false,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

    The ARN or name of the secret to rotate.

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

  • :client_request_token (String) —

    A unique identifier for the new version of the secret. You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn’t attempt to create a secret version twice.

    <note markdown=“1”> If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

    </note>

    If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ‘ClientRequestToken` and include it 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.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: wikipedia.org/wiki/Universally_unique_identifier

  • :rotation_lambda_arn (String) —

    For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function.

    For secrets that use *managed rotation*, omit this field. For more information, see [Managed rotation] in the *Secrets Manager User Guide*.

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html

  • :rotation_rules (Types::RotationRulesType) —

    A structure that defines the rotation configuration for this secret.

  • :rotate_immediately (Boolean) —

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

    For secrets that use a Lambda rotation function to rotate, if you don’t immediately rotate the secret, Secrets Manager tests the rotation configuration by running the [ ‘testSecret` step] of the Lambda rotation function. The test creates an `AWSPENDING` version of the secret and then removes it.

    By default, Secrets Manager rotates the secret immediately.

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_lambda-functions.html#rotate-secrets_lambda-functions-code

Returns:

See Also:



2646
2647
2648
2649
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 2646

def rotate_secret(params = {}, options = {})
  req = build_request(:rotate_secret, params)
  req.send_request(options)
end

#stop_replication_to_replica(params = {}) ⇒ Types::StopReplicationToReplicaResponse

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

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:StopReplicationToReplica`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

    The ARN of the primary secret.

Returns:

See Also:



2694
2695
2696
2697
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 2694

def stop_replication_to_replica(params = {}, options = {})
  req = build_request(:stop_replication_to_replica, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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

For tag quotas and naming restrictions, see [Service quotas for Tagging] in the *Amazon Web Services General Reference guide*.

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:TagResource`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

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",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

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

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

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

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

    For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see

    Specifying parameter values for the Amazon Web Services CLI][1

    in

    the Amazon Web Services CLI User Guide.

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2791
2792
2793
2794
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 2791

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes specific tags from a secret.

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

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:UntagResource`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

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
})

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

    The ARN or name of the secret.

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

  • :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 requires a JSON text string argument.

    For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see

    Specifying parameter values for the Amazon Web Services CLI][1

    in

    the Amazon Web Services CLI User Guide.

    [1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2873
2874
2875
2876
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 2873

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

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

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

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

To change a secret so that it is managed by another service, you need to recreate the secret in that service. See [Secrets Manager secrets managed by other Amazon Web Services services].

We recommend you avoid calling ‘UpdateSecret` at a sustained rate of more than once every 10 minutes. When you call `UpdateSecret` to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.

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

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except ‘SecretBinary` or `SecretString` because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:UpdateSecret`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager]. If you use a customer managed key, you must also have `kms:GenerateDataKey`, `kms:Encrypt`, and `kms:Decrypt` permissions on the key. If you change the KMS key and you don’t have ‘kms:Encrypt` permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information, see [ Secret encryption and decryption].

When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to [Mitigate the risks of using command-line tools to store Secrets Manager secrets].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html [5]: docs.aws.amazon.com/secretsmanager/latest/userguide/security-encryption.html [6]: docs.aws.amazon.com/secretsmanager/latest/userguide/security_cli-exposure-risks.html

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

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

    The ARN or name of the secret.

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

  • :client_request_token (String) —

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

    <note markdown=“1”> If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

    </note>

    If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ‘ClientRequestToken` and include it 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.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

    [1]: wikipedia.org/wiki/Universally_unique_identifier

  • :description (String) —

    The description of the secret.

  • :kms_key_id (String) —

    The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions with the staging labels ‘AWSCURRENT`, `AWSPENDING`, or `AWSPREVIOUS`. If you don’t have ‘kms:Encrypt` permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information about versions and staging labels, see [Concepts: Version].

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

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

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version [2]: docs.aws.amazon.com/kms/latest/developerguide/alias-about.html

  • :secret_binary (String, StringIO, File) —

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

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

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

    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

  • :secret_string (String) —

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

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

    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.

Returns:

See Also:



3120
3121
3122
3123
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 3120

def update_secret(params = {}, options = {})
  req = build_request(:update_secret, params)
  req.send_request(options)
end

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

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

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

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

<note markdown=“1”> Whenever you move ‘AWSCURRENT`, Secrets Manager automatically moves the label `AWSPREVIOUS` to the version that `AWSCURRENT` was removed from.

</note>

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

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:UpdateSecretVersionStage`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

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

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (required, String) —

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

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen

  • :version_stage (required, String) —

    The staging label to add to this version.

  • :remove_from_version_id (String) —

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

  • :move_to_version_id (String) —

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

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

Returns:

See Also:



3275
3276
3277
3278
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 3275

def update_secret_version_stage(params = {}, options = {})
  req = build_request(:update_secret_version_stage, params)
  req.send_request(options)
end

#validate_resource_policy(params = {}) ⇒ Types::ValidateResourcePolicyResponse

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

The API performs three checks when validating the policy:

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

  • Checks for correct syntax in a policy.

  • Verifies the policy does not lock out a caller.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see [Logging Secrets Manager events with CloudTrail].

Required permissions: ‘secretsmanager:ValidateResourcePolicy` and `secretsmanager:PutResourcePolicy`. For more information, see [ IAM policy actions for Secrets Manager] and [Authentication and access control in Secrets Manager].

[1]: aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/ [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html [3]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions [4]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html

Examples:

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


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

resp = client.validate_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:
{
  policy_validation_passed: true, 
  validation_errors: [
  ], 
}

Request syntax with placeholder values


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

Response structure


resp.policy_validation_passed #=> Boolean
resp.validation_errors #=> Array
resp.validation_errors[0].check_name #=> String
resp.validation_errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :secret_id (String) —

    The ARN or name of the secret with the resource-based policy you want to validate.

  • :resource_policy (required, String) —

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

    [1]: docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html

Returns:

See Also:



3365
3366
3367
3368
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 3365

def validate_resource_policy(params = {}, options = {})
  req = build_request(:validate_resource_policy, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


3394
3395
3396
 
# File 'lib/aws-sdk-secretsmanager/client.rb', line 3394

def waiter_names
  []
end