com.amazonaws.services.batch.model

Class EFSVolumeConfiguration

java.lang.Object

com.amazonaws.services.batch.model.EFSVolumeConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EFSVolumeConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
EFSVolumeConfiguration()

Method Summary

Modifier and Type	Method and Description
EFSVolumeConfiguration	clone()
boolean	equals(Object obj)
EFSAuthorizationConfig	getAuthorizationConfig() The authorization configuration details for the Amazon EFS file system.
String	getFileSystemId() The Amazon EFS file system ID to use.
String	getRootDirectory() The directory within the Amazon EFS file system to mount as the root directory inside the host.
String	getTransitEncryption() Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
Integer	getTransitEncryptionPort() The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAuthorizationConfig(EFSAuthorizationConfig authorizationConfig) The authorization configuration details for the Amazon EFS file system.
void	setFileSystemId(String fileSystemId) The Amazon EFS file system ID to use.
void	setRootDirectory(String rootDirectory) The directory within the Amazon EFS file system to mount as the root directory inside the host.
void	setTransitEncryption(String transitEncryption) Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
void	setTransitEncryptionPort(Integer transitEncryptionPort) The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
String	toString() Returns a string representation of this object.
EFSVolumeConfiguration	withAuthorizationConfig(EFSAuthorizationConfig authorizationConfig) The authorization configuration details for the Amazon EFS file system.
EFSVolumeConfiguration	withFileSystemId(String fileSystemId) The Amazon EFS file system ID to use.
EFSVolumeConfiguration	withRootDirectory(String rootDirectory) The directory within the Amazon EFS file system to mount as the root directory inside the host.
EFSVolumeConfiguration	withTransitEncryption(EFSTransitEncryption transitEncryption) Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
EFSVolumeConfiguration	withTransitEncryption(String transitEncryption) Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
EFSVolumeConfiguration	withTransitEncryptionPort(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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EFSVolumeConfiguration

public EFSVolumeConfiguration()

Method Detail

setFileSystemId

public void setFileSystemId(String fileSystemId)

The Amazon EFS file system ID to use.

Parameters:

fileSystemId - The Amazon EFS file system ID to use.

getFileSystemId

public String getFileSystemId()

The Amazon EFS file system ID to use.

Returns:

The Amazon EFS file system ID to use.

withFileSystemId

public EFSVolumeConfiguration withFileSystemId(String fileSystemId)

The Amazon EFS file system ID to use.

Parameters:

fileSystemId - The Amazon EFS file system ID to use.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRootDirectory

public void setRootDirectory(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.

Parameters:

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.

getRootDirectory

public 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.

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.

withRootDirectory

public EFSVolumeConfiguration withRootDirectory(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTransitEncryption

public void setTransitEncryption(String 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.

Parameters:

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.

See Also:

EFSTransitEncryption

getTransitEncryption

public 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.

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

withTransitEncryption

public EFSVolumeConfiguration withTransitEncryption(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EFSTransitEncryption

withTransitEncryption

public EFSVolumeConfiguration withTransitEncryption(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EFSTransitEncryption

setTransitEncryptionPort

public void setTransitEncryptionPort(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.

Parameters:

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.

getTransitEncryptionPort

public Integer 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.

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.

withTransitEncryptionPort

public EFSVolumeConfiguration withTransitEncryptionPort(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setAuthorizationConfig

public void setAuthorizationConfig(EFSAuthorizationConfig authorizationConfig)

The authorization configuration details for the Amazon EFS file system.

Parameters:

authorizationConfig - The authorization configuration details for the Amazon EFS file system.

getAuthorizationConfig

public EFSAuthorizationConfig getAuthorizationConfig()

The authorization configuration details for the Amazon EFS file system.

Returns:

The authorization configuration details for the Amazon EFS file system.

withAuthorizationConfig

public EFSVolumeConfiguration withAuthorizationConfig(EFSAuthorizationConfig authorizationConfig)

The authorization configuration details for the Amazon EFS file system.

Parameters:

authorizationConfig - The authorization configuration details for the Amazon EFS file system.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public EFSVolumeConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.