software.amazon.awssdk.services.storagegateway.model

Interface CreateNfsFileShareRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateNfsFileShareRequest.Builder,CreateNfsFileShareRequest>, SdkBuilder<CreateNfsFileShareRequest.Builder,CreateNfsFileShareRequest>, SdkPojo, SdkRequest.Builder, StorageGatewayRequest.Builder

Enclosing class:

CreateNfsFileShareRequest

public static interface CreateNfsFileShareRequest.Builder
extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateNfsFileShareRequest.Builder,CreateNfsFileShareRequest>

Method Summary

Modifier and Type	Method and Description
CreateNfsFileShareRequest.Builder	clientList(Collection<String> clientList) The list of clients that are allowed to access the file gateway.
CreateNfsFileShareRequest.Builder	clientList(String... clientList) The list of clients that are allowed to access the file gateway.
CreateNfsFileShareRequest.Builder	clientToken(String clientToken) A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
CreateNfsFileShareRequest.Builder	defaultStorageClass(String defaultStorageClass) The default storage class for objects put into an Amazon S3 bucket by the file gateway.
CreateNfsFileShareRequest.Builder	gatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
CreateNfsFileShareRequest.Builder	guessMIMETypeEnabled(Boolean guessMIMETypeEnabled) A value that enables guessing of the MIME type for uploaded objects based on file extensions.
CreateNfsFileShareRequest.Builder	kmsEncrypted(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.Builder	kmsKey(String kmsKey) The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption.
CreateNfsFileShareRequest.Builder	locationARN(String locationARN) The ARN of the backed storage used for storing file data.
default CreateNfsFileShareRequest.Builder	nfsFileShareDefaults(Consumer<NFSFileShareDefaults.Builder> nfsFileShareDefaults) File share default values.
CreateNfsFileShareRequest.Builder	nfsFileShareDefaults(NFSFileShareDefaults nfsFileShareDefaults) File share default values.
CreateNfsFileShareRequest.Builder	objectACL(ObjectACL objectACL) A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
CreateNfsFileShareRequest.Builder	objectACL(String objectACL) A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
CreateNfsFileShareRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateNfsFileShareRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateNfsFileShareRequest.Builder	readOnly(Boolean readOnly) A value that sets the write status of a file share.
CreateNfsFileShareRequest.Builder	requesterPays(Boolean requesterPays) A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
CreateNfsFileShareRequest.Builder	role(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.Builder	squash(String squash) A value that maps a user to anonymous user.
CreateNfsFileShareRequest.Builder	tags(Collection<Tag> tags) A list of up to 50 tags that can be assigned to the NFS file share.
CreateNfsFileShareRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of up to 50 tags that can be assigned to the NFS file share.
CreateNfsFileShareRequest.Builder	tags(Tag... tags) A list of up to 50 tags that can be assigned to the NFS file share.

Methods inherited from interface software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clientToken

CreateNfsFileShareRequest.Builder clientToken(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.

nfsFileShareDefaults

CreateNfsFileShareRequest.Builder nfsFileShareDefaults(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.

nfsFileShareDefaults

default CreateNfsFileShareRequest.Builder nfsFileShareDefaults(Consumer<NFSFileShareDefaults.Builder> nfsFileShareDefaults)

File share default values. Optional.

This is a convenience that creates an instance of the NFSFileShareDefaults.Builder avoiding the need to create one manually via NFSFileShareDefaults.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nfsFileShareDefaults(NFSFileShareDefaults).

Parameters:

nfsFileShareDefaults - a consumer that will call methods on NFSFileShareDefaults.Builder

Returns:

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

See Also:

nfsFileShareDefaults(NFSFileShareDefaults)

gatewayARN

CreateNfsFileShareRequest.Builder gatewayARN(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.

kmsEncrypted

CreateNfsFileShareRequest.Builder kmsEncrypted(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.

kmsKey

CreateNfsFileShareRequest.Builder kmsKey(String kmsKey)

The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Parameters:

kmsKey - The Amazon Resource Name (ARN) AWS 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.

role

CreateNfsFileShareRequest.Builder role(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.

locationARN

CreateNfsFileShareRequest.Builder locationARN(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.

defaultStorageClass

CreateNfsFileShareRequest.Builder defaultStorageClass(String defaultStorageClass)

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_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 the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_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.

objectACL

CreateNfsFileShareRequest.Builder objectACL(String objectACL)

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Parameters:

objectACL - A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Returns:

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

See Also:

ObjectACL, ObjectACL

objectACL

CreateNfsFileShareRequest.Builder objectACL(ObjectACL objectACL)

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Parameters:

objectACL - A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Returns:

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

See Also:

ObjectACL, ObjectACL

clientList

CreateNfsFileShareRequest.Builder clientList(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.

clientList

CreateNfsFileShareRequest.Builder clientList(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.

squash

CreateNfsFileShareRequest.Builder squash(String squash)

A value that 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 - A value that 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.

readOnly

CreateNfsFileShareRequest.Builder readOnly(Boolean readOnly)

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

Parameters:

readOnly - A value that sets the write status of a file share. This value is 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.

guessMIMETypeEnabled

CreateNfsFileShareRequest.Builder guessMIMETypeEnabled(Boolean guessMIMETypeEnabled)

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

Parameters:

guessMIMETypeEnabled - A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

Returns:

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

requesterPays

CreateNfsFileShareRequest.Builder requesterPays(Boolean requesterPays)

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Parameters:

requesterPays - A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Returns:

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

tags

CreateNfsFileShareRequest.Builder tags(Collection<Tag> tags)

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Parameters:

tags - A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Returns:

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

tags

CreateNfsFileShareRequest.Builder tags(Tag... tags)

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Parameters:

tags - A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Returns:

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

tags

CreateNfsFileShareRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

overrideConfiguration

CreateNfsFileShareRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateNfsFileShareRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder