software.amazon.awscdk.services.secretsmanager

Interface SecretProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SecretProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:19.215Z")
 @Stability(value=Stable)
public interface SecretProps
extends software.amazon.jsii.JsiiSerializable

The properties required to create a new secret in AWS Secrets Manager.

Example:

 Role role;
 Key key = new Key(this, "KMS");
 Secret secret = Secret.Builder.create(this, "Secret").encryptionKey(key).build();
 secret.grantRead(role);
 secret.grantWrite(role);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SecretProps.Builder A builder for SecretProps
static class	SecretProps.Jsii$Proxy An implementation for SecretProps

Method Summary

Modifier and Type	Method and Description
static SecretProps.Builder	builder()
default String	getDescription() An optional, human-friendly description of the secret.
default IKey	getEncryptionKey() The customer-managed encryption key to use for encrypting the secret value.
default SecretStringGenerator	getGenerateSecretString() Configuration for how to generate a secret value.
default RemovalPolicy	getRemovalPolicy() Policy to apply when the secret is removed from this stack.
default List<ReplicaRegion>	getReplicaRegions() A list of regions where to replicate this secret.
default String	getSecretName() A name for the secret.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

An optional, human-friendly description of the secret.

Default: - No description.

getEncryptionKey

@Stability(value=Stable)
 @Nullable
default IKey getEncryptionKey()

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

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

getGenerateSecretString

@Stability(value=Stable)
 @Nullable
default SecretStringGenerator getGenerateSecretString()

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

getRemovalPolicy

@Stability(value=Stable)
 @Nullable
default RemovalPolicy getRemovalPolicy()

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

Default: - Not set.

getReplicaRegions

@Stability(value=Stable)
 @Nullable
default List<ReplicaRegion> getReplicaRegions()

A list of regions where to replicate this secret.

Default: - Secret is not replicated

getSecretName

@Stability(value=Stable)
 @Nullable
default String getSecretName()

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.

builder

@Stability(value=Stable)
static SecretProps.Builder builder()

Returns:

a SecretProps.Builder of SecretProps