Class CfnTaskDefinition.DockerVolumeConfigurationProperty
The DockerVolumeConfiguration
property specifies a Docker volume configuration and is used when you use Docker volumes.
Inheritance
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.AWS.ECS.dll
Syntax (csharp)
public class DockerVolumeConfigurationProperty : Object, CfnTaskDefinition.IDockerVolumeConfigurationProperty
Syntax (vb)
Public Class DockerVolumeConfigurationProperty
Inherits Object
Implements CfnTaskDefinition.IDockerVolumeConfigurationProperty
Remarks
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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;
var dockerVolumeConfigurationProperty = new DockerVolumeConfigurationProperty {
Autoprovision = false,
Driver = "driver",
DriverOpts = new Dictionary<string, string> {
{ "driverOptsKey", "driverOpts" }
},
Labels = new Dictionary<string, string> {
{ "labelsKey", "labels" }
},
Scope = "scope"
};
Synopsis
Constructors
DockerVolumeConfigurationProperty() |
Properties
Autoprovision | If this value is |
Driver | The Docker volume driver to use. |
DriverOpts | A map of Docker driver-specific options passed through. |
Labels | Custom metadata to add to your Docker volume. |
Scope | The scope for the Docker volume that determines its lifecycle. |
Constructors
DockerVolumeConfigurationProperty()
public DockerVolumeConfigurationProperty()
Properties
Autoprovision
If this value is true
, the Docker volume is created if it doesn't already exist.
public object Autoprovision { get; set; }
Property Value
System.Object
Remarks
This field is only used if the scope
is shared
.
Driver
The Docker volume driver to use.
public string Driver { get; set; }
Property Value
System.String
Remarks
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 .
DriverOpts
A map of Docker driver-specific options passed through.
public object DriverOpts { get; set; }
Property Value
System.Object
Remarks
This parameter maps to DriverOpts
in the Create a volume section of the Docker Remote API and the xxopt
option to docker volume create .
Labels
Custom metadata to add to your Docker volume.
public object Labels { get; set; }
Property Value
System.Object
Remarks
This parameter maps to Labels
in the Create a volume section of the Docker Remote API and the xxlabel
option to docker volume create .
Scope
The scope for the Docker volume that determines its lifecycle.
public string Scope { get; set; }
Property Value
System.String
Remarks
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.