Header menu logo FsCDK

SecretsManagerConfig Type

High-level Secrets Manager Secret builder following AWS security best practices. **Default Security Settings:** - Encryption = KMS with AWS managed key (aws/secretsmanager) - Automatic rotation = disabled (opt-in via rotation operation) - Removal policy = RETAIN (prevents accidental deletion) **Rationale:** These defaults follow AWS Well-Architected Framework: - KMS encryption provides enhanced security and audit trails - Secrets retained on stack deletion prevents data loss - Rotation is opt-in as it requires Lambda function setup **Escape Hatch:** Access the underlying CDK Secret via the `Secret` property on the returned resource for advanced scenarios not covered by this builder.

Record fields

Record Field Description

ConstructId

Full Usage: ConstructId

Field type: string option
Field type: string option

Description

Full Usage: Description

Field type: string option
Field type: string option

EncryptionKey

Full Usage: EncryptionKey

Field type: IKey option
Field type: IKey option

GenerateSecretString

Full Usage: GenerateSecretString

Field type: SecretStringGenerator option
Field type: SecretStringGenerator option

RemovalPolicy

Full Usage: RemovalPolicy

Field type: RemovalPolicy option
Field type: RemovalPolicy option

ReplicaRegions

Full Usage: ReplicaRegions

Field type: ReplicaRegion list option
Field type: ReplicaRegion list option

SecretName

Full Usage: SecretName

Field type: string
Field type: string

SecretStringValue

Full Usage: SecretStringValue

Field type: SecretValue option
Field type: SecretValue option

Type something to start searching.