class Aws::Batch::Types::EFSVolumeConfiguration

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*.

[1]: docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html

@note When making an API call, you may pass EFSVolumeConfiguration

data as a hash:

    {
      file_system_id: "String", # required
      root_directory: "String",
      transit_encryption: "ENABLED", # accepts ENABLED, DISABLED
      transit_encryption_port: 1,
      authorization_config: {
        access_point_id: "String",
        iam: "ENABLED", # accepts ENABLED, DISABLED
      },
    }

@!attribute [rw] file_system_id

The Amazon EFS file system ID to use.
@return [String]

@!attribute [rw] root_directory

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.
@return [String]

@!attribute [rw] transit_encryption

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][1] in the *Amazon Elastic File System User Guide*.

[1]: https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html
@return [String]

@!attribute [rw] transit_encryption_port

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][1] in the *Amazon Elastic
File System User Guide*.

[1]: https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html
@return [Integer]

@!attribute [rw] authorization_config

The authorization configuration details for the Amazon EFS file
system.
@return [Types::EFSAuthorizationConfig]

@see docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/EFSVolumeConfiguration AWS API Documentation

Constants

SENSITIVE