Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Batch.Types.EFSVolumeConfiguration

Description

Documentation

data EFSVolumeConfiguration Source #

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.

See: newEFSVolumeConfiguration smart constructor.

Constructors

EFSVolumeConfiguration'

Fields

rootDirectory :: Maybe Text
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.
transitEncryption :: Maybe EFSTransitEncryption
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.
authorizationConfig :: Maybe EFSAuthorizationConfig
The authorization configuration details for the Amazon EFS file system.
transitEncryptionPort :: Maybe Int
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.
fileSystemId :: Text
The Amazon EFS file system ID to use.

Instances

Instances details

Eq EFSVolumeConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.EFSVolumeConfiguration Methods (==) :: EFSVolumeConfiguration -> EFSVolumeConfiguration -> Bool # (/=) :: EFSVolumeConfiguration -> EFSVolumeConfiguration -> Bool #
Read EFSVolumeConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.EFSVolumeConfiguration Methods readsPrec :: Int -> ReadS EFSVolumeConfiguration # readList :: ReadS [EFSVolumeConfiguration] # readPrec :: ReadPrec EFSVolumeConfiguration # readListPrec :: ReadPrec [EFSVolumeConfiguration] #
Show EFSVolumeConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.EFSVolumeConfiguration Methods showsPrec :: Int -> EFSVolumeConfiguration -> ShowS # show :: EFSVolumeConfiguration -> String # showList :: [EFSVolumeConfiguration] -> ShowS #
Generic EFSVolumeConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.EFSVolumeConfiguration Associated Types type Rep EFSVolumeConfiguration :: Type -> Type # Methods from :: EFSVolumeConfiguration -> Rep EFSVolumeConfiguration x # to :: Rep EFSVolumeConfiguration x -> EFSVolumeConfiguration #
NFData EFSVolumeConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.EFSVolumeConfiguration Methods rnf :: EFSVolumeConfiguration -> () #
Hashable EFSVolumeConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.EFSVolumeConfiguration Methods hashWithSalt :: Int -> EFSVolumeConfiguration -> Int # hash :: EFSVolumeConfiguration -> Int #
ToJSON EFSVolumeConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.EFSVolumeConfiguration Methods toJSON :: EFSVolumeConfiguration -> Value # toEncoding :: EFSVolumeConfiguration -> Encoding # toJSONList :: [EFSVolumeConfiguration] -> Value # toEncodingList :: [EFSVolumeConfiguration] -> Encoding #
FromJSON EFSVolumeConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.EFSVolumeConfiguration Methods parseJSON :: Value -> Parser EFSVolumeConfiguration # parseJSONList :: Value -> Parser [EFSVolumeConfiguration] #
type Rep EFSVolumeConfiguration Source #
Instance details Defined in Amazonka.Batch.Types.EFSVolumeConfiguration type Rep EFSVolumeConfiguration = D1 ('MetaData "EFSVolumeConfiguration" "Amazonka.Batch.Types.EFSVolumeConfiguration" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "EFSVolumeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rootDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "transitEncryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSTransitEncryption))) :: (S1 ('MetaSel ('Just "authorizationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSAuthorizationConfig)) :: (S1 ('MetaSel ('Just "transitEncryptionPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newEFSVolumeConfiguration Source #

Arguments

:: Text	`$sel:fileSystemId:EFSVolumeConfiguration'`
-> EFSVolumeConfiguration

Create a value of EFSVolumeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:rootDirectory:EFSVolumeConfiguration', eFSVolumeConfiguration_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.

$sel:transitEncryption:EFSVolumeConfiguration', eFSVolumeConfiguration_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.

$sel:authorizationConfig:EFSVolumeConfiguration', eFSVolumeConfiguration_authorizationConfig - The authorization configuration details for the Amazon EFS file system.

$sel:transitEncryptionPort:EFSVolumeConfiguration', eFSVolumeConfiguration_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.

$sel:fileSystemId:EFSVolumeConfiguration', eFSVolumeConfiguration_fileSystemId - The Amazon EFS file system ID to use.

eFSVolumeConfiguration_rootDirectory :: Lens' EFSVolumeConfiguration (Maybe Text) Source #

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.

eFSVolumeConfiguration_transitEncryption :: Lens' EFSVolumeConfiguration (Maybe EFSTransitEncryption) Source #

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.

eFSVolumeConfiguration_authorizationConfig :: Lens' EFSVolumeConfiguration (Maybe EFSAuthorizationConfig) Source #

The authorization configuration details for the Amazon EFS file system.

eFSVolumeConfiguration_transitEncryptionPort :: Lens' EFSVolumeConfiguration (Maybe Int) Source #

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.

eFSVolumeConfiguration_fileSystemId :: Lens' EFSVolumeConfiguration Text Source #

The Amazon EFS file system ID to use.