Skip to content
v2.278.0

RotationScheduleProps Struct ​

Construction properties for a RotationSchedule.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';
import { aws_secretsmanager as secretsmanager } from 'aws-cdk-lib';

declare const function_: lambda.Function;
declare const hostedRotation: secretsmanager.HostedRotation;
declare const secret: secretsmanager.Secret;
const rotationScheduleProps: secretsmanager.RotationScheduleProps = {
  secret: secret,

  // the properties below are optional
  automaticallyAfter: cdk.Duration.minutes(30),
  hostedRotation: hostedRotation,
  rotateImmediatelyOnUpdate: false,
  rotationLambda: function_,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_lambda as lambda_
from aws_cdk import aws_secretsmanager as secretsmanager

# function_: lambda.Function
# hosted_rotation: secretsmanager.HostedRotation
# secret: secretsmanager.Secret

rotation_schedule_props = secretsmanager.RotationScheduleProps(
    secret=secret,

    # the properties below are optional
    automatically_after=cdk.Duration.minutes(30),
    hosted_rotation=hosted_rotation,
    rotate_immediately_on_update=False,
    rotation_lambda=function_
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.services.secretsmanager.*;

Function function_;
HostedRotation hostedRotation;
Secret secret;

RotationScheduleProps rotationScheduleProps = RotationScheduleProps.builder()
        .secret(secret)

        // the properties below are optional
        .automaticallyAfter(Duration.minutes(30))
        .hostedRotation(hostedRotation)
        .rotateImmediatelyOnUpdate(false)
        .rotationLambda(function_)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Lambda;
using Amazon.CDK.AWS.SecretsManager;

Function function_;
HostedRotation hostedRotation;
Secret secret;

var rotationScheduleProps = new RotationScheduleProps {
    Secret = secret,

    // the properties below are optional
    AutomaticallyAfter = Duration.Minutes(30),
    HostedRotation = hostedRotation,
    RotateImmediatelyOnUpdate = false,
    RotationLambda = function_
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var function_ Function
var hostedRotation HostedRotation
var secret Secret

rotationScheduleProps := &RotationScheduleProps{
	Secret: secret,

	// the properties below are optional
	AutomaticallyAfter: cdk.Duration_Minutes(jsii.Number(30)),
	HostedRotation: hostedRotation,
	RotateImmediatelyOnUpdate: jsii.Boolean(false),
	RotationLambda: function_,
}

Properties ​

automaticallyAfteroptionalDurationautomatically_afteroptionalDurationautomaticallyAfteroptionalDurationAutomaticallyAfteroptionalDurationAutomaticallyAfteroptionalDuration = Duration.days(30) #
Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.

The minimum value is 4 hours. The maximum value is 1000 days.

A value of zero (Duration.days(0)) will not create RotationRules.

hostedRotationoptionalHostedRotationhosted_rotationoptionalHostedRotationhostedRotationoptionalHostedRotationHostedRotationoptionalHostedRotationHostedRotationoptionalHostedRotation #
Hosted rotation.

Default: either rotationLambda or hostedRotation must be specified

rotateImmediatelyOnUpdateoptionalbooleanrotate_immediately_on_updateoptionalboolrotateImmediatelyOnUpdateoptionalBooleanRotateImmediatelyOnUpdateoptionalboolRotateImmediatelyOnUpdateoptional*bool = true #
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
rotationLambdaoptionalIFunctionrotation_lambdaoptionalIFunctionrotationLambdaoptionalIFunctionRotationLambdaoptionalIFunctionRotationLambdaoptionalIFunction #
A Lambda function that can rotate the secret.

Default: either rotationLambda or hostedRotation must be specified

secretISecretsecretISecretsecretISecretSecretISecretSecretISecret required #
The secret to rotate.
notes

If hosted rotation is used, this must be a JSON string with the following format:

{
  "engine": <required: database engine>,
  "host": <required: instance host name>,
  "username": <required: username>,
  "password": <required: password>,
  "dbname": <optional: database name>,
  "port": <optional: if not specified, default port will be used>,
  "masterarn": <required for multi user rotation: the arn of the master secret which will be used to create users/change passwords>
}

This is typically the case for a secret referenced from an AWS::SecretsManager::SecretTargetAttachment or an ISecret returned by the attach() method of Secret.