public static interface CreateSmbFileShareRequest.Builder extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateSmbFileShareRequest.Builder,CreateSmbFileShareRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateSmbFileShareRequest.Builder |
adminUserList(Collection<String> adminUserList)
A list of users in the Active Directory that will be granted administrator privileges on the file share.
|
CreateSmbFileShareRequest.Builder |
adminUserList(String... adminUserList)
A list of users in the Active Directory that will be granted administrator privileges on the file share.
|
CreateSmbFileShareRequest.Builder |
authentication(String authentication)
The authentication method that users use to access the file share.
|
CreateSmbFileShareRequest.Builder |
clientToken(String clientToken)
A unique string value that you supply that is used by 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 file gateway.
|
CreateSmbFileShareRequest.Builder |
gatewayARN(String gatewayARN)
The Amazon Resource Name (ARN) of the 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)
True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by
Amazon S3.
|
CreateSmbFileShareRequest.Builder |
kmsKey(String kmsKey)
The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
|
CreateSmbFileShareRequest.Builder |
locationARN(String locationARN)
The ARN of the backed storage used for storing file data.
|
CreateSmbFileShareRequest.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.
|
CreateSmbFileShareRequest.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.
|
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 AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the
underlying storage.
|
CreateSmbFileShareRequest.Builder |
smbaclEnabled(Boolean smbaclEnabled)
Set this value to "true to enable ACL (access control list) 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)
A list of users or groups in the Active Directory that are allowed to access the file share.
|
CreateSmbFileShareRequest.Builder |
validUserList(String... validUserList)
A list of users or groups in the Active Directory that are allowed to access the file share.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateSmbFileShareRequest.Builder clientToken(String clientToken)
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
clientToken - A unique string value that you supply that is used by file gateway to ensure idempotent file share
creation.CreateSmbFileShareRequest.Builder gatewayARN(String gatewayARN)
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
gatewayARN - The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.CreateSmbFileShareRequest.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.
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.CreateSmbFileShareRequest.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.
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.CreateSmbFileShareRequest.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.
role - The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it
accesses the underlying storage.CreateSmbFileShareRequest.Builder locationARN(String locationARN)
The ARN of the backed storage used for storing file data.
locationARN - The ARN of the backed storage used for storing file data.CreateSmbFileShareRequest.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.
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.CreateSmbFileShareRequest.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".
CreateSmbFileShareRequest.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".
CreateSmbFileShareRequest.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.
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.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, and otherwise to false. The default value is true.
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.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.
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.
CreateSmbFileShareRequest.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.html in the Storage Gateway User Guide.
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.html in the Storage Gateway User Guide.
CreateSmbFileShareRequest.Builder adminUserList(Collection<String> adminUserList)
A list of users 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.
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 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. 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 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.
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 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. 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. For example @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. For example @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. For example @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. For example @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. For example @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. For example @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. For example @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. For example @group1. Can only be set if
Authentication is set to ActiveDirectory.CreateSmbFileShareRequest.Builder authentication(String authentication)
The authentication method that users use to access the file share.
Valid values are ActiveDirectory or GuestAccess. The default is
ActiveDirectory.
authentication - The authentication method that users use to access the file share.
Valid values are ActiveDirectory or GuestAccess. The default is
ActiveDirectory.
CreateSmbFileShareRequest.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 overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateSmbFileShareRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2019. All rights reserved.