AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ECS::Types::EFSVolumeConfiguration

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

Overview

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
  },
}

This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the Amazon Elastic Container Service Developer 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.



4703
4704
4705
4706
4707
4708
4709
4710
4711
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4703

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)


4703
4704
4705
4706
4707
4708
4709
4710
4711
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4703

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 will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

Returns:

  • (String)


4703
4704
4705
4706
4707
4708
4709
4710
4711
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4703

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

#transit_encryptionString

Whether or not 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)


4703
4704
4705
4706
4707
4708
4709
4710
4711
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4703

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 do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.

Returns:

  • (Integer)


4703
4704
4705
4706
4707
4708
4709
4710
4711
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 4703

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