com.amazonaws.services.elasticfilesystem.model

Class CreateMountTargetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticfilesystem.model.CreateMountTargetRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateMountTargetRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateMountTarget operation.

Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works .

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be "available" (see DescribeFileSystems).

In the request, you also provide a subnet ID, which serves several purposes:

• It determines the VPC in which Amazon EFS creates the mount target.
• It determines the Availability Zone in which Amazon EFS creates the mount target.
• It determines the IP address range from which Amazon EFS selects the IP address of the mount target if you don't specify an IP address in the request.

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress . You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the request to add another mount target must meet the following requirements:

• The subnet specified in the request must belong to the same VPC as the subnets of the existing mount targets.

• The subnet specified in the request must not be in the same Availability Zone as any of the subnets of the existing mount targets.

If the request satisfies the requirements, Amazon EFS does the following:

• Creates a new mount target in the specified subnet.
• Also creates a new network interface in the subnet as follows:
  • If the request provides an IpAddress , Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).
  • If the request provides SecurityGroups , this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.
  • Assigns the description "Mount target fsmt-id for file system fs-id" where fsmt-id is the mount target ID, and fs-id is the FileSystemId .
  • Sets the requesterManaged property of the network interface to "true", and the requesterId value to "EFS".

  Each Amazon EFS mount target has one corresponding requestor-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

NOTE:The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still "creating". You can check the mount target creation status by calling the DescribeFileSystems API, which among other things returns the mount target state.

We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, go to Amazon EFS product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availablity Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target.

This operation requires permission for the following action on the file system:

• elasticfilesystem:CreateMountTarget

This operation also requires permission for the following Amazon EC2 actions:

• ec2:DescribeSubnets
• ec2:DescribeNetworkInterfaces
• ec2:CreateNetworkInterface

See Also:

AmazonElasticFileSystem.createMountTarget(CreateMountTargetRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateMountTargetRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateMountTargetRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getFileSystemId() The ID of the file system for which to create the mount target.
String	getIpAddress() A valid IPv4 address within the address range of the specified subnet.
List<String>	getSecurityGroups() Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx".
String	getSubnetId() The ID of the subnet to add the mount target in.
int	hashCode()
void	setFileSystemId(String fileSystemId) The ID of the file system for which to create the mount target.
void	setIpAddress(String ipAddress) A valid IPv4 address within the address range of the specified subnet.
void	setSecurityGroups(Collection<String> securityGroups) Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx".
void	setSubnetId(String subnetId) The ID of the subnet to add the mount target in.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateMountTargetRequest	withFileSystemId(String fileSystemId) The ID of the file system for which to create the mount target.
CreateMountTargetRequest	withIpAddress(String ipAddress) A valid IPv4 address within the address range of the specified subnet.
CreateMountTargetRequest	withSecurityGroups(Collection<String> securityGroups) Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx".
CreateMountTargetRequest	withSecurityGroups(String... securityGroups) Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx".
CreateMountTargetRequest	withSubnetId(String subnetId) The ID of the subnet to add the mount target in.

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

CreateMountTargetRequest

public CreateMountTargetRequest()

Method Detail

getFileSystemId

public String getFileSystemId()

The ID of the file system for which to create the mount target.

Constraints:
Pattern: fs-[0-9a-f]{8}

Returns:

The ID of the file system for which to create the mount target.

setFileSystemId

public void setFileSystemId(String fileSystemId)

The ID of the file system for which to create the mount target.

Constraints:
Pattern: fs-[0-9a-f]{8}

Parameters:

fileSystemId - The ID of the file system for which to create the mount target.

withFileSystemId

public CreateMountTargetRequest withFileSystemId(String fileSystemId)

The ID of the file system for which to create the mount target.

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

Constraints:
Pattern: fs-[0-9a-f]{8}

Parameters:

fileSystemId - The ID of the file system for which to create the mount target.

Returns:

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

getSubnetId

public String getSubnetId()

The ID of the subnet to add the mount target in.

Constraints:
Pattern: subnet-[0-9a-f]{8}

Returns:

The ID of the subnet to add the mount target in.

setSubnetId

public void setSubnetId(String subnetId)

The ID of the subnet to add the mount target in.

Constraints:
Pattern: subnet-[0-9a-f]{8}

Parameters:

subnetId - The ID of the subnet to add the mount target in.

withSubnetId

public CreateMountTargetRequest withSubnetId(String subnetId)

The ID of the subnet to add the mount target in.

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

Constraints:
Pattern: subnet-[0-9a-f]{8}

Parameters:

subnetId - The ID of the subnet to add the mount target in.

Returns:

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

getIpAddress

public String getIpAddress()

A valid IPv4 address within the address range of the specified subnet.

Constraints:
Pattern: [0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}

Returns:

A valid IPv4 address within the address range of the specified subnet.

setIpAddress

public void setIpAddress(String ipAddress)

A valid IPv4 address within the address range of the specified subnet.

Constraints:
Pattern: [0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}

Parameters:

ipAddress - A valid IPv4 address within the address range of the specified subnet.

withIpAddress

public CreateMountTargetRequest withIpAddress(String ipAddress)

A valid IPv4 address within the address range of the specified subnet.

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

Constraints:
Pattern: [0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}

Parameters:

ipAddress - A valid IPv4 address within the address range of the specified subnet.

Returns:

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

getSecurityGroups

public List<String> getSecurityGroups()

Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.

Constraints:
Length: 0 - 5

Returns:

Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.

setSecurityGroups

public void setSecurityGroups(Collection<String> securityGroups)

Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.

Constraints:
Length: 0 - 5

Parameters:

securityGroups - Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.

withSecurityGroups

public CreateMountTargetRequest withSecurityGroups(String... securityGroups)

Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroups(java.util.Collection) or withSecurityGroups(java.util.Collection) if you want to override the existing values.

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

Constraints:
Length: 0 - 5

Parameters:

securityGroups - Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.

Returns:

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

withSecurityGroups

public CreateMountTargetRequest withSecurityGroups(Collection<String> securityGroups)

Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.

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

Constraints:
Length: 0 - 5

Parameters:

securityGroups - Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.

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 CreateMountTargetRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()