terraform/website/source/docs/providers/aws/r/ebs_volume.html.md

54 lines
1.4 KiB
Markdown
Raw Normal View History

2015-04-29 05:49:21 +02:00
---
layout: "aws"
page_title: "AWS: aws_ebs_volume"
sidebar_current: "docs-aws-resource-ebs-volume"
description: |-
2015-05-21 11:54:11 +02:00
Provides an elastic block storage resource.
2015-04-29 05:49:21 +02:00
---
# aws\_ebs\_volume
Manages a single EBS volume.
## Example Usage
```
resource "aws_ebs_volume" "example" {
availability_zone = "us-west-2a"
2015-04-29 05:49:21 +02:00
size = 40
2015-05-29 09:05:21 +02:00
tags {
Name = "HelloWorld"
}
2015-04-29 05:49:21 +02:00
}
```
~> **NOTE**: One of `size` or `snapshot_id` is required when specifying an EBS volume
2015-04-29 05:49:21 +02:00
## Argument Reference
The following arguments are supported:
* `availability_zone` - (Required) The AZ where the EBS volume will exist.
* `encrypted` - (Optional) If true, the disk will be encrypted.
* `iops` - (Optional) The amount of IOPS to provision for the disk.
* `size` - (Optional) The size of the drive in GB.
2015-05-29 03:00:44 +02:00
* `snapshot_id` (Optional) A snapshot to base the EBS volume off of.
2016-06-03 22:43:05 +02:00
* `type` - (Optional) The type of EBS volume. Can be "standard", "gp2", "io1", or "st1" (Default: "standard").
* `kms_key_id` - (Optional) The ARN for the KMS encryption key. When specifying `kms_key_id`, `encrypted` needs to be set to true
2015-05-29 09:05:21 +02:00
* `tags` - (Optional) A mapping of tags to assign to the resource.
## Attributes Reference
The following attributes are exported:
* `id` - The volume ID (e.g. vol-59fcb34e).
## Import
EBS Volumes can be imported using the `id`, e.g.
```
$ terraform import aws_ebs_volume.data vol-049df61146c4d7901
```