software.amazon.awscdk.services.batch

Interface CfnJobDefinition.AuthorizationConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.AuthorizationConfigProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(value=Stable)
public static interface CfnJobDefinition.AuthorizationConfigProperty
extends software.amazon.jsii.JsiiSerializable

The authorization configuration details for the Amazon EFS file system.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 AuthorizationConfigProperty authorizationConfigProperty = AuthorizationConfigProperty.builder()
         .accessPointId("accessPointId")
         .iam("iam")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnJobDefinition.AuthorizationConfigProperty.Builder A builder for CfnJobDefinition.AuthorizationConfigProperty
static class	CfnJobDefinition.AuthorizationConfigProperty.Jsii$Proxy An implementation for CfnJobDefinition.AuthorizationConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnJobDefinition.AuthorizationConfigProperty.Builder	builder()
default String	getAccessPointId() The Amazon EFS access point ID to use.
default String	getIam() Whether or not to use the AWS Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessPointId

@Stability(value=Stable)
 @Nullable
default String getAccessPointId()

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 will enforce 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 .

getIam

@Stability(value=Stable)
 @Nullable
default String getIam()

Whether or not to use the AWS 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 AWS Batch User Guide . EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

builder

@Stability(value=Stable)
static CfnJobDefinition.AuthorizationConfigProperty.Builder builder()

Returns:

a CfnJobDefinition.AuthorizationConfigProperty.Builder of CfnJobDefinition.AuthorizationConfigProperty