Package software.amazon.awssdk.services.storagegateway.model

Class CreateNFSFileShareRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.storagegateway.model.CreateNFSFileShareRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateNFSFileShareRequest.Builder,CreateNFSFileShareRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateNFSFileShareRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateNFSFileShareRequest.Builder,CreateNFSFileShareRequest>

CreateNFSFileShareInput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateNFSFileShareRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static CreateNFSFileShareRequest.Builder	builder()
List<String>	clientList()	The list of clients that are allowed to access the file gateway.
String	clientToken()	A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
String	defaultStorageClass()	The default storage class for objects put into an Amazon S3 bucket by file gateway.
boolean	equals(Object obj)
String	gatewayARN()	The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
int	hashCode()
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.
String	kmsKey()	The KMS key used for Amazon S3 server side encryption.
String	locationARN()	The ARN of the backed storage used for storing file data.
NFSFileShareDefaults	nfsFileShareDefaults()	File share default values.
Boolean	readOnly()	Sets the write status of a file share: "true" if the write status is read-only, and otherwise "false".
String	role()	The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
static Class<? extends CreateNFSFileShareRequest.Builder>	serializableBuilderClass()
String	squash()	Maps a user to anonymous user.
CreateNFSFileShareRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

clientToken

public String clientToken()

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.

nfsFileShareDefaults

public NFSFileShareDefaults nfsFileShareDefaults()

File share default values. Optional.

Returns:

File share default values. Optional.

gatewayARN

public String gatewayARN()

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.

kmsEncrypted

public 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.

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.

kmsKey

public String kmsKey()

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.

role

public String role()

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.

locationARN

public String locationARN()

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

Returns:

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

defaultStorageClass

public 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.

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.

clientList

public List<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.

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.

squash

public 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.

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.

readOnly

public Boolean readOnly()

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".

toBuilder

public CreateNFSFileShareRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateNFSFileShareRequest.Builder,CreateNFSFileShareRequest>

Returns:

a builder for type T

builder

public static CreateNFSFileShareRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateNFSFileShareRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object