AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.ECS.Model.DockerVolumeConfiguration

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

C# 
public class DockerVolumeConfiguration

The DockerVolumeConfiguration type exposes the following members

Constructors

NameDescription
Public Method DockerVolumeConfiguration()

Properties

NameTypeDescription
Public Property Autoprovision System.Boolean

Gets and sets the property Autoprovision.

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.

Public Property Driver System.String

Gets and sets the property Driver.

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. This parameter maps to Driver in the docker container create command and the xxdriver option to docker volume create.

Public Property DriverOpts System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property DriverOpts.

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the docker create-volume command and the xxopt option to docker volume create.

Public Property Labels System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Labels.

Custom metadata to add to your Docker volume. This parameter maps to Labels in the docker container create command and the xxlabel option to docker volume create.

Public Property Scope Amazon.ECS.Scope

Gets and sets the property Scope.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5