RotationSchedule
A rotation schedule.
Import
import { RotationSchedule } from 'aws-cdk-lib/aws-secretsmanager';Or use the module namespace:
import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager';
// secretsmanager.RotationScheduleProperties
Configuration passed to the constructor as RotationScheduleProps.
secretRequiredISecretThe secret to rotate. 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`.
4 properties inherited from RotationScheduleOptions
automaticallyAfterOptionalinherited from RotationScheduleOptionsDurationSpecifies 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)
hostedRotationOptionalinherited from RotationScheduleOptionsHostedRotationHosted rotation.
Default: - either `rotationLambda` or `hostedRotation` must be specified
rotateImmediatelyOnUpdateOptionalinherited from RotationScheduleOptionsbooleanSpecifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
Default: true
rotationLambdaOptionalinherited from RotationScheduleOptionsIFunctionA Lambda function that can rotate the secret.
Default: - either `rotationLambda` or `hostedRotation` must be specified
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-secretsmanager