RotationScheduleOptions

class aws_cdk.aws_secretsmanager.RotationScheduleOptions(*, automatically_after=None, hosted_rotation=None, rotate_immediately_on_update=None, rotation_lambda=None)

Bases: object

Options to add a rotation schedule to a secret.

Parameters:

automatically_after (Optional[Duration]) – 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. Default: Duration.days(30)
hosted_rotation (Optional[HostedRotation]) – Hosted rotation. Default: - either rotationLambda or hostedRotation must be specified
rotate_immediately_on_update (Optional[bool]) – Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. Default: true
rotation_lambda (Optional[IFunction]) – A Lambda function that can rotate the secret. Default: - either rotationLambda or hostedRotation must be specified

ExampleMetadata:

infused

Example:

import aws_cdk.aws_lambda as lambda_

# fn: lambda.Function

secret = secretsmanager.Secret(self, "Secret")

secret.add_rotation_schedule("RotationSchedule",
    rotation_lambda=fn,
    automatically_after=Duration.days(15),
    rotate_immediately_on_update=False
)

Attributes

automatically_after

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.

Default:: Duration.days(30)

hosted_rotation

Hosted rotation.

Default:

either rotationLambda or hostedRotation must be specified

rotate_immediately_on_update

Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.

Default:: true

rotation_lambda

A Lambda function that can rotate the secret.

Default:

either rotationLambda or hostedRotation must be specified