2021-05-21 08:30:56 -04:00
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
2022-06-17 06:09:59 -04:00
page_title: "Resource docker_volume - terraform-provider-docker"
2021-05-21 08:30:56 -04:00
subcategory: ""
description: |-
Creates and destroys a volume in Docker. This can be used alongside docker_container container.md to prepare volumes that can be shared across containers.
---
<!-- Bug: Type and Name are switched -->
2022-06-17 06:09:59 -04:00
# Resource (docker_volume)
2021-05-21 08:30:56 -04:00
Creates and destroys a volume in Docker. This can be used alongside [docker_container ](container.md ) to prepare volumes that can be shared across containers.
## Example Usage
```terraform
resource "docker_volume" "shared_volume" {
name = "shared_volume"
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Optional
2022-06-17 06:09:59 -04:00
- `driver` (String) Driver type for the volume. Defaults to `local` .
- `driver_opts` (Map of String) Options specific to the driver.
- `labels` (Block Set) User-defined key/value metadata (see [below for nested schema ](#nestedblock--labels ))
- `name` (String) The name of the Docker volume (will be generated if not provided).
2021-05-21 08:30:56 -04:00
### Read-Only
2022-06-17 06:09:59 -04:00
- `id` (String) The ID of this resource.
- `mountpoint` (String) The mountpoint of the volume.
2021-05-21 08:30:56 -04:00
< a id = "nestedblock--labels" > < / a >
### Nested Schema for `labels`
Required:
2022-06-17 06:09:59 -04:00
- `label` (String) Name of the label
- `value` (String) Value of the label
2021-05-21 08:30:56 -04:00
## Import
Import is supported using the following syntax by providing the `id` :
```shell
#!/bin/bash
terraform import docker_volume.foo id
```
### Example
Assuming you created a `volume` as follows
```shell
#!/bin/bash
docker volume create
# prints the long ID
524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d
```
you provide the definition for the resource as follows
```terraform
resource "docker_volume" "foo" {
name = "524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d"
}
```
then the import command is as follows
```shell
#!/bin/bash
terraform import docker_volume.foo 524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d
```