SecretRotation class

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

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.secretsmanager.SecretRotation("example", {
    rotationRules: {
        automaticallyAfterDays: 30,
    },
    secretId: exampleAwsSecretsmanagerSecret.id,
    rotationLambdaArn: exampleAwsLambdaFunction.arn,
});

import pulumi
import pulumi_aws as aws

example = aws.secretsmanager.SecretRotation("example",
    rotation_rules={
        "automatically_after_days": 30,
    },
    secret_id=example_aws_secretsmanager_secret["id"],
    rotation_lambda_arn=example_aws_lambda_function["arn"])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.SecretsManager.SecretRotation("example", new()
    {
        RotationRules = new Aws.SecretsManager.Inputs.SecretRotationRotationRulesArgs
        {
            AutomaticallyAfterDays = 30,
        },
        SecretId = exampleAwsSecretsmanagerSecret.Id,
        RotationLambdaArn = exampleAwsLambdaFunction.Arn,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/secretsmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := secretsmanager.NewSecretRotation(ctx, "example", &secretsmanager.SecretRotationArgs{
			RotationRules: &secretsmanager.SecretRotationRotationRulesArgs{
				AutomaticallyAfterDays: pulumi.Int(30),
			},
			SecretId:          pulumi.Any(exampleAwsSecretsmanagerSecret.Id),
			RotationLambdaArn: pulumi.Any(exampleAwsLambdaFunction.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_secretsmanager_secretrotation" "example" {
  rotation_rules = {
    automatically_after_days = 30
  }
  secret_id           = exampleAwsSecretsmanagerSecret.id
  rotation_lambda_arn = exampleAwsLambdaFunction.arn
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.secretsmanager.SecretRotation;
import com.pulumi.aws.secretsmanager.SecretRotationArgs;
import com.pulumi.aws.secretsmanager.inputs.SecretRotationRotationRulesArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new SecretRotation("example", SecretRotationArgs.builder()
            .rotationRules(SecretRotationRotationRulesArgs.builder()
                .automaticallyAfterDays(30)
                .build())
            .secretId(exampleAwsSecretsmanagerSecret.id())
            .rotationLambdaArn(exampleAwsLambdaFunction.arn())
            .build());

    }
}

resources:
  example:
    type: aws:secretsmanager:SecretRotation
    properties:
      rotationRules:
        automaticallyAfterDays: 30
      secretId: ${exampleAwsSecretsmanagerSecret.id}
      rotationLambdaArn: ${exampleAwsLambdaFunction.arn}

Managed External Secret Rotation

For managed external secrets that are rotated by AWS partner integrations:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.secretsmanager.Secret("example", {
    name: "example-salesforce-client-secret",
    type: "SalesforceClientSecret",
});
const exampleSecretRotation = new aws.secretsmanager.SecretRotation("example", {
    rotationRules: {
        automaticallyAfterDays: Number(rotationDays),
    },
    externalSecretRotationMetadatas: [
        {
            key: "adminSecretArn",
            value: example.arn,
        },
        {
            key: "apiVersion",
            value: "v65.0",
        },
    ],
    secretId: example.id,
    externalSecretRotationRoleArn: exampleAwsIamRole.arn,
});

import pulumi
import pulumi_aws as aws

example = aws.secretsmanager.Secret("example",
    name="example-salesforce-client-secret",
    type="SalesforceClientSecret")
example_secret_rotation = aws.secretsmanager.SecretRotation("example",
    rotation_rules={
        "automatically_after_days": int(rotation_days),
    },
    external_secret_rotation_metadatas=[
        {
            "key": "adminSecretArn",
            "value": example.arn,
        },
        {
            "key": "apiVersion",
            "value": "v65.0",
        },
    ],
    secret_id=example.id,
    external_secret_rotation_role_arn=example_aws_iam_role["arn"])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.SecretsManager.Secret("example", new()
    {
        Name = "example-salesforce-client-secret",
        Type = "SalesforceClientSecret",
    });

    var exampleSecretRotation = new Aws.SecretsManager.SecretRotation("example", new()
    {
        RotationRules = new Aws.SecretsManager.Inputs.SecretRotationRotationRulesArgs
        {
            AutomaticallyAfterDays = rotationDays,
        },
        ExternalSecretRotationMetadatas = new[]
        {
            new Aws.SecretsManager.Inputs.SecretRotationExternalSecretRotationMetadataArgs
            {
                Key = "adminSecretArn",
                Value = example.Arn,
            },
            new Aws.SecretsManager.Inputs.SecretRotationExternalSecretRotationMetadataArgs
            {
                Key = "apiVersion",
                Value = "v65.0",
            },
        },
        SecretId = example.Id,
        ExternalSecretRotationRoleArn = exampleAwsIamRole.Arn,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/secretsmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := secretsmanager.NewSecret(ctx, "example", &secretsmanager.SecretArgs{
			Name: pulumi.String("example-salesforce-client-secret"),
			Type: pulumi.String("SalesforceClientSecret"),
		})
		if err != nil {
			return err
		}
		_, err = secretsmanager.NewSecretRotation(ctx, "example", &secretsmanager.SecretRotationArgs{
			RotationRules: &secretsmanager.SecretRotationRotationRulesArgs{
				AutomaticallyAfterDays: pulumi.Any(rotationDays),
			},
			ExternalSecretRotationMetadatas: secretsmanager.SecretRotationExternalSecretRotationMetadataArray{
				&secretsmanager.SecretRotationExternalSecretRotationMetadataArgs{
					Key:   pulumi.String("adminSecretArn"),
					Value: example.Arn,
				},
				&secretsmanager.SecretRotationExternalSecretRotationMetadataArgs{
					Key:   pulumi.String("apiVersion"),
					Value: pulumi.String("v65.0"),
				},
			},
			SecretId:                      example.ID().ToIDOutput().ToStringOutput(),
			ExternalSecretRotationRoleArn: pulumi.Any(exampleAwsIamRole.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_secretsmanager_secret" "example" {
  name = "example-salesforce-client-secret"
  type = "SalesforceClientSecret"
}
resource "aws_secretsmanager_secretrotation" "example" {
  rotation_rules = {
    automatically_after_days = rotationDays
  }
  external_secret_rotation_metadatas {
    key   = "adminSecretArn"
    value = aws_secretsmanager_secret.example.arn
  }
  external_secret_rotation_metadatas {
    key   = "apiVersion"
    value = "v65.0"
  }
  secret_id                         = aws_secretsmanager_secret.example.id
  external_secret_rotation_role_arn = exampleAwsIamRole.arn
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.secretsmanager.Secret;
import com.pulumi.aws.secretsmanager.SecretArgs;
import com.pulumi.aws.secretsmanager.SecretRotation;
import com.pulumi.aws.secretsmanager.SecretRotationArgs;
import com.pulumi.aws.secretsmanager.inputs.SecretRotationRotationRulesArgs;
import com.pulumi.aws.secretsmanager.inputs.SecretRotationExternalSecretRotationMetadataArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Secret("example", SecretArgs.builder()
            .name("example-salesforce-client-secret")
            .type("SalesforceClientSecret")
            .build());

        var exampleSecretRotation = new SecretRotation("exampleSecretRotation", SecretRotationArgs.builder()
            .rotationRules(SecretRotationRotationRulesArgs.builder()
                .automaticallyAfterDays(rotationDays)
                .build())
            .externalSecretRotationMetadatas(
                SecretRotationExternalSecretRotationMetadataArgs.builder()
                    .key("adminSecretArn")
                    .value(example.arn())
                    .build(),
                SecretRotationExternalSecretRotationMetadataArgs.builder()
                    .key("apiVersion")
                    .value("v65.0")
                    .build())
            .secretId(example.id())
            .externalSecretRotationRoleArn(exampleAwsIamRole.arn())
            .build());

    }
}

resources:
  example:
    type: aws:secretsmanager:Secret
    properties:
      name: example-salesforce-client-secret
      type: SalesforceClientSecret
  exampleSecretRotation:
    type: aws:secretsmanager:SecretRotation
    name: example
    properties:
      rotationRules:
        automaticallyAfterDays: ${rotationDays}
      externalSecretRotationMetadatas:
        - key: adminSecretArn
          value: ${example.arn}
        - key: apiVersion
          value: v65.0
      secretId: ${example.id}
      externalSecretRotationRoleArn: ${exampleAwsIamRole.arn}

For more information about managed external secrets and partner-specific metadata requirements, see the AWS documentation and partner-specific guides.

Disable Rotation for a Managed Secret

When a secret is managed by AWS, such as an RDS master user password secret created via manageMasterUserPassword, rotation is enabled automatically. Set rotationEnabled to false (and omit rotationRules) to turn that rotation off:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.rds.Instance("example", {manageMasterUserPassword: true});
const exampleSecretRotation = new aws.secretsmanager.SecretRotation("example", {
    secretId: example.masterUserSecrets[0].secretArn,
    rotationEnabled: false,
});

import pulumi
import pulumi_aws as aws

example = aws.rds.Instance("example", manage_master_user_password=True)
example_secret_rotation = aws.secretsmanager.SecretRotation("example",
    secret_id=example.master_user_secrets[0].secret_arn,
    rotation_enabled=False)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Rds.Instance("example", new()
    {
        ManageMasterUserPassword = true,
    });

    var exampleSecretRotation = new Aws.SecretsManager.SecretRotation("example", new()
    {
        SecretId = example.MasterUserSecrets.Apply(masterUserSecrets => masterUserSecrets[0].SecretArn),
        RotationEnabled = false,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/secretsmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := rds.NewInstance(ctx, "example", &rds.InstanceArgs{
			ManageMasterUserPassword: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = secretsmanager.NewSecretRotation(ctx, "example", &secretsmanager.SecretRotationArgs{
			SecretId: example.MasterUserSecrets.ApplyT(func(masterUserSecrets []rds.InstanceMasterUserSecret) (*string, error) {
				return masterUserSecrets[0].SecretArn, nil
			}).(pulumi.StringPtrOutput),
			RotationEnabled: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_rds_instance" "example" {
  manage_master_user_password = true
}
resource "aws_secretsmanager_secretrotation" "example" {
  secret_id        = aws_rds_instance.example.master_user_secrets[0].secret_arn
  rotation_enabled = false
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Instance;
import com.pulumi.aws.rds.InstanceArgs;
import com.pulumi.aws.secretsmanager.SecretRotation;
import com.pulumi.aws.secretsmanager.SecretRotationArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Instance("example", InstanceArgs.builder()
            .manageMasterUserPassword(true)
            .build());

        var exampleSecretRotation = new SecretRotation("exampleSecretRotation", SecretRotationArgs.builder()
            .secretId(example.masterUserSecrets().applyValue(_masterUserSecrets -> _masterUserSecrets[0].secretArn()))
            .rotationEnabled(false)
            .build());

    }
}

resources:
  example:
    type: aws:rds:Instance
    properties:
      manageMasterUserPassword: true
  exampleSecretRotation:
    type: aws:secretsmanager:SecretRotation
    name: example
    properties:
      secretId: ${example.masterUserSecrets[0].secretArn}
      rotationEnabled: false

> NOTE: For Amazon Aurora and other clustered engines, rotation is finalized once a cluster instance is available, and AWS re-enables rotation if it is cancelled before then. Ensure this resource depends on the cluster instance (for example, with dependsOn = [aws_rds_cluster_instance.example]) so the cancellation is applied after the instance is available.

When rotationEnabled is false, rotationRules must be omitted. If you toggle rotation on and off through a variable (for example, in a module), gate the block with a dynamic block so it is only present when rotation is enabled:

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

function singleOrNone<T>(elements: pulumi.Input<T>[]): pulumi.Input<T> | undefined {
    if (elements.length > 1) {
        throw new Error("singleOrNone expected input list to have a single element");
    }
    return elements[0];
}

const config = new pulumi.Config();
const rotationEnabled = config.getBoolean("rotationEnabled") || true;
const example = new aws.secretsmanager.SecretRotation("example", {
    rotationRules: singleOrNone(rotationEnabled ? [{
        automaticallyAfterDays: 30,
    }] : []),
    secretId: exampleAwsDbInstance.masterUserSecret[0].secretArn,
    rotationEnabled: rotationEnabled,
});

import pulumi
import pulumi_aws as aws

def single_or_none(elements):
    if len(elements) > 1:
        raise Exception("single_or_none expected input list to have a single element")
    return elements[0] if elements else None


config = pulumi.Config()
rotation_enabled = config.get_bool("rotationEnabled")
if rotation_enabled is None:
    rotation_enabled = True
example = aws.secretsmanager.SecretRotation("example",
    rotation_rules=single_or_none([{
        "automaticallyAfterDays": 30,
    }] if rotation_enabled else []),
    secret_id=example_aws_db_instance["masterUserSecret"][0]["secretArn"],
    rotation_enabled=rotation_enabled)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var config = new Config();
    var rotationEnabled = config.GetBoolean("rotationEnabled") ?? true;
    var example = new Aws.SecretsManager.SecretRotation("example", new()
    {
        RotationRules = Enumerable.SingleOrDefault(rotationEnabled ? new[]
        {

            {
                { "automaticallyAfterDays", 30 },
            },
        } : new[] {}),
        SecretId = exampleAwsDbInstance.MasterUserSecret[0].SecretArn,
        RotationEnabled = rotationEnabled,
    });

});

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/secretsmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func singleOrNone[T any](elements []T) T {
	if len(elements) != 1 {
		panic(fmt.Errorf("singleOrNone expected input slice to have a single element"))
	}
	return elements[0]
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		rotationEnabled := true
		if param := cfg.GetBool("rotationEnabled"); param {
			rotationEnabled = param
		}
		var tmp0 []map[string]int
		if rotationEnabled {
			tmp0 = []map[string]int{
				{
					"automaticallyAfterDays": 30,
				},
			}
		} else {
			tmp0 = []interface{}{}
		}
		_, err := secretsmanager.NewSecretRotation(ctx, "example", &secretsmanager.SecretRotationArgs{
			RotationRules:   singleOrNone(tmp0),
			SecretId:        pulumi.Any(exampleAwsDbInstance.MasterUserSecret[0].SecretArn),
			RotationEnabled: pulumi.Bool(rotationEnabled),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_secretsmanager_secretrotation" "example" {
  rotation_rules = one(var.rotationEnabled ? [{
    "automaticallyAfterDays" = 30
  }] : [])
  secret_id        = exampleAwsDbInstance.masterUserSecret[0].secretArn
  rotation_enabled = var.rotationEnabled
}
variable "rotationEnabled" {
  type    = bool
  default = true
}

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

Identity Schema

Required

• secretId (String) ARN of the Secrets Manager secret.

Using pulumi import, import aws.secretsmanager.SecretRotation using the secret ARN. For example:

$ pulumi import aws:secretsmanager/secretRotation:SecretRotation example arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456