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.29.0 (build 41df200)",
           date="2021-06-02T09:55:48.019Z")
 @Stability(value=Experimental)
public interface SecretProps
extends software.amazon.jsii.JsiiSerializable

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

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() (experimental) An optional, human-friendly description of the secret.
default IKey	getEncryptionKey() (experimental) The customer-managed encryption key to use for encrypting the secret value.
default SecretStringGenerator	getGenerateSecretString() (experimental) Configuration for how to generate a secret value.
default RemovalPolicy	getRemovalPolicy() (experimental) Policy to apply when the secret is removed from this stack.
default List<ReplicaRegion>	getReplicaRegions() (experimental) A list of regions where to replicate this secret.
default String	getSecretName() (experimental) A name for the secret.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

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

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

Default: - No description.

getEncryptionKey

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

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

getGenerateSecretString

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

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

getRemovalPolicy

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

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

Default: - Not set.

getReplicaRegions

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

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

Default: - Secret is not replicated

getSecretName

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

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

builder

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

Returns:

a SecretProps.Builder of SecretProps