Skip to content

Commit

Permalink
docs: Added missing inputs. (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesiarmes authored Feb 28, 2025
1 parent b10d2a9 commit 02ed78f
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,15 @@ You now have a fully configured AWS backend for your project!

## Inputs

| Name | Description | Type | Default | Required |
|---------------------|-----------------------------------------------------------------------|----------|---------|:--------:|
| project | The name of the project. | `string` | n/a | yes |
| bucket_suffix | Adds a random suffix to the bucket name to ensure its uniqueness. | `bool` | `false` | no |
| environment | The environment for the project. | `string` | `"dev"` | no |
| key_recovery_period | The number of days to retain the KMS key for recovery after deletion. | `number` | `30` | no |
| tags | Optional tags to be applied to all resources. | `list` | `[]` | no |
| Name | Description | Type | Default | Required |
|--------------------------|------------------------------------------------------------------------------------------------------------|----------|---------|:--------:|
| project | The name of the project. | `string` | n/a | yes |
| bucket_suffix | Adds a random suffix to the bucket name to ensure its uniqueness. | `bool` | `false` | no |
| environment | The environment for the project. | `string` | `"dev"` | no |
| force_delete | Force delete resources on destroy. This must be set to true and applied before resources can be destroyed. | `bool` | `false` | no |
| key_recovery_period | The number of days to retain the KMS key for recovery after deletion. | `number` | `30` | no |
| state_version_expiration | Age (in days) before non-current versions of the state file are expired. | `number` | `30` | no |
| tags | Optional tags to be applied to all resources. | `list` | `[]` | no |

## Outputs

Expand Down

0 comments on commit 02ed78f

Please sign in to comment.