Interface IRotationScheduleProps
Construction properties for a RotationSchedule.
Inherited Members
Namespace: Amazon.CDK.AWS.SecretsManager
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IRotationScheduleProps : IRotationScheduleOptions
Syntax (vb)
Public Interface IRotationScheduleProps
Inherits IRotationScheduleOptions
Remarks
ExampleMetadata: fixture=_generated
Examples
// 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_
};
Synopsis
Properties
Secret | The secret to rotate. |
Properties
Secret
The secret to rotate.
ISecret Secret { get; }
Property Value
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
.