Header menu logo FsCDK

KMSKeyConfig Type

High-level KMS Key builder following AWS security best practices. **Default Security Settings:** - Key rotation = enabled (automatic yearly rotation) - Removal policy = RETAIN (prevents accidental key deletion) - Key spec = SYMMETRIC_DEFAULT (AES-256-GCM) - Key usage = ENCRYPT_DECRYPT **Rationale:** These defaults follow AWS Well-Architected Framework: - Automatic rotation reduces risk of key compromise - Retained keys prevent data loss (encrypted data becomes unreadable without key) - Symmetric encryption is most common use case - CloudTrail provides audit trails for all key usage **Use Cases:** - Encrypt data at rest (S3, EBS, RDS, DynamoDB) - Encrypt secrets (Secrets Manager, Parameter Store) - Sign and verify (asymmetric keys) - Generate HMACs **Escape Hatch:** Access the underlying CDK Key via the `Key` property on the returned resource for advanced scenarios not covered by this builder.

Record fields

Record Field Description

AdmissionPrincipal

Full Usage: AdmissionPrincipal

Field type: IPrincipal option
Field type: IPrincipal option

Alias

Full Usage: Alias

Field type: string option
Field type: string option

ConstructId

Full Usage: ConstructId

Field type: string option
Field type: string option

Description

Full Usage: Description

Field type: string option
Field type: string option

EnableKeyRotation

Full Usage: EnableKeyRotation

Field type: bool option
Field type: bool option

Enabled

Full Usage: Enabled

Field type: bool option
Field type: bool option

KeyName

Full Usage: KeyName

Field type: string
Field type: string

KeySpec

Full Usage: KeySpec

Field type: KeySpec option
Field type: KeySpec option

KeyUsage

Full Usage: KeyUsage

Field type: KeyUsage option
Field type: KeyUsage option

PendingWindow

Full Usage: PendingWindow

Field type: Duration option
Field type: Duration option

Policy

Full Usage: Policy

Field type: PolicyDocument option
Field type: PolicyDocument option

RemovalPolicy

Full Usage: RemovalPolicy

Field type: RemovalPolicy option
Field type: RemovalPolicy option

Type something to start searching.