amazonka-batch-2.0: Amazon Batch SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Batch.Types.EFSAuthorizationConfig

Description

 
Synopsis

Documentation

data EFSAuthorizationConfig Source #

The authorization configuration details for the Amazon EFS file system.

See: newEFSAuthorizationConfig smart constructor.

Constructors

EFSAuthorizationConfig' 

Fields

  • accessPointId :: Maybe Text

    The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

  • iam :: Maybe EFSAuthorizationConfigIAM

    Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

Instances

Instances details
FromJSON EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

ToJSON EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Generic EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Associated Types

type Rep EFSAuthorizationConfig :: Type -> Type #

Read EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Show EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

NFData EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Methods

rnf :: EFSAuthorizationConfig -> () #

Eq EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Hashable EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

type Rep EFSAuthorizationConfig Source # 
Instance details

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

type Rep EFSAuthorizationConfig = D1 ('MetaData "EFSAuthorizationConfig" "Amazonka.Batch.Types.EFSAuthorizationConfig" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EFSAuthorizationConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accessPointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "iam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EFSAuthorizationConfigIAM))))

newEFSAuthorizationConfig :: EFSAuthorizationConfig Source #

Create a value of EFSAuthorizationConfig 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:accessPointId:EFSAuthorizationConfig', eFSAuthorizationConfig_accessPointId - The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

$sel:iam:EFSAuthorizationConfig', eFSAuthorizationConfig_iam - Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

eFSAuthorizationConfig_accessPointId :: Lens' EFSAuthorizationConfig (Maybe Text) Source #

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

eFSAuthorizationConfig_iam :: Lens' EFSAuthorizationConfig (Maybe EFSAuthorizationConfigIAM) Source #

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.