Skip to content

DockerVolumeConfiguration

Source code in docs_src/capo_ecs/types/docker_volume_configuration.py 
14
15
16
17
18
19
20
21
22
23
24
class DockerVolumeConfiguration(TypedDict, closed=True):
    scope: NotRequired["capo_ecs.types.scope.Scope"]
    """<p>The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a <code>task</code> are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as <code>shared</code> persist after the task stops.</p>"""
    autoprovision: NotRequired["capo_ecs.types.boxed_boolean.BoxedBoolean"]
    """<p>If this value is <code>true</code>, the Docker volume is created if it doesn't already exist.</p> <note> <p>This field is only used if the <code>scope</code> is <code>shared</code>.</p> </note>"""
    driver: NotRequired["capo_ecs.types.string.String"]
    """<p>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 <code>docker plugin ls</code> 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 <code>Driver</code> in the docker container create command and the <code>xxdriver</code> option to docker volume create.</p>"""
    driver_opts: NotRequired["capo_ecs.types.string_map.StringMap"]
    """<p>A map of Docker driver-specific options passed through. This parameter maps to <code>DriverOpts</code> in the docker create-volume command and the <code>xxopt</code> option to docker volume create.</p>"""
    labels: NotRequired["capo_ecs.types.string_map.StringMap"]
    """<p>Custom metadata to add to your Docker volume. This parameter maps to <code>Labels</code> in the docker container create command and the <code>xxlabel</code> option to docker volume create.</p>"""

autoprovision instance-attribute 

autoprovision: NotRequired[BoxedBoolean]

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.

driver instance-attribute 

driver: NotRequired[String]

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.

driver_opts instance-attribute 

driver_opts: NotRequired[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.

labels instance-attribute 

labels: NotRequired[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.

scope instance-attribute 

scope: NotRequired[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.