Volume Class | AWS SDK for .NET V3

The data volume configuration for tasks launched using this task definition. Specifying a volume configuration in a task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at launch is supported. Each volume defined in the volume configuration may only specify a name and one of either configuredAtLaunch, dockerVolumeConfiguration, efsVolumeConfiguration, fsxWindowsFileServerVolumeConfiguration, or host. If an empty volume configuration is specified, by default Amazon ECS uses a host volume. For more information, see Using data volumes in tasks.

Inheritance Hierarchy

System.Object
Amazon.ECS.Model.Volume

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

Syntax

public class Volume

The Volume type exposes the following members

Constructors

	Name	Description
	Volume()

Properties

Name	Type	Description
ConfiguredAtLaunch	System.Boolean	Gets and sets the property ConfiguredAtLaunch. Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a `volumeConfigurations` object when calling the `CreateService`, `UpdateService`, `RunTask` or `StartTask` APIs.
DockerVolumeConfiguration	Amazon.ECS.Model.DockerVolumeConfiguration	Gets and sets the property DockerVolumeConfiguration. This parameter is specified when you use Docker volumes. Windows containers only support the use of the `local` driver. To use bind mounts, specify the `host` parameter instead. Docker volumes aren't supported by tasks run on Fargate.
EfsVolumeConfiguration	Amazon.ECS.Model.EFSVolumeConfiguration	Gets and sets the property EfsVolumeConfiguration. This parameter is specified when you use an Amazon Elastic File System file system for task storage.
FsxWindowsFileServerVolumeConfiguration	Amazon.ECS.Model.FSxWindowsFileServerVolumeConfiguration	Gets and sets the property FsxWindowsFileServerVolumeConfiguration. This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
Host	Amazon.ECS.Model.HostVolumeProperties	Gets and sets the property Host. This parameter is specified when you use bind mount host volumes. The contents of the `host` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the `host` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as `$env:ProgramData`. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount `C:\my\path:C:\my\path` and `D:\:D:\`, but not `D:\my\path:C:\my\path` or `D:\:C:\my\path`.
Name	System.String	Gets and sets the property Name. The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the `name` is required and must also be specified as the volume name in the `ServiceVolumeConfiguration` or `TaskVolumeConfiguration` parameter when creating your service or standalone task. For all other types of volumes, this name is referenced in the `sourceVolume` parameter of the `mountPoints` object in the container definition. When a volume is using the `efsVolumeConfiguration`, the name is required.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5