AWS::ECS::TaskDefinition Volume

The Volume property specifies a data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information about host and optional sourcePath, see Volumes and Using Data Volumes in Tasks.

Syntax

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

JSON

{
  "DockerVolumeConfiguration" : DockerVolumeConfiguration,
  "EFSVolumeConfiguration" : EFSVolumeConfiguration,
  "Host" : HostVolumeProperties,
  "Name" : String
}

YAML

  DockerVolumeConfiguration: 
    DockerVolumeConfiguration
  EFSVolumeConfiguration: 
    EFSVolumeConfiguration
  Host: 
    HostVolumeProperties
  Name: String

Properties

DockerVolumeConfiguration

This parameter is specified when you use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Note

Docker volumes aren't supported by tasks run on AWS Fargate.

Required: No

Type: DockerVolumeConfiguration

Update requires: Replacement

EFSVolumeConfiguration

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

Required: No

Type: EFSVolumeConfiguration

Update requires: Replacement

Host

This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

Required: No

Type: HostVolumeProperties

Update requires: Replacement

Name

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

This is required wwhen you use an Amazon EFS volume.

Required: No

Type: String

Update requires: Replacement