Package software.amazon.awssdk.services.batch.model

Class EFSVolumeConfiguration

java.lang.Object

software.amazon.awssdk.services.batch.model.EFSVolumeConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EFSVolumeConfiguration.Builder,EFSVolumeConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class EFSVolumeConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EFSVolumeConfiguration.Builder,EFSVolumeConfiguration>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EFSVolumeConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
EFSAuthorizationConfig	authorizationConfig()	The authorization configuration details for the Amazon EFS file system.
static EFSVolumeConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fileSystemId()	The Amazon EFS file system ID to use.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	rootDirectory()	The directory within the Amazon EFS file system to mount as the root directory inside the host.
List<SdkField<?>>	sdkFields()
static Class<? extends EFSVolumeConfiguration.Builder>	serializableBuilderClass()
EFSVolumeConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
EFSTransitEncryption	transitEncryption()	Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
String	transitEncryptionAsString()	Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
Integer	transitEncryptionPort()	The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fileSystemId

public final String fileSystemId()

The Amazon EFS file system ID to use.

Returns:

The Amazon EFS file system ID to use.

rootDirectory

public final String rootDirectory()

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.

Returns:

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.

transitEncryption

public final EFSTransitEncryption transitEncryption()

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.

If the service returns an enum value that is not available in the current SDK version, transitEncryption will return EFSTransitEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transitEncryptionAsString().

Returns:

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.

See Also:

EFSTransitEncryption

transitEncryptionAsString

public final String transitEncryptionAsString()

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.

If the service returns an enum value that is not available in the current SDK version, transitEncryption will return EFSTransitEncryption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transitEncryptionAsString().

Returns:

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.

See Also:

EFSTransitEncryption

transitEncryptionPort

public final Integer transitEncryptionPort()

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.

Returns:

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.

authorizationConfig

public final EFSAuthorizationConfig authorizationConfig()

The authorization configuration details for the Amazon EFS file system.

Returns:

The authorization configuration details for the Amazon EFS file system.

toBuilder

public EFSVolumeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EFSVolumeConfiguration.Builder,EFSVolumeConfiguration>

builder

public static EFSVolumeConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends EFSVolumeConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo