Interface IRotationScheduleProps

Namespace

Amazon.CDK.AWS.SecretsManager

Assembly

Amazon.CDK.AWS.SecretsManager.dll

Construction properties for a RotationSchedule.

public interface IRotationScheduleProps : IRotationScheduleOptions

Inherited Members

IRotationScheduleOptions.AutomaticallyAfter

IRotationScheduleOptions.HostedRotation

IRotationScheduleOptions.RotationLambda

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.Lambda;
            using Amazon.CDK.AWS.SecretsManager;
            using Amazon.CDK;

            Function function_;
            HostedRotation hostedRotation;
            Secret secret;
            var rotationScheduleProps = new RotationScheduleProps {
                Secret = secret,

                // the properties below are optional
                AutomaticallyAfter = Duration.Minutes(30),
                HostedRotation = hostedRotation,
                RotationLambda = function_
            };

Remarks

ExampleMetadata: fixture=_generated

Properties

Secret

The secret to rotate.

ISecret Secret { get; }

Property Value

ISecret

Remarks

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.