class CfnRotationSchedule (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.SecretsManager.CfnRotationSchedule`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssecretsmanager#CfnRotationSchedule`
Java	`software.amazon.awscdk.services.secretsmanager.CfnRotationSchedule`
Python	`aws_cdk.aws_secretsmanager.CfnRotationSchedule`
TypeScript	`aws-cdk-lib` » `aws_secretsmanager` » `CfnRotationSchedule`

Implements IConstruct, IDependable, IInspectable

Configure the rotation schedule and Lambda rotation function for a secret. For more information, see How rotation works .

For database credentials, refer to the following resources:

Amazon RDS master user credentials: AWS::RDS::DBCluster MasterUserSecret
Amazon Redshift admin user credentials: AWS::Redshift::Cluster

Choose one of the following options for the rotation function:

Create a new rotation function using HostedRotationLambda based on a Secrets Manager rotation function template .
Use an existing rotation function by specifying its ARN with RotationLambdaARN .

For database secrets defined in the same AWS CloudFormation template as the database or service:

Use the AWS::SecretsManager::SecretTargetAttachment resource to populate the secret with connection details.

Add a DependsOn attribute to the RotationSchedule resource that uses a SecretTargetAttachment . This ensures the rotation is configured after the secret is populated with connection details. > You can define only one rotation schedule per secret.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_secretsmanager as secretsmanager } from 'aws-cdk-lib';
const cfnRotationSchedule = new secretsmanager.CfnRotationSchedule(this, 'MyCfnRotationSchedule', {
  secretId: 'secretId',

  // the properties below are optional
  hostedRotationLambda: {
    rotationType: 'rotationType',

    // the properties below are optional
    excludeCharacters: 'excludeCharacters',
    kmsKeyArn: 'kmsKeyArn',
    masterSecretArn: 'masterSecretArn',
    masterSecretKmsKeyArn: 'masterSecretKmsKeyArn',
    rotationLambdaName: 'rotationLambdaName',
    runtime: 'runtime',
    superuserSecretArn: 'superuserSecretArn',
    superuserSecretKmsKeyArn: 'superuserSecretKmsKeyArn',
    vpcSecurityGroupIds: 'vpcSecurityGroupIds',
    vpcSubnetIds: 'vpcSubnetIds',
  },
  rotateImmediatelyOnUpdate: false,
  rotationLambdaArn: 'rotationLambdaArn',
  rotationRules: {
    automaticallyAfterDays: 123,
    duration: 'duration',
    scheduleExpression: 'scheduleExpression',
  },
});

Initializer

new CfnRotationSchedule(scope: Construct, id: string, props: CfnRotationScheduleProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnRotationScheduleProps — Resource properties.

Construct Props

Name	Type	Description
secretId	`string`	The ARN or name of the secret to rotate. This is unique for each rotation schedule definition.
hostedRotationLambda?	`IResolvable` `\|` `HostedRotationLambdaProperty`	Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates . To use a rotation function that already exists, specify `RotationLambdaARN` instead.
rotateImmediatelyOnUpdate?	`boolean \|` `IResolvable`	Determines whether to rotate the secret immediately or wait until the next scheduled rotation window when the rotation schedule is updated.
rotationLambdaArn?	`string`	The ARN of an existing Lambda rotation function.
rotationRules?	`IResolvable` `\|` `RotationRulesProperty`	A structure that defines the rotation configuration for this secret.

secretId

Type: string

The ARN or name of the secret to rotate. This is unique for each rotation schedule definition.

To reference a secret also created in this template, use the Ref function with the secret's logical ID.

hostedRotationLambda?

Type: IResolvable | HostedRotationLambdaProperty (optional)

Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates . To use a rotation function that already exists, specify RotationLambdaARN instead.

You must specify Transform: AWS::SecretsManager-2024-09-16 at the beginning of the CloudFormation template. Transforms are macros hosted by AWS CloudFormation that help you create and manage complex infrastructure. The Transform: AWS::SecretsManager-2024-09-16 transform automatically extends the CloudFormation stack to include a nested stack (of type AWS::CloudFormation::Stack ), which then creates and updates on your behalf during subsequent stack operations, the appropriate rotation Lambda function for your database or service. For general information on transforms, see the AWS CloudFormation documentation.

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

rotateImmediatelyOnUpdate?

Type: boolean | IResolvable (optional)

Determines whether to rotate the secret immediately or wait until the next scheduled rotation window when the rotation schedule is updated.

The rotation schedule is defined in RotationRules .

The default for RotateImmediatelyOnUpdate is true . If you don't specify this value, Secrets Manager rotates the secret immediately.

If you set RotateImmediatelyOnUpdate to false , Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. This test creates an AWSPENDING version of the secret and then removes it.

When changing an existing rotation schedule and setting RotateImmediatelyOnUpdate to false :

If using AutomaticallyAfterDays or a ScheduleExpression with rate() , the previously scheduled rotation might still occur.

To prevent unintended rotations, use a ScheduleExpression with cron() for granular control over rotation windows.

Rotation is an asynchronous process. For more information, see How rotation works .

rotationLambdaArn?

Type: string (optional)

The ARN of an existing Lambda rotation function.

To specify a rotation function that is also defined in this template, use the Ref function.

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

To create a new rotation function based on one of the Secrets Manager rotation function templates , specify HostedRotationLambda instead.

rotationRules?

Type: IResolvable | RotationRulesProperty (optional)

A structure that defines the rotation configuration for this secret.

Properties

Name	Type	Description
attrId	`string`	The ARN of the secret.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
secretId	`string`	The ARN or name of the secret to rotate.
stack	`Stack`	The stack in which this element is defined.
hostedRotationLambda?	`IResolvable` `\|` `HostedRotationLambdaProperty`	Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates . To use a rotation function that already exists, specify `RotationLambdaARN` instead.
rotateImmediatelyOnUpdate?	`boolean \|` `IResolvable`	Determines whether to rotate the secret immediately or wait until the next scheduled rotation window when the rotation schedule is updated.
rotationLambdaArn?	`string`	The ARN of an existing Lambda rotation function.
rotationRules?	`IResolvable` `\|` `RotationRulesProperty`	A structure that defines the rotation configuration for this secret.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrId

Type: string

The ARN of the secret.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

secretId

Type: string

The ARN or name of the secret to rotate.

This is unique for each rotation schedule definition.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

hostedRotationLambda?

Type: IResolvable | HostedRotationLambdaProperty (optional)

Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates . To use a rotation function that already exists, specify RotationLambdaARN instead.

rotateImmediatelyOnUpdate?

Type: boolean | IResolvable (optional)

Determines whether to rotate the secret immediately or wait until the next scheduled rotation window when the rotation schedule is updated.

rotationLambdaArn?

Type: string (optional)

The ARN of an existing Lambda rotation function.

rotationRules?

Type: IResolvable | RotationRulesProperty (optional)

A structure that defines the rotation configuration for this secret.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }