software.amazon.awssdk.services.storagegateway.model

Interface UpdateSmbFileShareRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateSmbFileShareRequest

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

Method Summary

Modifier and Type	Method and Description
UpdateSmbFileShareRequest.Builder	adminUserList(Collection<String> adminUserList) A list of users in the Active Directory that have administrator rights to the file share.
UpdateSmbFileShareRequest.Builder	adminUserList(String... adminUserList) A list of users in the Active Directory that have administrator rights to the file share.
UpdateSmbFileShareRequest.Builder	defaultStorageClass(String defaultStorageClass) The default storage class for objects put into an Amazon S3 bucket by the file gateway.
UpdateSmbFileShareRequest.Builder	fileShareARN(String fileShareARN) The Amazon Resource Name (ARN) of the SMB file share that you want to update.
UpdateSmbFileShareRequest.Builder	guessMIMETypeEnabled(Boolean guessMIMETypeEnabled) A value that enables guessing of the MIME type for uploaded objects based on file extensions.
UpdateSmbFileShareRequest.Builder	invalidUserList(Collection<String> invalidUserList) A list of users or groups in the Active Directory that are not allowed to access the file share.
UpdateSmbFileShareRequest.Builder	invalidUserList(String... invalidUserList) A list of users or groups in the Active Directory that are not allowed to access the file share.
UpdateSmbFileShareRequest.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.
UpdateSmbFileShareRequest.Builder	kmsKey(String kmsKey) The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
UpdateSmbFileShareRequest.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.
UpdateSmbFileShareRequest.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.
UpdateSmbFileShareRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateSmbFileShareRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateSmbFileShareRequest.Builder	readOnly(Boolean readOnly) A value that sets the write status of a file share.
UpdateSmbFileShareRequest.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.
UpdateSmbFileShareRequest.Builder	smbaclEnabled(Boolean smbaclEnabled) Set this value to "true to enable ACL (access control list) on the SMB file share.
UpdateSmbFileShareRequest.Builder	validUserList(Collection<String> validUserList) A list of users or groups in the Active Directory that are allowed to access the file share.
UpdateSmbFileShareRequest.Builder	validUserList(String... validUserList) A list of users or groups in the Active Directory that are allowed to access the 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

fileShareARN

UpdateSmbFileShareRequest.Builder fileShareARN(String fileShareARN)

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

Parameters:

fileShareARN - The Amazon Resource Name (ARN) of the SMB file share that you want to update.

Returns:

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

kmsEncrypted

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

UpdateSmbFileShareRequest.Builder kmsKey(String kmsKey)

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

defaultStorageClass

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

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

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

readOnly

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

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

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

smbaclEnabled

UpdateSmbFileShareRequest.Builder smbaclEnabled(Boolean smbaclEnabled)

Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.

Parameters:

smbaclEnabled - Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.

Returns:

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

adminUserList

UpdateSmbFileShareRequest.Builder adminUserList(Collection<String> adminUserList)

A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Parameters:

adminUserList - A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

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

adminUserList

UpdateSmbFileShareRequest.Builder adminUserList(String... adminUserList)

A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Parameters:

adminUserList - A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

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

validUserList

UpdateSmbFileShareRequest.Builder validUserList(Collection<String> validUserList)

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Parameters:

validUserList - A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

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

validUserList

UpdateSmbFileShareRequest.Builder validUserList(String... validUserList)

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Parameters:

validUserList - A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

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

invalidUserList

UpdateSmbFileShareRequest.Builder invalidUserList(Collection<String> invalidUserList)

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Parameters:

invalidUserList - A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

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

invalidUserList

UpdateSmbFileShareRequest.Builder invalidUserList(String... invalidUserList)

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Parameters:

invalidUserList - A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

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

overrideConfiguration

UpdateSmbFileShareRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder