You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ECS::Types::DockerVolumeConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::DockerVolumeConfiguration
- Defined in:
- (unknown)
Overview
When passing DockerVolumeConfiguration as input to an Aws::Client method, you can use a vanilla Hash:
{
scope: "task", # accepts task, shared
autoprovision: false,
driver: "String",
driver_opts: {
"String" => "String",
},
labels: {
"String" => "String",
},
}
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.
Returned by:
Instance Attribute Summary collapse
-
#autoprovision ⇒ Boolean
If this value is
true
, the Docker volume is created if it does not already exist. -
#driver ⇒ String
The Docker volume driver to use.
-
#driver_opts ⇒ Hash<String,String>
A map of Docker driver-specific options passed through.
-
#labels ⇒ Hash<String,String>
Custom metadata to add to your Docker volume.
-
#scope ⇒ String
The scope for the Docker volume that determines its lifecycle.
Instance Attribute Details
#autoprovision ⇒ Boolean
If this value is true
, the Docker volume is created if it does not
already exist.
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. For more information, see Docker plugin
discovery. This parameter maps to Driver
in the Create a
volume section of the Docker Remote API and the xxdriver
option to docker volume create.
#driver_opts ⇒ Hash<String,String>
A map of Docker driver-specific options passed through. This parameter
maps to DriverOpts
in the Create a volume section of the Docker
Remote API and the xxopt
option to docker volume create.
#labels ⇒ Hash<String,String>
Custom metadata to add to your Docker volume. This parameter maps to
Labels
in the Create a volume section of the Docker Remote
API 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.
Possible values:
- task
- shared