Class CfnRotationScheduleProps
Properties for defining a CfnRotationSchedule
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.SecretsManager
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRotationScheduleProps : Object, ICfnRotationScheduleProps
Syntax (vb)
Public Class CfnRotationScheduleProps
Inherits Object
Implements ICfnRotationScheduleProps
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.AWS.SecretsManager;
var cfnRotationScheduleProps = new CfnRotationScheduleProps {
SecretId = "secretId",
// the properties below are optional
HostedRotationLambda = new HostedRotationLambdaProperty {
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 = new RotationRulesProperty {
AutomaticallyAfterDays = 123,
Duration = "duration",
ScheduleExpression = "scheduleExpression"
}
};
Synopsis
Constructors
CfnRotationScheduleProps() |
Properties
HostedRotationLambda | 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 |
RotateImmediatelyOnUpdate | Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. |
RotationLambdaArn | The ARN of an existing Lambda rotation function. |
RotationRules | A structure that defines the rotation configuration for this secret. |
SecretId | The ARN or name of the secret to rotate. This is unique for each rotation schedule definition. |
Constructors
CfnRotationScheduleProps()
public CfnRotationScheduleProps()
Properties
HostedRotationLambda
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.
public object HostedRotationLambda { get; set; }
Property Value
System.Object
Remarks
For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .
For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .
RotateImmediatelyOnUpdate
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
public object RotateImmediatelyOnUpdate { get; set; }
Property Value
System.Object
Remarks
The rotation schedule is defined in RotationRules
.
If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret
step of the Lambda rotation function. The test creates an AWSPENDING
version of the secret and then removes it.
If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.
Rotation is an asynchronous process. For more information, see How rotation works .
RotationLambdaArn
The ARN of an existing Lambda rotation function.
public string RotationLambdaArn { get; set; }
Property Value
System.String
Remarks
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
A structure that defines the rotation configuration for this secret.
public object RotationRules { get; set; }
Property Value
System.Object
Remarks
SecretId
The ARN or name of the secret to rotate. This is unique for each rotation schedule definition.
public string SecretId { get; set; }
Property Value
System.String
Remarks
To reference a secret also created in this template, use the Ref function with the secret's logical ID.