/AWS1/CL_ECSDOCKERVOLUMECONF

This parameter is specified when you're using Docker volumes. Docker volumes are only supported when you're using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_scope TYPE /AWS1/ECSSCOPE /AWS1/ECSSCOPE

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

iv_autoprovision TYPE /AWS1/ECSBOXEDBOOLEAN /AWS1/ECSBOXEDBOOLEAN

If this value is true, the Docker volume is created if it doesn't already exist.

This field is only used if the scope is shared.

iv_driver TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. This parameter maps to Driver in the docker container create command and the xxdriver option to docker volume create.

it_driveropts TYPE /AWS1/CL_ECSSTRINGMAP_W=>TT_STRINGMAP TT_STRINGMAP

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the docker create-volume command and the xxopt option to docker volume create.

it_labels TYPE /AWS1/CL_ECSSTRINGMAP_W=>TT_STRINGMAP TT_STRINGMAP

Custom metadata to add to your Docker volume. This parameter maps to Labels in the docker container create command and the xxlabel option to docker volume create.

---

Queryable Attributes

scope

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

Accessible with the following methods

Method	Description
GET_SCOPE()	Getter for SCOPE, with configurable default
ASK_SCOPE()	Getter for SCOPE w/ exceptions if field has no value
HAS_SCOPE()	Determine if SCOPE has a value

autoprovision

If this value is true, the Docker volume is created if it doesn't already exist.

This field is only used if the scope is shared.

Accessible with the following methods

Method	Description
GET_AUTOPROVISION()	Getter for AUTOPROVISION, with configurable default
ASK_AUTOPROVISION()	Getter for AUTOPROVISION w/ exceptions if field has no value
HAS_AUTOPROVISION()	Determine if AUTOPROVISION has a value

driver

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. This parameter maps to Driver in the docker container create command and the xxdriver option to docker volume create.

Accessible with the following methods

Method	Description
GET_DRIVER()	Getter for DRIVER, with configurable default
ASK_DRIVER()	Getter for DRIVER w/ exceptions if field has no value
HAS_DRIVER()	Determine if DRIVER has a value

driverOpts

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the docker create-volume command and the xxopt option to docker volume create.

Accessible with the following methods

Method	Description
GET_DRIVEROPTS()	Getter for DRIVEROPTS, with configurable default
ASK_DRIVEROPTS()	Getter for DRIVEROPTS w/ exceptions if field has no value
HAS_DRIVEROPTS()	Determine if DRIVEROPTS has a value

labels

Custom metadata to add to your Docker volume. This parameter maps to Labels in the docker container create command and the xxlabel option to docker volume create.

Accessible with the following methods

Method	Description
GET_LABELS()	Getter for LABELS, with configurable default
ASK_LABELS()	Getter for LABELS w/ exceptions if field has no value
HAS_LABELS()	Determine if LABELS has a value