com.amazonaws.services.storagegateway.model

Class UpdateSMBFileShareRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.UpdateSMBFileShareRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateSMBFileShareRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

UpdateSMBFileShareInput

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateSMBFileShareRequest()

Method Summary

Modifier and Type	Method and Description
UpdateSMBFileShareRequest	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 have administrator rights to the file share.
String	getAuditDestinationARN() The Amazon Resource Name (ARN) of the storage used for audit logs.
CacheAttributes	getCacheAttributes() Specifies 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 file gateway.
String	getFileShareARN() The Amazon Resource Name (ARN) of the SMB file share that you want to update.
String	getFileShareName() The name of the 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 AWS 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	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 file gateway puts objects into.
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.
Boolean	getSMBACLEnabled() Set this value to true to enable access control list (ACL) on the SMB file share.
List<String>	getValidUserList() A list of users or groups in the Active Directory that are allowed to access the file share.
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 AWS KMS key, or false to use a key managed by Amazon S3.
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 have administrator rights to the file share.
void	setAuditDestinationARN(String auditDestinationARN) The Amazon Resource Name (ARN) of the storage used for audit logs.
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	setDefaultStorageClass(String defaultStorageClass) The default storage class for objects put into an Amazon S3 bucket by the file gateway.
void	setFileShareARN(String fileShareARN) The Amazon Resource Name (ARN) of the SMB file share that you want to update.
void	setFileShareName(String fileShareName) The name of the 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 AWS 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	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 file gateway puts objects into.
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	setSMBACLEnabled(Boolean sMBACLEnabled) Set this value to true to enable access control list (ACL) on the SMB file share.
void	setValidUserList(Collection<String> validUserList) A list of users or groups in the Active Directory that are allowed to access the file share.
String	toString() Returns a string representation of this object.
UpdateSMBFileShareRequest	withAccessBasedEnumeration(Boolean accessBasedEnumeration) The files and folders on this share will only be visible to users with read access.
UpdateSMBFileShareRequest	withAdminUserList(Collection<String> adminUserList) A list of users or groups in the Active Directory that have administrator rights to the file share.
UpdateSMBFileShareRequest	withAdminUserList(String... adminUserList) A list of users or groups in the Active Directory that have administrator rights to the file share.
UpdateSMBFileShareRequest	withAuditDestinationARN(String auditDestinationARN) The Amazon Resource Name (ARN) of the storage used for audit logs.
UpdateSMBFileShareRequest	withCacheAttributes(CacheAttributes cacheAttributes) Specifies refresh cache information for the file share.
UpdateSMBFileShareRequest	withCaseSensitivity(CaseSensitivity caseSensitivity) The case of an object name in an Amazon S3 bucket.
UpdateSMBFileShareRequest	withCaseSensitivity(String caseSensitivity) The case of an object name in an Amazon S3 bucket.
UpdateSMBFileShareRequest	withDefaultStorageClass(String defaultStorageClass) The default storage class for objects put into an Amazon S3 bucket by the file gateway.
UpdateSMBFileShareRequest	withFileShareARN(String fileShareARN) The Amazon Resource Name (ARN) of the SMB file share that you want to update.
UpdateSMBFileShareRequest	withFileShareName(String fileShareName) The name of the file share.
UpdateSMBFileShareRequest	withGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled) A value that enables guessing of the MIME type for uploaded objects based on file extensions.
UpdateSMBFileShareRequest	withInvalidUserList(Collection<String> invalidUserList) A list of users or groups in the Active Directory that are not allowed to access the file share.
UpdateSMBFileShareRequest	withInvalidUserList(String... invalidUserList) A list of users or groups in the Active Directory that are not allowed to access the file share.
UpdateSMBFileShareRequest	withKMSEncrypted(Boolean kMSEncrypted) Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
UpdateSMBFileShareRequest	withKMSKey(String kMSKey) The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
UpdateSMBFileShareRequest	withNotificationPolicy(String notificationPolicy) The notification policy of the file share.
UpdateSMBFileShareRequest	withObjectACL(ObjectACL objectACL) A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into.
UpdateSMBFileShareRequest	withObjectACL(String objectACL) A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into.
UpdateSMBFileShareRequest	withReadOnly(Boolean readOnly) A value that sets the write status of a file share.
UpdateSMBFileShareRequest	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.
UpdateSMBFileShareRequest	withSMBACLEnabled(Boolean sMBACLEnabled) Set this value to true to enable access control list (ACL) on the SMB file share.
UpdateSMBFileShareRequest	withValidUserList(Collection<String> validUserList) A list of users or groups in the Active Directory that are allowed to access the file share.
UpdateSMBFileShareRequest	withValidUserList(String... validUserList) A list of users or groups in the Active Directory that are allowed to access the file share.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateSMBFileShareRequest

public UpdateSMBFileShareRequest()

Method Detail

setFileShareARN

public void setFileShareARN(String fileShareARN)

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

Parameters:

fileShareARN - The Amazon Resource Name (ARN) of the SMB file share that you want to update.

getFileShareARN

public String getFileShareARN()

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

Returns:

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

withFileShareARN

public UpdateSMBFileShareRequest withFileShareARN(String fileShareARN)

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

Parameters:

fileShareARN - The Amazon Resource Name (ARN) of the SMB file share that you want to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKMSEncrypted

public void setKMSEncrypted(Boolean kMSEncrypted)

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Parameters:

kMSEncrypted - Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

getKMSEncrypted

public Boolean getKMSEncrypted()

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Returns:

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

withKMSEncrypted

public UpdateSMBFileShareRequest withKMSEncrypted(Boolean kMSEncrypted)

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Parameters:

kMSEncrypted - Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Returns:

Returns a reference to this object so that method calls can be chained together.

isKMSEncrypted

public Boolean isKMSEncrypted()

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Returns:

Set to true to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

setKMSKey

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.

Parameters:

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.

getKMSKey

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.

Returns:

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.

withKMSKey

public UpdateSMBFileShareRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDefaultStorageClass

public void setDefaultStorageClass(String defaultStorageClass)

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Parameters:

defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

getDefaultStorageClass

public String getDefaultStorageClass()

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Returns:

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

withDefaultStorageClass

public UpdateSMBFileShareRequest withDefaultStorageClass(String defaultStorageClass)

The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Parameters:

defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Returns:

Returns a reference to this object so that method calls can be chained together.

setObjectACL

public void setObjectACL(String objectACL)

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

Parameters:

objectACL - A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

See Also:

ObjectACL

getObjectACL

public String getObjectACL()

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

Returns:

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

See Also:

ObjectACL

withObjectACL

public UpdateSMBFileShareRequest withObjectACL(String objectACL)

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

Parameters:

objectACL - A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectACL

withObjectACL

public UpdateSMBFileShareRequest withObjectACL(ObjectACL objectACL)

A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

Parameters:

objectACL - A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectACL

setReadOnly

public void setReadOnly(Boolean readOnly)

A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

Valid Values: true | false

Parameters:

readOnly - A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

Valid Values: true | false

getReadOnly

public Boolean getReadOnly()

A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

Valid Values: true | false

Returns:

A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

Valid Values: true | false

withReadOnly

public UpdateSMBFileShareRequest withReadOnly(Boolean readOnly)

A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

Valid Values: true | false

Parameters:

readOnly - A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

Valid Values: true | false

Returns:

Returns a reference to this object so that method calls can be chained together.

isReadOnly

public Boolean isReadOnly()

A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

Valid Values: true | false

Returns:

A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

Valid Values: true | false

setGuessMIMETypeEnabled

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

Parameters:

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

getGuessMIMETypeEnabled

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

Returns:

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

withGuessMIMETypeEnabled

public UpdateSMBFileShareRequest 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isGuessMIMETypeEnabled

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

Returns:

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

setRequesterPays

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

Parameters:

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

getRequesterPays

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

Returns:

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

withRequesterPays

public UpdateSMBFileShareRequest 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isRequesterPays

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

Returns:

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

setSMBACLEnabled

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 AWS Storage Gateway User Guide.

Valid Values: true | false

Parameters:

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 AWS Storage Gateway User Guide.

Valid Values: true | false

getSMBACLEnabled

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 AWS Storage Gateway User Guide.

Valid Values: true | false

Returns:

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 AWS Storage Gateway User Guide.

Valid Values: true | false

withSMBACLEnabled

public UpdateSMBFileShareRequest 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 AWS Storage Gateway User Guide.

Valid Values: true | false

Parameters:

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 AWS Storage Gateway User Guide.

Valid Values: true | false

Returns:

Returns a reference to this object so that method calls can be chained together.

isSMBACLEnabled

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 AWS Storage Gateway User Guide.

Valid Values: true | false

Returns:

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 AWS Storage Gateway User Guide.

Valid Values: true | false

setAccessBasedEnumeration

public void setAccessBasedEnumeration(Boolean accessBasedEnumeration)

The files and folders on this share will only be visible to users with read access.

Parameters:

accessBasedEnumeration - The files and folders on this share will only be visible to users with read access.

getAccessBasedEnumeration

public Boolean getAccessBasedEnumeration()

The files and folders on this share will only be visible to users with read access.

Returns:

The files and folders on this share will only be visible to users with read access.

withAccessBasedEnumeration

public UpdateSMBFileShareRequest withAccessBasedEnumeration(Boolean accessBasedEnumeration)

The files and folders on this share will only be visible to users with read access.

Parameters:

accessBasedEnumeration - The files and folders on this share will only be visible to users with read access.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAccessBasedEnumeration

public Boolean isAccessBasedEnumeration()

The files and folders on this share will only be visible to users with read access.

Returns:

The files and folders on this share will only be visible to users with read access.

getAdminUserList

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.

Returns:

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.

setAdminUserList

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.

Parameters:

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.

withAdminUserList

public UpdateSMBFileShareRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAdminUserList

public UpdateSMBFileShareRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getValidUserList

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.

Returns:

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.

setValidUserList

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.

Parameters:

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.

withValidUserList

public UpdateSMBFileShareRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withValidUserList

public UpdateSMBFileShareRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getInvalidUserList

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.

Returns:

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.

setInvalidUserList

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.

Parameters:

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.

withInvalidUserList

public UpdateSMBFileShareRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withInvalidUserList

public UpdateSMBFileShareRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAuditDestinationARN

public void setAuditDestinationARN(String auditDestinationARN)

The Amazon Resource Name (ARN) of the storage used for audit logs.

Parameters:

auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for audit logs.

getAuditDestinationARN

public String getAuditDestinationARN()

The Amazon Resource Name (ARN) of the storage used for audit logs.

Returns:

The Amazon Resource Name (ARN) of the storage used for audit logs.

withAuditDestinationARN

public UpdateSMBFileShareRequest withAuditDestinationARN(String auditDestinationARN)

The Amazon Resource Name (ARN) of the storage used for audit logs.

Parameters:

auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for audit logs.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCaseSensitivity

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.

Parameters:

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.

See Also:

CaseSensitivity

getCaseSensitivity

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.

Returns:

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.

See Also:

CaseSensitivity

withCaseSensitivity

public UpdateSMBFileShareRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CaseSensitivity

withCaseSensitivity

public UpdateSMBFileShareRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CaseSensitivity

setFileShareName

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.

Parameters:

fileShareName - The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

getFileShareName

public String getFileShareName()

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

Returns:

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

withFileShareName

public UpdateSMBFileShareRequest withFileShareName(String fileShareName)

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

Parameters:

fileShareName - The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCacheAttributes

public void setCacheAttributes(CacheAttributes cacheAttributes)

Specifies refresh cache information for the file share.

Parameters:

cacheAttributes - Specifies refresh cache information for the file share.

getCacheAttributes

public CacheAttributes getCacheAttributes()

Specifies refresh cache information for the file share.

Returns:

Specifies refresh cache information for the file share.

withCacheAttributes

public UpdateSMBFileShareRequest withCacheAttributes(CacheAttributes cacheAttributes)

Specifies refresh cache information for the file share.

Parameters:

cacheAttributes - Specifies refresh cache information for the file share.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNotificationPolicy

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.

{}

Parameters:

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.

{}

getNotificationPolicy

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.

{}

Returns:

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.

{}

withNotificationPolicy

public UpdateSMBFileShareRequest 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.

{}

Parameters:

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.

{}

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateSMBFileShareRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()