com.amazonaws.services.ecs.model

Class EFSVolumeConfiguration

java.lang.Object

com.amazonaws.services.ecs.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 parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the Amazon Elastic Container Service Developer 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() Whether or not 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)
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) Whether or not 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) Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
EFSVolumeConfiguration	withTransitEncryption(String transitEncryption) Whether or not 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

finalize, 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 will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the 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 will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the 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 will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the 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 will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the 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 will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the 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 will be used. Specifying / will have the same effect as omitting this parameter.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to / which will enforce the path set on the EFS access point.

Returns:

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

setTransitEncryption

public void setTransitEncryption(String transitEncryption)

Whether or not 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 - Whether or not 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()

Whether or not 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:

Whether or not 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)

Whether or not 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 - Whether or not 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)

Whether or not 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 - Whether or not 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 do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. 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 do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. 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 do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. 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 do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. 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 do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. 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 do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. 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)

Specified by:

marshall in interface StructuredPojo