@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateSMBFileShareRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
CreateSMBFileShareInput
NOOP| Constructor and Description |
|---|
CreateSMBFileShareRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateSMBFileShareRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getAccessBasedEnumeration()
The files and folders on this share will only be visible to users with read access.
|
List<String> |
getAdminUserList()
A list of users or groups in the Active Directory that will be granted administrator privileges on the file
share.
|
String |
getAuditDestinationARN()
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
String |
getAuthentication()
The authentication method that users use to access the file share.
|
String |
getBucketRegion()
Specifies the Region of the S3 bucket where the SMB file share stores files.
|
CacheAttributes |
getCacheAttributes()
Specifies refresh cache information for the file share.
|
String |
getCaseSensitivity()
The case of an object name in an Amazon S3 bucket.
|
String |
getClientToken()
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
|
String |
getDefaultStorageClass()
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
String |
getFileShareName()
The name of the file share.
|
String |
getGatewayARN()
The ARN of the S3 File Gateway on which you want to create a file share.
|
Boolean |
getGuessMIMETypeEnabled()
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
List<String> |
getInvalidUserList()
A list of users or groups in the Active Directory that are not allowed to access the file share.
|
Boolean |
getKMSEncrypted()
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 |
getKMSKey()
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption.
|
String |
getLocationARN()
A custom ARN for the backend storage used for storing data for file shares.
|
String |
getNotificationPolicy()
The notification policy of the file share.
|
String |
getObjectACL()
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 |
getOplocksEnabled()
Specifies whether opportunistic locking is enabled for the SMB file share.
|
Boolean |
getReadOnly()
A value that sets the write status of a file share.
|
Boolean |
getRequesterPays()
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
|
String |
getRole()
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the
underlying storage.
|
Boolean |
getSMBACLEnabled()
Set this value to
true to enable access control list (ACL) on the SMB file share. |
List<Tag> |
getTags()
A list of up to 50 tags that can be assigned to the NFS file share.
|
List<String> |
getValidUserList()
|
String |
getVPCEndpointDNSName()
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
|
int |
hashCode() |
Boolean |
isAccessBasedEnumeration()
The files and folders on this share will only be visible to users with read access.
|
Boolean |
isGuessMIMETypeEnabled()
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
Boolean |
isKMSEncrypted()
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. |
Boolean |
isOplocksEnabled()
Specifies whether opportunistic locking is enabled for the SMB file share.
|
Boolean |
isReadOnly()
A value that sets the write status of a file share.
|
Boolean |
isRequesterPays()
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
|
Boolean |
isSMBACLEnabled()
Set this value to
true to enable access control list (ACL) on the SMB file share. |
void |
setAccessBasedEnumeration(Boolean accessBasedEnumeration)
The files and folders on this share will only be visible to users with read access.
|
void |
setAdminUserList(Collection<String> adminUserList)
A list of users or groups in the Active Directory that will be granted administrator privileges on the file
share.
|
void |
setAuditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
void |
setAuthentication(String authentication)
The authentication method that users use to access the file share.
|
void |
setBucketRegion(String bucketRegion)
Specifies the Region of the S3 bucket where the SMB file share stores files.
|
void |
setCacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
|
void |
setCaseSensitivity(String caseSensitivity)
The case of an object name in an Amazon S3 bucket.
|
void |
setClientToken(String clientToken)
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
|
void |
setDefaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
void |
setFileShareName(String fileShareName)
The name of the file share.
|
void |
setGatewayARN(String gatewayARN)
The ARN of the S3 File Gateway on which you want to create a file share.
|
void |
setGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
void |
setInvalidUserList(Collection<String> invalidUserList)
A list of users or groups in the Active Directory that are not allowed to access the file share.
|
void |
setKMSEncrypted(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. |
void |
setKMSKey(String kMSKey)
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption.
|
void |
setLocationARN(String locationARN)
A custom ARN for the backend storage used for storing data for file shares.
|
void |
setNotificationPolicy(String notificationPolicy)
The notification policy of the file share.
|
void |
setObjectACL(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.
|
void |
setOplocksEnabled(Boolean oplocksEnabled)
Specifies whether opportunistic locking is enabled for the SMB file share.
|
void |
setReadOnly(Boolean readOnly)
A value that sets the write status of a file share.
|
void |
setRequesterPays(Boolean requesterPays)
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
|
void |
setRole(String role)
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the
underlying storage.
|
void |
setSMBACLEnabled(Boolean sMBACLEnabled)
Set this value to
true to enable access control list (ACL) on the SMB file share. |
void |
setTags(Collection<Tag> tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
void |
setValidUserList(Collection<String> validUserList)
|
void |
setVPCEndpointDNSName(String vPCEndpointDNSName)
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
|
String |
toString()
Returns a string representation of this object.
|
CreateSMBFileShareRequest |
withAccessBasedEnumeration(Boolean accessBasedEnumeration)
The files and folders on this share will only be visible to users with read access.
|
CreateSMBFileShareRequest |
withAdminUserList(Collection<String> adminUserList)
A list of users or groups in the Active Directory that will be granted administrator privileges on the file
share.
|
CreateSMBFileShareRequest |
withAdminUserList(String... adminUserList)
A list of users or groups in the Active Directory that will be granted administrator privileges on the file
share.
|
CreateSMBFileShareRequest |
withAuditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
CreateSMBFileShareRequest |
withAuthentication(String authentication)
The authentication method that users use to access the file share.
|
CreateSMBFileShareRequest |
withBucketRegion(String bucketRegion)
Specifies the Region of the S3 bucket where the SMB file share stores files.
|
CreateSMBFileShareRequest |
withCacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
|
CreateSMBFileShareRequest |
withCaseSensitivity(CaseSensitivity caseSensitivity)
The case of an object name in an Amazon S3 bucket.
|
CreateSMBFileShareRequest |
withCaseSensitivity(String caseSensitivity)
The case of an object name in an Amazon S3 bucket.
|
CreateSMBFileShareRequest |
withClientToken(String clientToken)
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
|
CreateSMBFileShareRequest |
withDefaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
CreateSMBFileShareRequest |
withFileShareName(String fileShareName)
The name of the file share.
|
CreateSMBFileShareRequest |
withGatewayARN(String gatewayARN)
The ARN of the S3 File Gateway on which you want to create a file share.
|
CreateSMBFileShareRequest |
withGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
CreateSMBFileShareRequest |
withInvalidUserList(Collection<String> invalidUserList)
A list of users or groups in the Active Directory that are not allowed to access the file share.
|
CreateSMBFileShareRequest |
withInvalidUserList(String... invalidUserList)
A list of users or groups in the Active Directory that are not allowed to access the file share.
|
CreateSMBFileShareRequest |
withKMSEncrypted(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 |
withKMSKey(String kMSKey)
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side
encryption.
|
CreateSMBFileShareRequest |
withLocationARN(String locationARN)
A custom ARN for the backend storage used for storing data for file shares.
|
CreateSMBFileShareRequest |
withNotificationPolicy(String notificationPolicy)
The notification policy of the file share.
|
CreateSMBFileShareRequest |
withObjectACL(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 |
withObjectACL(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 |
withOplocksEnabled(Boolean oplocksEnabled)
Specifies whether opportunistic locking is enabled for the SMB file share.
|
CreateSMBFileShareRequest |
withReadOnly(Boolean readOnly)
A value that sets the write status of a file share.
|
CreateSMBFileShareRequest |
withRequesterPays(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 |
withRole(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 |
withSMBACLEnabled(Boolean sMBACLEnabled)
Set this value to
true to enable access control list (ACL) on the SMB file share. |
CreateSMBFileShareRequest |
withTags(Collection<Tag> tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateSMBFileShareRequest |
withTags(Tag... tags)
A list of up to 50 tags that can be assigned to the NFS file share.
|
CreateSMBFileShareRequest |
withValidUserList(Collection<String> validUserList)
|
CreateSMBFileShareRequest |
withValidUserList(String... validUserList)
|
CreateSMBFileShareRequest |
withVPCEndpointDNSName(String vPCEndpointDNSName)
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setClientToken(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.public String getClientToken()
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
public CreateSMBFileShareRequest withClientToken(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.public void setGatewayARN(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.public String getGatewayARN()
The ARN of the S3 File Gateway on which you want to create a file share.
public CreateSMBFileShareRequest withGatewayARN(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.public void setKMSEncrypted(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
public Boolean getKMSEncrypted()
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 CreateSMBFileShareRequest withKMSEncrypted(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
public Boolean isKMSEncrypted()
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 void setKMSKey(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.public String getKMSKey()
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 CreateSMBFileShareRequest withKMSKey(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.public void setRole(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.public String getRole()
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
public CreateSMBFileShareRequest withRole(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.public void setLocationARN(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
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
public String getLocationARN()
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 CreateSMBFileShareRequest withLocationARN(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
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
public void setDefaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
S3_STANDARD. 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_STANDARD. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA
| S3_ONEZONE_IA
public String getDefaultStorageClass()
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
S3_STANDARD. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
S3_ONEZONE_IA
S3_STANDARD. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |
S3_STANDARD_IA | S3_ONEZONE_IA
public CreateSMBFileShareRequest withDefaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is
S3_STANDARD. 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_STANDARD. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA
| S3_ONEZONE_IA
public void setObjectACL(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.ObjectACLpublic String getObjectACL()
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.
private.ObjectACLpublic CreateSMBFileShareRequest withObjectACL(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.ObjectACLpublic CreateSMBFileShareRequest withObjectACL(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.ObjectACLpublic void setReadOnly(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
public Boolean getReadOnly()
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 CreateSMBFileShareRequest withReadOnly(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
public Boolean isReadOnly()
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 void setGuessMIMETypeEnabled(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
public Boolean getGuessMIMETypeEnabled()
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 CreateSMBFileShareRequest withGuessMIMETypeEnabled(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
public Boolean isGuessMIMETypeEnabled()
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 void setRequesterPays(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
public Boolean getRequesterPays()
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 CreateSMBFileShareRequest withRequesterPays(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
public Boolean isRequesterPays()
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 void setSMBACLEnabled(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
public Boolean getSMBACLEnabled()
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 CreateSMBFileShareRequest withSMBACLEnabled(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
public Boolean isSMBACLEnabled()
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 void setAccessBasedEnumeration(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.public Boolean getAccessBasedEnumeration()
The files and folders on this share will only be visible to users with read access.
public CreateSMBFileShareRequest withAccessBasedEnumeration(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.public Boolean isAccessBasedEnumeration()
The files and folders on this share will only be visible to users with read access.
public List<String> getAdminUserList()
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.
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 void setAdminUserList(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.
public CreateSMBFileShareRequest withAdminUserList(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.
NOTE: This method appends the values to the existing list (if any). Use
setAdminUserList(java.util.Collection) or withAdminUserList(java.util.Collection) if you want
to override the existing values.
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.
public CreateSMBFileShareRequest withAdminUserList(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.
public void setValidUserList(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.public CreateSMBFileShareRequest withValidUserList(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.
NOTE: This method appends the values to the existing list (if any). Use
setValidUserList(java.util.Collection) or withValidUserList(java.util.Collection) if you want
to override the existing values.
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.public CreateSMBFileShareRequest withValidUserList(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.public List<String> getInvalidUserList()
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.
DOMAIN\User1,
user1, @group1, and @DOMAIN\group1. Can only be set if
Authentication is set to ActiveDirectory.public void setInvalidUserList(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.public CreateSMBFileShareRequest withInvalidUserList(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.
NOTE: This method appends the values to the existing list (if any). Use
setInvalidUserList(java.util.Collection) or withInvalidUserList(java.util.Collection) if you
want to override the existing values.
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.public CreateSMBFileShareRequest withInvalidUserList(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.public void setAuditDestinationARN(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.public String getAuditDestinationARN()
The Amazon Resource Name (ARN) of the storage used for audit logs.
public CreateSMBFileShareRequest withAuditDestinationARN(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.public void setAuthentication(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
public String getAuthentication()
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 CreateSMBFileShareRequest withAuthentication(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
public void setCaseSensitivity(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.CaseSensitivitypublic String getCaseSensitivity()
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.
ClientSpecified, the client
determines the case sensitivity. For CaseSensitive, the gateway determines the case
sensitivity. The default value is ClientSpecified.CaseSensitivitypublic CreateSMBFileShareRequest withCaseSensitivity(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.CaseSensitivitypublic CreateSMBFileShareRequest withCaseSensitivity(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.CaseSensitivitypublic List<Tag> getTags()
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.
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 void setTags(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.
public CreateSMBFileShareRequest withTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
existing values.
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.
public CreateSMBFileShareRequest withTags(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.
public void setFileShareName(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.
public String getFileShareName()
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 CreateSMBFileShareRequest withFileShareName(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.
public void setCacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
cacheAttributes - Specifies refresh cache information for the file share.public CacheAttributes getCacheAttributes()
Specifies refresh cache information for the file share.
public CreateSMBFileShareRequest withCacheAttributes(CacheAttributes cacheAttributes)
Specifies refresh cache information for the file share.
cacheAttributes - Specifies refresh cache information for the file share.public void setNotificationPolicy(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.
{}
public String getNotificationPolicy()
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 CreateSMBFileShareRequest withNotificationPolicy(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.
{}
public void setVPCEndpointDNSName(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.
public String getVPCEndpointDNSName()
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 CreateSMBFileShareRequest withVPCEndpointDNSName(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.
public void setBucketRegion(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.
public String getBucketRegion()
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 CreateSMBFileShareRequest withBucketRegion(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.
public void setOplocksEnabled(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
public Boolean getOplocksEnabled()
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 withOplocksEnabled(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
public Boolean isOplocksEnabled()
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 String toString()
toString in class ObjectObject.toString()public CreateSMBFileShareRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()