Package software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.DockerVolumeConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnTaskDefinition.DockerVolumeConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnTaskDefinition
@Stability(Stable) public static interface CfnTaskDefinition.DockerVolumeConfigurationProperty extends software.amazon.jsii.JsiiSerializable
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();

  • Method Details

    • getAutoprovision

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) static CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder builder()
      Returns:
      a CfnTaskDefinition.DockerVolumeConfigurationProperty.Builder of CfnTaskDefinition.DockerVolumeConfigurationProperty