interface VolumeProperty

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.CfnTaskDefinition.VolumeProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsecs#CfnTaskDefinition_VolumeProperty`
Java	`software.amazon.awscdk.services.ecs.CfnTaskDefinition.VolumeProperty`
Python	`aws_cdk.aws_ecs.CfnTaskDefinition.VolumeProperty`
TypeScript	`aws-cdk-lib` » `aws_ecs` » `CfnTaskDefinition` » `VolumeProperty`

The data volume configuration for tasks launched using this task definition.

Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a name and one of either configuredAtLaunch , dockerVolumeConfiguration , efsVolumeConfiguration , fsxWindowsFileServerVolumeConfiguration , or host . If an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see 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 { aws_ecs as ecs } from 'aws-cdk-lib';
const volumeProperty: ecs.CfnTaskDefinition.VolumeProperty = {
  configuredAtLaunch: false,
  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,
  },
  fSxWindowsFileServerVolumeConfiguration: {
    fileSystemId: 'fileSystemId',
    rootDirectory: 'rootDirectory',

    // the properties below are optional
    authorizationConfig: {
      credentialsParameter: 'credentialsParameter',
      domain: 'domain',
    },
  },
  host: {
    sourcePath: 'sourcePath',
  },
  name: 'name',
};

Properties

Name	Type	Description
configuredAtLaunch?	`boolean \|` `IResolvable`	Indicates whether the volume should be configured at launch time.
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.
fSxWindowsFileServerVolumeConfiguration?	`IResolvable` `\|` `FSxWindowsFileServerVolumeConfigurationProperty`	This parameter is specified when you use Amazon FSx for Windows File Server 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. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

configuredAtLaunch?

Type: boolean | IResolvable (optional)

Indicates whether the volume should be configured at launch time.

This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.

To configure a volume at launch time, use this task definition revision and specify a volumeConfigurations object when calling the CreateService , UpdateService , RunTask or StartTask APIs.

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.

fSxWindowsFileServerVolumeConfiguration?

Type: IResolvable | FSxWindowsFileServerVolumeConfigurationProperty (optional)

This parameter is specified when you use Amazon FSx for Windows File Server 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.

When using a volume configured at launch, the name is required and must also be specified as the volume name in the ServiceVolumeConfiguration or TaskVolumeConfiguration parameter when creating your service or standalone task.

For all other types of volumes, this name is referenced in the sourceVolume parameter of the mountPoints object in the container definition.

When a volume is using the efsVolumeConfiguration , the name is required.