com.amazonaws.services.fsx.model

Class UpdateFileSystemRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.fsx.model.UpdateFileSystemRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

The request object for the UpdateFileSystem operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateFileSystemRequest()

Method Summary

Modifier and Type	Method and Description
UpdateFileSystemRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates.
String	getFileSystemId() The ID of the file system that you are updating.
UpdateFileSystemLustreConfiguration	getLustreConfiguration()
UpdateFileSystemOntapConfiguration	getOntapConfiguration()
UpdateFileSystemOpenZFSConfiguration	getOpenZFSConfiguration() The configuration updates for an Amazon FSx for OpenZFS file system.
Integer	getStorageCapacity() Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system.
UpdateFileSystemWindowsConfiguration	getWindowsConfiguration() The configuration updates for an Amazon FSx for Windows File Server file system.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates.
void	setFileSystemId(String fileSystemId) The ID of the file system that you are updating.
void	setLustreConfiguration(UpdateFileSystemLustreConfiguration lustreConfiguration)
void	setOntapConfiguration(UpdateFileSystemOntapConfiguration ontapConfiguration)
void	setOpenZFSConfiguration(UpdateFileSystemOpenZFSConfiguration openZFSConfiguration) The configuration updates for an Amazon FSx for OpenZFS file system.
void	setStorageCapacity(Integer storageCapacity) Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system.
void	setWindowsConfiguration(UpdateFileSystemWindowsConfiguration windowsConfiguration) The configuration updates for an Amazon FSx for Windows File Server file system.
String	toString() Returns a string representation of this object.
UpdateFileSystemRequest	withClientRequestToken(String clientRequestToken) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates.
UpdateFileSystemRequest	withFileSystemId(String fileSystemId) The ID of the file system that you are updating.
UpdateFileSystemRequest	withLustreConfiguration(UpdateFileSystemLustreConfiguration lustreConfiguration)
UpdateFileSystemRequest	withOntapConfiguration(UpdateFileSystemOntapConfiguration ontapConfiguration)
UpdateFileSystemRequest	withOpenZFSConfiguration(UpdateFileSystemOpenZFSConfiguration openZFSConfiguration) The configuration updates for an Amazon FSx for OpenZFS file system.
UpdateFileSystemRequest	withStorageCapacity(Integer storageCapacity) Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system.
UpdateFileSystemRequest	withWindowsConfiguration(UpdateFileSystemWindowsConfiguration windowsConfiguration) The configuration updates for an Amazon FSx for Windows File Server file system.

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

UpdateFileSystemRequest

public UpdateFileSystemRequest()

Method Detail

setFileSystemId

public void setFileSystemId(String fileSystemId)

The ID of the file system that you are updating.

Parameters:

fileSystemId - The ID of the file system that you are updating.

getFileSystemId

public String getFileSystemId()

The ID of the file system that you are updating.

Returns:

The ID of the file system that you are updating.

withFileSystemId

public UpdateFileSystemRequest withFileSystemId(String fileSystemId)

The ID of the file system that you are updating.

Parameters:

fileSystemId - The ID of the file system that you are updating.

Returns:

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

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

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

Parameters:

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

getClientRequestToken

public String getClientRequestToken()

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

Returns:

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

withClientRequestToken

public UpdateFileSystemRequest withClientRequestToken(String clientRequestToken)

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

Parameters:

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

Returns:

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

setStorageCapacity

public void setStorageCapacity(Integer storageCapacity)

Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.

You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity.

For Lustre file systems, the storage capacity target value can be the following:

• For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

• For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.

• For SCRATCH_1 file systems, you can't increase the storage capacity.

For OpenZFS file systems, the input/output operations per second (IOPS) automatically scale with increases to the storage capacity if IOPS is configured for automatic scaling. If the storage capacity increase would result in less than 3 IOPS per GiB of storage, this operation returns an error.

For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity in the Amazon FSx for OpenZFS User Guide.

Parameters:

storageCapacity - Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.

You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity.

For Lustre file systems, the storage capacity target value can be the following:

• For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

• For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.

• For SCRATCH_1 file systems, you can't increase the storage capacity.

For OpenZFS file systems, the input/output operations per second (IOPS) automatically scale with increases to the storage capacity if IOPS is configured for automatic scaling. If the storage capacity increase would result in less than 3 IOPS per GiB of storage, this operation returns an error.

For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity in the Amazon FSx for OpenZFS User Guide.

getStorageCapacity

public Integer getStorageCapacity()

Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.

You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity.

For Lustre file systems, the storage capacity target value can be the following:

• For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

• For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.

• For SCRATCH_1 file systems, you can't increase the storage capacity.

For OpenZFS file systems, the input/output operations per second (IOPS) automatically scale with increases to the storage capacity if IOPS is configured for automatic scaling. If the storage capacity increase would result in less than 3 IOPS per GiB of storage, this operation returns an error.

For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity in the Amazon FSx for OpenZFS User Guide.

Returns:

Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.

You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity.

For Lustre file systems, the storage capacity target value can be the following:

• For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

• For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.

• For SCRATCH_1 file systems, you can't increase the storage capacity.

For OpenZFS file systems, the input/output operations per second (IOPS) automatically scale with increases to the storage capacity if IOPS is configured for automatic scaling. If the storage capacity increase would result in less than 3 IOPS per GiB of storage, this operation returns an error.

For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity in the Amazon FSx for OpenZFS User Guide.

withStorageCapacity

public UpdateFileSystemRequest withStorageCapacity(Integer storageCapacity)

Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.

You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity.

For Lustre file systems, the storage capacity target value can be the following:

• For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

• For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.

• For SCRATCH_1 file systems, you can't increase the storage capacity.

For OpenZFS file systems, the input/output operations per second (IOPS) automatically scale with increases to the storage capacity if IOPS is configured for automatic scaling. If the storage capacity increase would result in less than 3 IOPS per GiB of storage, this operation returns an error.

For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity in the Amazon FSx for OpenZFS User Guide.

Parameters:

storageCapacity - Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server or Amazon FSx for Lustre file system. Specifies the storage capacity target value, in GiB, to increase the storage capacity for the file system that you're updating.

You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows file systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the file system must have at least 16 MBps of throughput capacity.

For Lustre file systems, the storage capacity target value can be the following:

• For SCRATCH_2 and PERSISTENT_1 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

• For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput per TiB file systems. The values must be greater than the current storage capacity.

• For SCRATCH_1 file systems, you can't increase the storage capacity.

For OpenZFS file systems, the input/output operations per second (IOPS) automatically scale with increases to the storage capacity if IOPS is configured for automatic scaling. If the storage capacity increase would result in less than 3 IOPS per GiB of storage, this operation returns an error.

For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity in the Amazon FSx for OpenZFS User Guide.

Returns:

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

setWindowsConfiguration

public void setWindowsConfiguration(UpdateFileSystemWindowsConfiguration windowsConfiguration)

The configuration updates for an Amazon FSx for Windows File Server file system.

Parameters:

windowsConfiguration - The configuration updates for an Amazon FSx for Windows File Server file system.

getWindowsConfiguration

public UpdateFileSystemWindowsConfiguration getWindowsConfiguration()

The configuration updates for an Amazon FSx for Windows File Server file system.

Returns:

The configuration updates for an Amazon FSx for Windows File Server file system.

withWindowsConfiguration

public UpdateFileSystemRequest withWindowsConfiguration(UpdateFileSystemWindowsConfiguration windowsConfiguration)

The configuration updates for an Amazon FSx for Windows File Server file system.

Parameters:

windowsConfiguration - The configuration updates for an Amazon FSx for Windows File Server file system.

Returns:

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

setLustreConfiguration

public void setLustreConfiguration(UpdateFileSystemLustreConfiguration lustreConfiguration)

Parameters:

lustreConfiguration -

getLustreConfiguration

public UpdateFileSystemLustreConfiguration getLustreConfiguration()

Returns:

withLustreConfiguration

public UpdateFileSystemRequest withLustreConfiguration(UpdateFileSystemLustreConfiguration lustreConfiguration)

Parameters:

lustreConfiguration -

Returns:

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

setOntapConfiguration

public void setOntapConfiguration(UpdateFileSystemOntapConfiguration ontapConfiguration)

Parameters:

ontapConfiguration -

getOntapConfiguration

public UpdateFileSystemOntapConfiguration getOntapConfiguration()

Returns:

withOntapConfiguration

public UpdateFileSystemRequest withOntapConfiguration(UpdateFileSystemOntapConfiguration ontapConfiguration)

Parameters:

ontapConfiguration -

Returns:

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

setOpenZFSConfiguration

public void setOpenZFSConfiguration(UpdateFileSystemOpenZFSConfiguration openZFSConfiguration)

The configuration updates for an Amazon FSx for OpenZFS file system.

Parameters:

openZFSConfiguration - The configuration updates for an Amazon FSx for OpenZFS file system.

getOpenZFSConfiguration

public UpdateFileSystemOpenZFSConfiguration getOpenZFSConfiguration()

The configuration updates for an Amazon FSx for OpenZFS file system.

Returns:

The configuration updates for an Amazon FSx for OpenZFS file system.

withOpenZFSConfiguration

public UpdateFileSystemRequest withOpenZFSConfiguration(UpdateFileSystemOpenZFSConfiguration openZFSConfiguration)

The configuration updates for an Amazon FSx for OpenZFS file system.

Parameters:

openZFSConfiguration - The configuration updates for an Amazon FSx for OpenZFS 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 UpdateFileSystemRequest 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()