DockerVolumeConfiguration
This parameter is specified when you're using Docker volumes. Docker volumes are only supported when
you're using the EC2 launch type. Windows containers only support the use of the
local
driver. To use bind mounts, specify a host
instead.
Contents
- autoprovision
-
If this value is
true
, the Docker volume is created if it doesn't already exist.Note
This field is only used if the
scope
isshared
.Type: Boolean
Required: No
- driver
-
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 toDriver
in the docker container create command and thexxdriver
option to docker volume create.Type: String
Required: No
- driverOpts
-
A map of Docker driver-specific options passed through. This parameter maps to
DriverOpts
in the docker create-volume command and thexxopt
option to docker volume create.Type: String to string map
Required: No
- labels
-
Custom metadata to add to your Docker volume. This parameter maps to
Labels
in the docker container create command and thexxlabel
option to docker volume create.Type: String to string map
Required: No
- scope
-
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 asshared
persist after the task stops.Type: String
Valid Values:
task | shared
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: