Package 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(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	Description
CfnRotationSchedule	build()
static CfnRotationSchedule.Builder	create(software.constructs.Construct scope, String id)
CfnRotationSchedule.Builder	externalSecretRotationMetadata(List<? extends Object> externalSecretRotationMetadata)	The list of metadata needed to successfully rotate a managed external secret.
CfnRotationSchedule.Builder	externalSecretRotationMetadata(IResolvable externalSecretRotationMetadata)	The list of metadata needed to successfully rotate a managed external secret.
CfnRotationSchedule.Builder	externalSecretRotationRoleArn(String externalSecretRotationRoleArn)	The ARN of the IAM role that is used by Secrets Manager to rotate a managed external secret.
CfnRotationSchedule.Builder	hostedRotationLambda(IResolvable hostedRotationLambda)	Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates .
CfnRotationSchedule.Builder	hostedRotationLambda(CfnRotationSchedule.HostedRotationLambdaProperty hostedRotationLambda)	Creates a new Lambda rotation function based on one of the Secrets Manager rotation function templates .
CfnRotationSchedule.Builder	rotateImmediatelyOnUpdate(Boolean rotateImmediatelyOnUpdate)	Determines whether to rotate the secret immediately or wait until the next scheduled rotation window when the rotation schedule is updated.
CfnRotationSchedule.Builder	rotateImmediatelyOnUpdate(IResolvable rotateImmediatelyOnUpdate)	Determines whether to rotate the secret immediately or wait until the next scheduled rotation window when the rotation schedule is updated.
CfnRotationSchedule.Builder	rotationLambdaArn(String rotationLambdaArn)	The ARN of an existing Lambda rotation function.
CfnRotationSchedule.Builder	rotationRules(IResolvable rotationRules)	A structure that defines the rotation configuration for this secret.
CfnRotationSchedule.Builder	rotationRules(CfnRotationSchedule.RotationRulesProperty 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 Details

create

@Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnRotationSchedule.Builder.

secretId

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

The ARN or name of the secret to rotate. This is unique for each rotation schedule definition.

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 is unique for each rotation schedule definition. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-secretid

externalSecretRotationMetadata

@Stability(Stable)
public CfnRotationSchedule.Builder externalSecretRotationMetadata(IResolvable externalSecretRotationMetadata)

The list of metadata needed to successfully rotate a managed external secret.

Parameters:

externalSecretRotationMetadata - The list of metadata needed to successfully rotate a managed external secret. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-externalsecretrotationmetadata

externalSecretRotationMetadata

@Stability(Stable)
public CfnRotationSchedule.Builder externalSecretRotationMetadata(List<? extends Object> externalSecretRotationMetadata)

The list of metadata needed to successfully rotate a managed external secret.

Parameters:

externalSecretRotationMetadata - The list of metadata needed to successfully rotate a managed external secret. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-externalsecretrotationmetadata

externalSecretRotationRoleArn

@Stability(Stable)
public CfnRotationSchedule.Builder externalSecretRotationRoleArn(String externalSecretRotationRoleArn)

The ARN of the IAM role that is used by Secrets Manager to rotate a managed external secret.

Parameters:

externalSecretRotationRoleArn - The ARN of the IAM role that is used by Secrets Manager to rotate a managed external secret. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-externalsecretrotationrolearn

hostedRotationLambda

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

You must specify Transform: AWS::SecretsManager-2024-09-16 at the beginning of the CloudFormation template. Transforms are macros hosted by AWS CloudFormation that help you create and manage complex infrastructure. The Transform: AWS::SecretsManager-2024-09-16 transform automatically extends the CloudFormation stack to include a nested stack (of type AWS::CloudFormation::Stack ), which then creates and updates on your behalf during subsequent stack operations, the appropriate rotation Lambda function for your database or service. For general information on transforms, see the AWS CloudFormation documentation.

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

Parameters:

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda

hostedRotationLambda

@Stability(Stable)
public CfnRotationSchedule.Builder hostedRotationLambda(CfnRotationSchedule.HostedRotationLambdaProperty 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.

You must specify Transform: AWS::SecretsManager-2024-09-16 at the beginning of the CloudFormation template. Transforms are macros hosted by AWS CloudFormation that help you create and manage complex infrastructure. The Transform: AWS::SecretsManager-2024-09-16 transform automatically extends the CloudFormation stack to include a nested stack (of type AWS::CloudFormation::Stack ), which then creates and updates on your behalf during subsequent stack operations, the appropriate rotation Lambda function for your database or service. For general information on transforms, see the AWS CloudFormation documentation.

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

Parameters:

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-hostedrotationlambda

rotateImmediatelyOnUpdate

@Stability(Stable)
public CfnRotationSchedule.Builder rotateImmediatelyOnUpdate(Boolean rotateImmediatelyOnUpdate)

Determines whether to rotate the secret immediately or wait until the next scheduled rotation window when the rotation schedule is updated.

The rotation schedule is defined in RotationRules .

The default for RotateImmediatelyOnUpdate is true . If you don't specify this value, Secrets Manager rotates the secret immediately.

If you set RotateImmediatelyOnUpdate to false , Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. This test creates an AWSPENDING version of the secret and then removes it.

When changing an existing rotation schedule and setting RotateImmediatelyOnUpdate to false :

• If using AutomaticallyAfterDays or a ScheduleExpression with rate() , the previously scheduled rotation might still occur.
• To prevent unintended rotations, use a ScheduleExpression with cron() for granular control over rotation windows.

Rotation is an asynchronous process. For more information, see How rotation works .

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotateimmediatelyonupdate

rotateImmediatelyOnUpdate

@Stability(Stable)
public CfnRotationSchedule.Builder rotateImmediatelyOnUpdate(IResolvable rotateImmediatelyOnUpdate)

Determines whether to rotate the secret immediately or wait until the next scheduled rotation window when the rotation schedule is updated.

The rotation schedule is defined in RotationRules .

The default for RotateImmediatelyOnUpdate is true . If you don't specify this value, Secrets Manager rotates the secret immediately.

If you set RotateImmediatelyOnUpdate to false , Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. This test creates an AWSPENDING version of the secret and then removes it.

When changing an existing rotation schedule and setting RotateImmediatelyOnUpdate to false :

• If using AutomaticallyAfterDays or a ScheduleExpression with rate() , the previously scheduled rotation might still occur.
• To prevent unintended rotations, use a ScheduleExpression with cron() for granular control over rotation windows.

Rotation is an asynchronous process. For more information, see How rotation works .

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotateimmediatelyonupdate

rotationLambdaArn

@Stability(Stable)
public CfnRotationSchedule.Builder rotationLambdaArn(String 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 .

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.

Parameters:

rotationLambdaArn - The ARN of an existing Lambda rotation function. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotationlambdaarn

rotationRules

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotationrules

rotationRules

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-rotationschedule.html#cfn-secretsmanager-rotationschedule-rotationrules

build

@Stability(Stable)
public CfnRotationSchedule build()

Specified by:

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

Returns:

a newly built instance of CfnRotationSchedule.