DockerVolumeConfigurationArgs

data class DockerVolumeConfigurationArgs(val autoprovision: Output<Boolean>? = null, val driver: Output<String>? = null, val driverOpts: Output<Any>? = null, val labels: Output<Any>? = null, val scope: Output<String>? = null) : ConvertibleToJava<DockerVolumeConfigurationArgs>

Definition of DockerVolumeConfiguration

Constructors

Link copied to clipboard
constructor(autoprovision: Output<Boolean>? = null, driver: Output<String>? = null, driverOpts: Output<Any>? = null, labels: Output<Any>? = null, scope: Output<String>? = null)

Properties

Link copied to clipboard
val autoprovision: Output<Boolean>? = null

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

Link copied to clipboard
val driver: Output<String>? = null

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.

Link copied to clipboard
val driverOpts: Output<Any>? = null

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.

Link copied to clipboard
val labels: Output<Any>? = null

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.

Link copied to clipboard
val scope: Output<String>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): DockerVolumeConfigurationArgs