@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SMBFileShareInfo extends Object implements Serializable, Cloneable, StructuredPojo
The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways.
Constructor and Description |
---|
SMBFileShareInfo() |
Modifier and Type | Method and Description |
---|---|
SMBFileShareInfo |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAccessBasedEnumeration()
Indicates whether
AccessBasedEnumeration is enabled. |
List<String> |
getAdminUserList()
A list of users or groups in the Active Directory that have administrator rights to the file share.
|
String |
getAuditDestinationARN()
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
String |
getAuthentication() |
String |
getBucketRegion()
Specifies the Region of the S3 bucket where the SMB file share stores files.
|
CacheAttributes |
getCacheAttributes()
Refresh cache information for the file share.
|
String |
getCaseSensitivity()
The case of an object name in an Amazon S3 bucket.
|
String |
getDefaultStorageClass()
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
String |
getFileShareARN() |
String |
getFileShareId() |
String |
getFileShareName()
The name of the file share.
|
String |
getFileShareStatus() |
String |
getGatewayARN() |
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() |
String |
getLocationARN() |
String |
getNotificationPolicy()
The notification policy of the file share.
|
String |
getObjectACL() |
Boolean |
getOplocksEnabled()
Specifies whether opportunistic locking is enabled for the SMB file share.
|
String |
getPath()
The file share path used by the SMB client to identify the mount point.
|
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() |
Boolean |
getSMBACLEnabled()
If this value is set to
true , it indicates that access control list (ACL) is enabled on the SMB file
share. |
List<Tag> |
getTags()
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
|
List<String> |
getValidUserList()
A list of users or groups in the Active Directory that are allowed to access the file share.
|
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()
Indicates whether
AccessBasedEnumeration is enabled. |
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()
If this value is set to
true , it indicates that access control list (ACL) is enabled on the SMB file
share. |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAccessBasedEnumeration(Boolean accessBasedEnumeration)
Indicates whether
AccessBasedEnumeration is enabled. |
void |
setAdminUserList(Collection<String> adminUserList)
A list of users or groups in the Active Directory that have administrator rights to the file share.
|
void |
setAuditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
void |
setAuthentication(String authentication) |
void |
setBucketRegion(String bucketRegion)
Specifies the Region of the S3 bucket where the SMB file share stores files.
|
void |
setCacheAttributes(CacheAttributes cacheAttributes)
Refresh cache information for the file share.
|
void |
setCaseSensitivity(String caseSensitivity)
The case of an object name in an Amazon S3 bucket.
|
void |
setDefaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
void |
setFileShareARN(String fileShareARN) |
void |
setFileShareId(String fileShareId) |
void |
setFileShareName(String fileShareName)
The name of the file share.
|
void |
setFileShareStatus(String fileShareStatus) |
void |
setGatewayARN(String gatewayARN) |
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) |
void |
setLocationARN(String locationARN) |
void |
setNotificationPolicy(String notificationPolicy)
The notification policy of the file share.
|
void |
setObjectACL(String objectACL) |
void |
setOplocksEnabled(Boolean oplocksEnabled)
Specifies whether opportunistic locking is enabled for the SMB file share.
|
void |
setPath(String path)
The file share path used by the SMB client to identify the mount point.
|
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) |
void |
setSMBACLEnabled(Boolean sMBACLEnabled)
If this value is set to
true , it indicates that access control list (ACL) is enabled on the SMB file
share. |
void |
setTags(Collection<Tag> tags)
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
|
void |
setValidUserList(Collection<String> validUserList)
A list of users or groups in the Active Directory that are allowed to access the file share.
|
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.
|
SMBFileShareInfo |
withAccessBasedEnumeration(Boolean accessBasedEnumeration)
Indicates whether
AccessBasedEnumeration is enabled. |
SMBFileShareInfo |
withAdminUserList(Collection<String> adminUserList)
A list of users or groups in the Active Directory that have administrator rights to the file share.
|
SMBFileShareInfo |
withAdminUserList(String... adminUserList)
A list of users or groups in the Active Directory that have administrator rights to the file share.
|
SMBFileShareInfo |
withAuditDestinationARN(String auditDestinationARN)
The Amazon Resource Name (ARN) of the storage used for audit logs.
|
SMBFileShareInfo |
withAuthentication(String authentication) |
SMBFileShareInfo |
withBucketRegion(String bucketRegion)
Specifies the Region of the S3 bucket where the SMB file share stores files.
|
SMBFileShareInfo |
withCacheAttributes(CacheAttributes cacheAttributes)
Refresh cache information for the file share.
|
SMBFileShareInfo |
withCaseSensitivity(CaseSensitivity caseSensitivity)
The case of an object name in an Amazon S3 bucket.
|
SMBFileShareInfo |
withCaseSensitivity(String caseSensitivity)
The case of an object name in an Amazon S3 bucket.
|
SMBFileShareInfo |
withDefaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
|
SMBFileShareInfo |
withFileShareARN(String fileShareARN) |
SMBFileShareInfo |
withFileShareId(String fileShareId) |
SMBFileShareInfo |
withFileShareName(String fileShareName)
The name of the file share.
|
SMBFileShareInfo |
withFileShareStatus(String fileShareStatus) |
SMBFileShareInfo |
withGatewayARN(String gatewayARN) |
SMBFileShareInfo |
withGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
A value that enables guessing of the MIME type for uploaded objects based on file extensions.
|
SMBFileShareInfo |
withInvalidUserList(Collection<String> invalidUserList)
A list of users or groups in the Active Directory that are not allowed to access the file share.
|
SMBFileShareInfo |
withInvalidUserList(String... invalidUserList)
A list of users or groups in the Active Directory that are not allowed to access the file share.
|
SMBFileShareInfo |
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. |
SMBFileShareInfo |
withKMSKey(String kMSKey) |
SMBFileShareInfo |
withLocationARN(String locationARN) |
SMBFileShareInfo |
withNotificationPolicy(String notificationPolicy)
The notification policy of the file share.
|
SMBFileShareInfo |
withObjectACL(ObjectACL objectACL) |
SMBFileShareInfo |
withObjectACL(String objectACL) |
SMBFileShareInfo |
withOplocksEnabled(Boolean oplocksEnabled)
Specifies whether opportunistic locking is enabled for the SMB file share.
|
SMBFileShareInfo |
withPath(String path)
The file share path used by the SMB client to identify the mount point.
|
SMBFileShareInfo |
withReadOnly(Boolean readOnly)
A value that sets the write status of a file share.
|
SMBFileShareInfo |
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.
|
SMBFileShareInfo |
withRole(String role) |
SMBFileShareInfo |
withSMBACLEnabled(Boolean sMBACLEnabled)
If this value is set to
true , it indicates that access control list (ACL) is enabled on the SMB file
share. |
SMBFileShareInfo |
withTags(Collection<Tag> tags)
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
|
SMBFileShareInfo |
withTags(Tag... tags)
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
|
SMBFileShareInfo |
withValidUserList(Collection<String> validUserList)
A list of users or groups in the Active Directory that are allowed to access the file share.
|
SMBFileShareInfo |
withValidUserList(String... validUserList)
A list of users or groups in the Active Directory that are allowed to access the file share.
|
SMBFileShareInfo |
withVPCEndpointDNSName(String vPCEndpointDNSName)
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
|
public void setFileShareARN(String fileShareARN)
fileShareARN
- public String getFileShareARN()
public SMBFileShareInfo withFileShareARN(String fileShareARN)
fileShareARN
- public void setFileShareId(String fileShareId)
fileShareId
- public String getFileShareId()
public SMBFileShareInfo withFileShareId(String fileShareId)
fileShareId
- public void setFileShareStatus(String fileShareStatus)
fileShareStatus
- public String getFileShareStatus()
public SMBFileShareInfo withFileShareStatus(String fileShareStatus)
fileShareStatus
- public void setGatewayARN(String gatewayARN)
gatewayARN
- public String getGatewayARN()
public SMBFileShareInfo withGatewayARN(String gatewayARN)
gatewayARN
- 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 SMBFileShareInfo 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)
kMSKey
- public String getKMSKey()
public SMBFileShareInfo withKMSKey(String kMSKey)
kMSKey
- public void setPath(String path)
The file share path used by the SMB client to identify the mount point.
path
- The file share path used by the SMB client to identify the mount point.public String getPath()
The file share path used by the SMB client to identify the mount point.
public SMBFileShareInfo withPath(String path)
The file share path used by the SMB client to identify the mount point.
path
- The file share path used by the SMB client to identify the mount point.public void setRole(String role)
role
- public String getRole()
public SMBFileShareInfo withRole(String role)
role
- public void setLocationARN(String locationARN)
locationARN
- public String getLocationARN()
public SMBFileShareInfo withLocationARN(String locationARN)
locationARN
- 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 SMBFileShareInfo 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 SMBFileShareInfo withObjectACL(String objectACL)
objectACL
- ObjectACL
public SMBFileShareInfo withObjectACL(ObjectACL objectACL)
objectACL
- ObjectACL
public 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 SMBFileShareInfo 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 SMBFileShareInfo 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 SMBFileShareInfo 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)
If this value is set to true
, it indicates that access control list (ACL) is enabled on the SMB file
share. If it is set to false
, it indicates that file and directory permissions are mapped to the
POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
sMBACLEnabled
- If this value is set to true
, it indicates that access control list (ACL) is enabled on the
SMB file share. If it is set to false
, it indicates that file and directory permissions are
mapped to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
public Boolean getSMBACLEnabled()
If this value is set to true
, it indicates that access control list (ACL) is enabled on the SMB file
share. If it is set to false
, it indicates that file and directory permissions are mapped to the
POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
true
, it indicates that access control list (ACL) is enabled on the
SMB file share. If it is set to false
, it indicates that file and directory permissions are
mapped to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
public SMBFileShareInfo withSMBACLEnabled(Boolean sMBACLEnabled)
If this value is set to true
, it indicates that access control list (ACL) is enabled on the SMB file
share. If it is set to false
, it indicates that file and directory permissions are mapped to the
POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
sMBACLEnabled
- If this value is set to true
, it indicates that access control list (ACL) is enabled on the
SMB file share. If it is set to false
, it indicates that file and directory permissions are
mapped to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
public Boolean isSMBACLEnabled()
If this value is set to true
, it indicates that access control list (ACL) is enabled on the SMB file
share. If it is set to false
, it indicates that file and directory permissions are mapped to the
POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
true
, it indicates that access control list (ACL) is enabled on the
SMB file share. If it is set to false
, it indicates that file and directory permissions are
mapped to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
public void setAccessBasedEnumeration(Boolean accessBasedEnumeration)
Indicates whether AccessBasedEnumeration
is enabled.
accessBasedEnumeration
- Indicates whether AccessBasedEnumeration
is enabled.public Boolean getAccessBasedEnumeration()
Indicates whether AccessBasedEnumeration
is enabled.
AccessBasedEnumeration
is enabled.public SMBFileShareInfo withAccessBasedEnumeration(Boolean accessBasedEnumeration)
Indicates whether AccessBasedEnumeration
is enabled.
accessBasedEnumeration
- Indicates whether AccessBasedEnumeration
is enabled.public Boolean isAccessBasedEnumeration()
Indicates whether AccessBasedEnumeration
is enabled.
AccessBasedEnumeration
is enabled.public List<String> getAdminUserList()
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must
be prefixed with the @ character. Acceptable formats include: DOMAIN\User1
, user1
,
@group1
, and @DOMAIN\group1
. Can only be set if Authentication is set to
ActiveDirectory
.
DOMAIN\User1
,
user1
, @group1
, and @DOMAIN\group1
. Can only be set if
Authentication is set to ActiveDirectory
.public void setAdminUserList(Collection<String> adminUserList)
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must
be prefixed with the @ character. Acceptable formats include: DOMAIN\User1
, user1
,
@group1
, and @DOMAIN\group1
. Can only be set if Authentication is set to
ActiveDirectory
.
adminUserList
- A list of users or groups in the Active Directory that have administrator rights to the file share. A
group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1
,
user1
, @group1
, and @DOMAIN\group1
. Can only be set if
Authentication is set to ActiveDirectory
.public SMBFileShareInfo withAdminUserList(String... adminUserList)
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must
be prefixed with the @ character. Acceptable formats include: DOMAIN\User1
, user1
,
@group1
, and @DOMAIN\group1
. Can only be set if Authentication is set to
ActiveDirectory
.
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 have administrator rights to the file share. A
group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1
,
user1
, @group1
, and @DOMAIN\group1
. Can only be set if
Authentication is set to ActiveDirectory
.public SMBFileShareInfo withAdminUserList(Collection<String> adminUserList)
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must
be prefixed with the @ character. Acceptable formats include: DOMAIN\User1
, user1
,
@group1
, and @DOMAIN\group1
. Can only be set if Authentication is set to
ActiveDirectory
.
adminUserList
- A list of users or groups in the Active Directory that have administrator rights to the file share. A
group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1
,
user1
, @group1
, and @DOMAIN\group1
. Can only be set if
Authentication is set to ActiveDirectory
.public List<String> getValidUserList()
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
.
DOMAIN\User1
,
user1
, @group1
, and @DOMAIN\group1
. Can only be set if
Authentication is set to ActiveDirectory
.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 SMBFileShareInfo 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 SMBFileShareInfo 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 SMBFileShareInfo 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 SMBFileShareInfo 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 SMBFileShareInfo 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)
authentication
- public String getAuthentication()
public SMBFileShareInfo withAuthentication(String authentication)
authentication
- 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
.CaseSensitivity
public 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
.CaseSensitivity
public SMBFileShareInfo 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
.CaseSensitivity
public SMBFileShareInfo 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
.CaseSensitivity
public List<Tag> getTags()
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a
key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource
API operation.
ListTagsForResource
API operation.public void setTags(Collection<Tag> tags)
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a
key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource
API operation.
tags
- A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a
key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource
API operation.public SMBFileShareInfo withTags(Tag... tags)
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a
key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource
API operation.
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 assigned to the SMB file share, sorted alphabetically by key name. Each tag is a
key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource
API operation.public SMBFileShareInfo withTags(Collection<Tag> tags)
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a
key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource
API operation.
tags
- A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a
key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the
ListTagsForResource
API operation.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 SMBFileShareInfo 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)
Refresh cache information for the file share.
cacheAttributes
- Refresh cache information for the file share.public CacheAttributes getCacheAttributes()
Refresh cache information for the file share.
public SMBFileShareInfo withCacheAttributes(CacheAttributes cacheAttributes)
Refresh cache information for the file share.
cacheAttributes
- 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 SMBFileShareInfo 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 SMBFileShareInfo 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 SMBFileShareInfo 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 SMBFileShareInfo 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 Object
Object.toString()
public SMBFileShareInfo clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.