com.amazonaws.services.storagegateway.model

Class CreateNFSFileShareRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.CreateNFSFileShareRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

CreateNFSFileShareInput

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateNFSFileShareRequest()

Method Summary

Modifier and Type	Method and Description
CreateNFSFileShareRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getClientList() The list of clients that are allowed to access the file gateway.
String	getClientToken() A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
String	getDefaultStorageClass() The default storage class for objects put into an Amazon S3 bucket by file gateway.
String	getGatewayARN() The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
Boolean	getKMSEncrypted() True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
String	getKMSKey() The KMS key used for Amazon S3 server side encryption.
String	getLocationARN() The ARN of the backed storage used for storing file data.
NFSFileShareDefaults	getNFSFileShareDefaults() File share default values.
Boolean	getReadOnly() Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".
String	getRole() The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
String	getSquash() Maps a user to anonymous user.
int	hashCode()
Boolean	isKMSEncrypted() True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
Boolean	isReadOnly() Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".
void	setClientList(Collection<String> clientList) The list of clients that are allowed to access the file gateway.
void	setClientToken(String clientToken) A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
void	setDefaultStorageClass(String defaultStorageClass) The default storage class for objects put into an Amazon S3 bucket by file gateway.
void	setGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
void	setKMSEncrypted(Boolean kMSEncrypted) True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
void	setKMSKey(String kMSKey) The KMS key used for Amazon S3 server side encryption.
void	setLocationARN(String locationARN) The ARN of the backed storage used for storing file data.
void	setNFSFileShareDefaults(NFSFileShareDefaults nFSFileShareDefaults) File share default values.
void	setReadOnly(Boolean readOnly) Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".
void	setRole(String role) The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
void	setSquash(String squash) Maps a user to anonymous user.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateNFSFileShareRequest	withClientList(Collection<String> clientList) The list of clients that are allowed to access the file gateway.
CreateNFSFileShareRequest	withClientList(String... clientList) The list of clients that are allowed to access the file gateway.
CreateNFSFileShareRequest	withClientToken(String clientToken) A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
CreateNFSFileShareRequest	withDefaultStorageClass(String defaultStorageClass) The default storage class for objects put into an Amazon S3 bucket by file gateway.
CreateNFSFileShareRequest	withGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
CreateNFSFileShareRequest	withKMSEncrypted(Boolean kMSEncrypted) True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
CreateNFSFileShareRequest	withKMSKey(String kMSKey) The KMS key used for Amazon S3 server side encryption.
CreateNFSFileShareRequest	withLocationARN(String locationARN) The ARN of the backed storage used for storing file data.
CreateNFSFileShareRequest	withNFSFileShareDefaults(NFSFileShareDefaults nFSFileShareDefaults) File share default values.
CreateNFSFileShareRequest	withReadOnly(Boolean readOnly) Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".
CreateNFSFileShareRequest	withRole(String role) The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
CreateNFSFileShareRequest	withSquash(String squash) Maps a user to anonymous user.

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

CreateNFSFileShareRequest

public CreateNFSFileShareRequest()

Method Detail

setClientToken

public void setClientToken(String clientToken)

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Parameters:

clientToken - A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

getClientToken

public String getClientToken()

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Returns:

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

withClientToken

public CreateNFSFileShareRequest withClientToken(String clientToken)

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Parameters:

clientToken - A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Returns:

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

setNFSFileShareDefaults

public void setNFSFileShareDefaults(NFSFileShareDefaults nFSFileShareDefaults)

File share default values. Optional.

Parameters:

nFSFileShareDefaults - File share default values. Optional.

getNFSFileShareDefaults

public NFSFileShareDefaults getNFSFileShareDefaults()

File share default values. Optional.

Returns:

File share default values. Optional.

withNFSFileShareDefaults

public CreateNFSFileShareRequest withNFSFileShareDefaults(NFSFileShareDefaults nFSFileShareDefaults)

File share default values. Optional.

Parameters:

nFSFileShareDefaults - File share default values. Optional.

Returns:

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

setGatewayARN

public void setGatewayARN(String gatewayARN)

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Parameters:

gatewayARN - The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

getGatewayARN

public String getGatewayARN()

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Returns:

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

withGatewayARN

public CreateNFSFileShareRequest withGatewayARN(String gatewayARN)

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Parameters:

gatewayARN - The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Returns:

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

setKMSEncrypted

public void setKMSEncrypted(Boolean kMSEncrypted)

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Parameters:

kMSEncrypted - True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

getKMSEncrypted

public Boolean getKMSEncrypted()

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Returns:

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

withKMSEncrypted

public CreateNFSFileShareRequest withKMSEncrypted(Boolean kMSEncrypted)

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Parameters:

kMSEncrypted - True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Returns:

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

isKMSEncrypted

public Boolean isKMSEncrypted()

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Returns:

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

setKMSKey

public void setKMSKey(String kMSKey)

The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

Parameters:

kMSKey - The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

getKMSKey

public String getKMSKey()

The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

Returns:

The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

withKMSKey

public CreateNFSFileShareRequest withKMSKey(String kMSKey)

The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

Parameters:

kMSKey - The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

Returns:

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

setRole

public void setRole(String role)

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Parameters:

role - The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

getRole

public String getRole()

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Returns:

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

withRole

public CreateNFSFileShareRequest withRole(String role)

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Parameters:

role - The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Returns:

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

setLocationARN

public void setLocationARN(String locationARN)

The ARN of the backed storage used for storing file data.

Parameters:

locationARN - The ARN of the backed storage used for storing file data.

getLocationARN

public String getLocationARN()

The ARN of the backed storage used for storing file data.

Returns:

The ARN of the backed storage used for storing file data.

withLocationARN

public CreateNFSFileShareRequest withLocationARN(String locationARN)

The ARN of the backed storage used for storing file data.

Parameters:

locationARN - The ARN of the backed storage used for storing file data.

Returns:

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

setDefaultStorageClass

public void setDefaultStorageClass(String defaultStorageClass)

The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Parameters:

defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

getDefaultStorageClass

public String getDefaultStorageClass()

The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Returns:

The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

withDefaultStorageClass

public CreateNFSFileShareRequest withDefaultStorageClass(String defaultStorageClass)

The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Parameters:

defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Returns:

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

getClientList

public List<String> getClientList()

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Returns:

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

setClientList

public void setClientList(Collection<String> clientList)

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Parameters:

clientList - The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

withClientList

public CreateNFSFileShareRequest withClientList(String... clientList)

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

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

Parameters:

clientList - The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Returns:

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

withClientList

public CreateNFSFileShareRequest withClientList(Collection<String> clientList)

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Parameters:

clientList - The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Returns:

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

setSquash

public void setSquash(String squash)

Maps a user to anonymous user. Valid options are the following:

• "RootSquash" - Only root is mapped to anonymous user.

• "NoSquash" - No one is mapped to anonymous user.

• "AllSquash" - Everyone is mapped to anonymous user.

Parameters:

squash - Maps a user to anonymous user. Valid options are the following:

• "RootSquash" - Only root is mapped to anonymous user.

• "NoSquash" - No one is mapped to anonymous user.

• "AllSquash" - Everyone is mapped to anonymous user.

getSquash

public String getSquash()

Maps a user to anonymous user. Valid options are the following:

• "RootSquash" - Only root is mapped to anonymous user.

• "NoSquash" - No one is mapped to anonymous user.

• "AllSquash" - Everyone is mapped to anonymous user.

Returns:

Maps a user to anonymous user. Valid options are the following:

• "RootSquash" - Only root is mapped to anonymous user.

• "NoSquash" - No one is mapped to anonymous user.

• "AllSquash" - Everyone is mapped to anonymous user.

withSquash

public CreateNFSFileShareRequest withSquash(String squash)

Maps a user to anonymous user. Valid options are the following:

• "RootSquash" - Only root is mapped to anonymous user.

• "NoSquash" - No one is mapped to anonymous user.

• "AllSquash" - Everyone is mapped to anonymous user.

Parameters:

squash - Maps a user to anonymous user. Valid options are the following:

• "RootSquash" - Only root is mapped to anonymous user.

• "NoSquash" - No one is mapped to anonymous user.

• "AllSquash" - Everyone is mapped to anonymous user.

Returns:

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

setReadOnly

public void setReadOnly(Boolean readOnly)

Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".

Parameters:

readOnly - Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".

getReadOnly

public Boolean getReadOnly()

Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".

Returns:

Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".

withReadOnly

public CreateNFSFileShareRequest withReadOnly(Boolean readOnly)

Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".

Parameters:

readOnly - Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".

Returns:

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

isReadOnly

public Boolean isReadOnly()

Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".

Returns:

Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateNFSFileShareRequest 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()