/AWS1/CL_ECSVOLUME

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_name TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

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.

io_host TYPE REF TO /AWS1/CL_ECSHOSTVOLUMEPRPS /AWS1/CL_ECSHOSTVOLUMEPRPS

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.

io_dockervolumeconfiguration TYPE REF TO /AWS1/CL_ECSDOCKERVOLUMECONF /AWS1/CL_ECSDOCKERVOLUMECONF

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 Fargate.

io_efsvolumeconfiguration TYPE REF TO /AWS1/CL_ECSEFSVOLUMECONF /AWS1/CL_ECSEFSVOLUMECONF

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

io_fsxwindowsfileservervol00 TYPE REF TO /AWS1/CL_ECSFSXWINDOWSFILESE00 /AWS1/CL_ECSFSXWINDOWSFILESE00

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

iv_configuredatlaunch TYPE /AWS1/ECSBOXEDBOOLEAN /AWS1/ECSBOXEDBOOLEAN

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.

---

Queryable Attributes

name

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.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

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.

Accessible with the following methods

Method	Description
GET_HOST()	Getter for HOST

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.

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

Accessible with the following methods

Method	Description
GET_DOCKERVOLUMECONF()	Getter for DOCKERVOLUMECONFIGURATION

efsVolumeConfiguration

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

Accessible with the following methods

Method	Description
GET_EFSVOLUMECONFIGURATION()	Getter for EFSVOLUMECONFIGURATION

fsxWindowsFileServerVolumeConfiguration

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

Accessible with the following methods

Method	Description
GET_FSXWINDOWSFILESERVERVO00()	Getter for FSXWINDOWSFILESERVERVOLCONF

configuredAtLaunch

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.

Accessible with the following methods

Method	Description
GET_CONFIGUREDATLAUNCH()	Getter for CONFIGUREDATLAUNCH, with configurable default
ASK_CONFIGUREDATLAUNCH()	Getter for CONFIGUREDATLAUNCH w/ exceptions if field has no
HAS_CONFIGUREDATLAUNCH()	Determine if CONFIGUREDATLAUNCH has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_VOLUMELIST

TYPES TT_VOLUMELIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_ECSVOLUME WITH DEFAULT KEY
.