@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
101 lines • 5.43 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.SecretRotation = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides a resource to manage AWS Secrets Manager secret rotation. To manage a secret, see the `aws.secretsmanager.Secret` resource. To manage a secret value, see the `aws.secretsmanager.SecretVersion` resource.
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.secretsmanager.SecretRotation("example", {
* secretId: exampleAwsSecretsmanagerSecret.id,
* rotationLambdaArn: exampleAwsLambdaFunction.arn,
* rotationRules: {
* automaticallyAfterDays: 30,
* },
* });
* ```
*
* ### Rotation Configuration
*
* To enable automatic secret rotation, the Secrets Manager service requires usage of a Lambda function. The [Rotate Secrets section in the Secrets Manager User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html) provides additional information about deploying a prebuilt Lambda functions for supported credential rotation (e.g., RDS) or deploying a custom Lambda function.
*
* > **NOTE:** Configuring rotation causes the secret to rotate once as soon as you enable rotation. Before you do this, you must ensure that all of your applications that use the credentials stored in the secret are updated to retrieve the secret from AWS Secrets Manager. The old credentials might no longer be usable after the initial rotation and any applications that you fail to update will break as soon as the old credentials are no longer valid.
*
* > **NOTE:** If you cancel a rotation that is in progress (by removing the `rotation` configuration), 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.
*
* ## Import
*
* Using `pulumi import`, import `aws_secretsmanager_secret_rotation` using the secret Amazon Resource Name (ARN). For example:
*
* ```sh
* $ pulumi import aws:secretsmanager/secretRotation:SecretRotation example arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456
* ```
*/
class SecretRotation extends pulumi.CustomResource {
/**
* Get an existing SecretRotation resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new SecretRotation(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of SecretRotation. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === SecretRotation.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["region"] = state?.region;
resourceInputs["rotateImmediately"] = state?.rotateImmediately;
resourceInputs["rotationEnabled"] = state?.rotationEnabled;
resourceInputs["rotationLambdaArn"] = state?.rotationLambdaArn;
resourceInputs["rotationRules"] = state?.rotationRules;
resourceInputs["secretId"] = state?.secretId;
}
else {
const args = argsOrState;
if (args?.rotationRules === undefined && !opts.urn) {
throw new Error("Missing required property 'rotationRules'");
}
if (args?.secretId === undefined && !opts.urn) {
throw new Error("Missing required property 'secretId'");
}
resourceInputs["region"] = args?.region;
resourceInputs["rotateImmediately"] = args?.rotateImmediately;
resourceInputs["rotationLambdaArn"] = args?.rotationLambdaArn;
resourceInputs["rotationRules"] = args?.rotationRules;
resourceInputs["secretId"] = args?.secretId;
resourceInputs["rotationEnabled"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(SecretRotation.__pulumiType, name, resourceInputs, opts);
}
}
exports.SecretRotation = SecretRotation;
/** @internal */
SecretRotation.__pulumiType = 'aws:secretsmanager/secretRotation:SecretRotation';
//# sourceMappingURL=secretRotation.js.map