public static interface CreateSmbFileShareRequest.Builder extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateSmbFileShareRequest.Builder,CreateSmbFileShareRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateSmbFileShareRequest.Builder |
accessBasedEnumeration(Boolean accessBasedEnumeration)
The files and folders on this share will only be visible to users with read access.
|
CreateSmbFileShareRequest.Builder |
adminUserList(Collection<String> adminUserList)
A list of users or groups in the Active Directory that will be granted administrator privileges on the file
share.
|
CreateSmbFileShareRequest.Builder |
adminUserList(String... adminUserList)
A list of users or groups in the Active Directory that will be granted administrator privileges on the file
share.
|
CreateSmbFileShareRequest.Builder |
auditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
CreateSmbFileShareRequest.Builder |
authentication(String authentication)
The authentication method that users use to access the file share.
|
CreateSmbFileShareRequest.Builder |
bucketRegion(String bucketRegion)
Specifies the Region of the S3 bucket where the SMB file share stores files.
|
CreateSmbFileShareRequest.Builder |
cacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
|
default CreateSmbFileShareRequest.Builder |
cacheAttributes(Consumer<CacheAttributes.Builder> cacheAttributes)
Specifies refresh cache information for the file share.
|
CreateSmbFileShareRequest.Builder |
caseSensitivity(CaseSensitivity caseSensitivity)
The case of an object name in an Amazon S3 bucket.
|
CreateSmbFileShareRequest.Builder |
caseSensitivity(String caseSensitivity)
The case of an object name in an Amazon S3 bucket.
|
CreateSmbFileShareRequest.Builder |
clientToken(String clientToken)
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share
creation.
|
CreateSmbFileShareRequest.Builder |
defaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
CreateSmbFileShareRequest.Builder |
fileShareName(String fileShareName)
The name of the file share.
|
CreateSmbFileShareRequest.Builder |
gatewayARN(String gatewayARN)
The ARN of the S3 File Gateway on which you want to create a file share.
|
CreateSmbFileShareRequest.Builder |
guessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
CreateSmbFileShareRequest.Builder |
invalidUserList(Collection<String> invalidUserList)
A list of users or groups in the Active Directory that are not allowed to access the file share.
|
CreateSmbFileShareRequest.Builder |
invalidUserList(String... invalidUserList)
A list of users or groups in the Active Directory that are not allowed to access the file share.
|
CreateSmbFileShareRequest.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. |
CreateSmbFileShareRequest.Builder |
kmsKey(String kmsKey)
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption.
|
CreateSmbFileShareRequest.Builder |
locationARN(String locationARN)
The ARN of the backend storage used for storing file data.
|
CreateSmbFileShareRequest.Builder |
notificationPolicy(String notificationPolicy)
The notification policy of the file share.
|
CreateSmbFileShareRequest.Builder |
objectACL(ObjectACL objectACL)
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into.
|
CreateSmbFileShareRequest.Builder |
objectACL(String objectACL)
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into.
|
CreateSmbFileShareRequest.Builder |
oplocksEnabled(Boolean oplocksEnabled)
Specifies whether opportunistic locking is enabled for the SMB file share.
|
CreateSmbFileShareRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateSmbFileShareRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateSmbFileShareRequest.Builder |
readOnly(Boolean readOnly)
A value that sets the write status of a file share.
|
CreateSmbFileShareRequest.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.
|
CreateSmbFileShareRequest.Builder |
role(String role)
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the
underlying storage.
|
CreateSmbFileShareRequest.Builder |
smbaclEnabled(Boolean smbaclEnabled)
Set this value to
true to enable access control list (ACL) on the SMB file share. |
CreateSmbFileShareRequest.Builder |
tags(Collection<Tag> tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateSmbFileShareRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateSmbFileShareRequest.Builder |
tags(Tag... tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateSmbFileShareRequest.Builder |
validUserList(Collection<String> validUserList)
|
CreateSmbFileShareRequest.Builder |
validUserList(String... validUserList)
|
CreateSmbFileShareRequest.Builder |
vpcEndpointDNSName(String vpcEndpointDNSName)
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateSmbFileShareRequest.Builder clientToken(String clientToken)
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
clientToken - A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share
creation.CreateSmbFileShareRequest.Builder gatewayARN(String gatewayARN)
The ARN of the S3 File Gateway on which you want to create a file share.
gatewayARN - The ARN of the S3 File Gateway on which you want to create a file share.CreateSmbFileShareRequest.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
CreateSmbFileShareRequest.Builder kmsKey(String kmsKey)
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when
KMSEncrypted is true. Optional.
kmsKey - The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when
KMSEncrypted is true. Optional.CreateSmbFileShareRequest.Builder role(String role)
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
role - The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it
accesses the underlying storage.CreateSmbFileShareRequest.Builder locationARN(String locationARN)
The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".
You can specify a bucket attached to an access point using a complete ARN that includes the bucket region as shown:
arn:aws:s3:region:account-id:accesspoint/access-point-name
If you specify a bucket attached to an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
locationARN - The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket
name. It must end with a "/". You can specify a bucket attached to an access point using a complete ARN that includes the bucket region as shown:
arn:aws:s3:region:account-id:accesspoint/access-point-name
If you specify a bucket attached to an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
CreateSmbFileShareRequest.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
CreateSmbFileShareRequest.Builder objectACL(String objectACL)
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into. The default value is private.
objectACL - A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into. The default value is private.ObjectACL,
ObjectACLCreateSmbFileShareRequest.Builder objectACL(ObjectACL objectACL)
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into. The default value is private.
objectACL - A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File
Gateway puts objects into. The default value is private.ObjectACL,
ObjectACLCreateSmbFileShareRequest.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
CreateSmbFileShareRequest.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
CreateSmbFileShareRequest.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
CreateSmbFileShareRequest.Builder smbaclEnabled(Boolean smbaclEnabled)
Set this value to true to enable access control list (ACL) on the SMB file share. Set it to
false to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
Valid Values: true | false
smbaclEnabled - Set this value to true to enable access control list (ACL) on the SMB file share. Set it
to false to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
Valid Values: true | false
CreateSmbFileShareRequest.Builder accessBasedEnumeration(Boolean accessBasedEnumeration)
The files and folders on this share will only be visible to users with read access.
accessBasedEnumeration - The files and folders on this share will only be visible to users with read access.CreateSmbFileShareRequest.Builder adminUserList(Collection<String> adminUserList)
A list of users or groups in the Active Directory that will be granted administrator privileges on the file
share. These users can do all file operations as the super-user. Acceptable formats include:
DOMAIN\User1, user1, @group1, and @DOMAIN\group1.
Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
adminUserList - A list of users or groups in the Active Directory that will be granted administrator privileges on the
file share. These users can do all file operations as the super-user. Acceptable formats include:
DOMAIN\User1, user1, @group1, and @DOMAIN\group1
. Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
CreateSmbFileShareRequest.Builder adminUserList(String... adminUserList)
A list of users or groups in the Active Directory that will be granted administrator privileges on the file
share. These users can do all file operations as the super-user. Acceptable formats include:
DOMAIN\User1, user1, @group1, and @DOMAIN\group1.
Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
adminUserList - A list of users or groups in the Active Directory that will be granted administrator privileges on the
file share. These users can do all file operations as the super-user. Acceptable formats include:
DOMAIN\User1, user1, @group1, and @DOMAIN\group1
. Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
CreateSmbFileShareRequest.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.CreateSmbFileShareRequest.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.CreateSmbFileShareRequest.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.CreateSmbFileShareRequest.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.CreateSmbFileShareRequest.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.CreateSmbFileShareRequest.Builder authentication(String authentication)
The authentication method that users use to access the file share. The default is
ActiveDirectory.
Valid Values: ActiveDirectory | GuestAccess
authentication - The authentication method that users use to access the file share. The default is
ActiveDirectory.
Valid Values: ActiveDirectory | GuestAccess
CreateSmbFileShareRequest.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,
CaseSensitivityCreateSmbFileShareRequest.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,
CaseSensitivityCreateSmbFileShareRequest.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.
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.
CreateSmbFileShareRequest.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.
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.
CreateSmbFileShareRequest.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.
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) CreateSmbFileShareRequest.Builder fileShareName(String fileShareName)
The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN.
fileShareName - The name of the file share. Optional.
FileShareName must be set if an S3 prefix name is set in LocationARN.
CreateSmbFileShareRequest.Builder cacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
cacheAttributes - Specifies refresh cache information for the file share.default CreateSmbFileShareRequest.Builder cacheAttributes(Consumer<CacheAttributes.Builder> cacheAttributes)
Specifies 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)CreateSmbFileShareRequest.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.
{}
CreateSmbFileShareRequest.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.
CreateSmbFileShareRequest.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.
CreateSmbFileShareRequest.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
CreateSmbFileShareRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateSmbFileShareRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.