Skip to content

Commit 60936f9

Browse files
committed
docs: readme update
Signed-off-by: John C. Bland II <[email protected]>
1 parent 007435b commit 60936f9

File tree

2 files changed

+38
-15
lines changed

2 files changed

+38
-15
lines changed

README.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,18 @@ description: |-
2222
1) Set `s3_force_destroy` to `true` and apply
2323
2) Set `enabled` to `false` and apply, or run `terraform destroy`
2424
25+
## CloudTrail KMS Encryption
26+
27+
By default, this component creates a KMS key to encrypt CloudTrail logs for compliance and security. The KMS encryption can be configured using these variables:
28+
29+
- `cloudtrail_enable_kms_encryption` (default: `true`) - Enable/disable KMS encryption for CloudTrail logs
30+
- `cloudtrail_kms_key_arn` (default: `null`) - Provide an existing KMS key ARN to use instead of creating a new one
31+
- `cloudtrail_create_kms_key` (default: `true`) - Create a new KMS key when `cloudtrail_kms_key_arn` is not provided
32+
- `cloudtrail_kms_key_deletion_window_in_days` (default: `10`) - KMS key deletion window (7-30 days)
33+
- `cloudtrail_kms_key_enable_rotation` (default: `true`) - Enable automatic KMS key rotation
34+
35+
The created KMS key includes the required policy statements for CloudTrail to encrypt logs and for authorized principals to decrypt them.
36+
2537
## Sponsorship
2638
2739
<picture>

src/README.md

Lines changed: 26 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)