aws-cdk-lib.aws_batch.CfnJobDefinition.AuthorizationConfigProperty

interface AuthorizationConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Batch.CfnJobDefinition.AuthorizationConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnJobDefinition_AuthorizationConfigProperty
Javasoftware.amazon.awscdk.services.batch.CfnJobDefinition.AuthorizationConfigProperty
Pythonaws_cdk.aws_batch.CfnJobDefinition.AuthorizationConfigProperty
TypeScript aws-cdk-lib » aws_batch » CfnJobDefinition » AuthorizationConfigProperty

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 { aws_batch as batch } from 'aws-cdk-lib';
const authorizationConfigProperty: batch.CfnJobDefinition.AuthorizationConfigProperty = {
  accessPointId: 'accessPointId',
  iam: 'iam',
};

Properties

NameTypeDescription
accessPointId?stringThe Amazon EFS access point ID to use.
iam?stringWhether or not to use the AWS Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.

accessPointId?

Type: string (optional)

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?

Type: string (optional)

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.