terraform/website/source/docs/providers/openstack/r/blockstorage_volume_v1.html...

84 lines
2.6 KiB
Markdown
Raw Normal View History

---
layout: "openstack"
page_title: "OpenStack: openstack_blockstorage_volume_v1"
sidebar_current: "docs-openstack-resource-blockstorage-volume-v1"
description: |-
2015-04-02 20:19:27 +02:00
Manages a V1 volume resource within OpenStack.
---
# openstack\_blockstorage\_volume_v1
Manages a V1 volume resource within OpenStack.
## Example Usage
```hcl
resource "openstack_blockstorage_volume_v1" "volume_1" {
region = "RegionOne"
name = "tf-test-volume"
description = "first test volume"
size = 3
}
```
## Argument Reference
The following arguments are supported:
* `region` - (Required) The region in which to create the volume. If
omitted, the `OS_REGION_NAME` environment variable is used. Changing this
creates a new volume.
* `size` - (Required) The size of the volume to create (in gigabytes). Changing
this creates a new volume.
* `name` - (Optional) A unique name for the volume. Changing this updates the
volume's name.
* `description` - (Optional) A description of the volume. Changing this updates
the volume's description.
* `availability_zone` - (Optional) The availability zone for the volume.
Changing this creates a new volume.
* `image_id` - (Optional) The image ID from which to create the volume.
Changing this creates a new volume.
* `snapshot_id` - (Optional) The snapshot ID from which to create the volume.
Changing this creates a new volume.
* `source_vol_id` - (Optional) The volume ID from which to create the volume.
Changing this creates a new volume.
* `metadata` - (Optional) Metadata key/value pairs to associate with the volume.
Changing this updates the existing volume metadata.
* `volume_type` - (Optional) The type of volume to create.
Changing this creates a new volume.
## Attributes Reference
The following attributes are exported:
* `region` - See Argument Reference above.
* `size` - See Argument Reference above.
* `name` - See Argument Reference above.
* `description` - See Argument Reference above.
* `availability_zone` - See Argument Reference above.
* `image_id` - See Argument Reference above.
* `source_vol_id` - See Argument Reference above.
* `snapshot_id` - See Argument Reference above.
* `metadata` - See Argument Reference above.
* `volume_type` - See Argument Reference above.
2015-04-02 18:12:18 +02:00
* `attachment` - If a volume is attached to an instance, this attribute will
display the Attachment ID, Instance ID, and the Device as the Instance
sees it.
## Import
Volumes can be imported using the `id`, e.g.
```
$ terraform import openstack_blockstorage_volume_v1.volume_1 ea257959-eeb1-4c10-8d33-26f0409a755d
```