/AWS1/CL_BTCEFSVOLUMECONF¶
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 Batch User Guide.
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
iv_filesystemid
TYPE /AWS1/BTCSTRING
/AWS1/BTCSTRING
¶
The Amazon EFS file system ID to use.
Optional arguments:¶
iv_rootdirectory
TYPE /AWS1/BTCSTRING
/AWS1/BTCSTRING
¶
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.
iv_transitencryption
TYPE /AWS1/BTCEFSTRANSITENCRYPTION
/AWS1/BTCEFSTRANSITENCRYPTION
¶
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.
iv_transitencryptionport
TYPE /AWS1/BTCINTEGER
/AWS1/BTCINTEGER
¶
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.
io_authorizationconfig
TYPE REF TO /AWS1/CL_BTCEFSAUTHCONFIG
/AWS1/CL_BTCEFSAUTHCONFIG
¶
The authorization configuration details for the Amazon EFS file system.
Queryable Attributes¶
fileSystemId¶
The Amazon EFS file system ID to use.
Accessible with the following methods¶
Method | Description |
---|---|
GET_FILESYSTEMID() |
Getter for FILESYSTEMID, with configurable default |
ASK_FILESYSTEMID() |
Getter for FILESYSTEMID w/ exceptions if field has no value |
HAS_FILESYSTEMID() |
Determine if FILESYSTEMID has a value |
rootDirectory¶
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ROOTDIRECTORY() |
Getter for ROOTDIRECTORY, with configurable default |
ASK_ROOTDIRECTORY() |
Getter for ROOTDIRECTORY w/ exceptions if field has no value |
HAS_ROOTDIRECTORY() |
Determine if ROOTDIRECTORY has a value |
transitEncryption¶
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TRANSITENCRYPTION() |
Getter for TRANSITENCRYPTION, with configurable default |
ASK_TRANSITENCRYPTION() |
Getter for TRANSITENCRYPTION w/ exceptions if field has no v |
HAS_TRANSITENCRYPTION() |
Determine if TRANSITENCRYPTION has a value |
transitEncryptionPort¶
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TRANSITENCRYPTIONPORT() |
Getter for TRANSITENCRYPTIONPORT, with configurable default |
ASK_TRANSITENCRYPTIONPORT() |
Getter for TRANSITENCRYPTIONPORT w/ exceptions if field has |
HAS_TRANSITENCRYPTIONPORT() |
Determine if TRANSITENCRYPTIONPORT has a value |
authorizationConfig¶
The authorization configuration details for the Amazon EFS file system.
Accessible with the following methods¶
Method | Description |
---|---|
GET_AUTHORIZATIONCONFIG() |
Getter for AUTHORIZATIONCONFIG |