software.amazon.awssdk.services.storagegateway.model

Interface SMBFileShareInfo.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>, SdkBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>, SdkPojo

Enclosing class:

SMBFileShareInfo

public static interface SMBFileShareInfo.Builder
extends SdkPojo, CopyableBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>

Method Summary

Modifier and Type	Method and Description
SMBFileShareInfo.Builder	adminUserList(Collection<String> adminUserList) A list of users or groups in the Active Directory that have administrator rights to the file share.
SMBFileShareInfo.Builder	adminUserList(String... adminUserList) A list of users or groups in the Active Directory that have administrator rights to the file share.
SMBFileShareInfo.Builder	authentication(String authentication) Sets the value of the Authentication property for this object.
SMBFileShareInfo.Builder	defaultStorageClass(String defaultStorageClass) The default storage class for objects put into an Amazon S3 bucket by the file gateway.
SMBFileShareInfo.Builder	fileShareARN(String fileShareARN) Sets the value of the FileShareARN property for this object.
SMBFileShareInfo.Builder	fileShareId(String fileShareId) Sets the value of the FileShareId property for this object.
SMBFileShareInfo.Builder	fileShareStatus(String fileShareStatus) Sets the value of the FileShareStatus property for this object.
SMBFileShareInfo.Builder	gatewayARN(String gatewayARN) Sets the value of the GatewayARN property for this object.
SMBFileShareInfo.Builder	guessMIMETypeEnabled(Boolean guessMIMETypeEnabled) A value that enables guessing of the MIME type for uploaded objects based on file extensions.
SMBFileShareInfo.Builder	invalidUserList(Collection<String> invalidUserList) A list of users or groups in the Active Directory that are not allowed to access the file share.
SMBFileShareInfo.Builder	invalidUserList(String... invalidUserList) A list of users or groups in the Active Directory that are not allowed to access the file share.
SMBFileShareInfo.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.
SMBFileShareInfo.Builder	kmsKey(String kmsKey) Sets the value of the KMSKey property for this object.
SMBFileShareInfo.Builder	locationARN(String locationARN) Sets the value of the LocationARN property for this object.
SMBFileShareInfo.Builder	objectACL(ObjectACL objectACL) Sets the value of the ObjectACL property for this object.
SMBFileShareInfo.Builder	objectACL(String objectACL) Sets the value of the ObjectACL property for this object.
SMBFileShareInfo.Builder	path(String path) The file share path used by the SMB client to identify the mount point.
SMBFileShareInfo.Builder	readOnly(Boolean readOnly) A value that sets the write status of a file share.
SMBFileShareInfo.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.
SMBFileShareInfo.Builder	role(String role) Sets the value of the Role property for this object.
SMBFileShareInfo.Builder	smbaclEnabled(Boolean smbaclEnabled) If this value is set to "true", indicates that ACL (access control list) is enabled on the SMB file share.
SMBFileShareInfo.Builder	tags(Collection<Tag> tags) A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
SMBFileShareInfo.Builder	tags(Consumer<Tag.Builder>... tags) A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
SMBFileShareInfo.Builder	tags(Tag... tags) A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
SMBFileShareInfo.Builder	validUserList(Collection<String> validUserList) A list of users or groups in the Active Directory that are allowed to access the file share.
SMBFileShareInfo.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.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

SMBFileShareInfo.Builder fileShareARN(String fileShareARN)

Sets the value of the FileShareARN property for this object.

Parameters:

fileShareARN - The new value for the FileShareARN property for this object.

Returns:

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

fileShareId

SMBFileShareInfo.Builder fileShareId(String fileShareId)

Sets the value of the FileShareId property for this object.

Parameters:

fileShareId - The new value for the FileShareId property for this object.

Returns:

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

fileShareStatus

SMBFileShareInfo.Builder fileShareStatus(String fileShareStatus)

Sets the value of the FileShareStatus property for this object.

Parameters:

fileShareStatus - The new value for the FileShareStatus property for this object.

Returns:

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

gatewayARN

SMBFileShareInfo.Builder gatewayARN(String gatewayARN)

Sets the value of the GatewayARN property for this object.

Parameters:

gatewayARN - The new value for the GatewayARN property for this object.

Returns:

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

kmsEncrypted

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

SMBFileShareInfo.Builder kmsKey(String kmsKey)

Sets the value of the KMSKey property for this object.

Parameters:

kmsKey - The new value for the KMSKey property for this object.

Returns:

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

path

SMBFileShareInfo.Builder path(String path)

The file share path used by the SMB client to identify the mount point.

Parameters:

path - The file share path used by the SMB client to identify the mount point.

Returns:

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

role

SMBFileShareInfo.Builder role(String role)

Sets the value of the Role property for this object.

Parameters:

role - The new value for the Role property for this object.

Returns:

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

locationARN

SMBFileShareInfo.Builder locationARN(String locationARN)

Sets the value of the LocationARN property for this object.

Parameters:

locationARN - The new value for the LocationARN property for this object.

Returns:

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

defaultStorageClass

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

SMBFileShareInfo.Builder objectACL(String objectACL)

Sets the value of the ObjectACL property for this object.

Parameters:

objectACL - The new value for the ObjectACL property for this object.

Returns:

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

See Also:

ObjectACL, ObjectACL

objectACL

SMBFileShareInfo.Builder objectACL(ObjectACL objectACL)

Sets the value of the ObjectACL property for this object.

Parameters:

objectACL - The new value for the ObjectACL property for this object.

Returns:

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

See Also:

ObjectACL, ObjectACL

readOnly

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

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

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

SMBFileShareInfo.Builder smbaclEnabled(Boolean smbaclEnabled)

If this value is set to "true", indicates that ACL (access control list) is enabled on the SMB file share. If it is set to "false", it indicates that file and directory permissions are mapped to the POSIX permission.

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

Parameters:

smbaclEnabled - If this value is set to "true", indicates that ACL (access control list) is enabled on the SMB file share. If it is set to "false", it indicates that file and directory permissions are mapped to the POSIX permission.

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

Returns:

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

adminUserList

SMBFileShareInfo.Builder adminUserList(Collection<String> adminUserList)

A list of users or groups 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 or groups 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

SMBFileShareInfo.Builder adminUserList(String... adminUserList)

A list of users or groups 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 or groups 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

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

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

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

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

authentication

SMBFileShareInfo.Builder authentication(String authentication)

Sets the value of the Authentication property for this object.

Parameters:

authentication - The new value for the Authentication property for this object.

Returns:

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

tags

SMBFileShareInfo.Builder tags(Collection<Tag> tags)

A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Parameters:

tags - A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Returns:

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

tags

SMBFileShareInfo.Builder tags(Tag... tags)

A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Parameters:

tags - A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Returns:

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

tags

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

A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

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)