software.amazon.awscdk.services.secretsmanager

Class CfnRotationScheduleProps.Builder

java.lang.Object

software.amazon.awscdk.services.secretsmanager.CfnRotationScheduleProps.Builder

Enclosing interface:

CfnRotationScheduleProps

public static final class CfnRotationScheduleProps.Builder
extends java.lang.Object

A builder for CfnRotationScheduleProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnRotationScheduleProps	build() Builds the configured instance.
CfnRotationScheduleProps.Builder	hostedRotationLambda(CfnRotationSchedule.HostedRotationLambdaProperty hostedRotationLambda) Sets the value of CfnRotationScheduleProps.getHostedRotationLambda()
CfnRotationScheduleProps.Builder	hostedRotationLambda(IResolvable hostedRotationLambda) Sets the value of CfnRotationScheduleProps.getHostedRotationLambda()
CfnRotationScheduleProps.Builder	rotateImmediatelyOnUpdate(java.lang.Boolean rotateImmediatelyOnUpdate) Sets the value of CfnRotationScheduleProps.getRotateImmediatelyOnUpdate()
CfnRotationScheduleProps.Builder	rotateImmediatelyOnUpdate(IResolvable rotateImmediatelyOnUpdate) Sets the value of CfnRotationScheduleProps.getRotateImmediatelyOnUpdate()
CfnRotationScheduleProps.Builder	rotationLambdaArn(java.lang.String rotationLambdaArn) Sets the value of CfnRotationScheduleProps.getRotationLambdaArn()
CfnRotationScheduleProps.Builder	rotationRules(CfnRotationSchedule.RotationRulesProperty rotationRules) Sets the value of CfnRotationScheduleProps.getRotationRules()
CfnRotationScheduleProps.Builder	rotationRules(IResolvable rotationRules) Sets the value of CfnRotationScheduleProps.getRotationRules()
CfnRotationScheduleProps.Builder	secretId(java.lang.String secretId) Sets the value of CfnRotationScheduleProps.getSecretId()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

secretId

public CfnRotationScheduleProps.Builder secretId(java.lang.String secretId)

Sets the value of CfnRotationScheduleProps.getSecretId()

Parameters:

secretId - The ARN or name of the secret to rotate. This parameter is required. To reference a secret also created in this template, use the Ref function with the secret's logical ID.

Returns:

this

hostedRotationLambda

public CfnRotationScheduleProps.Builder hostedRotationLambda(CfnRotationSchedule.HostedRotationLambdaProperty hostedRotationLambda)

Sets the value of CfnRotationScheduleProps.getHostedRotationLambda()

Parameters:

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. For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

Returns:

this

hostedRotationLambda

public CfnRotationScheduleProps.Builder hostedRotationLambda(IResolvable hostedRotationLambda)

Sets the value of CfnRotationScheduleProps.getHostedRotationLambda()

Parameters:

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. For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

Returns:

this

rotateImmediatelyOnUpdate

public CfnRotationScheduleProps.Builder rotateImmediatelyOnUpdate(java.lang.Boolean rotateImmediatelyOnUpdate)

Sets the value of CfnRotationScheduleProps.getRotateImmediatelyOnUpdate()

Parameters:

rotateImmediatelyOnUpdate - 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 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 .

Returns:

this

rotateImmediatelyOnUpdate

public CfnRotationScheduleProps.Builder rotateImmediatelyOnUpdate(IResolvable rotateImmediatelyOnUpdate)

Sets the value of CfnRotationScheduleProps.getRotateImmediatelyOnUpdate()

Parameters:

rotateImmediatelyOnUpdate - 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 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 .

Returns:

this

rotationLambdaArn

public CfnRotationScheduleProps.Builder rotationLambdaArn(java.lang.String rotationLambdaArn)

Sets the value of CfnRotationScheduleProps.getRotationLambdaArn()

Parameters:

rotationLambdaArn - 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.

Returns:

this

rotationRules

public CfnRotationScheduleProps.Builder rotationRules(IResolvable rotationRules)

Sets the value of CfnRotationScheduleProps.getRotationRules()

Parameters:

rotationRules - A structure that defines the rotation configuration for this secret.

Returns:

this

rotationRules

public CfnRotationScheduleProps.Builder rotationRules(CfnRotationSchedule.RotationRulesProperty rotationRules)

Sets the value of CfnRotationScheduleProps.getRotationRules()

Parameters:

rotationRules - A structure that defines the rotation configuration for this secret.

Returns:

this

build

public CfnRotationScheduleProps build()

Builds the configured instance.

Returns:

a new instance of CfnRotationScheduleProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided