software.amazon.awscdk.services.secretsmanager

Class CfnRotationSchedule.Builder

java.lang.Object

software.amazon.awscdk.services.secretsmanager.CfnRotationSchedule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRotationSchedule>

Enclosing class:

CfnRotationSchedule

@Stability(value=Stable)
public static final class CfnRotationSchedule.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRotationSchedule>

A fluent builder for CfnRotationSchedule.

Method Summary

Modifier and Type	Method and Description
CfnRotationSchedule	build()
static CfnRotationSchedule.Builder	create(software.constructs.Construct scope, String id)
CfnRotationSchedule.Builder	hostedRotationLambda(CfnRotationSchedule.HostedRotationLambdaProperty hostedRotationLambda) To use these values, you must specify `Transform: AWS::SecretsManager-2020-07-23` at the beginning of the CloudFormation template.
CfnRotationSchedule.Builder	hostedRotationLambda(IResolvable hostedRotationLambda) To use these values, you must specify `Transform: AWS::SecretsManager-2020-07-23` at the beginning of the CloudFormation template.
CfnRotationSchedule.Builder	rotateImmediatelyOnUpdate(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(String rotationLambdaArn) The ARN of the Lambda function that can rotate the secret.
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(String secretId) The ARN or name of the secret to rotate.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnRotationSchedule.Builder create(software.constructs.Construct scope,
                                                                          String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnRotationSchedule.HostedRotationLambdaProperty.Builder.

secretId

@Stability(value=Stable)
public CfnRotationSchedule.Builder secretId(String secretId)

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.

Parameters:

secretId - The ARN or name of the secret to rotate. This parameter is required.

Returns:

this

hostedRotationLambda

@Stability(value=Stable)
public CfnRotationSchedule.Builder hostedRotationLambda(CfnRotationSchedule.HostedRotationLambdaProperty hostedRotationLambda)

To use these values, you must specify `Transform: AWS::SecretsManager-2020-07-23` at the beginning of the CloudFormation template.

When you enter valid values for RotationSchedule.HostedRotationLambda , Secrets Manager launches a Lambda that performs rotation on the secret specified in the secret-id property. The template creates a Lambda as part of a nested stack within the current stack.

Parameters:

hostedRotationLambda - To use these values, you must specify `Transform: AWS::SecretsManager-2020-07-23` at the beginning of the CloudFormation template. This parameter is required.

Returns:

this

hostedRotationLambda

@Stability(value=Stable)
public CfnRotationSchedule.Builder hostedRotationLambda(IResolvable hostedRotationLambda)

To use these values, you must specify `Transform: AWS::SecretsManager-2020-07-23` at the beginning of the CloudFormation template.

When you enter valid values for RotationSchedule.HostedRotationLambda , Secrets Manager launches a Lambda that performs rotation on the secret specified in the secret-id property. The template creates a Lambda as part of a nested stack within the current stack.

Parameters:

hostedRotationLambda - To use these values, you must specify `Transform: AWS::SecretsManager-2020-07-23` at the beginning of the CloudFormation template. This parameter is required.

Returns:

this

rotateImmediatelyOnUpdate

@Stability(value=Stable)
public CfnRotationSchedule.Builder rotateImmediatelyOnUpdate(Boolean 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.

Parameters:

rotateImmediatelyOnUpdate - Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. This parameter is required.

Returns:

this

rotateImmediatelyOnUpdate

@Stability(value=Stable)
public CfnRotationSchedule.Builder rotateImmediatelyOnUpdate(IResolvable 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.

Parameters:

rotateImmediatelyOnUpdate - Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. This parameter is required.

Returns:

this

rotationLambdaArn

@Stability(value=Stable)
public CfnRotationSchedule.Builder rotationLambdaArn(String rotationLambdaArn)

The ARN of the Lambda function that can rotate the secret.

If you don't specify this parameter, then the secret must already have the ARN of a Lambda function configured.

To reference a Lambda function also created in this template, use the Ref function with the function's logical ID.

Parameters:

rotationLambdaArn - The ARN of the Lambda function that can rotate the secret. This parameter is required.

Returns:

this

rotationRules

@Stability(value=Stable)
public CfnRotationSchedule.Builder rotationRules(CfnRotationSchedule.RotationRulesProperty rotationRules)

A structure that defines the rotation configuration for this secret.

Parameters:

rotationRules - A structure that defines the rotation configuration for this secret. This parameter is required.

Returns:

this

rotationRules

@Stability(value=Stable)
public CfnRotationSchedule.Builder rotationRules(IResolvable rotationRules)

A structure that defines the rotation configuration for this secret.

Parameters:

rotationRules - A structure that defines the rotation configuration for this secret. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnRotationSchedule build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnRotationSchedule>