Class: Aws::SecretsManager::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SecretsManager::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-secretsmanager/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#cancel_rotate_secret(params = {}) ⇒ Types::CancelRotateSecretResponse
Disables automatic scheduled rotation and cancels the rotation of a secret if currently in progress.
-
#create_secret(params = {}) ⇒ Types::CreateSecretResponse
Creates a new secret.
-
#delete_resource_policy(params = {}) ⇒ Types::DeleteResourcePolicyResponse
Deletes the resource-based permission policy attached to the secret.
-
#delete_secret(params = {}) ⇒ Types::DeleteSecretResponse
Deletes an entire secret and all of its versions.
-
#describe_secret(params = {}) ⇒ Types::DescribeSecretResponse
Retrieves the details of a secret.
-
#get_random_password(params = {}) ⇒ Types::GetRandomPasswordResponse
Generates a random password of the specified complexity.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves the JSON text of the resource-based policy document attached to the specified secret.
-
#get_secret_value(params = {}) ⇒ Types::GetSecretValueResponse
Retrieves the contents of the encrypted fields
SecretString
orSecretBinary
from the specified version of a secret, whichever contains content. -
#list_secret_version_ids(params = {}) ⇒ Types::ListSecretVersionIdsResponse
Lists all of the versions attached to the specified secret.
-
#list_secrets(params = {}) ⇒ Types::ListSecretsResponse
Lists all of the secrets that are stored by Secrets Manager in the AWS account.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Attaches the contents of the specified resource-based permission policy to a secret.
-
#put_secret_value(params = {}) ⇒ Types::PutSecretValueResponse
Stores a new encrypted secret value in the specified secret.
-
#restore_secret(params = {}) ⇒ Types::RestoreSecretResponse
Cancels the scheduled deletion of a secret by removing the
DeletedDate
time stamp. -
#rotate_secret(params = {}) ⇒ Types::RotateSecretResponse
Configures and starts the asynchronous process of rotating this secret.
-
#tag_resource(params = {}) ⇒ Struct
Attaches one or more tags, each consisting of a key name and a value, to the specified secret.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified secret.
-
#update_secret(params = {}) ⇒ Types::UpdateSecretResponse
Modifies many of the details of the specified secret.
-
#update_secret_version_stage(params = {}) ⇒ Types::UpdateSecretVersionStageResponse
Modifies the staging labels attached to a version of a secret.
-
#validate_resource_policy(params = {}) ⇒ Types::ValidateResourcePolicyResponse
Validates the JSON text of the resource-based policy document attached to the specified secret.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#cancel_rotate_secret(params = {}) ⇒ Types::CancelRotateSecretResponse
Disables automatic scheduled rotation and cancels the rotation of a secret if currently in progress.
To re-enable scheduled rotation, call RotateSecret with
AutomaticallyRotateAfterDays
set to a value greater than 0. This
immediately rotates your secret and then enables the automatic
schedule.
VersionStage
labels in an unexpected state. Depending on the step of
the rotation in progress, you might need to remove the staging label
AWSPENDING
from the partially created version, specified by the
VersionId
response value. You should also evaluate the partially
rotated new version to see if it should be deleted, which you can do
by removing all staging labels from the new version VersionStage
field.
To successfully start a rotation, the staging label AWSPENDING
must
be in one of the following states:
Not attached to any version at all
Attached to the same version as the staging label
AWSCURRENT
If the staging label AWSPENDING
attached to a different version than
the version with AWSCURRENT
then the attempt to rotate fails.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:CancelRotateSecret
^
Related operations
To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.
To get the rotation configuration details for a secret, use DescribeSecret.
To list all of the currently available secrets, use ListSecrets.
To list all of the versions currently associated with a secret, use ListSecretVersionIds.
455 456 457 458 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 455 def cancel_rotate_secret(params = {}, = {}) req = build_request(:cancel_rotate_secret, params) req.send_request() end |
#create_secret(params = {}) ⇒ Types::CreateSecretResponse
Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
Secrets Manager stores the encrypted secret data in one of a
collection of "versions" associated with the secret. Each version
contains a copy of the encrypted secret data. Each version is
associated with one or more "staging labels" that identify where the
version is in the rotation cycle. The SecretVersionsToStages
field
of the secret contains the mapping of staging labels to the active
versions of the secret. Versions without a staging label are
considered deprecated and not included in the list.
You provide the secret data to be encrypted by putting text in either
the SecretString
parameter or binary data in the SecretBinary
parameter, but not both. If you include SecretString
or
SecretBinary
then Secrets Manager also creates an initial secret
version and automatically attaches the staging label AWSCURRENT
to
the new version.
SecretString
or
SecretBinary
for a secret in the same account as the calling user
and that secret doesn't specify a AWS KMS encryption key, Secrets
Manager uses the account's default AWS managed customer master key
(CMK) with the alias aws/secretsmanager
. If this key doesn't
already exist in your account then Secrets Manager creates it for
you automatically. All users and roles in the same AWS account
automatically have access to use the default CMK. Note that if an
Secrets Manager API call results in AWS creating the account's
AWS-managed CMK, it can result in a one-time significant delay in
returning the result.
- If the secret resides in a different AWS account from the
credentials calling an API that requires encryption or decryption of
the secret value then you must create and use a custom AWS KMS CMK
because you can't access the default CMK for the account using
credentials from a different AWS account. Store the ARN of the CMK
in the secret when you create the secret or when you update it by
including it in the
KMSKeyId
. If you call an API that must encrypt or decryptSecretString
orSecretBinary
using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:CreateSecret
kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account default AWS managed CMK for Secrets Manager.
kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account default AWS managed CMK for Secrets Manager.
secretsmanager:TagResource - needed only if you include the
Tags
parameter.
Related operations
To delete a secret, use DeleteSecret.
To modify an existing secret, use UpdateSecret.
To create a new version of a secret, use PutSecretValue.
To retrieve the encrypted secure string and secure binary values, use GetSecretValue.
To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values.
To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the
SecretVersionsToStages
response value.
770 771 772 773 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 770 def create_secret(params = {}, = {}) req = build_request(:create_secret, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Types::DeleteResourcePolicyResponse
Deletes the resource-based permission policy attached to the secret.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:DeleteResourcePolicy
^
Related operations
To attach a resource policy to a secret, use PutResourcePolicy.
To retrieve the current resource-based policy that's attached to a secret, use GetResourcePolicy.
To list all of the currently available secrets, use ListSecrets.
855 856 857 858 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 855 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#delete_secret(params = {}) ⇒ Types::DeleteSecretResponse
Deletes an entire secret and all of its versions. You can optionally
include a recovery window during which you can restore the secret. If
you don't specify a recovery window value, the operation defaults to
30 days. Secrets Manager attaches a DeletionDate
stamp to the secret
that specifies the end of the recovery window. At the end of the
recovery window, Secrets Manager deletes the secret permanently.
At any time before recovery window ends, you can use RestoreSecret to
remove the DeletionDate
and cancel the deletion of the secret.
You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.
VersionStage
field of
a version. That marks the version as deprecated and allows Secrets
Manager to delete it as needed. Versions that do not have any
staging labels do not show up in ListSecretVersionIds unless you
specify IncludeDeprecated
.
- The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:DeleteSecret
^
Related operations
To create a secret, use CreateSecret.
To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret.
997 998 999 1000 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 997 def delete_secret(params = {}, = {}) req = build_request(:delete_secret, params) req.send_request() end |
#describe_secret(params = {}) ⇒ Types::DescribeSecretResponse
Retrieves the details of a secret. It does not include the encrypted fields. Secrets Manager only returns fields populated with a value in the response.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:DescribeSecret
^
Related operations
To create a secret, use CreateSecret.
To modify a secret, use UpdateSecret.
To retrieve the encrypted secret information in a version of the secret, use GetSecretValue.
To list all of the secrets in the AWS account, use ListSecrets.
1144 1145 1146 1147 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 1144 def describe_secret(params = {}, = {}) req = build_request(:describe_secret, params) req.send_request() end |
#get_random_password(params = {}) ⇒ Types::GetRandomPasswordResponse
Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:GetRandomPassword
^
1252 1253 1254 1255 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 1252 def get_random_password(params = {}, = {}) req = build_request(:get_random_password, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Retrieves the JSON text of the resource-based policy document attached to the specified secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:GetResourcePolicy
^
Related operations
To attach a resource policy to a secret, use PutResourcePolicy.
To delete the resource-based policy attached to a secret, use DeleteResourcePolicy.
To list all of the currently available secrets, use ListSecrets.
1343 1344 1345 1346 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 1343 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, params) req.send_request() 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.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:GetSecretValue
kms:Decrypt - required only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.
Related operations
To create a new version of the secret with different encrypted information, use PutSecretValue.
To retrieve the non-encrypted details for the secret, use DescribeSecret.
1477 1478 1479 1480 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 1477 def get_secret_value(params = {}, = {}) req = build_request(:get_secret_value, params) req.send_request() end |
#list_secret_version_ids(params = {}) ⇒ Types::ListSecretVersionIdsResponse
Lists all of the versions attached to the specified secret. The output
does not include the SecretString
or SecretBinary
fields. By
default, the list includes only versions that have at least one
staging label in VersionStage
attached.
NextToken
response parameter when calling any of
the List*
operations. These operations can occasionally return an
empty or shorter than expected list of results even when there more
results become available. When this happens, the NextToken
response
parameter contains a value to pass to the next call to the same API to
request the next part of the list.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:ListSecretVersionIds
^
Related operations
- To list the secrets in an account, use ListSecrets.
^
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1632 1633 1634 1635 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 1632 def list_secret_version_ids(params = {}, = {}) req = build_request(:list_secret_version_ids, params) req.send_request() end |
#list_secrets(params = {}) ⇒ Types::ListSecretsResponse
Lists all of the secrets that are stored by Secrets Manager in the AWS
account. To list the versions currently stored for a specific secret,
use ListSecretVersionIds. The encrypted fields SecretString
and
SecretBinary
are not included in the output. To get that
information, call the GetSecretValue operation.
NextToken
response parameter when calling any of
the List*
operations. These operations can occasionally return an
empty or shorter than expected list of results even when there more
results become available. When this happens, the NextToken
response
parameter contains a value to pass to the next call to the same API to
request the next part of the list.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:ListSecrets
^
Related operations
- To list the versions attached to a secret, use ListSecretVersionIds.
^
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1776 1777 1778 1779 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 1776 def list_secrets(params = {}, = {}) req = build_request(:list_secrets, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Attaches the contents of the specified resource-based permission
policy to a secret. A resource-based policy is optional.
Alternatively, you can use IAM identity-based policies that specify
the secret's Amazon Resource Name (ARN) in the policy statement's
Resources
element. You can also use a combination of both
identity-based and resource-based policies. The affected users and
roles receive the permissions that are permitted by all of the
relevant policies. For more information, see Using Resource-Based
Policies for AWS Secrets Manager. For the complete description of
the AWS policy syntax and grammar, see IAM JSON Policy Reference
in the IAM User Guide.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:PutResourcePolicy
^
Related operations
To retrieve the resource policy attached to a secret, use GetResourcePolicy.
To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy.
To list all of the currently available secrets, use ListSecrets.
1895 1896 1897 1898 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 1895 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#put_secret_value(params = {}) ⇒ Types::PutSecretValueResponse
Stores a new encrypted secret value in the specified secret. To do
this, the operation creates a new version and attaches it to the
secret. The version can contain a new SecretString
value or a new
SecretBinary
value. You can also specify the staging labels that are
initially attached to the new version.
SecretString
field. To add
binary data to a secret with the SecretBinary
field you must use the
AWS CLI or one of the AWS SDKs.
If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label
AWSCURRENT
to the new version.If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the
VersionStages
parameter.If this operation moves the staging label
AWSCURRENT
from another version to this version (because you included it in theStagingLabels
parameter) then Secrets Manager also automatically moves the staging labelAWSPREVIOUS
to the version thatAWSCURRENT
was removed from.This operation is idempotent. If a version with a
VersionId
with the same value as theClientRequestToken
parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.
SecretString
or
SecretBinary
for a secret in the same account as the calling user
and that secret doesn't specify a AWS KMS encryption key, Secrets
Manager uses the account's default AWS managed customer master key
(CMK) with the alias aws/secretsmanager
. If this key doesn't
already exist in your account then Secrets Manager creates it for
you automatically. All users and roles in the same AWS account
automatically have access to use the default CMK. Note that if an
Secrets Manager API call results in AWS creating the account's
AWS-managed CMK, it can result in a one-time significant delay in
returning the result.
- If the secret resides in a different AWS account from the
credentials calling an API that requires encryption or decryption of
the secret value then you must create and use a custom AWS KMS CMK
because you can't access the default CMK for the account using
credentials from a different AWS account. Store the ARN of the CMK
in the secret when you create the secret or when you update it by
including it in the
KMSKeyId
. If you call an API that must encrypt or decryptSecretString
orSecretBinary
using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:PutSecretValue
kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.
Related operations
To retrieve the encrypted value you store in the version of a secret, use GetSecretValue.
To create a secret, use CreateSecret.
To get the details for a secret, use DescribeSecret.
To list the versions attached to a secret, use ListSecretVersionIds.
2156 2157 2158 2159 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 2156 def put_secret_value(params = {}, = {}) req = build_request(:put_secret_value, params) req.send_request() end |
#restore_secret(params = {}) ⇒ Types::RestoreSecretResponse
Cancels the scheduled deletion of a secret by removing the
DeletedDate
time stamp. This makes the secret accessible to query
once again.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:RestoreSecret
^
Related operations
- To delete a secret, use DeleteSecret.
^
2240 2241 2242 2243 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 2240 def restore_secret(params = {}, = {}) req = build_request(:restore_secret, params) req.send_request() end |
#rotate_secret(params = {}) ⇒ Types::RotateSecretResponse
Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret.
This required configuration information includes the ARN of an AWS
Lambda function and the time between scheduled rotations. The Lambda
rotation function creates a new version of the secret and creates or
updates the credentials on the protected service to match. After
testing the new credentials, the function marks the new secret with
the staging label AWSCURRENT
so that your clients all immediately
begin to use the new version. For more information about rotating
secrets and how to configure a Lambda function to rotate the secrets
for your protected service, see Rotating Secrets in AWS Secrets
Manager in the AWS Secrets Manager User Guide.
Secrets Manager schedules the next rotation when the previous one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.
The rotation function must end with the versions of the secret in one of two states:
The
AWSPENDING
andAWSCURRENT
staging labels are attached to the same version of the secret, orThe
AWSPENDING
staging label is not attached to any version of the secret.
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.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:RotateSecret
lambda:InvokeFunction (on the function specified in the secret's metadata)
Related operations
To list the secrets in your account, use ListSecrets.
To get the details for a version of a secret, use DescribeSecret.
To create a new version of a secret, use CreateSecret.
To attach staging labels to or remove staging labels from a version of a secret, use UpdateSecretVersionStage.
2398 2399 2400 2401 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 2398 def rotate_secret(params = {}, = {}) req = build_request(:rotate_secret, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the
aws:
prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:TagResource
^
Related operations
To remove one or more tags from the collection attached to a secret, use UntagResource.
To view the list of tags attached to a secret, use DescribeSecret.
2528 2529 2530 2531 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 2528 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from the specified secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:UntagResource
^
Related operations
To add one or more tags to the collection attached to a secret, use TagResource.
To view the list of tags attached to a secret, use DescribeSecret.
2624 2625 2626 2627 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 2624 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_secret(params = {}) ⇒ Types::UpdateSecretResponse
Modifies many of the details of the specified secret. If you include a
ClientRequestToken
and either SecretString
or SecretBinary
then it also creates a new version attached to the secret.
To modify the rotation configuration of a secret, use RotateSecret instead.
SecretString
parameter and
therefore limits you to encrypting and storing only a text string. To
encrypt and store binary data as part of the version of a secret, you
must use either the AWS CLI or one of the AWS SDKs.
If a version with a
VersionId
with the same value as theClientRequestToken
parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.If you include
SecretString
orSecretBinary
to create a new secret version, Secrets Manager automatically attaches the staging labelAWSCURRENT
to the new version.
SecretString
or
SecretBinary
for a secret in the same account as the calling user
and that secret doesn't specify a AWS KMS encryption key, Secrets
Manager uses the account's default AWS managed customer master key
(CMK) with the alias aws/secretsmanager
. If this key doesn't
already exist in your account then Secrets Manager creates it for
you automatically. All users and roles in the same AWS account
automatically have access to use the default CMK. Note that if an
Secrets Manager API call results in AWS creating the account's
AWS-managed CMK, it can result in a one-time significant delay in
returning the result.
- If the secret resides in a different AWS account from the
credentials calling an API that requires encryption or decryption of
the secret value then you must create and use a custom AWS KMS CMK
because you can't access the default CMK for the account using
credentials from a different AWS account. Store the ARN of the CMK
in the secret when you create the secret or when you update it by
including it in the
KMSKeyId
. If you call an API that must encrypt or decryptSecretString
orSecretBinary
using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UpdateSecret
kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.
kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.
Related operations
To create a new secret, use CreateSecret.
To add only a new version to an existing secret, use PutSecretValue.
To get the details for a secret, use DescribeSecret.
To list the versions contained in a secret, use ListSecretVersionIds.
2910 2911 2912 2913 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 2910 def update_secret(params = {}, = {}) req = build_request(:update_secret, params) req.send_request() end |
#update_secret_version_stage(params = {}) ⇒ Types::UpdateSecretVersionStageResponse
Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the AWS Secrets Manager User Guide.
The staging labels that you specify in the VersionStage
parameter
are added to the existing list of staging labels--they don't replace
it.
You can move the AWSCURRENT
staging label to this version by
including it in this call.
AWSCURRENT
, Secrets Manager automatically moves
the label AWSPREVIOUS
to the version that AWSCURRENT
was removed
from.
If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:UpdateSecretVersionStage
^
Related operations
- To get the list of staging labels that are currently associated with
a version of a secret, use
DescribeSecret
and examine theSecretVersionsToStages
response value.
^
3086 3087 3088 3089 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 3086 def update_secret_version_stage(params = {}, = {}) req = build_request(:update_secret_version_stage, params) req.send_request() end |
#validate_resource_policy(params = {}) ⇒ Types::ValidateResourcePolicyResponse
Validates the JSON text of the resource-based policy document attached to the specified secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string. A resource-based policy is optional.
3166 3167 3168 3169 |
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/client.rb', line 3166 def validate_resource_policy(params = {}, = {}) req = build_request(:validate_resource_policy, params) req.send_request() end |