Class: Aws::ECS::Types::DockerVolumeConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::DockerVolumeConfiguration
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ecs/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#autoprovision ⇒ Boolean
If this value is ‘true`, the Docker volume is created if it doesn’t 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 doesn’t already exist.
<note markdown=“1”> This field is only used if the ‘scope` is `shared`.
</note>
4697 4698 4699 4700 4701 4702 4703 4704 4705 |
# File 'lib/aws-sdk-ecs/types.rb', line 4697 class DockerVolumeConfiguration < Struct.new( :scope, :autoprovision, :driver, :driver_opts, :labels) SENSITIVE = [] include Aws::Structure end |
#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.
4697 4698 4699 4700 4701 4702 4703 4704 4705 |
# File 'lib/aws-sdk-ecs/types.rb', line 4697 class DockerVolumeConfiguration < Struct.new( :scope, :autoprovision, :driver, :driver_opts, :labels) SENSITIVE = [] include Aws::Structure end |
#driver_opts ⇒ Hash<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.
4697 4698 4699 4700 4701 4702 4703 4704 4705 |
# File 'lib/aws-sdk-ecs/types.rb', line 4697 class DockerVolumeConfiguration < Struct.new( :scope, :autoprovision, :driver, :driver_opts, :labels) SENSITIVE = [] include Aws::Structure end |
#labels ⇒ Hash<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.
4697 4698 4699 4700 4701 4702 4703 4704 4705 |
# File 'lib/aws-sdk-ecs/types.rb', line 4697 class DockerVolumeConfiguration < Struct.new( :scope, :autoprovision, :driver, :driver_opts, :labels) SENSITIVE = [] include Aws::Structure end |
#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.
4697 4698 4699 4700 4701 4702 4703 4704 4705 |
# File 'lib/aws-sdk-ecs/types.rb', line 4697 class DockerVolumeConfiguration < Struct.new( :scope, :autoprovision, :driver, :driver_opts, :labels) SENSITIVE = [] include Aws::Structure end |