Skip to content

Commit

Permalink
add doc
Browse files Browse the repository at this point in the history
Signed-off-by: ziyeqf <[email protected]>
  • Loading branch information
ziyeqf committed Apr 27, 2023
1 parent a6a304e commit 56b8f91
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions website/docs/r/backup_policy_vm.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -134,21 +134,33 @@ The `retention_monthly` block supports:

* `count` - (Required) The number of monthly backups to keep. Must be between `1` and `9999`

* `weekdays` - (Required) The weekday backups to retain . Must be one of `Sunday`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday` or `Saturday`.
* `weekdays` - (Optional) The weekday backups to retain . Must be one of `Sunday`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday` or `Saturday`.

* `weeks` - (Required) The weeks of the month to retain backups of. Must be one of `First`, `Second`, `Third`, `Fourth`, `Last`.
* `weeks` - (Optional) The weeks of the month to retain backups of. Must be one of `First`, `Second`, `Third`, `Fourth`, `Last`.

* `days` - (Optional) The days of the month to retain backups of. Must be between `1` and `31`.

* `include_last_days` - (Optional) Including the last day of the month, default to `false`.

-> **NOTE:**: Either `weekdays` and `weeks` or `days` and `include_last_days` must be specified.

---

The `retention_yearly` block supports:

* `count` - (Required) The number of yearly backups to keep. Must be between `1` and `9999`

* `weekdays` - (Required) The weekday backups to retain . Must be one of `Sunday`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday` or `Saturday`.
* `months` - (Required) The months of the year to retain backups of. Must be one of `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November` and `December`.

* `weekdays` - (Optional) The weekday backups to retain . Must be one of `Sunday`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday` or `Saturday`.

* `weeks` - (Required) The weeks of the month to retain backups of. Must be one of `First`, `Second`, `Third`, `Fourth`, `Last`.
* `weeks` - (Optional) The weeks of the month to retain backups of. Must be one of `First`, `Second`, `Third`, `Fourth`, `Last`.

* `months` - (Required) The months of the year to retain backups of. Must be one of `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November` and `December`.
* `days` - (Optional) The days of the month to retain backups of. Must be between `1` and `31`.

* `include_last_days` - (Optional) Including the last day of the month, default to `false`.

-> **NOTE:**: Either `weekdays` and `weeks` or `days` and `include_last_days` must be specified.

---

Expand Down

0 comments on commit 56b8f91

Please sign in to comment.