interface VolumeProperty

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.CfnTaskDefinition.VolumeProperty`
Java	`software.amazon.awscdk.services.ecs.CfnTaskDefinition.VolumeProperty`
Python	`aws_cdk.aws_ecs.CfnTaskDefinition.VolumeProperty`
TypeScript	`@aws-cdk/aws-ecs` » `CfnTaskDefinition` » `VolumeProperty`

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
const volumeProperty: ecs.CfnTaskDefinition.VolumeProperty = {
  dockerVolumeConfiguration: {
    autoprovision: false,
    driver: 'driver',
    driverOpts: {
      driverOptsKey: 'driverOpts',
    },
    labels: {
      labelsKey: 'labels',
    },
    scope: 'scope',
  },
  efsVolumeConfiguration: {
    filesystemId: 'filesystemId',

    // the properties below are optional
    authorizationConfig: {
      accessPointId: 'accessPointId',
      iam: 'iam',
    },
    rootDirectory: 'rootDirectory',
    transitEncryption: 'transitEncryption',
    transitEncryptionPort: 123,
  },
  host: {
    sourcePath: 'sourcePath',
  },
  name: 'name',
};

Properties

Name	Type	Description
dockerVolumeConfiguration?	`IResolvable` `\|` `DockerVolumeConfigurationProperty`	This parameter is specified when you use Docker volumes.
efsVolumeConfiguration?	`IResolvable` `\|` `EFSVolumeConfigurationProperty`	This parameter is specified when you use an Amazon Elastic File System file system for task storage.
host?	`IResolvable` `\|` `HostVolumePropertiesProperty`	This parameter is specified when you use bind mount host volumes.
name?	`string`	The name of the volume.

dockerVolumeConfiguration?

Type: IResolvable | DockerVolumeConfigurationProperty (optional)

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.

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

efsVolumeConfiguration?

Type: IResolvable | EFSVolumeConfigurationProperty (optional)

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

host?

Type: IResolvable | HostVolumePropertiesProperty (optional)

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 .

name?

Type: string (optional)

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 .