Class CfnJobDefinition.EfsVolumeConfigurationProperty
This is used when you're using an Amazon Elastic File System file system for job storage.
Inheritance
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EfsVolumeConfigurationProperty : Object, CfnJobDefinition.IEfsVolumeConfigurationProperty
Syntax (vb)
Public Class EfsVolumeConfigurationProperty
Inherits Object
Implements CfnJobDefinition.IEfsVolumeConfigurationProperty
Remarks
For more information, see Amazon EFS Volumes in the AWS Batch User Guide .
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 efsVolumeConfigurationProperty = new EfsVolumeConfigurationProperty {
FileSystemId = "fileSystemId",
// the properties below are optional
AuthorizationConfig = new AuthorizationConfigProperty {
AccessPointId = "accessPointId",
Iam = "iam"
},
RootDirectory = "rootDirectory",
TransitEncryption = "transitEncryption",
TransitEncryptionPort = 123
};
Synopsis
Constructors
EfsVolumeConfigurationProperty() |
Properties
AuthorizationConfig | The authorization configuration details for the Amazon EFS file system. |
FileSystemId | The Amazon EFS file system ID to use. |
RootDirectory | The directory within the Amazon EFS file system to mount as the root directory inside the host. |
TransitEncryption | Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. |
TransitEncryptionPort | The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. |
Constructors
EfsVolumeConfigurationProperty()
public EfsVolumeConfigurationProperty()
Properties
AuthorizationConfig
The authorization configuration details for the Amazon EFS file system.
public object AuthorizationConfig { get; set; }
Property Value
System.Object
Remarks
FileSystemId
The Amazon EFS file system ID to use.
public string FileSystemId { get; set; }
Property Value
System.String
Remarks
RootDirectory
The directory within the Amazon EFS file system to mount as the root directory inside the host.
public string RootDirectory { get; set; }
Property Value
System.String
Remarks
If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying /
has the same effect as omitting this parameter. The maximum length is 4,096 characters.
If an EFS access point is specified in the authorizationConfig
, the root directory parameter must either be omitted or set to /
, which enforces the path set on the Amazon EFS access point.
TransitEncryption
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
public string TransitEncryption { get; set; }
Property Value
System.String
Remarks
Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED
is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide .
TransitEncryptionPort
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
public Nullable<double> TransitEncryptionPort { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide .