Interface CfnTaskDefinition.IVolumeProperty
The data volume configuration for tasks launched using this task definition.
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IVolumeProperty
Syntax (vb)
Public Interface IVolumeProperty
Remarks
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 .
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 volumeProperty = new VolumeProperty {
ConfiguredAtLaunch = false,
DockerVolumeConfiguration = new DockerVolumeConfigurationProperty {
Autoprovision = false,
Driver = "driver",
DriverOpts = new Dictionary<string, string> {
{ "driverOptsKey", "driverOpts" }
},
Labels = new Dictionary<string, string> {
{ "labelsKey", "labels" }
},
Scope = "scope"
},
EfsVolumeConfiguration = new EFSVolumeConfigurationProperty {
FilesystemId = "filesystemId",
// the properties below are optional
AuthorizationConfig = new AuthorizationConfigProperty {
AccessPointId = "accessPointId",
Iam = "iam"
},
RootDirectory = "rootDirectory",
TransitEncryption = "transitEncryption",
TransitEncryptionPort = 123
},
FSxWindowsFileServerVolumeConfiguration = new FSxWindowsFileServerVolumeConfigurationProperty {
FileSystemId = "fileSystemId",
RootDirectory = "rootDirectory",
// the properties below are optional
AuthorizationConfig = new FSxAuthorizationConfigProperty {
CredentialsParameter = "credentialsParameter",
Domain = "domain"
}
},
Host = new HostVolumePropertiesProperty {
SourcePath = "sourcePath"
},
Name = "name"
};
Synopsis
Properties
ConfiguredAtLaunch | Indicates whether the volume should be configured at launch time. |
DockerVolumeConfiguration | This parameter is specified when you use Docker volumes. |
EfsVolumeConfiguration | This parameter is specified when you use an Amazon Elastic File System file system for task storage. |
FSxWindowsFileServerVolumeConfiguration | This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. |
Host | This parameter is specified when you use bind mount host volumes. |
Name | The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. |
Properties
ConfiguredAtLaunch
Indicates whether the volume should be configured at launch time.
virtual object ConfiguredAtLaunch { get; }
Property Value
System.Object
Remarks
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
This parameter is specified when you use Docker volumes.
virtual object DockerVolumeConfiguration { get; }
Property Value
System.Object
Remarks
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 AWS Fargate .
EfsVolumeConfiguration
This parameter is specified when you use an Amazon Elastic File System file system for task storage.
virtual object EfsVolumeConfiguration { get; }
Property Value
System.Object
Remarks
FSxWindowsFileServerVolumeConfiguration
This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.
virtual object FSxWindowsFileServerVolumeConfiguration { get; }
Property Value
System.Object
Remarks
Host
This parameter is specified when you use bind mount host volumes.
virtual object Host { get; }
Property Value
System.Object
Remarks
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:</code> , but not
D:\my\path:C:\my\path
or D::C:\my\path
.
Name
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
virtual string Name { get; }
Property Value
System.String
Remarks
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.