terraform-provider-stackitp.../docs/data-sources/server_backup_schedule.md
João Palet fc14fd5293
Improve beta resources documentation (#436)
* Improve beta resources documentation

* Improve phrasing
2024-06-26 17:53:32 +01:00

50 lines
2.1 KiB
Markdown

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit_server_backup_schedule Data Source - stackit"
subcategory: ""
description: |-
Server backup schedule datasource schema. Must have a region specified in the provider configuration.
~> This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our guide https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources for how to opt-in to use beta resources.
---
# stackit_server_backup_schedule (Data Source)
Server backup schedule datasource schema. Must have a `region` specified in the provider configuration.
~> This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our [guide](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources) for how to opt-in to use beta resources.
## Example Usage
```terraform
data "stackit_server_backup_schedule" "example" {
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
server_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
backup_schedule_id = xxxxx
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `backup_schedule_id` (Number) Backup schedule ID.
- `project_id` (String) STACKIT Project ID to which the server is associated.
- `server_id` (String) Server ID for the backup schedule.
### Read-Only
- `backup_properties` (Attributes) Backup schedule details for the backups. (see [below for nested schema](#nestedatt--backup_properties))
- `enabled` (Boolean) Is the backup schedule enabled or disabled.
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`server_id`,`backup_schedule_id`".
- `name` (String) The schedule name.
- `rrule` (String) Backup schedule described in `rrule` (recurrence rule) format.
<a id="nestedatt--backup_properties"></a>
### Nested Schema for `backup_properties`
Read-Only:
- `name` (String)
- `retention_period` (Number)
- `volume_ids` (List of String)