EFSVolumeConﬁguration

This is used when you're using an Amazon Elastic File System ﬁle system for job storage. For more information, see Amazon EFS Volumes in the AWS Batch User Guide.

authorizationConﬁg

The authorization conﬁguration details for the Amazon EFS ﬁle system.

Type: EFSAuthorizationConﬁg (p. 146) object Required: No

ﬁleSystemId

The Amazon EFS ﬁle system ID to use.

Type: String Required: Yes rootDirectory

The directory within the Amazon EFS ﬁle 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 eﬀect as omitting this parameter. The maximum length is 4,096 characters.

Important

If an EFS access point is speciﬁed 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.

Type: String Required: No 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.

Type: String

Valid Values: ENABLED | DISABLED Required: No

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.

Type: Integer Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for Ruby V3

EvaluateOnExit

Speciﬁes a set of conditions to be met, and an action to take (RETRY or EXIT) if all conditions are met.

action

Speciﬁes the action to take if all of the speciﬁed conditions (onStatusReason, onReason, and onExitCode) are met. The values aren't case sensitive.

Type: String

Valid Values: RETRY | EXIT Required: Yes

onExitCode

Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters in length. It can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can be between 1 and 512 characters in length.

Type: String Required: No onReason

Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can be between 1 and 512 characters in length.

Type: String Required: No onStatusReason

Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can be between 1 and 512 characters in length.

Type: String Required: No

For example, a computeReservation value of 50 indicates that AWS Batch should reserve 50% of the maximum available vCPU if there is only one fair share identiﬁer, 25% if there are two fair share identiﬁers, and 12.5% if there are three fair share identiﬁers. A computeReservation value of 25 indicates that AWS Batch should reserve 25% of the maximum available vCPU if there is only one fair share identiﬁer, 6.25% if there are two fair share identiﬁers, and 1.56% if there are three fair share identiﬁers.

The minimum value is 0 and the maximum value is 99.

Type: Integer Required: No shareDecaySeconds

The time period to use to calculate a fair share percentage for each fair share identiﬁer in use, in seconds. A value of zero (0) indicates that only current usage should be measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

Type: Integer Required: No shareDistribution

An array of SharedIdentifier objects that contain the weights for the fair share identiﬁers for the fair share policy. Fair share identiﬁers that aren't included have a default weight of 1.0.

Type: Array of ShareAttributes (p. 191) objects Required: No

EFSVolumeConﬁguration