com.amazonaws.services.fsx.model

Class CreateFileSystemRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.fsx.model.CreateFileSystemRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

The request object used to create a new Amazon FSx file system.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateFileSystemRequest()

Method Summary

Modifier and Type	Method and Description
CreateFileSystemRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation.
String	getFileSystemType() The type of Amazon FSx file system to create.
String	getKmsKeyId()
CreateFileSystemLustreConfiguration	getLustreConfiguration()
List<String>	getSecurityGroupIds() A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
Integer	getStorageCapacity() The storage capacity of the file system being created.
List<String>	getSubnetIds() Specifies the IDs of the subnets that the file system will be accessible from.
List<Tag>	getTags() The tags to apply to the file system being created.
CreateFileSystemWindowsConfiguration	getWindowsConfiguration() The Microsoft Windows configuration for the file system being created.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation.
void	setFileSystemType(String fileSystemType) The type of Amazon FSx file system to create.
void	setKmsKeyId(String kmsKeyId)
void	setLustreConfiguration(CreateFileSystemLustreConfiguration lustreConfiguration)
void	setSecurityGroupIds(Collection<String> securityGroupIds) A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
void	setStorageCapacity(Integer storageCapacity) The storage capacity of the file system being created.
void	setSubnetIds(Collection<String> subnetIds) Specifies the IDs of the subnets that the file system will be accessible from.
void	setTags(Collection<Tag> tags) The tags to apply to the file system being created.
void	setWindowsConfiguration(CreateFileSystemWindowsConfiguration windowsConfiguration) The Microsoft Windows configuration for the file system being created.
String	toString() Returns a string representation of this object.
CreateFileSystemRequest	withClientRequestToken(String clientRequestToken) (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation.
CreateFileSystemRequest	withFileSystemType(FileSystemType fileSystemType) The type of Amazon FSx file system to create.
CreateFileSystemRequest	withFileSystemType(String fileSystemType) The type of Amazon FSx file system to create.
CreateFileSystemRequest	withKmsKeyId(String kmsKeyId)
CreateFileSystemRequest	withLustreConfiguration(CreateFileSystemLustreConfiguration lustreConfiguration)
CreateFileSystemRequest	withSecurityGroupIds(Collection<String> securityGroupIds) A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
CreateFileSystemRequest	withSecurityGroupIds(String... securityGroupIds) A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
CreateFileSystemRequest	withStorageCapacity(Integer storageCapacity) The storage capacity of the file system being created.
CreateFileSystemRequest	withSubnetIds(Collection<String> subnetIds) Specifies the IDs of the subnets that the file system will be accessible from.
CreateFileSystemRequest	withSubnetIds(String... subnetIds) Specifies the IDs of the subnets that the file system will be accessible from.
CreateFileSystemRequest	withTags(Collection<Tag> tags) The tags to apply to the file system being created.
CreateFileSystemRequest	withTags(Tag... tags) The tags to apply to the file system being created.
CreateFileSystemRequest	withWindowsConfiguration(CreateFileSystemWindowsConfiguration windowsConfiguration) The Microsoft Windows configuration for the file system being created.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateFileSystemRequest

public CreateFileSystemRequest()

Method Detail

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Parameters:

clientRequestToken - (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

getClientRequestToken

public String getClientRequestToken()

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Returns:

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

withClientRequestToken

public CreateFileSystemRequest withClientRequestToken(String clientRequestToken)

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Parameters:

clientRequestToken - (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Returns:

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

setFileSystemType

public void setFileSystemType(String fileSystemType)

The type of Amazon FSx file system to create.

Parameters:

fileSystemType - The type of Amazon FSx file system to create.

See Also:

FileSystemType

getFileSystemType

public String getFileSystemType()

The type of Amazon FSx file system to create.

Returns:

The type of Amazon FSx file system to create.

See Also:

FileSystemType

withFileSystemType

public CreateFileSystemRequest withFileSystemType(String fileSystemType)

The type of Amazon FSx file system to create.

Parameters:

fileSystemType - The type of Amazon FSx file system to create.

Returns:

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

See Also:

FileSystemType

withFileSystemType

public CreateFileSystemRequest withFileSystemType(FileSystemType fileSystemType)

The type of Amazon FSx file system to create.

Parameters:

fileSystemType - The type of Amazon FSx file system to create.

Returns:

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

See Also:

FileSystemType

setStorageCapacity

public void setStorageCapacity(Integer storageCapacity)

The storage capacity of the file system being created.

For Windows file systems, valid values are 32 GiB - 65,536 GiB.

For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB.

Parameters:

storageCapacity - The storage capacity of the file system being created.

For Windows file systems, valid values are 32 GiB - 65,536 GiB.

For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB.

getStorageCapacity

public Integer getStorageCapacity()

The storage capacity of the file system being created.

For Windows file systems, valid values are 32 GiB - 65,536 GiB.

For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB.

Returns:

The storage capacity of the file system being created.

For Windows file systems, valid values are 32 GiB - 65,536 GiB.

For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB.

withStorageCapacity

public CreateFileSystemRequest withStorageCapacity(Integer storageCapacity)

The storage capacity of the file system being created.

For Windows file systems, valid values are 32 GiB - 65,536 GiB.

For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB.

Parameters:

storageCapacity - The storage capacity of the file system being created.

For Windows file systems, valid values are 32 GiB - 65,536 GiB.

For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB.

Returns:

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

getSubnetIds

public List<String> getSubnetIds()

Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standy file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Returns:

Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standy file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

setSubnetIds

public void setSubnetIds(Collection<String> subnetIds)

Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standy file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Parameters:

subnetIds - Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standy file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

withSubnetIds

public CreateFileSystemRequest withSubnetIds(String... subnetIds)

Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standy file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

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

Parameters:

subnetIds - Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standy file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Returns:

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

withSubnetIds

public CreateFileSystemRequest withSubnetIds(Collection<String> subnetIds)

Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standy file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Parameters:

subnetIds - Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standy file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Returns:

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

getSecurityGroupIds

public List<String> getSecurityGroupIds()

A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

Returns:

A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

setSecurityGroupIds

public void setSecurityGroupIds(Collection<String> securityGroupIds)

A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

Parameters:

securityGroupIds - A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

withSecurityGroupIds

public CreateFileSystemRequest withSecurityGroupIds(String... securityGroupIds)

A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

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

Parameters:

securityGroupIds - A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

Returns:

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

withSecurityGroupIds

public CreateFileSystemRequest withSecurityGroupIds(Collection<String> securityGroupIds)

A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

Parameters:

securityGroupIds - A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

Returns:

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

getTags

public List<Tag> getTags()

The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

Returns:

The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

setTags

public void setTags(Collection<Tag> tags)

The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

Parameters:

tags - The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

withTags

public CreateFileSystemRequest withTags(Tag... tags)

The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

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

Parameters:

tags - The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

Returns:

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

withTags

public CreateFileSystemRequest withTags(Collection<Tag> tags)

The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

Parameters:

tags - The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

Returns:

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

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

Parameters:

kmsKeyId -

getKmsKeyId

public String getKmsKeyId()

Returns:

withKmsKeyId

public CreateFileSystemRequest withKmsKeyId(String kmsKeyId)

Parameters:

kmsKeyId -

Returns:

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

setWindowsConfiguration

public void setWindowsConfiguration(CreateFileSystemWindowsConfiguration windowsConfiguration)

The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS.

Parameters:

windowsConfiguration - The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS.

getWindowsConfiguration

public CreateFileSystemWindowsConfiguration getWindowsConfiguration()

The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS.

Returns:

The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS.

withWindowsConfiguration

public CreateFileSystemRequest withWindowsConfiguration(CreateFileSystemWindowsConfiguration windowsConfiguration)

The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS.

Parameters:

windowsConfiguration - The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS.

Returns:

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

setLustreConfiguration

public void setLustreConfiguration(CreateFileSystemLustreConfiguration lustreConfiguration)

Parameters:

lustreConfiguration -

getLustreConfiguration

public CreateFileSystemLustreConfiguration getLustreConfiguration()

Returns:

withLustreConfiguration

public CreateFileSystemRequest withLustreConfiguration(CreateFileSystemLustreConfiguration lustreConfiguration)

Parameters:

lustreConfiguration -

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()