Skip to content

Commit 483985a

Browse files
committed
chore: Update README
1 parent 555d9db commit 483985a

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ A module to create application secrets stored in [AWS Secrets Manager](https://a
1111
* [Cross-account secrets](#cross-account-secrets)
1212
* [Inputs](#inputs)
1313
* [Secrets](#secrets)
14+
* [Recovery window](#recovery-window)
1415
* [Outputs](#outputs)
1516
* [Release](#release)
1617
* [Maintainers](#maintainers)
@@ -210,12 +211,13 @@ module "user" {
210211
211212
## Inputs
212213

213-
| Name | Description | Type | Default | Required |
214-
|:-------------|:---------------------------------------|:-------------|:------------|:---------|
215-
| `app_name` | Application name | string | `null` | yes |
216-
| `aws_region` | AWS region | string | `us-east-2` | no |
217-
| `secrets` | List of objects of [secrets](#secrets) | list(object) | `null` | yes |
218-
| `tags` | Key-value map of tags | map(string) | `{}` | no |
214+
| Name | Description | Type | Default | Required |
215+
|:-------------|:------------------------------------------------------------------|:-------------|:------------|:---------|
216+
| `app_name` | Application name | string | `null` | yes |
217+
| `aws_region` | AWS region | string | `us-east-2` | no |
218+
| `secrets` | List of objects of [secrets](#secrets) | list(object) | `null` | yes |
219+
| `delete_in` | [Number of days](#recovery-window) to wait before secret deletion | number | `30` | no |
220+
| `tags` | Key-value map of tags | map(string) | `{}` | no |
219221

220222
### Secrets
221223

@@ -225,6 +227,10 @@ module "user" {
225227
| `value` | Secret value | string | `null` |
226228
| `allowed_arns` | List of principal ARNs that have access to the secret | list | `null` |
227229

230+
### Recovery window
231+
232+
Number of days that AWS Secrets Manager waits before it can delete the secret. This value can be `0` to force deletion without recovery or range from `7` to `30` days. The default value is `30`.
233+
228234
## Outputs
229235

230236
| Name | Description | Sensitive |

0 commit comments

Comments
 (0)