Class: Aws::Batch::Types::EFSVolumeConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorization_configTypes::EFSAuthorizationConfig

The authorization configuration details for the Amazon EFS file system.



2879
2880
2881
2882
2883
2884
2885
2886
2887
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2879

class EFSVolumeConfiguration < Struct.new(
  :file_system_id,
  :root_directory,
  :transit_encryption,
  :transit_encryption_port,
  :authorization_config)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_idString

The Amazon EFS file system ID to use.

Returns:

  • (String)


2879
2880
2881
2882
2883
2884
2885
2886
2887
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2879

class EFSVolumeConfiguration < Struct.new(
  :file_system_id,
  :root_directory,
  :transit_encryption,
  :transit_encryption_port,
  :authorization_config)
  SENSITIVE = []
  include Aws::Structure
end

#root_directoryString

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.

Returns:

  • (String)


2879
2880
2881
2882
2883
2884
2885
2886
2887
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2879

class EFSVolumeConfiguration < Struct.new(
  :file_system_id,
  :root_directory,
  :transit_encryption,
  :transit_encryption_port,
  :authorization_config)
  SENSITIVE = []
  include Aws::Structure
end

#transit_encryptionString

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.

Returns:

  • (String)


2879
2880
2881
2882
2883
2884
2885
2886
2887
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2879

class EFSVolumeConfiguration < Struct.new(
  :file_system_id,
  :root_directory,
  :transit_encryption,
  :transit_encryption_port,
  :authorization_config)
  SENSITIVE = []
  include Aws::Structure
end

#transit_encryption_portInteger

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.

Returns:

  • (Integer)


2879
2880
2881
2882
2883
2884
2885
2886
2887
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2879

class EFSVolumeConfiguration < Struct.new(
  :file_system_id,
  :root_directory,
  :transit_encryption,
  :transit_encryption_port,
  :authorization_config)
  SENSITIVE = []
  include Aws::Structure
end