interface EfsVolumeConfigurationProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Batch.CfnJobDefinition.EfsVolumeConfigurationProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnJobDefinition_EfsVolumeConfigurationProperty |
Java | software.amazon.awscdk.services.batch.CfnJobDefinition.EfsVolumeConfigurationProperty |
Python | aws_cdk.aws_batch.CfnJobDefinition.EfsVolumeConfigurationProperty |
TypeScript | aws-cdk-lib » aws_batch » CfnJobDefinition » EfsVolumeConfigurationProperty |
This is used when you're using an Amazon Elastic File System file system for job storage.
For more information, see Amazon EFS Volumes in the AWS Batch User Guide .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_batch as batch } from 'aws-cdk-lib';
const efsVolumeConfigurationProperty: batch.CfnJobDefinition.EfsVolumeConfigurationProperty = {
fileSystemId: 'fileSystemId',
// the properties below are optional
authorizationConfig: {
accessPointId: 'accessPointId',
iam: 'iam',
},
rootDirectory: 'rootDirectory',
transitEncryption: 'transitEncryption',
transitEncryptionPort: 123,
};
Properties
Name | Type | Description |
---|---|---|
file | string | The Amazon EFS file system ID to use. |
authorization | IResolvable | Authorization | The authorization configuration details for the Amazon EFS file system. |
root | string | The directory within the Amazon EFS file system to mount as the root directory inside the host. |
transit | string | Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. |
transit | number | The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. |
fileSystemId
Type:
string
The Amazon EFS file system ID to use.
authorizationConfig?
Type:
IResolvable
|
Authorization
(optional)
The authorization configuration details for the Amazon EFS file system.
rootDirectory?
Type:
string
(optional)
The directory within the Amazon EFS file system to mount as the root directory inside the host.
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?
Type:
string
(optional)
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
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?
Type:
number
(optional)
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
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 .