github.com/nathanielks/terraform@v0.6.1-0.20170509030759-13e1a62319dc/website/source/docs/providers/openstack/r/blockstorage_volume_v2.html.markdown (about)

     1  ---
     2  layout: "openstack"
     3  page_title: "OpenStack: openstack_blockstorage_volume_v2"
     4  sidebar_current: "docs-openstack-resource-blockstorage-volume-v2"
     5  description: |-
     6    Manages a V2 volume resource within OpenStack.
     7  ---
     8  
     9  # openstack\_blockstorage\_volume_v2
    10  
    11  Manages a V2 volume resource within OpenStack.
    12  
    13  ## Example Usage
    14  
    15  ```hcl
    16  resource "openstack_blockstorage_volume_v2" "volume_1" {
    17    region      = "RegionOne"
    18    name        = "volume_1"
    19    description = "first test volume"
    20    size        = 3
    21  }
    22  ```
    23  
    24  ## Argument Reference
    25  
    26  The following arguments are supported:
    27  
    28  * `region` - (Required) The region in which to create the volume. If
    29      omitted, the `OS_REGION_NAME` environment variable is used. Changing this
    30      creates a new volume.
    31  
    32  * `size` - (Required) The size of the volume to create (in gigabytes). Changing
    33      this creates a new volume.
    34  
    35  * `availability_zone` - (Optional) The availability zone for the volume.
    36      Changing this creates a new volume.
    37  
    38  * `consistency_group_id` - (Optional) The consistency group to place the volume
    39      in.
    40  
    41  * `description` - (Optional) A description of the volume. Changing this updates
    42      the volume's description.
    43  
    44  * `image_id` - (Optional) The image ID from which to create the volume.
    45      Changing this creates a new volume.
    46  
    47  * `metadata` - (Optional) Metadata key/value pairs to associate with the volume.
    48      Changing this updates the existing volume metadata.
    49  
    50  * `name` - (Optional) A unique name for the volume. Changing this updates the
    51      volume's name.
    52  
    53  * `snapshot_id` - (Optional) The snapshot ID from which to create the volume.
    54      Changing this creates a new volume.
    55  
    56  * `source_replica` - (Optional) The volume ID to replicate with.
    57  
    58  * `source_vol_id` - (Optional) The volume ID from which to create the volume.
    59      Changing this creates a new volume.
    60  
    61  * `volume_type` - (Optional) The type of volume to create.
    62      Changing this creates a new volume.
    63  
    64  ## Attributes Reference
    65  
    66  The following attributes are exported:
    67  
    68  * `region` - See Argument Reference above.
    69  * `size` - See Argument Reference above.
    70  * `name` - See Argument Reference above.
    71  * `description` - See Argument Reference above.
    72  * `availability_zone` - See Argument Reference above.
    73  * `image_id` - See Argument Reference above.
    74  * `source_vol_id` - See Argument Reference above.
    75  * `snapshot_id` - See Argument Reference above.
    76  * `metadata` - See Argument Reference above.
    77  * `volume_type` - See Argument Reference above.
    78  * `attachment` - If a volume is attached to an instance, this attribute will
    79      display the Attachment ID, Instance ID, and the Device as the Instance
    80      sees it.
    81  
    82  ## Import
    83  
    84  Volumes can be imported using the `id`, e.g.
    85  
    86  ```
    87  $ terraform import openstack_blockstorage_volume_v2.volume_1 ea257959-eeb1-4c10-8d33-26f0409a755d
    88  ```