# DockerVolumeConfigurationProperty

The `DockerVolumeConfiguration` property specifies a Docker volume configuration and is used when you use Docker volumes.

Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the `local` driver. To use bind mounts, specify a `host` instead.

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const dockerVolumeConfigurationProperty: ecs.CfnTaskDefinition.DockerVolumeConfigurationProperty = {
  autoprovision: false,
  driver: 'driver',
  driverOpts: {
    driverOptsKey: 'driverOpts',
  },
  labels: {
    labelsKey: 'labels',
  },
  scope: 'scope',
};
```

## Properties

- `autoprovision`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — If this value is `true` , the Docker volume is created if it doesn't already exist.

  > This field is only used if the `scope` is `shared` .

- `driver`: string — The Docker volume driver to use.

  The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use `docker plugin ls` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. This parameter maps to `Driver` in the docker container create command and the `xxdriver` option to docker volume create.

- `driverOpts`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: string } — A map of Docker driver-specific options passed through.

  This parameter maps to `DriverOpts` in the docker create-volume command and the `xxopt` option to docker volume create.

- `labels`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: string } — Custom metadata to add to your Docker volume.

  This parameter maps to `Labels` in the docker container create command and the `xxlabel` option to docker volume create.

- `scope`: string — The scope for the Docker volume that determines its lifecycle.

  Docker volumes that are scoped to a `task` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as `shared` persist after the task stops.