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", {
secretId: exampleAwsSecretsmanagerSecret.id,
rotationLambdaArn: exampleAwsLambdaFunction.arn,
rotationRules: {
automaticallyAfterDays: 30,
},
});
import pulumi
import pulumi_aws as aws
example = aws.secretsmanager.SecretRotation("example",
secret_id=example_aws_secretsmanager_secret["id"],
rotation_lambda_arn=example_aws_lambda_function["arn"],
rotation_rules={
"automatically_after_days": 30,
})
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()
{
SecretId = exampleAwsSecretsmanagerSecret.Id,
RotationLambdaArn = exampleAwsLambdaFunction.Arn,
RotationRules = new Aws.SecretsManager.Inputs.SecretRotationRotationRulesArgs
{
AutomaticallyAfterDays = 30,
},
});
});
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{
SecretId: pulumi.Any(exampleAwsSecretsmanagerSecret.Id),
RotationLambdaArn: pulumi.Any(exampleAwsLambdaFunction.Arn),
RotationRules: &secretsmanager.SecretRotationRotationRulesArgs{
AutomaticallyAfterDays: pulumi.Int(30),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_secretsmanager_secretrotation" "example" {
secret_id = exampleAwsSecretsmanagerSecret.id
rotation_lambda_arn = exampleAwsLambdaFunction.arn
rotation_rules = {
automatically_after_days = 30
}
}
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()
.secretId(exampleAwsSecretsmanagerSecret.id())
.rotationLambdaArn(exampleAwsLambdaFunction.arn())
.rotationRules(SecretRotationRotationRulesArgs.builder()
.automaticallyAfterDays(30)
.build())
.build());
}
}
resources:
example:
type: aws:secretsmanager:SecretRotation
properties:
secretId: ${exampleAwsSecretsmanagerSecret.id}
rotationLambdaArn: ${exampleAwsLambdaFunction.arn}
rotationRules:
automaticallyAfterDays: 30
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", {
secretId: example.id,
externalSecretRotationRoleArn: exampleAwsIamRole.arn,
externalSecretRotationMetadatas: [
{
key: "adminSecretArn",
value: example.arn,
},
{
key: "apiVersion",
value: "v65.0",
},
],
rotationRules: {
automaticallyAfterDays: Number(rotationDays),
},
});
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",
secret_id=example.id,
external_secret_rotation_role_arn=example_aws_iam_role["arn"],
external_secret_rotation_metadatas=[
{
"key": "adminSecretArn",
"value": example.arn,
},
{
"key": "apiVersion",
"value": "v65.0",
},
],
rotation_rules={
"automatically_after_days": int(rotation_days),
})
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()
{
SecretId = example.Id,
ExternalSecretRotationRoleArn = exampleAwsIamRole.Arn,
ExternalSecretRotationMetadatas = new[]
{
new Aws.SecretsManager.Inputs.SecretRotationExternalSecretRotationMetadataArgs
{
Key = "adminSecretArn",
Value = example.Arn,
},
new Aws.SecretsManager.Inputs.SecretRotationExternalSecretRotationMetadataArgs
{
Key = "apiVersion",
Value = "v65.0",
},
},
RotationRules = new Aws.SecretsManager.Inputs.SecretRotationRotationRulesArgs
{
AutomaticallyAfterDays = rotationDays,
},
});
});
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{
SecretId: example.ID().ToIDOutput().ToStringOutput(),
ExternalSecretRotationRoleArn: pulumi.Any(exampleAwsIamRole.Arn),
ExternalSecretRotationMetadatas: secretsmanager.SecretRotationExternalSecretRotationMetadataArray{
&secretsmanager.SecretRotationExternalSecretRotationMetadataArgs{
Key: pulumi.String("adminSecretArn"),
Value: example.Arn,
},
&secretsmanager.SecretRotationExternalSecretRotationMetadataArgs{
Key: pulumi.String("apiVersion"),
Value: pulumi.String("v65.0"),
},
},
RotationRules: &secretsmanager.SecretRotationRotationRulesArgs{
AutomaticallyAfterDays: pulumi.Any(rotationDays),
},
})
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" {
secret_id = aws_secretsmanager_secret.example.id
external_secret_rotation_role_arn = exampleAwsIamRole.arn
external_secret_rotation_metadatas {
key = "adminSecretArn"
value = aws_secretsmanager_secret.example.arn
}
external_secret_rotation_metadatas {
key = "apiVersion"
value = "v65.0"
}
rotation_rules = {
automatically_after_days = rotationDays
}
}
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.SecretRotationExternalSecretRotationMetadataArgs;
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 Secret("example", SecretArgs.builder()
.name("example-salesforce-client-secret")
.type("SalesforceClientSecret")
.build());
var exampleSecretRotation = new SecretRotation("exampleSecretRotation", SecretRotationArgs.builder()
.secretId(example.id())
.externalSecretRotationRoleArn(exampleAwsIamRole.arn())
.externalSecretRotationMetadatas(
SecretRotationExternalSecretRotationMetadataArgs.builder()
.key("adminSecretArn")
.value(example.arn())
.build(),
SecretRotationExternalSecretRotationMetadataArgs.builder()
.key("apiVersion")
.value("v65.0")
.build())
.rotationRules(SecretRotationRotationRulesArgs.builder()
.automaticallyAfterDays(rotationDays)
.build())
.build());
}
}
resources:
example:
type: aws:secretsmanager:Secret
properties:
name: example-salesforce-client-secret
type: SalesforceClientSecret
exampleSecretRotation:
type: aws:secretsmanager:SecretRotation
name: example
properties:
secretId: ${example.id}
externalSecretRotationRoleArn: ${exampleAwsIamRole.arn}
externalSecretRotationMetadatas:
- key: adminSecretArn
value: ${example.arn}
- key: apiVersion
value: v65.0
rotationRules:
automaticallyAfterDays: ${rotationDays}
For more information about managed external secrets and partner-specific metadata requirements, see the AWS documentation and partner-specific guides.
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) Amazon Resource Name (ARN) of the Secrets Manager secret.
Using pulumi import, import aws.secretsmanager.SecretRotation using the secret Amazon Resource Name (ARN). For example:
$ pulumi import aws:secretsmanager/secretRotation:SecretRotation example arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456
Constructors
- SecretRotation(String name, {SecretRotationArgs? args, CustomResourceOptions? options})
-
Creates a new SecretRotation.
nameThe Pulumi resource name.argsArguments used to configure this SecretRotation. The set of arguments for SecretRotation.optionsResource options controlling this resource's behavior.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
externalSecretRotationMetadatas
↔ Output<
List< Map< ?>String, dynamic> > -
Configuration block for metadata required by the external secret partner. Required for managed external secrets. See details below.
latefinal
-
externalSecretRotationRoleArn
↔ Output<
String?> -
ARN of the IAM role that allows Secrets Manager to rotate the secret held by a third-party partner. Required for managed external secrets.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
rotateImmediately
↔ Output<
bool?> -
Whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in
rotationRules. For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it. Defaults totrue.latefinal -
rotationEnabled
↔ Output<
bool> -
Whether automatic rotation is enabled for this secret.
latefinal
-
rotationLambdaArn
↔ Output<
String?> -
ARN of the Lambda function that can rotate the secret. Must be supplied if the secret is not managed by AWS.
latefinal
-
rotationRules
↔ Output<
SecretRotationRotationRules> -
Structure that defines the rotation configuration for this secret. Defined below.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
secretId
↔ Output<
String> -
Secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {SecretRotationState? state}) → SecretRotation -
Gets an existing SecretRotation resource's state with the given
nameandid.