@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSSecretsManager extends Object implements AWSSecretsManager
AWSSecretsManager. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier | Constructor and Description |
|---|---|
protected |
AbstractAWSSecretsManager() |
| Modifier and Type | Method and Description |
|---|---|
CancelRotateSecretResult |
cancelRotateSecret(CancelRotateSecretRequest request)
Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.
|
CreateSecretResult |
createSecret(CreateSecretRequest request)
Creates a new secret.
|
DeleteSecretResult |
deleteSecret(DeleteSecretRequest request)
Deletes an entire secret and all of its versions.
|
DescribeSecretResult |
describeSecret(DescribeSecretRequest request)
Retrieves the details of a secret.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetRandomPasswordResult |
getRandomPassword(GetRandomPasswordRequest request)
Generates a random password of the specified complexity.
|
GetSecretValueResult |
getSecretValue(GetSecretValueRequest request)
Retrieves the contents of the encrypted fields
SecretString or SecretBinary from the
specified version of a secret, whichever contains content. |
ListSecretsResult |
listSecrets(ListSecretsRequest request)
Lists all of the secrets that are stored by Secrets Manager in the AWS account.
|
ListSecretVersionIdsResult |
listSecretVersionIds(ListSecretVersionIdsRequest request)
Lists all of the versions attached to the specified secret.
|
PutSecretValueResult |
putSecretValue(PutSecretValueRequest request)
Stores a new encrypted secret value in the specified secret.
|
RestoreSecretResult |
restoreSecret(RestoreSecretRequest request)
Cancels the scheduled deletion of a secret by removing the
DeletedDate time stamp. |
RotateSecretResult |
rotateSecret(RotateSecretRequest request)
Configures and starts the asynchronous process of rotating this secret.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Attaches one or more tags, each consisting of a key name and a value, to the specified secret.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes one or more tags from the specified secret.
|
UpdateSecretResult |
updateSecret(UpdateSecretRequest request)
Modifies many of the details of a secret.
|
UpdateSecretVersionStageResult |
updateSecretVersionStage(UpdateSecretVersionStageRequest request)
Modifies the staging labels attached to a version of a secret.
|
public CancelRotateSecretResult cancelRotateSecret(CancelRotateSecretRequest request)
AWSSecretsManagerDisables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.
To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a
value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.
If you cancel a rotation that is in progress, it can leave the VersionStage labels in an unexpected
state. Depending on what step of the rotation was in progress, you might need to remove the staging label
AWSPENDING from the partially created version, specified by the SecretVersionId
response value. You should also evaluate the partially rotated new version to see if it should be deleted, which
you can do by removing all staging labels from the new version's VersionStage field.
To successfully start a rotation, the staging label AWSPENDING must be in one of the following
states:
Not be attached to any version at all
Attached to the same version as the staging label AWSCURRENT
If the staging label AWSPENDING is attached to a different version than the version with
AWSCURRENT then the attempt to rotate fails.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:CancelRotateSecret
Related operations
To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.
To get the rotation configuration details for a secret, use DescribeSecret.
To list all of the currently available secrets, use ListSecrets.
To list all of the versions currently associated with a secret, use ListSecretVersionIds.
cancelRotateSecret in interface AWSSecretsManagerpublic CreateSecretResult createSecret(CreateSecretRequest request)
AWSSecretsManagerCreates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret.
Each version contains a copy of the encrypted secret data. Each version is associated with one or more
"staging labels" that identify where the version is in the rotation cycle. The
SecretVersionsToStages field of the secret contains the mapping of staging labels to the active
versions of the secret. Versions without a staging label are considered deprecated and are not included in the
list.
You provide the secret data to be encrypted by putting text in either the SecretString parameter or
binary data in the SecretBinary parameter, but not both. If you include SecretString or
SecretBinary then Secrets Manager also creates an initial secret version and automatically attaches
the staging label AWSCURRENT to the new version.
If you call an operation that needs to encrypt or decrypt the SecretString or
SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a
AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the
alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager
creates it for you automatically. All users in the same AWS account automatically have access to use the default
CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it
can result in a one-time significant delay in returning the result.
If the secret is in a different AWS account from the credentials calling an API that requires encryption or
decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the
default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the
secret when you create the secret or when you update it by including it in the KMSKeyId. If you call
an API that must encrypt or decrypt SecretString or SecretBinary using credentials from
a different account then the AWS KMS key policy must grant cross-account access to that other account's user or
role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:CreateSecret
kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.
kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.
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.
createSecret in interface AWSSecretsManagerpublic DeleteSecretResult deleteSecret(DeleteSecretRequest request)
AWSSecretsManager
Deletes an entire secret and all of its versions. You can optionally include a recovery window during which you
can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets
Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window.
At the end of the recovery window, Secrets Manager deletes the secret permanently.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
and cancel the deletion of the secret.
You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.
There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the
VersionStage field of a version. That marks the version as deprecated and allows Secrets Manager to
delete it as needed. Versions that do not have any staging labels do not show up in ListSecretVersionIds
unless you specify IncludeDeprecated.
The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:DeleteSecret
Related operations
To create a secret, use CreateSecret.
To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret.
deleteSecret in interface AWSSecretsManagerpublic DescribeSecretResult describeSecret(DescribeSecretRequest request)
AWSSecretsManagerRetrieves the details of a secret. It does not include the encrypted fields. Only those fields that are populated with a value are returned in the response.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:DescribeSecret
Related operations
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.
describeSecret in interface AWSSecretsManagerpublic GetRandomPasswordResult getRandomPassword(GetRandomPasswordRequest request)
AWSSecretsManagerGenerates 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
getRandomPassword in interface AWSSecretsManagerpublic GetSecretValueResult getSecretValue(GetSecretValueRequest request)
AWSSecretsManager
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.
getSecretValue in interface AWSSecretsManagerpublic ListSecretVersionIdsResult listSecretVersionIds(ListSecretVersionIdsRequest request)
AWSSecretsManager
Lists all of the versions attached to the specified secret. The output does not include the
SecretString or SecretBinary fields. By default, the list includes only versions that
have at least one staging label in VersionStage attached.
Always check the NextToken response parameter when calling any of the List* operations.
These operations can occasionally return an empty or shorter than expected list of results even when there are
more results available. When this happens, the NextToken response parameter contains a value to pass
to the next call to the same API to request the next part of the list.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:ListSecretVersionIds
Related operations
To list the secrets in an account, use ListSecrets.
listSecretVersionIds in interface AWSSecretsManagerpublic ListSecretsResult listSecrets(ListSecretsRequest request)
AWSSecretsManager
Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently
stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString and
SecretBinary are not included in the output. To get that information, call the GetSecretValue
operation.
Always check the NextToken response parameter when calling any of the List* operations.
These operations can occasionally return an empty or shorter than expected list of results even when there are
more results available. When this happens, the NextToken response parameter contains a value to pass
to the next call to the same API to request the next part of the list.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:ListSecrets
Related operations
To list the versions attached to a secret, use ListSecretVersionIds.
listSecrets in interface AWSSecretsManagerpublic PutSecretValueResult putSecretValue(PutSecretValueRequest request)
AWSSecretsManager
Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and
attaches it to the secret. The version can contain a new SecretString value or a new
SecretBinary value. You can also specify the staging labels that are initially attached to the new
version.
The Secrets Manager console uses only the SecretString field. To add binary data to a secret with
the SecretBinary field you must use the AWS CLI or one of the AWS SDKs.
If this operation creates the first version for the secret then Secrets Manager automatically attaches the
staging label AWSCURRENT to the new version.
If another version of this secret already exists, then this operation does not automatically move any staging
labels other than those that you explicitly specify in the VersionStages parameter.
If this operation moves the staging label AWSCURRENT from another version to this version (because
you included it in the StagingLabels parameter) then Secrets Manager also automatically moves the
staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
This operation is idempotent. If a version with a SecretVersionId with the same value as the
ClientRequestToken parameter already exists and you specify the same secret data, the operation
succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot
modify an existing version; you can only create new ones.
If you call an operation that needs to encrypt or decrypt the SecretString or
SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a
AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the
alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager
creates it for you automatically. All users in the same AWS account automatically have access to use the default
CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it
can result in a one-time significant delay in returning the result.
If the secret is in a different AWS account from the credentials calling an API that requires encryption or
decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the
default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the
secret when you create the secret or when you update it by including it in the KMSKeyId. If you call
an API that must encrypt or decrypt SecretString or SecretBinary using credentials from
a different account then the AWS KMS key policy must grant cross-account access to that other account's user or
role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:PutSecretValue
kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.
Related operations
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.
putSecretValue in interface AWSSecretsManagerpublic RestoreSecretResult restoreSecret(RestoreSecretRequest request)
AWSSecretsManager
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.
restoreSecret in interface AWSSecretsManagerpublic RotateSecretResult rotateSecret(RotateSecretRequest request)
AWSSecretsManagerConfigures 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.
The rotation function must end with the versions of the secret in one of two states:
The AWSPENDING and AWSCURRENT staging labels are attached to the same version of the
secret, or
The AWSPENDING staging label is not attached to any version of the secret.
If instead the AWSPENDING staging label is present but is not attached to the same version as
AWSCURRENT then any later invocation of RotateSecret assumes that a previous rotation
request is still in progress and returns an error.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:RotateSecret
lambda:InvokeFunction (on the function specified in the secret's metadata)
Related operations
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.
rotateSecret in interface AWSSecretsManagerpublic TagResourceResult tagResource(TagResourceRequest request)
AWSSecretsManagerAttaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't
edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per
secret limit.
If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:TagResource
Related operations
To remove one or more tags from the collection attached to a secret, use UntagResource.
To view the list of tags attached to a secret, use DescribeSecret.
tagResource in interface AWSSecretsManagerpublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSSecretsManagerRemoves 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.
untagResource in interface AWSSecretsManagerpublic UpdateSecretResult updateSecret(UpdateSecretRequest request)
AWSSecretsManager
Modifies many of the details of a secret. If you include a ClientRequestToken and either
SecretString or SecretBinary then it also creates a new version attached to the secret.
To modify the rotation configuration of a secret, use RotateSecret instead.
The Secrets Manager console uses only the SecretString parameter and therefore limits you to
encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret,
you must use either the AWS CLI or one of the AWS SDKs.
If a version with a SecretVersionId with the same value as the ClientRequestToken
parameter already exists, the operation generates an error. You cannot modify an existing version, you can only
create new ones.
If you include SecretString or SecretBinary to create a new secret version, Secrets
Manager automatically attaches the staging label AWSCURRENT to the new version.
If you call an operation that needs to encrypt or decrypt the SecretString or
SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a
AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the
alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager
creates it for you automatically. All users in the same AWS account automatically have access to use the default
CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it
can result in a one-time significant delay in returning the result.
If the secret is in a different AWS account from the credentials calling an API that requires encryption or
decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the
default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the
secret when you create the secret or when you update it by including it in the KMSKeyId. If you call
an API that must encrypt or decrypt SecretString or SecretBinary using credentials from
a different account then the AWS KMS key policy must grant cross-account access to that other account's user or
role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UpdateSecret
kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.
kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.
Related operations
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.
updateSecret in interface AWSSecretsManagerpublic UpdateSecretVersionStageResult updateSecretVersionStage(UpdateSecretVersionStageRequest request)
AWSSecretsManagerModifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the AWS Secrets Manager User Guide.
The staging labels that you specify in the VersionStage parameter are added to the existing list of
staging labels--they don't replace it.
You can move the AWSCURRENT staging label to this version by including it in this call.
Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS
to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UpdateSecretVersionStage
Related operations
To get the list of staging labels that are currently associated with a version of a secret, use
DescribeSecret and examine the SecretVersionsToStages response value.
updateSecretVersionStage in interface AWSSecretsManagerpublic void shutdown()
AWSSecretsManagershutdown in interface AWSSecretsManagerpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSecretsManagerResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSSecretsManagerrequest - The originally executed request.Copyright © 2018. All rights reserved.