Skip to content

feat: Allow overriding the default recovery window. #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesiarmes merged 2 commits into from
Jan 28, 2026
Merged

feat: Allow overriding the default recovery window. #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04e9334
feat: Allow secrets to be deleted immediatly.
jamesiarmes Jan 21, 2026
94b9b40
Fix: Use the correct variables.
jamesiarmes Jan 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,18 @@ kms_key_arn = aws_kms_key.example.arn

## Inputs

| Name | Description | Type | Default | Required |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | ----------- |
| project | Name of the project. | `string` | n/a | yes |
| kms_key_arn | ARN for an existing KMS key to use for encryption. Required if `create_kms_key` is set to `false`; ignored otherwise. | `string` | `null` | conditional |
| add_suffix | Apply a random suffix to the secret name. Useful when secrets may need to be replaced, but makes identify secrets by name alone more difficult. | `bool` | `true` | no |
| create_kms_key | Whether to create a new KMS key for encrypting secrets. If set to `false`, `kms_key_arn` must be provided. | `bool` | `true` | no |
| environment | Environment for the project. | `string` | `"dev"` | no |
| key_recovery_period | Recovery period for deleted KMS keys in days. Must be between 7 and 30. Only used if `create_kms_key` is set to `true`. | `number` | `30` | no |
| [secrets] | Secrets to be created. | `map(object)` | `{}` | no |
| service | Optional service that these resources are supporting. Example: `"api"`, `"web"`, `"worker"` | `string` | n/a | no |
| tags | Optional tags to be applied to all resources. | `list` | `[]` | no |
| Name | Description | Type | Default | Required |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------- | ----------- |
| project | Name of the project. | `string` | n/a | yes |
| kms_key_arn | ARN for an existing KMS key to use for encryption. Required if `create_kms_key` is set to `false`; ignored otherwise. | `string` | `null` | conditional |
| add_suffix | Apply a random suffix to the secret name. Useful when secrets may need to be replaced, but makes identify secrets by name alone more difficult. | `bool` | `true` | no |
| create_kms_key | Whether to create a new KMS key for encrypting secrets. If set to `false`, `kms_key_arn` must be provided. | `bool` | `true` | no |
| environment | Environment for the project. | `string` | `"dev"` | no |
| key_recovery_period | Recovery period for deleted KMS keys in days. Must be between 7 and 30. Only used if `create_kms_key` is set to `true`. | `number` | `30` | no |
| recovery_window | Recovery window for deleted secrets, in days. Must be between 7 and 30, or 0 to disable recovery when the secret is deleted. This value can be overridden for each secret by setting the `recovery_window` for the secret. | `number` | `30` | no |
| [secrets] | Secrets to be created. | `map(object)` | `{}` | no |
| service | Optional service that these resources are supporting. Example: `"api"`, `"web"`, `"worker"` | `string` | n/a | no |
| tags | Optional tags to be applied to all resources. | `list` | `[]` | no |

### secrets

Expand Down Expand Up @@ -112,13 +113,13 @@ secrets = {
This would result in a key named `my/example/key-` before the random suffix is
applied.

| Name | Description | Type | Default | Required |
| ---------------------- | ------------------------------------------------------------- | -------- | ------- | -------- |
| description | Description of the secret. | `string` | n/a | yes |
| create_random_password | Creates a random password as the staring value. | `bool` | `false` | no |
| name | Name to use as the prefix for the secret. | `string` | `""` | no |
| recovery_window | Number of days that a secret can be recovered after deletion. | `string` | `30` | no |
| start_value | Value to be set into the secret at creation. | `string` | `"{}"` | no |
| Name | Description | Type | Default | Required |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------- | -------- | ------- | -------- |
| description | Description of the secret. | `string` | n/a | yes |
| create_random_password | Creates a random password as the staring value. | `bool` | `false` | no |
| name | Name to use as the prefix for the secret. | `string` | `""` | no |
| recovery_window | Override the default recovery window. Must be between 7 and 30, or 0 to disable recovery when the secret is deleted. | `number` | `null` | no |
| start_value | Value to be set into the secret at creation. | `string` | `"{}"` | no |

## Outputs

Expand Down
2 changes: 1 addition & 1 deletion main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ module "secrets_manager" {
)
create_random_password = each.value.create_random_password
description = each.value.description
recovery_window_in_days = each.value.recovery_window
recovery_window_in_days = coalesce(each.value.recovery_window, var.recovery_window)
kms_key_id = local.kms_key_id
secret_string = each.value.start_value

Expand Down
19 changes: 17 additions & 2 deletions variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ variable "key_recovery_period" {

validation {
condition = var.key_recovery_period > 6 && var.key_recovery_period < 31
error_message = "Recovery period must be between 7 and 30."
error_message = "Key recovery period must be between 7 and 30."
}
}

Expand All @@ -47,14 +47,29 @@ variable "project" {
description = "Project that these resources are supporting."
}

variable "recovery_window" {
type = number
default = 30
description = <<-EOT
Recovery window for deleted secrets, in days. Must be between 7 and 30, or 0
to disable recovery when the secret is deleted. This value can be overridden
for each secret by setting the `recovery_window` for the secret.
EOT

validation {
condition = var.recovery_window == 0 || (var.recovery_window > 6 && var.recovery_window < 31)
error_message = "Recovery window must be between 7 and 30, or 0 to disable recovery."
}
}

# TODO: Support rotation.
variable "secrets" {
type = map(object({
add_suffix = optional(bool, null)
create_random_password = optional(bool, false)
description = string
name = optional(string, null)
recovery_window = optional(number, 30)
recovery_window = optional(number, null)
start_value = optional(string, "{}")
}))

Expand Down
Loading