com.amazonaws.services.elasticfilesystem.model

Class CreateFileSystemRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticfilesystem.model.CreateFileSystemRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateFileSystemRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateFileSystem operation.

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:

• Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state "creating".
• Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

NOTE:For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

NOTE:The CreateFileSystem call returns while the file system's lifecycle state is still "creating". You can check the file system creation status by calling the DescribeFileSystems API, which among other things returns the file system state.

After the file system is fully created, Amazon EFS sets its lifecycle state to "available", at which point you can create one or more mount targets for the file system (CreateMountTarget) in your VPC. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works

This operation requires permission for the elasticfilesystem:CreateFileSystem action.

See Also:

AmazonElasticFileSystem.createFileSystem(CreateFileSystemRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateFileSystemRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateFileSystemRequest	clone()
boolean	equals(Object obj)
String	getCreationToken() String of up to 64 ASCII characters.
int	hashCode()
void	setCreationToken(String creationToken) String of up to 64 ASCII characters.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateFileSystemRequest	withCreationToken(String creationToken) String of up to 64 ASCII characters.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateFileSystemRequest

public CreateFileSystemRequest()

Method Detail

getCreationToken

public String getCreationToken()

String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Constraints:
Length: 1 - 64

Returns:

String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

setCreationToken

public void setCreationToken(String creationToken)

String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Constraints:
Length: 1 - 64

Parameters:

creationToken - String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

withCreationToken

public CreateFileSystemRequest withCreationToken(String creationToken)

String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

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

Constraints:
Length: 1 - 64

Parameters:

creationToken - String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CreateFileSystemRequest clone()

Overrides:

clone in class AmazonWebServiceRequest