Interface CfnRotationScheduleProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRotationScheduleProps.Jsii$Proxy
CfnRotationSchedule
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.secretsmanager.*; CfnRotationScheduleProps cfnRotationScheduleProps = CfnRotationScheduleProps.builder() .secretId("secretId") // the properties below are optional .hostedRotationLambda(HostedRotationLambdaProperty.builder() .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") .build()) .rotateImmediatelyOnUpdate(false) .rotationLambdaArn("rotationLambdaArn") .rotationRules(RotationRulesProperty.builder() .automaticallyAfterDays(123) .duration("duration") .scheduleExpression("scheduleExpression") .build()) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnRotationScheduleProps
static final class
An implementation forCfnRotationScheduleProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates .default Object
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.default String
The ARN of an existing Lambda rotation function.default Object
A structure that defines the rotation configuration for this secret.The ARN or name of the secret to rotate.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getSecretId
The ARN or name of the secret to rotate.To reference a secret also created in this template, use the Ref function with the secret's logical ID.
-
getHostedRotationLambda
Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates . To use a rotation function that already exists, specifyRotationLambdaARN
instead.For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .
-
getRotateImmediatelyOnUpdate
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.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 anAWSPENDING
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 .
-
getRotationLambdaArn
The ARN of an existing Lambda rotation function.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 .
To create a new rotation function based on one of the Secrets Manager rotation function templates , specify
HostedRotationLambda
instead. -
getRotationRules
A structure that defines the rotation configuration for this secret. -
builder
- Returns:
- a
CfnRotationScheduleProps.Builder
ofCfnRotationScheduleProps
-