Interface CfnTaskDefinition.IDockerVolumeConfigurationProperty

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

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.AWS.ECS.dll

Syntax (csharp)

public interface IDockerVolumeConfigurationProperty

Syntax (vb)

Public Interface 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html

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

Properties

Autoprovision	If this value is true , the Docker volume is created if it doesn't already exist.
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.

Properties

Autoprovision

If this value is true , the Docker volume is created if it doesn't already exist.

virtual object Autoprovision { get; }

Property Value

System.Object

Remarks

This field is only used if the scope is shared .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-autoprovision

Driver

The Docker volume driver to use.

virtual string Driver { get; }

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driver

DriverOpts

A map of Docker driver-specific options passed through.

virtual object DriverOpts { get; }

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-driveropts

Labels

Custom metadata to add to your Docker volume.

virtual object Labels { get; }

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-labels

Scope

The scope for the Docker volume that determines its lifecycle.

virtual string Scope { get; }

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-dockervolumeconfiguration.html#cfn-ecs-taskdefinition-dockervolumeconfiguration-scope