Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Elastic Container Service Resource Types Reference » AWS::ECS::TaskDefinition » Amazon ECS TaskDefinition DockerVolumeConfiguration

Amazon ECS TaskDefinition DockerVolumeConfiguration

The DockerVolumeConfiguration property type specifies the configuration of a Docker volume. This parameter is specified when using Docker volumes. Docker volumes are only supported when using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

DockerVolumeConfiguration is a property of the Amazon Elastic Container Service TaskDefinition Volumes property type.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Autoprovision" : Boolean,
  "Driver" : String,
  "DriverOpts" : [ String, ... ] ,
  "Labels" : [ String, ... ] ,
  "Scope" : String
}

YAML


Autoprovision: Boolean
Driver: String
DriverOpts
  - String
Labels
  - String
Scope: String

Properties

Autoprovision

If true, the Docker volume is created if it does not already exist. This field is only used if the scope is shared.

Required: No

Type: Boolean

Update requires: Replacement

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. For more information, see DockerVolumeConfiguration in the Amazon Elastic Container Service API Reference.

Required: No

Type: String

Update requires: Replacement

DriverOpts

A map of Docker driver specific options passed through. For more information, see DockerVolumeConfiguration in the Amazon Elastic Container Service API Reference.

Duplicate values are not allowed.

Required: No

Type: List of Strings

Update requires: Replacement

Labels

Custom metadata to add to your Docker volume. For more information, see DockerVolumeConfiguration in the Amazon Elastic Container Service API Reference.

Duplicate values are not allowed.

Required: No

Type: List of String

Update requires: Replacement

Scope

The scope for the Docker volume which determines it's 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.

Valid values include shared and task.

Required: No

Type: String

Update requires: Replacement

See Also

On this page: