@Generated(value="software.amazon.awssdk:codegen") public final class CreateSmbFileShareRequest extends StorageGatewayRequest implements ToCopyableBuilder<CreateSmbFileShareRequest.Builder,CreateSmbFileShareRequest>
CreateSMBFileShareInput
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateSmbFileShareRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
Boolean |
accessBasedEnumeration()
The files and folders on this share will only be visible to users with read access.
|
List<String> |
adminUserList()
A list of users or groups in the Active Directory that will be granted administrator privileges on the file
share.
|
String |
auditDestinationARN()
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
String |
authentication()
The authentication method that users use to access the file share.
|
String |
bucketRegion()
Specifies the Region of the S3 bucket where the SMB file share stores files.
|
static CreateSmbFileShareRequest.Builder |
builder() |
CacheAttributes |
cacheAttributes()
Specifies refresh cache information for the file share.
|
CaseSensitivity |
caseSensitivity()
The case of an object name in an Amazon S3 bucket.
|
String |
caseSensitivityAsString()
The case of an object name in an Amazon S3 bucket.
|
String |
clientToken()
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
|
String |
defaultStorageClass()
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
fileShareName()
The name of the file share.
|
String |
gatewayARN()
The ARN of the S3 File Gateway on which you want to create a file share.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
Boolean |
guessMIMETypeEnabled()
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
boolean |
hasAdminUserList()
For responses, this returns true if the service returned a value for the AdminUserList property.
|
int |
hashCode() |
boolean |
hasInvalidUserList()
For responses, this returns true if the service returned a value for the InvalidUserList property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasValidUserList()
For responses, this returns true if the service returned a value for the ValidUserList property.
|
List<String> |
invalidUserList()
A list of users or groups in the Active Directory that are not allowed to access the file share.
|
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. |
String |
kmsKey()
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption.
|
String |
locationARN()
A custom ARN for the backend storage used for storing data for file shares.
|
String |
notificationPolicy()
The notification policy of the file share.
|
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.
|
String |
objectACLAsString()
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway
puts objects into.
|
Boolean |
oplocksEnabled()
Specifies whether opportunistic locking is enabled for the SMB file share.
|
Boolean |
readOnly()
A value that sets the write status of a file share.
|
Boolean |
requesterPays()
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
|
String |
role()
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the
underlying storage.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateSmbFileShareRequest.Builder> |
serializableBuilderClass() |
Boolean |
smbaclEnabled()
Set this value to
true to enable access control list (ACL) on the SMB file share. |
List<Tag> |
tags()
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateSmbFileShareRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<String> |
validUserList()
|
String |
vpcEndpointDNSName()
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String clientToken()
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
public final String gatewayARN()
The ARN of the S3 File Gateway on which you want to create a file share.
public final 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
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
public final 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.
KMSEncrypted is true. Optional.public final String role()
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
public final String locationARN()
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify 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.
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify 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.
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
public final 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
S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
S3_STANDARD_IA | S3_ONEZONE_IA
public final 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.
If the service returns an enum value that is not available in the current SDK version, objectACL will
return ObjectACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
objectACLAsString().
private.ObjectACLpublic final String objectACLAsString()
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.
If the service returns an enum value that is not available in the current SDK version, objectACL will
return ObjectACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
objectACLAsString().
private.ObjectACLpublic final 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
true to set the write
status to read-only, otherwise set to false.
Valid Values: true | false
public final 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
true to enable MIME type guessing, otherwise set to false. The default
value is true.
Valid Values: true | false
public final 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
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
public final 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
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
public final Boolean accessBasedEnumeration()
The files and folders on this share will only be visible to users with read access.
public final boolean hasAdminUserList()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAdminUserList() method.
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.
public final boolean hasValidUserList()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasValidUserList() method.
public final boolean hasInvalidUserList()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasInvalidUserList() method.
DOMAIN\User1,
user1, @group1, and @DOMAIN\group1. Can only be set if
Authentication is set to ActiveDirectory.public final String auditDestinationARN()
The Amazon Resource Name (ARN) of the storage used for audit logs.
public final String authentication()
The authentication method that users use to access the file share. The default is ActiveDirectory.
Valid Values: ActiveDirectory | GuestAccess
ActiveDirectory.
Valid Values: ActiveDirectory | GuestAccess
public final 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.
If the service returns an enum value that is not available in the current SDK version, caseSensitivity
will return CaseSensitivity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from caseSensitivityAsString().
ClientSpecified, the client
determines the case sensitivity. For CaseSensitive, the gateway determines the case
sensitivity. The default value is ClientSpecified.CaseSensitivitypublic final String caseSensitivityAsString()
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.
If the service returns an enum value that is not available in the current SDK version, caseSensitivity
will return CaseSensitivity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from caseSensitivityAsString().
ClientSpecified, the client
determines the case sensitivity. For CaseSensitive, the gateway determines the case
sensitivity. The default value is ClientSpecified.CaseSensitivitypublic final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
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.
public final 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 must be set if an S3 prefix name is set in LocationARN, or if an
access point or access point alias is used.
public final CacheAttributes cacheAttributes()
Specifies refresh cache information for the file share.
public final 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.
{}
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.
{}
public final 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.
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.
public final 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.
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.
public final 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
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
public CreateSmbFileShareRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateSmbFileShareRequest.Builder,CreateSmbFileShareRequest>toBuilder in class StorageGatewayRequestpublic static CreateSmbFileShareRequest.Builder builder()
public static Class<? extends CreateSmbFileShareRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.