software.amazon.awscdk.services.secretsmanager

Class Secret.Builder

java.lang.Object

software.amazon.awscdk.services.secretsmanager.Secret.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Secret>

Enclosing class:

Secret

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

(experimental) A fluent builder for Secret.

Method Summary

Modifier and Type	Method and Description
Secret	build()
static Secret.Builder	create(software.constructs.Construct scope, String id)
Secret.Builder	description(String description) (experimental) An optional, human-friendly description of the secret.
Secret.Builder	encryptionKey(IKey encryptionKey) (experimental) The customer-managed encryption key to use for encrypting the secret value.
Secret.Builder	generateSecretString(SecretStringGenerator generateSecretString) (experimental) Configuration for how to generate a secret value.
Secret.Builder	removalPolicy(RemovalPolicy removalPolicy) (experimental) Policy to apply when the secret is removed from this stack.
Secret.Builder	replicaRegions(List<? extends ReplicaRegion> replicaRegions) (experimental) A list of regions where to replicate this secret.
Secret.Builder	secretName(String secretName) (experimental) A name for the secret.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static Secret.Builder create(software.constructs.Construct scope,
                                                                   String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Secret.Builder.

description

@Stability(value=Experimental)
public Secret.Builder description(String description)

(experimental) An optional, human-friendly description of the secret.

Default: - No description.

Parameters:

description - An optional, human-friendly description of the secret. This parameter is required.

Returns:

this

encryptionKey

@Stability(value=Experimental)
public Secret.Builder encryptionKey(IKey encryptionKey)

(experimental) The customer-managed encryption key to use for encrypting the secret value.

Default: - A default KMS key for the account and region is used.

Parameters:

encryptionKey - The customer-managed encryption key to use for encrypting the secret value. This parameter is required.

Returns:

this

generateSecretString

@Stability(value=Experimental)
public Secret.Builder generateSecretString(SecretStringGenerator generateSecretString)

(experimental) Configuration for how to generate a secret value.

Default: - 32 characters with upper-case letters, lower-case letters, punctuation and numbers (at least one from each category), per the default values of ``SecretStringGenerator``.

Parameters:

generateSecretString - Configuration for how to generate a secret value. This parameter is required.

Returns:

this

removalPolicy

@Stability(value=Experimental)
public Secret.Builder removalPolicy(RemovalPolicy removalPolicy)

(experimental) Policy to apply when the secret is removed from this stack.

Default: - Not set.

Parameters:

removalPolicy - Policy to apply when the secret is removed from this stack. This parameter is required.

Returns:

this

replicaRegions

@Stability(value=Experimental)
public Secret.Builder replicaRegions(List<? extends ReplicaRegion> replicaRegions)

(experimental) A list of regions where to replicate this secret.

Default: - Secret is not replicated

Parameters:

replicaRegions - A list of regions where to replicate this secret. This parameter is required.

Returns:

this

secretName

@Stability(value=Experimental)
public Secret.Builder secretName(String secretName)

(experimental) A name for the secret.

Note that deleting secrets from SecretsManager does not happen immediately, but after a 7 to 30 days blackout period. During that period, it is not possible to create another secret that shares the same name.

Default: - A name is generated by CloudFormation.

Parameters:

secretName - A name for the secret. This parameter is required.

Returns:

this

build

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

Specified by:

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