public static interface SMBFileShareInfo.Builder extends SdkPojo, CopyableBuilder<SMBFileShareInfo.Builder,SMBFileShareInfo>
| Modifier and Type | Method and Description |
|---|---|
SMBFileShareInfo.Builder |
accessBasedEnumeration(Boolean accessBasedEnumeration)
Indicates whether
AccessBasedEnumeration is enabled. |
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 |
auditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
SMBFileShareInfo.Builder |
authentication(String authentication)
Sets the value of the Authentication property for this object.
|
SMBFileShareInfo.Builder |
bucketRegion(String bucketRegion)
Specifies the Region of the S3 bucket where the SMB file share stores files.
|
SMBFileShareInfo.Builder |
cacheAttributes(CacheAttributes cacheAttributes)
Refresh cache information for the file share.
|
default SMBFileShareInfo.Builder |
cacheAttributes(Consumer<CacheAttributes.Builder> cacheAttributes)
Refresh cache information for the file share.
|
SMBFileShareInfo.Builder |
caseSensitivity(CaseSensitivity caseSensitivity)
The case of an object name in an Amazon S3 bucket.
|
SMBFileShareInfo.Builder |
caseSensitivity(String caseSensitivity)
The case of an object name in an Amazon S3 bucket.
|
SMBFileShareInfo.Builder |
defaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 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 |
fileShareName(String fileShareName)
The name of the file share.
|
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)
Set to
true to use Amazon S3 server-side encryption with your own 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 |
notificationPolicy(String notificationPolicy)
The notification policy of the file share.
|
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 |
oplocksEnabled(Boolean oplocksEnabled)
Specifies whether opportunistic locking is enabled for the SMB file share.
|
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, it indicates that access control list (ACL) 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.
|
SMBFileShareInfo.Builder |
vpcEndpointDNSName(String vpcEndpointDNSName)
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildSMBFileShareInfo.Builder fileShareARN(String fileShareARN)
fileShareARN - The new value for the FileShareARN property for this object.SMBFileShareInfo.Builder fileShareId(String fileShareId)
fileShareId - The new value for the FileShareId property for this object.SMBFileShareInfo.Builder fileShareStatus(String fileShareStatus)
fileShareStatus - The new value for the FileShareStatus property for this object.SMBFileShareInfo.Builder gatewayARN(String gatewayARN)
gatewayARN - The new value for the GatewayARN property for this object.SMBFileShareInfo.Builder kmsEncrypted(Boolean kmsEncrypted)
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true | false
kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS key, or
false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
SMBFileShareInfo.Builder kmsKey(String kmsKey)
kmsKey - The new value for the KMSKey property for this object.SMBFileShareInfo.Builder path(String path)
The file share path used by the SMB client to identify the mount point.
path - The file share path used by the SMB client to identify the mount point.SMBFileShareInfo.Builder role(String role)
role - The new value for the Role property for this object.SMBFileShareInfo.Builder locationARN(String locationARN)
locationARN - The new value for the LocationARN property for this object.SMBFileShareInfo.Builder defaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value
is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
S3_ONEZONE_IA
defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default
value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
S3_STANDARD_IA | S3_ONEZONE_IA
SMBFileShareInfo.Builder objectACL(String objectACL)
SMBFileShareInfo.Builder objectACL(ObjectACL objectACL)
SMBFileShareInfo.Builder readOnly(Boolean readOnly)
A value that sets the write status of a file share. Set this value to true to set the write
status to read-only, otherwise set to false.
Valid Values: true | false
readOnly - A value that sets the write status of a file share. Set this value to true to set the
write status to read-only, otherwise set to false.
Valid Values: true | false
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, otherwise set to false. The default value is
true.
Valid Values: true | false
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, otherwise set to false. The
default value is true.
Valid Values: true | false
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.
Valid Values: true | false
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.
Valid Values: true | false
SMBFileShareInfo.Builder smbaclEnabled(Boolean smbaclEnabled)
If this value is set to true, it indicates that access control list (ACL) 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 Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
smbaclEnabled - If this value is set to true, it indicates that access control list (ACL) 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 Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
SMBFileShareInfo.Builder accessBasedEnumeration(Boolean accessBasedEnumeration)
Indicates whether AccessBasedEnumeration is enabled.
accessBasedEnumeration - Indicates whether AccessBasedEnumeration is enabled.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. Acceptable formats include: DOMAIN\User1,
user1, @group1, and @DOMAIN\group1. Can only be set if Authentication
is set to ActiveDirectory.
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. Acceptable formats include: DOMAIN\User1,
user1, @group1, and @DOMAIN\group1. Can only be set if
Authentication is set to ActiveDirectory.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. Acceptable formats include: DOMAIN\User1,
user1, @group1, and @DOMAIN\group1. Can only be set if Authentication
is set to ActiveDirectory.
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. Acceptable formats include: DOMAIN\User1,
user1, @group1, and @DOMAIN\group1. Can only be set if
Authentication is set to ActiveDirectory.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. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
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. Acceptable formats include: DOMAIN\User1,
user1, @group1, and @DOMAIN\group1. Can only be set if
Authentication is set to ActiveDirectory.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. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
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. Acceptable formats include: DOMAIN\User1,
user1, @group1, and @DOMAIN\group1. Can only be set if
Authentication is set to ActiveDirectory.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. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
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. Acceptable formats include: DOMAIN\User1,
user1, @group1, and @DOMAIN\group1. Can only be set if
Authentication is set to ActiveDirectory.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. Acceptable formats include: DOMAIN\User1, user1,
@group1, and @DOMAIN\group1. Can only be set if Authentication is set to
ActiveDirectory.
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. Acceptable formats include: DOMAIN\User1,
user1, @group1, and @DOMAIN\group1. Can only be set if
Authentication is set to ActiveDirectory.SMBFileShareInfo.Builder auditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for audit logs.SMBFileShareInfo.Builder authentication(String authentication)
authentication - The new value for the Authentication property for this object.SMBFileShareInfo.Builder caseSensitivity(String caseSensitivity)
The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines
the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The
default value is ClientSpecified.
caseSensitivity - The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client
determines the case sensitivity. For CaseSensitive, the gateway determines the case
sensitivity. The default value is ClientSpecified.CaseSensitivity,
CaseSensitivitySMBFileShareInfo.Builder caseSensitivity(CaseSensitivity caseSensitivity)
The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines
the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The
default value is ClientSpecified.
caseSensitivity - The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client
determines the case sensitivity. For CaseSensitive, the gateway determines the case
sensitivity. The default value is ClientSpecified.CaseSensitivity,
CaseSensitivitySMBFileShareInfo.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.
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.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.
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.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.
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) .tags - a consumer that will call methods on List.Builder #tags(List) SMBFileShareInfo.Builder fileShareName(String fileShareName)
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN, or if an
access point or access point alias is used.
fileShareName - The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN, or if
an access point or access point alias is used.
SMBFileShareInfo.Builder cacheAttributes(CacheAttributes cacheAttributes)
Refresh cache information for the file share.
cacheAttributes - Refresh cache information for the file share.default SMBFileShareInfo.Builder cacheAttributes(Consumer<CacheAttributes.Builder> cacheAttributes)
Refresh cache information for the file share.
This is a convenience that creates an instance of theCacheAttributes.Builder avoiding the need to
create one manually via CacheAttributes.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to cacheAttributes(CacheAttributes).cacheAttributes - a consumer that will call methods on CacheAttributes.BuildercacheAttributes(CacheAttributes)SMBFileShareInfo.Builder notificationPolicy(String notificationPolicy)
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds
to wait after the last point in time a client wrote to a file before generating an
ObjectUploaded notification. Because clients can make many small writes to files, it's best to
set this parameter for as long as possible to avoid generating multiple notifications for the same file in a
small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the
timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to
60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
notificationPolicy - The notification policy of the file share. SettlingTimeInSeconds controls the number of
seconds to wait after the last point in time a client wrote to a file before generating an
ObjectUploaded notification. Because clients can make many small writes to files, it's
best to set this parameter for as long as possible to avoid generating multiple notifications for the
same file in a small time period.
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3,
only the timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds
set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
SMBFileShareInfo.Builder vpcEndpointDNSName(String vpcEndpointDNSName)
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
vpcEndpointDNSName - Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
SMBFileShareInfo.Builder bucketRegion(String bucketRegion)
Specifies the Region of the S3 bucket where the SMB file share stores files.
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
bucketRegion - Specifies the Region of the S3 bucket where the SMB file share stores files. This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
SMBFileShareInfo.Builder oplocksEnabled(Boolean oplocksEnabled)
Specifies whether opportunistic locking is enabled for the SMB file share.
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
oplocksEnabled - Specifies whether opportunistic locking is enabled for the SMB file share. Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
Copyright © 2022. All rights reserved.