Package software.amazon.awscdk.cfnpropertymixins.services.secretsmanager

Class CfnRotationScheduleMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.secretsmanager.CfnRotationScheduleMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRotationScheduleMixinProps>

Enclosing interface:

CfnRotationScheduleMixinProps

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

A builder for CfnRotationScheduleMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRotationScheduleMixinProps	build()	Builds the configured instance.
CfnRotationScheduleMixinProps.Builder	externalSecretRotationMetadata(List<? extends Object> externalSecretRotationMetadata)	Sets the value of CfnRotationScheduleMixinProps.getExternalSecretRotationMetadata()
CfnRotationScheduleMixinProps.Builder	externalSecretRotationMetadata(IResolvable externalSecretRotationMetadata)	Sets the value of CfnRotationScheduleMixinProps.getExternalSecretRotationMetadata()
CfnRotationScheduleMixinProps.Builder	externalSecretRotationRoleArn(String externalSecretRotationRoleArn)	Sets the value of CfnRotationScheduleMixinProps.getExternalSecretRotationRoleArn()
CfnRotationScheduleMixinProps.Builder	hostedRotationLambda(CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty hostedRotationLambda)	Sets the value of CfnRotationScheduleMixinProps.getHostedRotationLambda()
CfnRotationScheduleMixinProps.Builder	hostedRotationLambda(IResolvable hostedRotationLambda)	Sets the value of CfnRotationScheduleMixinProps.getHostedRotationLambda()
CfnRotationScheduleMixinProps.Builder	rotateImmediatelyOnUpdate(Boolean rotateImmediatelyOnUpdate)	Sets the value of CfnRotationScheduleMixinProps.getRotateImmediatelyOnUpdate()
CfnRotationScheduleMixinProps.Builder	rotateImmediatelyOnUpdate(IResolvable rotateImmediatelyOnUpdate)	Sets the value of CfnRotationScheduleMixinProps.getRotateImmediatelyOnUpdate()
CfnRotationScheduleMixinProps.Builder	rotationLambdaArn(String rotationLambdaArn)	Sets the value of CfnRotationScheduleMixinProps.getRotationLambdaArn()
CfnRotationScheduleMixinProps.Builder	rotationRules(CfnRotationSchedulePropsMixin.RotationRulesProperty rotationRules)	Sets the value of CfnRotationScheduleMixinProps.getRotationRules()
CfnRotationScheduleMixinProps.Builder	rotationRules(IResolvable rotationRules)	Sets the value of CfnRotationScheduleMixinProps.getRotationRules()
CfnRotationScheduleMixinProps.Builder	secretId(String secretId)	Sets the value of CfnRotationScheduleMixinProps.getSecretId()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

externalSecretRotationMetadata

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

Sets the value of CfnRotationScheduleMixinProps.getExternalSecretRotationMetadata()

Parameters:

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

Returns:

this

externalSecretRotationMetadata

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

Sets the value of CfnRotationScheduleMixinProps.getExternalSecretRotationMetadata()

Parameters:

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

Returns:

this

externalSecretRotationRoleArn

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

Sets the value of CfnRotationScheduleMixinProps.getExternalSecretRotationRoleArn()

Parameters:

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

Returns:

this

hostedRotationLambda

@Stability(Stable)
public CfnRotationScheduleMixinProps.Builder hostedRotationLambda(IResolvable hostedRotationLambda)

Sets the value of CfnRotationScheduleMixinProps.getHostedRotationLambda()

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

Returns:

this

hostedRotationLambda

@Stability(Stable)
public CfnRotationScheduleMixinProps.Builder hostedRotationLambda(CfnRotationSchedulePropsMixin.HostedRotationLambdaProperty hostedRotationLambda)

Sets the value of CfnRotationScheduleMixinProps.getHostedRotationLambda()

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

Returns:

this

rotateImmediatelyOnUpdate

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

Sets the value of CfnRotationScheduleMixinProps.getRotateImmediatelyOnUpdate()

Parameters:

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 .

Returns:

this

rotateImmediatelyOnUpdate

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

Sets the value of CfnRotationScheduleMixinProps.getRotateImmediatelyOnUpdate()

Parameters:

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 .

Returns:

this

rotationLambdaArn

@Stability(Stable)
public CfnRotationScheduleMixinProps.Builder rotationLambdaArn(String rotationLambdaArn)

Sets the value of CfnRotationScheduleMixinProps.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 .

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.

Returns:

this

rotationRules

@Stability(Stable)
public CfnRotationScheduleMixinProps.Builder rotationRules(IResolvable rotationRules)

Sets the value of CfnRotationScheduleMixinProps.getRotationRules()

Parameters:

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

Returns:

this

rotationRules

@Stability(Stable)
public CfnRotationScheduleMixinProps.Builder rotationRules(CfnRotationSchedulePropsMixin.RotationRulesProperty rotationRules)

Sets the value of CfnRotationScheduleMixinProps.getRotationRules()

Parameters:

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

Returns:

this

secretId

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

Sets the value of CfnRotationScheduleMixinProps.getSecretId()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnRotationScheduleMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnRotationScheduleMixinProps

Throws:

NullPointerException - if any required attribute was not provided