software.amazon.awscdk.services.secretsmanager

Class RotationScheduleProps.Builder

java.lang.Object

software.amazon.awscdk.services.secretsmanager.RotationScheduleProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RotationScheduleProps>

Enclosing interface:

RotationScheduleProps

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

A builder for RotationScheduleProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RotationScheduleProps.Builder	automaticallyAfter(Duration automaticallyAfter) Sets the value of RotationScheduleOptions.getAutomaticallyAfter()
RotationScheduleProps	build() Builds the configured instance.
RotationScheduleProps.Builder	hostedRotation(HostedRotation hostedRotation) Sets the value of RotationScheduleOptions.getHostedRotation()
RotationScheduleProps.Builder	rotationLambda(IFunction rotationLambda) Sets the value of RotationScheduleOptions.getRotationLambda()
RotationScheduleProps.Builder	secret(ISecret secret) Sets the value of RotationScheduleProps.getSecret()

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

secret

@Stability(value=Experimental)
public RotationScheduleProps.Builder secret(ISecret secret)

Sets the value of RotationScheduleProps.getSecret()

Parameters:

secret - The secret to rotate. This parameter is required. 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.

Returns:

this

automaticallyAfter

@Stability(value=Experimental)
public RotationScheduleProps.Builder automaticallyAfter(Duration automaticallyAfter)

Sets the value of RotationScheduleOptions.getAutomaticallyAfter()

Parameters:

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

Returns:

this

hostedRotation

@Stability(value=Experimental)
public RotationScheduleProps.Builder hostedRotation(HostedRotation hostedRotation)

Sets the value of RotationScheduleOptions.getHostedRotation()

Parameters:

hostedRotation - Hosted rotation.

Returns:

this

rotationLambda

@Stability(value=Experimental)
public RotationScheduleProps.Builder rotationLambda(IFunction rotationLambda)

Sets the value of RotationScheduleOptions.getRotationLambda()

Parameters:

rotationLambda - A Lambda function that can rotate the secret.

Returns:

this

build

@Stability(value=Experimental)
public RotationScheduleProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of RotationScheduleProps

Throws:

NullPointerException - if any required attribute was not provided