class Aws::ECS::Types::DockerVolumeConfiguration
This parameter is specified when you are using 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.
@note When making an API call, you may pass DockerVolumeConfiguration
data as a hash: { scope: "task", # accepts task, shared autoprovision: false, driver: "String", driver_opts: { "String" => "String", }, labels: { "String" => "String", }, }
@!attribute [rw] 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 as `shared` persist after the task stops. @return [String]
@!attribute [rw] autoprovision
If this value is `true`, the Docker volume is created if it does not already exist. <note markdown="1"> This field is only used if the `scope` is `shared`. </note> @return [Boolean]
@!attribute [rw] 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. For more information, see [Docker plugin discovery][1]. This parameter maps to `Driver` in the [Create a volume][2] section of the [Docker Remote API][3] and the `xxdriver` option to [docker volume create][4]. [1]: https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery [2]: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate [3]: https://docs.docker.com/engine/api/v1.35/ [4]: https://docs.docker.com/engine/reference/commandline/volume_create/ @return [String]
@!attribute [rw] driver_opts
A map of Docker driver-specific options passed through. This parameter maps to `DriverOpts` in the [Create a volume][1] section of the [Docker Remote API][2] and the `xxopt` option to [docker volume create][3]. [1]: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate [2]: https://docs.docker.com/engine/api/v1.35/ [3]: https://docs.docker.com/engine/reference/commandline/volume_create/ @return [Hash<String,String>]
@!attribute [rw] labels
Custom metadata to add to your Docker volume. This parameter maps to `Labels` in the [Create a volume][1] section of the [Docker Remote API][2] and the `xxlabel` option to [docker volume create][3]. [1]: https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate [2]: https://docs.docker.com/engine/api/v1.35/ [3]: https://docs.docker.com/engine/reference/commandline/volume_create/ @return [Hash<String,String>]
@see docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DockerVolumeConfiguration AWS API Documentation
Constants
- SENSITIVE