51 lines
2.5 KiB
Markdown
51 lines
2.5 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "stackit_volume Data Source - stackit"
|
|
subcategory: ""
|
|
description: |-
|
|
Volume resource 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_volume (Data Source)
|
|
|
|
Volume resource 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_volume" "example" {
|
|
project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
volume_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- `project_id` (String) STACKIT project ID to which the volume is associated.
|
|
- `volume_id` (String) The volume ID.
|
|
|
|
### Read-Only
|
|
|
|
- `availability_zone` (String) The availability zone of the volume.
|
|
- `description` (String) The description of the volume.
|
|
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`volume_id`".
|
|
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
|
|
- `name` (String) The name of the volume.
|
|
- `performance_class` (String) The performance class of the volume. Possible values are documented in [Service plans BlockStorage](https://docs.stackit.cloud/stackit/en/service-plans-blockstorage-75137974.html#ServiceplansBlockStorage-CurrentlyavailableServicePlans%28performanceclasses%29)
|
|
- `server_id` (String) The server ID of the server to which the volume is attached to.
|
|
- `size` (Number) The size of the volume in GB. It can only be updated to a larger value than the current size
|
|
- `source` (Attributes) The source of the volume. It can be either a volume, an image, a snapshot or a backup (see [below for nested schema](#nestedatt--source))
|
|
|
|
<a id="nestedatt--source"></a>
|
|
### Nested Schema for `source`
|
|
|
|
Read-Only:
|
|
|
|
- `id` (String) The ID of the source, e.g. image ID
|
|
- `type` (String) The type of the source. Supported values are: `volume`, `image`, `snapshot`, `backup`.
|