public static final class CfnRotationSchedule.Builder
extends java.lang.Object
CfnRotationSchedule
.Modifier and Type | Method and Description |
---|---|
CfnRotationSchedule |
build() |
static CfnRotationSchedule.Builder |
create(Construct scope,
java.lang.String id) |
CfnRotationSchedule.Builder |
hostedRotationLambda(CfnRotationSchedule.HostedRotationLambdaProperty hostedRotationLambda)
Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) .
|
CfnRotationSchedule.Builder |
hostedRotationLambda(IResolvable hostedRotationLambda)
Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) .
|
CfnRotationSchedule.Builder |
rotateImmediatelyOnUpdate(java.lang.Boolean rotateImmediatelyOnUpdate)
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
|
CfnRotationSchedule.Builder |
rotateImmediatelyOnUpdate(IResolvable rotateImmediatelyOnUpdate)
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window.
|
CfnRotationSchedule.Builder |
rotationLambdaArn(java.lang.String rotationLambdaArn)
The ARN of an existing Lambda rotation function.
|
CfnRotationSchedule.Builder |
rotationRules(CfnRotationSchedule.RotationRulesProperty rotationRules)
A structure that defines the rotation configuration for this secret.
|
CfnRotationSchedule.Builder |
rotationRules(IResolvable rotationRules)
A structure that defines the rotation configuration for this secret.
|
CfnRotationSchedule.Builder |
secretId(java.lang.String secretId)
The ARN or name of the secret to rotate.
|
public static CfnRotationSchedule.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnRotationSchedule.HostedRotationLambdaProperty.Builder
.public CfnRotationSchedule.Builder secretId(java.lang.String secretId)
To reference a secret also created in this template, use the Ref function with the secret's logical ID.
secretId
- The ARN or name of the secret to rotate. This parameter is required.this
public CfnRotationSchedule.Builder hostedRotationLambda(CfnRotationSchedule.HostedRotationLambdaProperty hostedRotationLambda)
For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .
hostedRotationLambda
- Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) . To use a rotation function that already exists, specify `RotationLambdaARN` instead. This parameter is required.this
public CfnRotationSchedule.Builder hostedRotationLambda(IResolvable hostedRotationLambda)
For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .
hostedRotationLambda
- Creates a new Lambda rotation function based on one of the [Secrets Manager rotation function templates](https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_available-rotation-templates.html) . To use a rotation function that already exists, specify `RotationLambdaARN` instead. This parameter is required.this
public CfnRotationSchedule.Builder rotateImmediatelyOnUpdate(java.lang.Boolean rotateImmediatelyOnUpdate)
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 .
rotateImmediatelyOnUpdate
- Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. This parameter is required.this
public CfnRotationSchedule.Builder rotateImmediatelyOnUpdate(IResolvable rotateImmediatelyOnUpdate)
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 .
rotateImmediatelyOnUpdate
- Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. This parameter is required.this
public CfnRotationSchedule.Builder rotationLambdaArn(java.lang.String rotationLambdaArn)
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.
rotationLambdaArn
- The ARN of an existing Lambda rotation function. This parameter is required.this
public CfnRotationSchedule.Builder rotationRules(IResolvable rotationRules)
rotationRules
- A structure that defines the rotation configuration for this secret. This parameter is required.this
public CfnRotationSchedule.Builder rotationRules(CfnRotationSchedule.RotationRulesProperty rotationRules)
rotationRules
- A structure that defines the rotation configuration for this secret. This parameter is required.this
public CfnRotationSchedule build()