Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. secretsmanager
  5. SecretRotation

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi
pulumi/pulumi-aws

aws.secretsmanager.SecretRotation

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi
pulumi/pulumi-aws

    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

    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 = aws_secretsmanager_secret.Example.Id,
        RotationLambdaArn = aws_lambda_function.Example.Arn,
        RotationRules = new Aws.SecretsManager.Inputs.SecretRotationRotationRulesArgs
        {
            AutomaticallyAfterDays = 30,
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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(aws_secretsmanager_secret.Example.Id),
			RotationLambdaArn: pulumi.Any(aws_lambda_function.Example.Arn),
			RotationRules: &secretsmanager.SecretRotationRotationRulesArgs{
				AutomaticallyAfterDays: pulumi.Int(30),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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.List;
import java.util.ArrayList;
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(aws_secretsmanager_secret.example().id())
            .rotationLambdaArn(aws_lambda_function.example().arn())
            .rotationRules(SecretRotationRotationRulesArgs.builder()
                .automaticallyAfterDays(30)
                .build())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.secretsmanager.SecretRotation("example",
    secret_id=aws_secretsmanager_secret["example"]["id"],
    rotation_lambda_arn=aws_lambda_function["example"]["arn"],
    rotation_rules=aws.secretsmanager.SecretRotationRotationRulesArgs(
        automatically_after_days=30,
    ))

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

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

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

    Create SecretRotation Resource

    new SecretRotation(name: string, args: SecretRotationArgs, opts?: CustomResourceOptions);
    @overload
def SecretRotation(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   rotation_lambda_arn: Optional[str] = None,
                   rotation_rules: Optional[SecretRotationRotationRulesArgs] = None,
                   secret_id: Optional[str] = None)
@overload
def SecretRotation(resource_name: str,
                   args: SecretRotationArgs,
                   opts: Optional[ResourceOptions] = None)
    func NewSecretRotation(ctx *Context, name string, args SecretRotationArgs, opts ...ResourceOption) (*SecretRotation, error)
    public SecretRotation(string name, SecretRotationArgs args, CustomResourceOptions? opts = null)
    public SecretRotation(String name, SecretRotationArgs args)
public SecretRotation(String name, SecretRotationArgs args, CustomResourceOptions options)

    type: aws:secretsmanager:SecretRotation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretRotationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SecretRotationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SecretRotationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretRotationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecretRotationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    SecretRotation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SecretRotation resource accepts the following input properties:

    RotationLambdaArn string

    Specifies the ARN of the Lambda function that can rotate the secret.

    RotationRules SecretRotationRotationRules

    A structure that defines the rotation configuration for this secret. Defined below.

    SecretId string

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

    RotationLambdaArn string

    Specifies the ARN of the Lambda function that can rotate the secret.

    RotationRules SecretRotationRotationRulesArgs

    A structure that defines the rotation configuration for this secret. Defined below.

    SecretId string

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

    rotationLambdaArn String

    Specifies the ARN of the Lambda function that can rotate the secret.

    rotationRules SecretRotationRotationRules

    A structure that defines the rotation configuration for this secret. Defined below.

    secretId String

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

    rotationLambdaArn string

    Specifies the ARN of the Lambda function that can rotate the secret.

    rotationRules SecretRotationRotationRules

    A structure that defines the rotation configuration for this secret. Defined below.

    secretId string

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

    rotation_lambda_arn str

    Specifies the ARN of the Lambda function that can rotate the secret.

    rotation_rules SecretRotationRotationRulesArgs

    A structure that defines the rotation configuration for this secret. Defined below.

    secret_id str

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

    rotationLambdaArn String

    Specifies the ARN of the Lambda function that can rotate the secret.

    rotationRules Property Map

    A structure that defines the rotation configuration for this secret. Defined below.

    secretId String

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SecretRotation resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    RotationEnabled bool

    Specifies whether automatic rotation is enabled for this secret.

    Id string

    The provider-assigned unique ID for this managed resource.

    RotationEnabled bool

    Specifies whether automatic rotation is enabled for this secret.

    id String

    The provider-assigned unique ID for this managed resource.

    rotationEnabled Boolean

    Specifies whether automatic rotation is enabled for this secret.

    id string

    The provider-assigned unique ID for this managed resource.

    rotationEnabled boolean

    Specifies whether automatic rotation is enabled for this secret.

    id str

    The provider-assigned unique ID for this managed resource.

    rotation_enabled bool

    Specifies whether automatic rotation is enabled for this secret.

    id String

    The provider-assigned unique ID for this managed resource.

    rotationEnabled Boolean

    Specifies whether automatic rotation is enabled for this secret.

    Look up Existing SecretRotation Resource

    Get an existing SecretRotation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SecretRotationState, opts?: CustomResourceOptions): SecretRotation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        rotation_enabled: Optional[bool] = None,
        rotation_lambda_arn: Optional[str] = None,
        rotation_rules: Optional[SecretRotationRotationRulesArgs] = None,
        secret_id: Optional[str] = None) -> SecretRotation
    func GetSecretRotation(ctx *Context, name string, id IDInput, state *SecretRotationState, opts ...ResourceOption) (*SecretRotation, error)
    public static SecretRotation Get(string name, Input<string> id, SecretRotationState? state, CustomResourceOptions? opts = null)
    public static SecretRotation get(String name, Output<String> id, SecretRotationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    RotationEnabled bool

    Specifies whether automatic rotation is enabled for this secret.

    RotationLambdaArn string

    Specifies the ARN of the Lambda function that can rotate the secret.

    RotationRules SecretRotationRotationRules

    A structure that defines the rotation configuration for this secret. Defined below.

    SecretId string

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

    RotationEnabled bool

    Specifies whether automatic rotation is enabled for this secret.

    RotationLambdaArn string

    Specifies the ARN of the Lambda function that can rotate the secret.

    RotationRules SecretRotationRotationRulesArgs

    A structure that defines the rotation configuration for this secret. Defined below.

    SecretId string

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

    rotationEnabled Boolean

    Specifies whether automatic rotation is enabled for this secret.

    rotationLambdaArn String

    Specifies the ARN of the Lambda function that can rotate the secret.

    rotationRules SecretRotationRotationRules

    A structure that defines the rotation configuration for this secret. Defined below.

    secretId String

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

    rotationEnabled boolean

    Specifies whether automatic rotation is enabled for this secret.

    rotationLambdaArn string

    Specifies the ARN of the Lambda function that can rotate the secret.

    rotationRules SecretRotationRotationRules

    A structure that defines the rotation configuration for this secret. Defined below.

    secretId string

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

    rotation_enabled bool

    Specifies whether automatic rotation is enabled for this secret.

    rotation_lambda_arn str

    Specifies the ARN of the Lambda function that can rotate the secret.

    rotation_rules SecretRotationRotationRulesArgs

    A structure that defines the rotation configuration for this secret. Defined below.

    secret_id str

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

    rotationEnabled Boolean

    Specifies whether automatic rotation is enabled for this secret.

    rotationLambdaArn String

    Specifies the ARN of the Lambda function that can rotate the secret.

    rotationRules Property Map

    A structure that defines the rotation configuration for this secret. Defined below.

    secretId String

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

    Supporting Types

    SecretRotationRotationRules, SecretRotationRotationRulesArgs

    AutomaticallyAfterDays int

    Specifies the number of days between automatic scheduled rotations of the secret. Either automatically_after_days or schedule_expression must be specified.

    Duration string

    The length of the rotation window in hours. For example, 3h for a three hour window.

    ScheduleExpression string

    A cron() or rate() expression that defines the schedule for rotating your secret. Either automatically_after_days or schedule_expression must be specified.

    AutomaticallyAfterDays int

    Specifies the number of days between automatic scheduled rotations of the secret. Either automatically_after_days or schedule_expression must be specified.

    Duration string

    The length of the rotation window in hours. For example, 3h for a three hour window.

    ScheduleExpression string

    A cron() or rate() expression that defines the schedule for rotating your secret. Either automatically_after_days or schedule_expression must be specified.

    automaticallyAfterDays Integer

    Specifies the number of days between automatic scheduled rotations of the secret. Either automatically_after_days or schedule_expression must be specified.

    duration String

    The length of the rotation window in hours. For example, 3h for a three hour window.

    scheduleExpression String

    A cron() or rate() expression that defines the schedule for rotating your secret. Either automatically_after_days or schedule_expression must be specified.

    automaticallyAfterDays number

    Specifies the number of days between automatic scheduled rotations of the secret. Either automatically_after_days or schedule_expression must be specified.

    duration string

    The length of the rotation window in hours. For example, 3h for a three hour window.

    scheduleExpression string

    A cron() or rate() expression that defines the schedule for rotating your secret. Either automatically_after_days or schedule_expression must be specified.

    automatically_after_days int

    Specifies the number of days between automatic scheduled rotations of the secret. Either automatically_after_days or schedule_expression must be specified.

    duration str

    The length of the rotation window in hours. For example, 3h for a three hour window.

    schedule_expression str

    A cron() or rate() expression that defines the schedule for rotating your secret. Either automatically_after_days or schedule_expression must be specified.

    automaticallyAfterDays Number

    Specifies the number of days between automatic scheduled rotations of the secret. Either automatically_after_days or schedule_expression must be specified.

    duration String

    The length of the rotation window in hours. For example, 3h for a three hour window.

    scheduleExpression String

    A cron() or rate() expression that defines the schedule for rotating your secret. Either automatically_after_days or schedule_expression must be specified.

    Import

    Using pulumi import, import aws_secretsmanager_secret_rotation 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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi
    pulumi/pulumi-aws