1.204.0

interface Volume

LanguageType name
.NETAmazon.CDK.AWS.ECS.Volume
Javasoftware.amazon.awscdk.services.ecs.Volume
Pythonaws_cdk.aws_ecs.Volume
TypeScript (source)@aws-cdk/aws-ecs » Volume

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

Example

const fargateTaskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {
  memoryLimitMiB: 512,
  cpu: 256,
});
const volume = {
  // Use an Elastic FileSystem
  name: "mydatavolume",
  efsVolumeConfiguration: {
    fileSystemId: "EFS",
    // ... other options here ...
  },
};

const container = fargateTaskDefinition.addVolume(volume);

Properties

NameTypeDescription
namestringThe name of the volume.
dockerVolumeConfiguration?DockerVolumeConfigurationThis property is specified when you are using Docker volumes.
efsVolumeConfiguration?EfsVolumeConfigurationThis property is specified when you are using Amazon EFS.
host?HostThis property is specified when you are using bind mount host volumes.

name

Type: string

The name of the volume.

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

dockerVolumeConfiguration?

Type: DockerVolumeConfiguration (optional)

This property 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.

efsVolumeConfiguration?

Type: EfsVolumeConfiguration (optional, default: No Elastic FileSystem is setup)

This property is specified when you are using Amazon EFS.

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.

host?

Type: Host (optional)

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

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.

← PreviousNext →