software.amazon.awscdk.services.secretsmanager

Class RotationSchedule.Builder

java.lang.Object

software.amazon.awscdk.services.secretsmanager.RotationSchedule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RotationSchedule>

Enclosing class:

RotationSchedule

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

A fluent builder for RotationSchedule.

Method Summary

Modifier and Type	Method and Description
RotationSchedule.Builder	automaticallyAfter(Duration automaticallyAfter) Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.
RotationSchedule	build()
static RotationSchedule.Builder	create(software.constructs.Construct scope, String id)
RotationSchedule.Builder	hostedRotation(HostedRotation hostedRotation) Hosted rotation.
RotationSchedule.Builder	rotationLambda(IFunction rotationLambda) A Lambda function that can rotate the secret.
RotationSchedule.Builder	secret(ISecret secret) 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 RotationSchedule.Builder create(software.constructs.Construct scope,
                                                                       String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of RotationSchedule.Builder.

automaticallyAfter

@Stability(value=Stable)
public RotationSchedule.Builder automaticallyAfter(Duration automaticallyAfter)

Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation.

Default: Duration.days(30)

Parameters:

automaticallyAfter - Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation. This parameter is required.

Returns:

this

hostedRotation

@Stability(value=Stable)
public RotationSchedule.Builder hostedRotation(HostedRotation hostedRotation)

Hosted rotation.

Default: - either `rotationLambda` or `hostedRotation` must be specified

Parameters:

hostedRotation - Hosted rotation. This parameter is required.

Returns:

this

rotationLambda

@Stability(value=Stable)
public RotationSchedule.Builder rotationLambda(IFunction rotationLambda)

A Lambda function that can rotate the secret.

Default: - either `rotationLambda` or `hostedRotation` must be specified

Parameters:

rotationLambda - A Lambda function that can rotate the secret. This parameter is required.

Returns:

this

secret

@Stability(value=Stable)
public RotationSchedule.Builder secret(ISecret secret)

The secret to rotate.

If hosted rotation is used, this must be a JSON string with the following format:

 {
    "engine": <required: database engine>,
    "host": <required: instance host name>,
    "username": <required: username>,
    "password": <required: password>,
    "dbname": <optional: database name>,
    "port": <optional: if not specified, default port will be used>,
    "masterarn": <required for multi user rotation: the arn of the master secret which will be used to create users/change passwords>
 }
 

This is typically the case for a secret referenced from an AWS::SecretsManager::SecretTargetAttachment or an ISecret returned by the attach() method of Secret.

Parameters:

secret - The secret to rotate. This parameter is required.

Returns:

this

build

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

Specified by:

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