Package software.amazon.awscdk.services.secretsmanager

Class SecretRotationProps.Builder

java.lang.Object

software.amazon.awscdk.services.secretsmanager.SecretRotationProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SecretRotationProps>

Enclosing interface:

SecretRotationProps

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

A builder for SecretRotationProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SecretRotationProps.Builder	application(SecretRotationApplication application)	Sets the value of SecretRotationProps.getApplication()
SecretRotationProps.Builder	automaticallyAfter(Duration automaticallyAfter)	Sets the value of SecretRotationProps.getAutomaticallyAfter()
SecretRotationProps	build()	Builds the configured instance.
SecretRotationProps.Builder	endpoint(IInterfaceVpcEndpoint endpoint)	Sets the value of SecretRotationProps.getEndpoint()
SecretRotationProps.Builder	excludeCharacters(String excludeCharacters)	Sets the value of SecretRotationProps.getExcludeCharacters()
SecretRotationProps.Builder	masterSecret(ISecret masterSecret)	Sets the value of SecretRotationProps.getMasterSecret()
SecretRotationProps.Builder	rotateImmediatelyOnUpdate(Boolean rotateImmediatelyOnUpdate)	Sets the value of SecretRotationProps.getRotateImmediatelyOnUpdate()
SecretRotationProps.Builder	secret(ISecret secret)	Sets the value of SecretRotationProps.getSecret()
SecretRotationProps.Builder	securityGroup(ISecurityGroup securityGroup)	Sets the value of SecretRotationProps.getSecurityGroup()
SecretRotationProps.Builder	target(IConnectable target)	Sets the value of SecretRotationProps.getTarget()
SecretRotationProps.Builder	vpc(IVpc vpc)	Sets the value of SecretRotationProps.getVpc()
SecretRotationProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of SecretRotationProps.getVpcSubnets()

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

application

@Stability(Stable)
public SecretRotationProps.Builder application(SecretRotationApplication application)

Sets the value of SecretRotationProps.getApplication()

Parameters:

application - The serverless application for the rotation. This parameter is required.

Returns:

this

secret

@Stability(Stable)
public SecretRotationProps.Builder secret(ISecret secret)

Sets the value of SecretRotationProps.getSecret()

Parameters:

secret - The secret to rotate. It must be a JSON string with the following format:. This parameter is required.

               {
                 "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

target

@Stability(Stable)
public SecretRotationProps.Builder target(IConnectable target)

Sets the value of SecretRotationProps.getTarget()

Parameters:

target - The target service or database. This parameter is required.

Returns:

this

vpc

@Stability(Stable)
public SecretRotationProps.Builder vpc(IVpc vpc)

Sets the value of SecretRotationProps.getVpc()

Parameters:

vpc - The VPC where the Lambda rotation function will run. This parameter is required.

Returns:

this

automaticallyAfter

@Stability(Stable)
public SecretRotationProps.Builder automaticallyAfter(Duration automaticallyAfter)

Sets the value of SecretRotationProps.getAutomaticallyAfter()

Parameters:

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

Returns:

this

endpoint

@Stability(Stable)
public SecretRotationProps.Builder endpoint(IInterfaceVpcEndpoint endpoint)

Sets the value of SecretRotationProps.getEndpoint()

Parameters:

endpoint - The VPC interface endpoint to use for the Secrets Manager API. If you enable private DNS hostnames for your VPC private endpoint (the default), you don't need to specify an endpoint. The standard Secrets Manager DNS hostname the Secrets Manager CLI and SDKs use by default (https://secretsmanager..amazonaws.com) automatically resolves to your VPC endpoint.

Returns:

this

excludeCharacters

@Stability(Stable)
public SecretRotationProps.Builder excludeCharacters(String excludeCharacters)

Sets the value of SecretRotationProps.getExcludeCharacters()

Parameters:

excludeCharacters - Characters which should not appear in the generated password.

Returns:

this

masterSecret

@Stability(Stable)
public SecretRotationProps.Builder masterSecret(ISecret masterSecret)

Sets the value of SecretRotationProps.getMasterSecret()

Parameters:

masterSecret - The master secret for a multi user rotation scheme.

Returns:

this

rotateImmediatelyOnUpdate

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

Sets the value of SecretRotationProps.getRotateImmediatelyOnUpdate()

Parameters:

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

Returns:

this

securityGroup

@Stability(Stable)
public SecretRotationProps.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of SecretRotationProps.getSecurityGroup()

Parameters:

securityGroup - The security group for the Lambda rotation function.

Returns:

this

vpcSubnets

@Stability(Stable)
public SecretRotationProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of SecretRotationProps.getVpcSubnets()

Parameters:

vpcSubnets - The type of subnets in the VPC where the Lambda rotation function will run.

Returns:

this

build

@Stability(Stable)
public SecretRotationProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SecretRotationProps

Throws:

NullPointerException - if any required attribute was not provided