Amazonka.Batch.Types.EFSAuthorizationConfig

Documentation

data EFSAuthorizationConfig

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

FromJSON EFSAuthorizationConfig

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Methods

parseJSON :: Value -> Parser EFSAuthorizationConfig

parseJSONList :: Value -> Parser [EFSAuthorizationConfig]

ToJSON EFSAuthorizationConfig

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Methods

toJSON :: EFSAuthorizationConfig -> Value

toEncoding :: EFSAuthorizationConfig -> Encoding

toJSONList :: [EFSAuthorizationConfig] -> Value

toEncodingList :: [EFSAuthorizationConfig] -> Encoding

Generic EFSAuthorizationConfig

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Associated Types

type Rep EFSAuthorizationConfig :: Type -> Type

Methods

from :: EFSAuthorizationConfig -> Rep EFSAuthorizationConfig x

to :: Rep EFSAuthorizationConfig x -> EFSAuthorizationConfig

Read EFSAuthorizationConfig

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Methods

readsPrec :: Int -> ReadS EFSAuthorizationConfig

readList :: ReadS [EFSAuthorizationConfig]

readPrec :: ReadPrec EFSAuthorizationConfig

readListPrec :: ReadPrec [EFSAuthorizationConfig]

Show EFSAuthorizationConfig

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Methods

showsPrec :: Int -> EFSAuthorizationConfig -> ShowS

show :: EFSAuthorizationConfig -> String

showList :: [EFSAuthorizationConfig] -> ShowS

NFData EFSAuthorizationConfig

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Methods

rnf :: EFSAuthorizationConfig -> ()

Eq EFSAuthorizationConfig

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Methods

(==) :: EFSAuthorizationConfig -> EFSAuthorizationConfig -> Bool

(/=) :: EFSAuthorizationConfig -> EFSAuthorizationConfig -> Bool

Hashable EFSAuthorizationConfig

Defined in Amazonka.Batch.Types.EFSAuthorizationConfig

Methods

hashWithSalt :: Int -> EFSAuthorizationConfig -> Int

hash :: EFSAuthorizationConfig -> Int

type Rep EFSAuthorizationConfig

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

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)

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)

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.