SecretsManager

import { SecretsManager } from "https://aws-api.deno.dev/v0.4/services/secretsmanager.ts?docs=full";

class SecretsManager {

constructor(apiFactory: client.ApiFactory);

async cancelRotateSecret(params: CancelRotateSecretRequest, opts?: client.RequestOptions): Promise<CancelRotateSecretResponse>;

async createSecret(params: CreateSecretRequest, opts?: client.RequestOptions): Promise<CreateSecretResponse>;

async deleteResourcePolicy(params: DeleteResourcePolicyRequest, opts?: client.RequestOptions): Promise<DeleteResourcePolicyResponse>;

async deleteSecret(params: DeleteSecretRequest, opts?: client.RequestOptions): Promise<DeleteSecretResponse>;

async describeSecret(params: DescribeSecretRequest, opts?: client.RequestOptions): Promise<DescribeSecretResponse>;

async getRandomPassword(params?: GetRandomPasswordRequest, opts?: client.RequestOptions): Promise<GetRandomPasswordResponse>;

async getResourcePolicy(params: GetResourcePolicyRequest, opts?: client.RequestOptions): Promise<GetResourcePolicyResponse>;

async getSecretValue(params: GetSecretValueRequest, opts?: client.RequestOptions): Promise<GetSecretValueResponse>;

async listSecrets(params?: ListSecretsRequest, opts?: client.RequestOptions): Promise<ListSecretsResponse>;

async listSecretVersionIds(params: ListSecretVersionIdsRequest, opts?: client.RequestOptions): Promise<ListSecretVersionIdsResponse>;

async putResourcePolicy(params: PutResourcePolicyRequest, opts?: client.RequestOptions): Promise<PutResourcePolicyResponse>;

async putSecretValue(params: PutSecretValueRequest, opts?: client.RequestOptions): Promise<PutSecretValueResponse>;

async removeRegionsFromReplication(params: RemoveRegionsFromReplicationRequest, opts?: client.RequestOptions): Promise<RemoveRegionsFromReplicationResponse>;

async replicateSecretToRegions(params: ReplicateSecretToRegionsRequest, opts?: client.RequestOptions): Promise<ReplicateSecretToRegionsResponse>;

async restoreSecret(params: RestoreSecretRequest, opts?: client.RequestOptions): Promise<RestoreSecretResponse>;

async rotateSecret(params: RotateSecretRequest, opts?: client.RequestOptions): Promise<RotateSecretResponse>;

async stopReplicationToReplica(params: StopReplicationToReplicaRequest, opts?: client.RequestOptions): Promise<StopReplicationToReplicaResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateSecret(params: UpdateSecretRequest, opts?: client.RequestOptions): Promise<UpdateSecretResponse>;

async updateSecretVersionStage(params: UpdateSecretVersionStageRequest, opts?: client.RequestOptions): Promise<UpdateSecretVersionStageResponse>;

async validateResourcePolicy(params: ValidateResourcePolicyRequest, opts?: client.RequestOptions): Promise<ValidateResourcePolicyResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new SecretsManager(apiFactory: client.ApiFactory)

[src]

§Methods

cancelRotateSecret(params: CancelRotateSecretRequest, opts?: client.RequestOptions): Promise<CancelRotateSecretResponse>

[src]

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.

createSecret(params: CreateSecretRequest, opts?: client.RequestOptions): Promise<CreateSecretResponse>

[src]

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

deleteResourcePolicy(params: DeleteResourcePolicyRequest, opts?: client.RequestOptions): Promise<DeleteResourcePolicyResponse>

[src]

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

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

deleteSecret(params: DeleteSecretRequest, opts?: client.RequestOptions): Promise<DeleteSecretResponse>

[src]

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.

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

describeSecret(params: DescribeSecretRequest, opts?: client.RequestOptions): Promise<DescribeSecretResponse>

[src]

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.

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

getRandomPassword(params?: GetRandomPasswordRequest, opts?: client.RequestOptions): Promise<GetRandomPasswordResponse>

[src]

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.

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

getResourcePolicy(params: GetResourcePolicyRequest, opts?: client.RequestOptions): Promise<GetResourcePolicyResponse>

[src]

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.

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

getSecretValue(params: GetSecretValueRequest, opts?: client.RequestOptions): Promise<GetSecretValueResponse>

[src]

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

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

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

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.

listSecrets(params?: ListSecretsRequest, opts?: client.RequestOptions): Promise<ListSecretsResponse>

[src]

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

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

To list the versions of a secret, use "ListSecretVersionIds".

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

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

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

listSecretVersionIds(params: ListSecretVersionIdsRequest, opts?: client.RequestOptions): Promise<ListSecretVersionIdsResponse>

[src]

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

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

putResourcePolicy(params: PutResourcePolicyRequest, opts?: client.RequestOptions): Promise<PutResourcePolicyResponse>

[src]

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

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

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

putSecretValue(params: PutSecretValueRequest, opts?: client.RequestOptions): Promise<PutSecretValueResponse>

[src]

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.

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

removeRegionsFromReplication(params: RemoveRegionsFromReplicationRequest, opts?: client.RequestOptions): Promise<RemoveRegionsFromReplicationResponse>

[src]

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

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

replicateSecretToRegions(params: ReplicateSecretToRegionsRequest, opts?: client.RequestOptions): Promise<ReplicateSecretToRegionsResponse>

[src]

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

Required permissions: secretsmanager:ReplicateSecretToRegions. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

restoreSecret(params: RestoreSecretRequest, opts?: client.RequestOptions): Promise<RestoreSecretResponse>

[src]

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

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

rotateSecret(params: RotateSecretRequest, opts?: client.RequestOptions): Promise<RotateSecretResponse>

[src]

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.

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.

stopReplicationToReplica(params: StopReplicationToReplicaRequest, opts?: client.RequestOptions): Promise<StopReplicationToReplicaResponse>

[src]

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.

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

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

The following restrictions apply to tags:

Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws: prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

! IMPORTANT: ! 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.

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

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

! IMPORTANT: ! 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.

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

updateSecret(params: UpdateSecretRequest, opts?: client.RequestOptions): Promise<UpdateSecretResponse>

[src]

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

Required permissions: secretsmanager:UpdateSecret. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. If you use a customer managed key, you must also have kms:GenerateDataKey and kms:Decrypt permissions on the key. For more information, see Secret encryption and decryption.

updateSecretVersionStage(params: UpdateSecretVersionStageRequest, opts?: client.RequestOptions): Promise<UpdateSecretVersionStageResponse>

[src]

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

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

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

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

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

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

validateResourcePolicy(params: ValidateResourcePolicyRequest, opts?: client.RequestOptions): Promise<ValidateResourcePolicyResponse>

[src]

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.

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]