software.amazon.awscdk.services.batch

Interface CfnJobDefinition.EfsVolumeConfigurationProperty

All Known Implementing Classes:

CfnJobDefinition.EfsVolumeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

public static interface CfnJobDefinition.EfsVolumeConfigurationProperty

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 AWS Batch User Guide .

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.*;
 EfsVolumeConfigurationProperty efsVolumeConfigurationProperty = EfsVolumeConfigurationProperty.builder()
         .fileSystemId("fileSystemId")
         // the properties below are optional
         .authorizationConfig(AuthorizationConfigProperty.builder()
                 .accessPointId("accessPointId")
                 .iam("iam")
                 .build())
         .rootDirectory("rootDirectory")
         .transitEncryption("transitEncryption")
         .transitEncryptionPort(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnJobDefinition.EfsVolumeConfigurationProperty.Builder	builder()
default java.lang.Object	getAuthorizationConfig() The authorization configuration details for the Amazon EFS file system.
java.lang.String	getFileSystemId() The Amazon EFS file system ID to use.
default java.lang.String	getRootDirectory() The directory within the Amazon EFS file system to mount as the root directory inside the host.
default java.lang.String	getTransitEncryption() Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
default java.lang.Number	getTransitEncryptionPort() The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

Method Detail

getFileSystemId

java.lang.String getFileSystemId()

The Amazon EFS file system ID to use.

getAuthorizationConfig

default java.lang.Object getAuthorizationConfig()

The authorization configuration details for the Amazon EFS file system.

getRootDirectory

default java.lang.String getRootDirectory()

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.

getTransitEncryption

default java.lang.String getTransitEncryption()

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 .

getTransitEncryptionPort

default java.lang.Number getTransitEncryptionPort()

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 .

builder

static CfnJobDefinition.EfsVolumeConfigurationProperty.Builder builder()

Returns:

a CfnJobDefinition.EfsVolumeConfigurationProperty.Builder of CfnJobDefinition.EfsVolumeConfigurationProperty