github.com/minamijoyo/terraform@v0.7.8-0.20161029001309-18b3736ba44b/website/source/docs/providers/packet/r/volume.html.markdown (about)

     1  ---
     2  layout: "packet"
     3  page_title: "Packet: packet_volume"
     4  sidebar_current: "docs-packet-resource-volume"
     5  description: |-
     6    Provides a Packet Block Storage Volume Resource.
     7  ---
     8  
     9  # packet\_volume
    10  
    11  Provides a Packet Block Storage Volume resource to allow you to 
    12  manage block volumes on your account.
    13  Once created by Terraform, they must then be attached and mounted
    14  using the api and `packet_block_attach` and `packet_block_detach`
    15  scripts.
    16  
    17  ## Example Usage
    18  
    19  ```
    20  # Create a new block volume
    21  resource "packet_volume" "volume1" {
    22      description = "terraform-volume-1"
    23      facility = "ewr1"
    24  		project_id = "${packet_project.cool_project.id}"
    25      plan = 'storage_1'
    26      size = 100
    27      billing_cycle = "hourly"
    28      snapshot_policies = { snapshot_frequency = "1day", snapshot_count = 7 }
    29      snapshot_policies = { snapshot_frequency = "1month", snapshot_count = 6 }
    30  }
    31  ```
    32  
    33  ## Argument Reference
    34  
    35  The following arguments are supported:
    36  
    37  * `plan` - (Required) The service plan slug of the volume
    38  * `facility` - (Required) The facility to create the volume in
    39  * `project_id` - (Required) The packet project ID to deploy the volume in
    40  * `size` - (Required) The size in GB to make the volume
    41  * `billing_cycle` - The billing cycle, defaults to "hourly"
    42  * `description` - Optional description for the volume
    43  * `snapshot_policies` - Optional list of snapshot policies
    44  
    45  ## Attributes Reference
    46  
    47  The following attributes are exported:
    48  
    49  * `id` - The unique ID of the volume
    50  * `name` - The name of the volume
    51  * `description` - The description of the volume
    52  * `size` - The size in GB of the volume
    53  * `plan` - Performance plan the volume is on
    54  * `billing_cycle` - The billing cycle, defaults to hourly
    55  * `facility` - The facility slug the volume resides in
    56  * `state` - The state of the volume
    57  * `locked` - Whether the volume is locked or not
    58  * `project_id ` - The project id the volume is in
    59  * `created` - The timestamp for when the volume was created
    60  * `updated` - The timestamp for the last time the volume was updated