Class Volume

A data volume used in a task definition.

Inheritance

System.Object

Volume

Implements

IVolume

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.AWS.ECS.dll

Syntax (csharp)

public class Volume : Object, IVolume

Syntax (vb)

Public Class Volume
    Inherits Object
    Implements IVolume

Remarks

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, see Using Data Volumes in Tasks.

ExampleMetadata: infused

Examples

var fargateTaskDefinition = new FargateTaskDefinition(this, "TaskDef", new FargateTaskDefinitionProps {
    MemoryLimitMiB = 512,
    Cpu = 256
});
IDictionary<string, object> volume = new Dictionary<string, object> {
    // Use an Elastic FileSystem
    { "name", "mydatavolume" },
    { "efsVolumeConfiguration", new Dictionary<string, string> {
        { "fileSystemId", "EFS" }
    } }
};

var container = fargateTaskDefinition.AddVolume(volume);

Synopsis

Constructors

Volume()

Properties

DockerVolumeConfiguration	This property is specified when you are using Docker volumes.
EfsVolumeConfiguration	This property is specified when you are using Amazon EFS.
Host	This property is specified when you are using bind mount host volumes.
Name	The name of the volume.

Constructors

Volume()

public Volume()

Properties

DockerVolumeConfiguration

This property is specified when you are using Docker volumes.

public IDockerVolumeConfiguration DockerVolumeConfiguration { get; set; }

Property Value

IDockerVolumeConfiguration

Remarks

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.

EfsVolumeConfiguration

This property is specified when you are using Amazon EFS.

public IEfsVolumeConfiguration EfsVolumeConfiguration { get; set; }

Property Value

IEfsVolumeConfiguration

Remarks

When specifying Amazon EFS volumes in tasks using the Fargate launch type, Fargate creates a supervisor container that is responsible for managing the Amazon EFS volume. The supervisor container uses a small amount of the task's memory. The supervisor container is visible when querying the task metadata version 4 endpoint, but is not visible in CloudWatch Container Insights.

Default: No Elastic FileSystem is setup

Host

This property is specified when you are using bind mount host volumes.

public IHost Host { get; set; }

Property Value

IHost

Remarks

Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.

Name

The name of the volume.

public string Name { get; set; }

Property Value

System.String

Remarks

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

Implements

IVolume