software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.DockerVolumeConfigurationProperty

All Known Implementing Classes:

CfnTaskDefinition.DockerVolumeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

public static interface CfnTaskDefinition.DockerVolumeConfigurationProperty

The `DockerVolumeConfiguration` property specifies a Docker volume configuration and is used when you use Docker volumes.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 DockerVolumeConfigurationProperty dockerVolumeConfigurationProperty = DockerVolumeConfigurationProperty.builder()
         .autoprovision(false)
         .driver("driver")
         .driverOpts(Map.of(
                 "driverOptsKey", "driverOpts"))
         .labels(Map.of(
                 "labelsKey", "labels"))
         .scope("scope")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder A builder for CfnTaskDefinition.DockerVolumeConfigurationProperty
static class	CfnTaskDefinition.DockerVolumeConfigurationProperty.Jsii$Proxy An implementation for CfnTaskDefinition.DockerVolumeConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder	builder()
default java.lang.Object	getAutoprovision() If this value is `true` , the Docker volume is created if it doesn't already exist.
default java.lang.String	getDriver() The Docker volume driver to use.
default java.lang.Object	getDriverOpts() A map of Docker driver-specific options passed through.
default java.lang.Object	getLabels() Custom metadata to add to your Docker volume.
default java.lang.String	getScope() The scope for the Docker volume that determines its lifecycle.

Method Detail

getAutoprovision

default java.lang.Object getAutoprovision()

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 .

getDriver

default java.lang.String getDriver()

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. For more information, see Docker plugin discovery . This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create .

getDriverOpts

default java.lang.Object getDriverOpts()

A map of Docker driver-specific options passed through.

This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create .

getLabels

default java.lang.Object getLabels()

Custom metadata to add to your Docker volume.

This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create .

getScope

default java.lang.String getScope()

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.

builder

static CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder builder()

Returns:

a CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder of CfnTaskDefinition.DockerVolumeConfigurationProperty