Class CfnJobDefinition.VolumesProperty
A list of volumes that are associated with the job.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class VolumesProperty : Object, CfnJobDefinition.IVolumesProperty
Syntax (vb)
Public Class VolumesProperty
Inherits Object
Implements CfnJobDefinition.IVolumesProperty
Remarks
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.Batch;
var volumesProperty = new VolumesProperty {
EfsVolumeConfiguration = new EfsVolumeConfigurationProperty {
FileSystemId = "fileSystemId",
// the properties below are optional
AuthorizationConfig = new AuthorizationConfigProperty {
AccessPointId = "accessPointId",
Iam = "iam"
},
RootDirectory = "rootDirectory",
TransitEncryption = "transitEncryption",
TransitEncryptionPort = 123
},
Host = new VolumesHostProperty {
SourcePath = "sourcePath"
},
Name = "name"
};
Synopsis
Constructors
VolumesProperty() |
Properties
EfsVolumeConfiguration | This is used when you're using an Amazon Elastic File System file system for job storage. |
Host | The contents of the |
Name | The name of the volume. |
Constructors
VolumesProperty()
public VolumesProperty()
Properties
EfsVolumeConfiguration
This is used when you're using an Amazon Elastic File System file system for job storage.
public object EfsVolumeConfiguration { get; set; }
Property Value
System.Object
Remarks
For more information, see Amazon EFS Volumes in the AWS Batch User Guide .
Host
The contents of the host
parameter determine whether your data volume persists on the host container instance and where it's stored.
public object Host { get; set; }
Property Value
System.Object
Remarks
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.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
Name
The name of the volume.
public string Name { get; set; }
Property Value
System.String
Remarks
It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume
parameter of container definition mountPoints
.