AWS SDK for C++  1.9.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::StorageGateway::Model::UpdateSMBFileShareRequest Class Reference

#include <UpdateSMBFileShareRequest.h>

+ Inheritance diagram for Aws::StorageGateway::Model::UpdateSMBFileShareRequest:

Public Member Functions

 UpdateSMBFileShareRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetFileShareARN () const
 
bool FileShareARNHasBeenSet () const
 
void SetFileShareARN (const Aws::String &value)
 
void SetFileShareARN (Aws::String &&value)
 
void SetFileShareARN (const char *value)
 
UpdateSMBFileShareRequestWithFileShareARN (const Aws::String &value)
 
UpdateSMBFileShareRequestWithFileShareARN (Aws::String &&value)
 
UpdateSMBFileShareRequestWithFileShareARN (const char *value)
 
bool GetKMSEncrypted () const
 
bool KMSEncryptedHasBeenSet () const
 
void SetKMSEncrypted (bool value)
 
UpdateSMBFileShareRequestWithKMSEncrypted (bool value)
 
const Aws::StringGetKMSKey () const
 
bool KMSKeyHasBeenSet () const
 
void SetKMSKey (const Aws::String &value)
 
void SetKMSKey (Aws::String &&value)
 
void SetKMSKey (const char *value)
 
UpdateSMBFileShareRequestWithKMSKey (const Aws::String &value)
 
UpdateSMBFileShareRequestWithKMSKey (Aws::String &&value)
 
UpdateSMBFileShareRequestWithKMSKey (const char *value)
 
const Aws::StringGetDefaultStorageClass () const
 
bool DefaultStorageClassHasBeenSet () const
 
void SetDefaultStorageClass (const Aws::String &value)
 
void SetDefaultStorageClass (Aws::String &&value)
 
void SetDefaultStorageClass (const char *value)
 
UpdateSMBFileShareRequestWithDefaultStorageClass (const Aws::String &value)
 
UpdateSMBFileShareRequestWithDefaultStorageClass (Aws::String &&value)
 
UpdateSMBFileShareRequestWithDefaultStorageClass (const char *value)
 
const ObjectACLGetObjectACL () const
 
bool ObjectACLHasBeenSet () const
 
void SetObjectACL (const ObjectACL &value)
 
void SetObjectACL (ObjectACL &&value)
 
UpdateSMBFileShareRequestWithObjectACL (const ObjectACL &value)
 
UpdateSMBFileShareRequestWithObjectACL (ObjectACL &&value)
 
bool GetReadOnly () const
 
bool ReadOnlyHasBeenSet () const
 
void SetReadOnly (bool value)
 
UpdateSMBFileShareRequestWithReadOnly (bool value)
 
bool GetGuessMIMETypeEnabled () const
 
bool GuessMIMETypeEnabledHasBeenSet () const
 
void SetGuessMIMETypeEnabled (bool value)
 
UpdateSMBFileShareRequestWithGuessMIMETypeEnabled (bool value)
 
bool GetRequesterPays () const
 
bool RequesterPaysHasBeenSet () const
 
void SetRequesterPays (bool value)
 
UpdateSMBFileShareRequestWithRequesterPays (bool value)
 
bool GetSMBACLEnabled () const
 
bool SMBACLEnabledHasBeenSet () const
 
void SetSMBACLEnabled (bool value)
 
UpdateSMBFileShareRequestWithSMBACLEnabled (bool value)
 
bool GetAccessBasedEnumeration () const
 
bool AccessBasedEnumerationHasBeenSet () const
 
void SetAccessBasedEnumeration (bool value)
 
UpdateSMBFileShareRequestWithAccessBasedEnumeration (bool value)
 
const Aws::Vector< Aws::String > & GetAdminUserList () const
 
bool AdminUserListHasBeenSet () const
 
void SetAdminUserList (const Aws::Vector< Aws::String > &value)
 
void SetAdminUserList (Aws::Vector< Aws::String > &&value)
 
UpdateSMBFileShareRequestWithAdminUserList (const Aws::Vector< Aws::String > &value)
 
UpdateSMBFileShareRequestWithAdminUserList (Aws::Vector< Aws::String > &&value)
 
UpdateSMBFileShareRequestAddAdminUserList (const Aws::String &value)
 
UpdateSMBFileShareRequestAddAdminUserList (Aws::String &&value)
 
UpdateSMBFileShareRequestAddAdminUserList (const char *value)
 
const Aws::Vector< Aws::String > & GetValidUserList () const
 
bool ValidUserListHasBeenSet () const
 
void SetValidUserList (const Aws::Vector< Aws::String > &value)
 
void SetValidUserList (Aws::Vector< Aws::String > &&value)
 
UpdateSMBFileShareRequestWithValidUserList (const Aws::Vector< Aws::String > &value)
 
UpdateSMBFileShareRequestWithValidUserList (Aws::Vector< Aws::String > &&value)
 
UpdateSMBFileShareRequestAddValidUserList (const Aws::String &value)
 
UpdateSMBFileShareRequestAddValidUserList (Aws::String &&value)
 
UpdateSMBFileShareRequestAddValidUserList (const char *value)
 
const Aws::Vector< Aws::String > & GetInvalidUserList () const
 
bool InvalidUserListHasBeenSet () const
 
void SetInvalidUserList (const Aws::Vector< Aws::String > &value)
 
void SetInvalidUserList (Aws::Vector< Aws::String > &&value)
 
UpdateSMBFileShareRequestWithInvalidUserList (const Aws::Vector< Aws::String > &value)
 
UpdateSMBFileShareRequestWithInvalidUserList (Aws::Vector< Aws::String > &&value)
 
UpdateSMBFileShareRequestAddInvalidUserList (const Aws::String &value)
 
UpdateSMBFileShareRequestAddInvalidUserList (Aws::String &&value)
 
UpdateSMBFileShareRequestAddInvalidUserList (const char *value)
 
const Aws::StringGetAuditDestinationARN () const
 
bool AuditDestinationARNHasBeenSet () const
 
void SetAuditDestinationARN (const Aws::String &value)
 
void SetAuditDestinationARN (Aws::String &&value)
 
void SetAuditDestinationARN (const char *value)
 
UpdateSMBFileShareRequestWithAuditDestinationARN (const Aws::String &value)
 
UpdateSMBFileShareRequestWithAuditDestinationARN (Aws::String &&value)
 
UpdateSMBFileShareRequestWithAuditDestinationARN (const char *value)
 
const CaseSensitivityGetCaseSensitivity () const
 
bool CaseSensitivityHasBeenSet () const
 
void SetCaseSensitivity (const CaseSensitivity &value)
 
void SetCaseSensitivity (CaseSensitivity &&value)
 
UpdateSMBFileShareRequestWithCaseSensitivity (const CaseSensitivity &value)
 
UpdateSMBFileShareRequestWithCaseSensitivity (CaseSensitivity &&value)
 
const Aws::StringGetFileShareName () const
 
bool FileShareNameHasBeenSet () const
 
void SetFileShareName (const Aws::String &value)
 
void SetFileShareName (Aws::String &&value)
 
void SetFileShareName (const char *value)
 
UpdateSMBFileShareRequestWithFileShareName (const Aws::String &value)
 
UpdateSMBFileShareRequestWithFileShareName (Aws::String &&value)
 
UpdateSMBFileShareRequestWithFileShareName (const char *value)
 
const CacheAttributesGetCacheAttributes () const
 
bool CacheAttributesHasBeenSet () const
 
void SetCacheAttributes (const CacheAttributes &value)
 
void SetCacheAttributes (CacheAttributes &&value)
 
UpdateSMBFileShareRequestWithCacheAttributes (const CacheAttributes &value)
 
UpdateSMBFileShareRequestWithCacheAttributes (CacheAttributes &&value)
 
const Aws::StringGetNotificationPolicy () const
 
bool NotificationPolicyHasBeenSet () const
 
void SetNotificationPolicy (const Aws::String &value)
 
void SetNotificationPolicy (Aws::String &&value)
 
void SetNotificationPolicy (const char *value)
 
UpdateSMBFileShareRequestWithNotificationPolicy (const Aws::String &value)
 
UpdateSMBFileShareRequestWithNotificationPolicy (Aws::String &&value)
 
UpdateSMBFileShareRequestWithNotificationPolicy (const char *value)
 
bool GetOplocksEnabled () const
 
bool OplocksEnabledHasBeenSet () const
 
void SetOplocksEnabled (bool value)
 
UpdateSMBFileShareRequestWithOplocksEnabled (bool value)
 
- Public Member Functions inherited from Aws::StorageGateway::StorageGatewayRequest
virtual ~StorageGatewayRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

UpdateSMBFileShareInput

See Also:

AWS API Reference

Definition at line 28 of file UpdateSMBFileShareRequest.h.

Constructor & Destructor Documentation

◆ UpdateSMBFileShareRequest()

Aws::StorageGateway::Model::UpdateSMBFileShareRequest::UpdateSMBFileShareRequest ( )

Member Function Documentation

◆ AccessBasedEnumerationHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AccessBasedEnumerationHasBeenSet ( ) const
inline

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

Definition at line 477 of file UpdateSMBFileShareRequest.h.

◆ AddAdminUserList() [1/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AddAdminUserList ( Aws::String &&  value)
inline

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.

Definition at line 562 of file UpdateSMBFileShareRequest.h.

◆ AddAdminUserList() [2/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AddAdminUserList ( const Aws::String value)
inline

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.

Definition at line 553 of file UpdateSMBFileShareRequest.h.

◆ AddAdminUserList() [3/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AddAdminUserList ( const char *  value)
inline

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.

Definition at line 571 of file UpdateSMBFileShareRequest.h.

◆ AddInvalidUserList() [1/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AddInvalidUserList ( Aws::String &&  value)
inline

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.

Definition at line 726 of file UpdateSMBFileShareRequest.h.

◆ AddInvalidUserList() [2/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AddInvalidUserList ( const Aws::String value)
inline

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.

Definition at line 717 of file UpdateSMBFileShareRequest.h.

◆ AddInvalidUserList() [3/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AddInvalidUserList ( const char *  value)
inline

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.

Definition at line 735 of file UpdateSMBFileShareRequest.h.

◆ AddValidUserList() [1/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AddValidUserList ( Aws::String &&  value)
inline

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.

Definition at line 644 of file UpdateSMBFileShareRequest.h.

◆ AddValidUserList() [2/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AddValidUserList ( const Aws::String value)
inline

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.

Definition at line 635 of file UpdateSMBFileShareRequest.h.

◆ AddValidUserList() [3/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AddValidUserList ( const char *  value)
inline

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.

Definition at line 653 of file UpdateSMBFileShareRequest.h.

◆ AdminUserListHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AdminUserListHasBeenSet ( ) const
inline

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.

Definition at line 508 of file UpdateSMBFileShareRequest.h.

◆ AuditDestinationARNHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::AuditDestinationARNHasBeenSet ( ) const
inline

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

Definition at line 746 of file UpdateSMBFileShareRequest.h.

◆ CacheAttributesHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::CacheAttributesHasBeenSet ( ) const
inline

Specifies refresh cache information for the file share.

Definition at line 893 of file UpdateSMBFileShareRequest.h.

◆ CaseSensitivityHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::CaseSensitivityHasBeenSet ( ) const
inline

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.

Definition at line 793 of file UpdateSMBFileShareRequest.h.

◆ DefaultStorageClassHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::DefaultStorageClassHasBeenSet ( ) const
inline

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 203 of file UpdateSMBFileShareRequest.h.

◆ FileShareARNHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::FileShareARNHasBeenSet ( ) const
inline

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

Definition at line 54 of file UpdateSMBFileShareRequest.h.

◆ FileShareNameHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::FileShareNameHasBeenSet ( ) const
inline

The name of the file share. Optional.

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

Definition at line 840 of file UpdateSMBFileShareRequest.h.

◆ GetAccessBasedEnumeration()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetAccessBasedEnumeration ( ) const
inline

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

Definition at line 471 of file UpdateSMBFileShareRequest.h.

◆ GetAdminUserList()

const Aws::Vector<Aws::String>& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetAdminUserList ( ) const
inline

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.

Definition at line 499 of file UpdateSMBFileShareRequest.h.

◆ GetAuditDestinationARN()

const Aws::String& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetAuditDestinationARN ( ) const
inline

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

Definition at line 741 of file UpdateSMBFileShareRequest.h.

◆ GetCacheAttributes()

const CacheAttributes& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetCacheAttributes ( ) const
inline

Specifies refresh cache information for the file share.

Definition at line 888 of file UpdateSMBFileShareRequest.h.

◆ GetCaseSensitivity()

const CaseSensitivity& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetCaseSensitivity ( ) const
inline

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.

Definition at line 785 of file UpdateSMBFileShareRequest.h.

◆ GetDefaultStorageClass()

const Aws::String& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetDefaultStorageClass ( ) const
inline

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 194 of file UpdateSMBFileShareRequest.h.

◆ GetFileShareARN()

const Aws::String& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetFileShareARN ( ) const
inline

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

Definition at line 48 of file UpdateSMBFileShareRequest.h.

◆ GetFileShareName()

const Aws::String& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetFileShareName ( ) const
inline

The name of the file share. Optional.

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

Definition at line 833 of file UpdateSMBFileShareRequest.h.

◆ GetGuessMIMETypeEnabled()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetGuessMIMETypeEnabled ( ) const
inline

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

Definition at line 343 of file UpdateSMBFileShareRequest.h.

◆ GetInvalidUserList()

const Aws::Vector<Aws::String>& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetInvalidUserList ( ) const
inline

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.

Definition at line 663 of file UpdateSMBFileShareRequest.h.

◆ GetKMSEncrypted()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetKMSEncrypted ( ) const
inline

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

Definition at line 98 of file UpdateSMBFileShareRequest.h.

◆ GetKMSKey()

const Aws::String& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetKMSKey ( ) const
inline

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.

Definition at line 128 of file UpdateSMBFileShareRequest.h.

◆ GetNotificationPolicy()

const Aws::String& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetNotificationPolicy ( ) const
inline

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.

{}

Definition at line 930 of file UpdateSMBFileShareRequest.h.

◆ GetObjectACL()

const ObjectACL& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetObjectACL ( ) const
inline

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

Definition at line 265 of file UpdateSMBFileShareRequest.h.

◆ GetOplocksEnabled()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetOplocksEnabled ( ) const
inline

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

Definition at line 1052 of file UpdateSMBFileShareRequest.h.

◆ GetReadOnly()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetReadOnly ( ) const
inline

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

Definition at line 309 of file UpdateSMBFileShareRequest.h.

◆ GetRequesterPays()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetRequesterPays ( ) const
inline

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

Definition at line 383 of file UpdateSMBFileShareRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file UpdateSMBFileShareRequest.h.

◆ GetSMBACLEnabled()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetSMBACLEnabled ( ) const
inline

Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

Valid Values: true | false

Definition at line 431 of file UpdateSMBFileShareRequest.h.

◆ GetValidUserList()

const Aws::Vector<Aws::String>& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GetValidUserList ( ) const
inline

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.

Definition at line 581 of file UpdateSMBFileShareRequest.h.

◆ GuessMIMETypeEnabledHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::GuessMIMETypeEnabledHasBeenSet ( ) const
inline

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

Definition at line 352 of file UpdateSMBFileShareRequest.h.

◆ InvalidUserListHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::InvalidUserListHasBeenSet ( ) const
inline

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.

Definition at line 672 of file UpdateSMBFileShareRequest.h.

◆ KMSEncryptedHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::KMSEncryptedHasBeenSet ( ) const
inline

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

Definition at line 105 of file UpdateSMBFileShareRequest.h.

◆ KMSKeyHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::KMSKeyHasBeenSet ( ) const
inline

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.

Definition at line 136 of file UpdateSMBFileShareRequest.h.

◆ NotificationPolicyHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::NotificationPolicyHasBeenSet ( ) const
inline

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.

{}

Definition at line 946 of file UpdateSMBFileShareRequest.h.

◆ ObjectACLHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::ObjectACLHasBeenSet ( ) const
inline

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

Definition at line 272 of file UpdateSMBFileShareRequest.h.

◆ OplocksEnabledHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::OplocksEnabledHasBeenSet ( ) const
inline

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

Definition at line 1061 of file UpdateSMBFileShareRequest.h.

◆ ReadOnlyHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::ReadOnlyHasBeenSet ( ) const
inline

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

Definition at line 317 of file UpdateSMBFileShareRequest.h.

◆ RequesterPaysHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::RequesterPaysHasBeenSet ( ) const
inline

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

Definition at line 395 of file UpdateSMBFileShareRequest.h.

◆ SerializePayload()

Aws::String Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccessBasedEnumeration()

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetAccessBasedEnumeration ( bool  value)
inline

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

Definition at line 483 of file UpdateSMBFileShareRequest.h.

◆ SetAdminUserList() [1/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetAdminUserList ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 526 of file UpdateSMBFileShareRequest.h.

◆ SetAdminUserList() [2/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetAdminUserList ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 517 of file UpdateSMBFileShareRequest.h.

◆ SetAuditDestinationARN() [1/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetAuditDestinationARN ( Aws::String &&  value)
inline

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

Definition at line 756 of file UpdateSMBFileShareRequest.h.

◆ SetAuditDestinationARN() [2/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetAuditDestinationARN ( const Aws::String value)
inline

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

Definition at line 751 of file UpdateSMBFileShareRequest.h.

◆ SetAuditDestinationARN() [3/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetAuditDestinationARN ( const char *  value)
inline

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

Definition at line 761 of file UpdateSMBFileShareRequest.h.

◆ SetCacheAttributes() [1/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetCacheAttributes ( CacheAttributes &&  value)
inline

Specifies refresh cache information for the file share.

Definition at line 903 of file UpdateSMBFileShareRequest.h.

◆ SetCacheAttributes() [2/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetCacheAttributes ( const CacheAttributes value)
inline

Specifies refresh cache information for the file share.

Definition at line 898 of file UpdateSMBFileShareRequest.h.

◆ SetCaseSensitivity() [1/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetCaseSensitivity ( CaseSensitivity &&  value)
inline

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.

Definition at line 809 of file UpdateSMBFileShareRequest.h.

◆ SetCaseSensitivity() [2/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetCaseSensitivity ( const CaseSensitivity value)
inline

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.

Definition at line 801 of file UpdateSMBFileShareRequest.h.

◆ SetDefaultStorageClass() [1/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetDefaultStorageClass ( Aws::String &&  value)
inline

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 221 of file UpdateSMBFileShareRequest.h.

◆ SetDefaultStorageClass() [2/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetDefaultStorageClass ( const Aws::String value)
inline

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 212 of file UpdateSMBFileShareRequest.h.

◆ SetDefaultStorageClass() [3/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetDefaultStorageClass ( const char *  value)
inline

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 230 of file UpdateSMBFileShareRequest.h.

◆ SetFileShareARN() [1/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetFileShareARN ( Aws::String &&  value)
inline

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

Definition at line 66 of file UpdateSMBFileShareRequest.h.

◆ SetFileShareARN() [2/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetFileShareARN ( const Aws::String value)
inline

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

Definition at line 60 of file UpdateSMBFileShareRequest.h.

◆ SetFileShareARN() [3/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetFileShareARN ( const char *  value)
inline

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

Definition at line 72 of file UpdateSMBFileShareRequest.h.

◆ SetFileShareName() [1/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetFileShareName ( Aws::String &&  value)
inline

The name of the file share. Optional.

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

Definition at line 854 of file UpdateSMBFileShareRequest.h.

◆ SetFileShareName() [2/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetFileShareName ( const Aws::String value)
inline

The name of the file share. Optional.

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

Definition at line 847 of file UpdateSMBFileShareRequest.h.

◆ SetFileShareName() [3/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetFileShareName ( const char *  value)
inline

The name of the file share. Optional.

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

Definition at line 861 of file UpdateSMBFileShareRequest.h.

◆ SetGuessMIMETypeEnabled()

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetGuessMIMETypeEnabled ( bool  value)
inline

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

Definition at line 361 of file UpdateSMBFileShareRequest.h.

◆ SetInvalidUserList() [1/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetInvalidUserList ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 690 of file UpdateSMBFileShareRequest.h.

◆ SetInvalidUserList() [2/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetInvalidUserList ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 681 of file UpdateSMBFileShareRequest.h.

◆ SetKMSEncrypted()

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetKMSEncrypted ( bool  value)
inline

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

Definition at line 112 of file UpdateSMBFileShareRequest.h.

◆ SetKMSKey() [1/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetKMSKey ( Aws::String &&  value)
inline

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.

Definition at line 152 of file UpdateSMBFileShareRequest.h.

◆ SetKMSKey() [2/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetKMSKey ( const Aws::String value)
inline

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.

Definition at line 144 of file UpdateSMBFileShareRequest.h.

◆ SetKMSKey() [3/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetKMSKey ( const char *  value)
inline

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.

Definition at line 160 of file UpdateSMBFileShareRequest.h.

◆ SetNotificationPolicy() [1/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetNotificationPolicy ( Aws::String &&  value)
inline

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.

{}

Definition at line 978 of file UpdateSMBFileShareRequest.h.

◆ SetNotificationPolicy() [2/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetNotificationPolicy ( const Aws::String value)
inline

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.

{}

Definition at line 962 of file UpdateSMBFileShareRequest.h.

◆ SetNotificationPolicy() [3/3]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetNotificationPolicy ( const char *  value)
inline

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.

{}

Definition at line 994 of file UpdateSMBFileShareRequest.h.

◆ SetObjectACL() [1/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetObjectACL ( const ObjectACL value)
inline

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

Definition at line 279 of file UpdateSMBFileShareRequest.h.

◆ SetObjectACL() [2/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetObjectACL ( ObjectACL &&  value)
inline

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

Definition at line 286 of file UpdateSMBFileShareRequest.h.

◆ SetOplocksEnabled()

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetOplocksEnabled ( bool  value)
inline

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

Definition at line 1070 of file UpdateSMBFileShareRequest.h.

◆ SetReadOnly()

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetReadOnly ( bool  value)
inline

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

Definition at line 325 of file UpdateSMBFileShareRequest.h.

◆ SetRequesterPays()

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetRequesterPays ( bool  value)
inline

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

Definition at line 407 of file UpdateSMBFileShareRequest.h.

◆ SetSMBACLEnabled()

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetSMBACLEnabled ( bool  value)
inline

Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

Valid Values: true | false

Definition at line 453 of file UpdateSMBFileShareRequest.h.

◆ SetValidUserList() [1/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetValidUserList ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 608 of file UpdateSMBFileShareRequest.h.

◆ SetValidUserList() [2/2]

void Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SetValidUserList ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 599 of file UpdateSMBFileShareRequest.h.

◆ SMBACLEnabledHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::SMBACLEnabledHasBeenSet ( ) const
inline

Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

Valid Values: true | false

Definition at line 442 of file UpdateSMBFileShareRequest.h.

◆ ValidUserListHasBeenSet()

bool Aws::StorageGateway::Model::UpdateSMBFileShareRequest::ValidUserListHasBeenSet ( ) const
inline

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.

Definition at line 590 of file UpdateSMBFileShareRequest.h.

◆ WithAccessBasedEnumeration()

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithAccessBasedEnumeration ( bool  value)
inline

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

Definition at line 489 of file UpdateSMBFileShareRequest.h.

◆ WithAdminUserList() [1/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithAdminUserList ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 544 of file UpdateSMBFileShareRequest.h.

◆ WithAdminUserList() [2/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithAdminUserList ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 535 of file UpdateSMBFileShareRequest.h.

◆ WithAuditDestinationARN() [1/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithAuditDestinationARN ( Aws::String &&  value)
inline

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

Definition at line 771 of file UpdateSMBFileShareRequest.h.

◆ WithAuditDestinationARN() [2/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithAuditDestinationARN ( const Aws::String value)
inline

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

Definition at line 766 of file UpdateSMBFileShareRequest.h.

◆ WithAuditDestinationARN() [3/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithAuditDestinationARN ( const char *  value)
inline

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

Definition at line 776 of file UpdateSMBFileShareRequest.h.

◆ WithCacheAttributes() [1/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithCacheAttributes ( CacheAttributes &&  value)
inline

Specifies refresh cache information for the file share.

Definition at line 913 of file UpdateSMBFileShareRequest.h.

◆ WithCacheAttributes() [2/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithCacheAttributes ( const CacheAttributes value)
inline

Specifies refresh cache information for the file share.

Definition at line 908 of file UpdateSMBFileShareRequest.h.

◆ WithCaseSensitivity() [1/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithCaseSensitivity ( CaseSensitivity &&  value)
inline

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.

Definition at line 825 of file UpdateSMBFileShareRequest.h.

◆ WithCaseSensitivity() [2/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithCaseSensitivity ( const CaseSensitivity value)
inline

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.

Definition at line 817 of file UpdateSMBFileShareRequest.h.

◆ WithDefaultStorageClass() [1/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithDefaultStorageClass ( Aws::String &&  value)
inline

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 248 of file UpdateSMBFileShareRequest.h.

◆ WithDefaultStorageClass() [2/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithDefaultStorageClass ( const Aws::String value)
inline

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 239 of file UpdateSMBFileShareRequest.h.

◆ WithDefaultStorageClass() [3/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithDefaultStorageClass ( const char *  value)
inline

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 257 of file UpdateSMBFileShareRequest.h.

◆ WithFileShareARN() [1/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithFileShareARN ( Aws::String &&  value)
inline

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

Definition at line 84 of file UpdateSMBFileShareRequest.h.

◆ WithFileShareARN() [2/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithFileShareARN ( const Aws::String value)
inline

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

Definition at line 78 of file UpdateSMBFileShareRequest.h.

◆ WithFileShareARN() [3/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithFileShareARN ( const char *  value)
inline

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

Definition at line 90 of file UpdateSMBFileShareRequest.h.

◆ WithFileShareName() [1/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithFileShareName ( Aws::String &&  value)
inline

The name of the file share. Optional.

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

Definition at line 875 of file UpdateSMBFileShareRequest.h.

◆ WithFileShareName() [2/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithFileShareName ( const Aws::String value)
inline

The name of the file share. Optional.

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

Definition at line 868 of file UpdateSMBFileShareRequest.h.

◆ WithFileShareName() [3/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithFileShareName ( const char *  value)
inline

The name of the file share. Optional.

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

Definition at line 882 of file UpdateSMBFileShareRequest.h.

◆ WithGuessMIMETypeEnabled()

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithGuessMIMETypeEnabled ( bool  value)
inline

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

Definition at line 370 of file UpdateSMBFileShareRequest.h.

◆ WithInvalidUserList() [1/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithInvalidUserList ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 708 of file UpdateSMBFileShareRequest.h.

◆ WithInvalidUserList() [2/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithInvalidUserList ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 699 of file UpdateSMBFileShareRequest.h.

◆ WithKMSEncrypted()

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithKMSEncrypted ( bool  value)
inline

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

Definition at line 119 of file UpdateSMBFileShareRequest.h.

◆ WithKMSKey() [1/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithKMSKey ( Aws::String &&  value)
inline

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.

Definition at line 176 of file UpdateSMBFileShareRequest.h.

◆ WithKMSKey() [2/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithKMSKey ( const Aws::String value)
inline

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.

Definition at line 168 of file UpdateSMBFileShareRequest.h.

◆ WithKMSKey() [3/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithKMSKey ( const char *  value)
inline

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.

Definition at line 184 of file UpdateSMBFileShareRequest.h.

◆ WithNotificationPolicy() [1/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithNotificationPolicy ( Aws::String &&  value)
inline

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.

{}

Definition at line 1026 of file UpdateSMBFileShareRequest.h.

◆ WithNotificationPolicy() [2/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithNotificationPolicy ( const Aws::String value)
inline

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.

{}

Definition at line 1010 of file UpdateSMBFileShareRequest.h.

◆ WithNotificationPolicy() [3/3]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithNotificationPolicy ( const char *  value)
inline

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.

{}

Definition at line 1042 of file UpdateSMBFileShareRequest.h.

◆ WithObjectACL() [1/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithObjectACL ( const ObjectACL value)
inline

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

Definition at line 293 of file UpdateSMBFileShareRequest.h.

◆ WithObjectACL() [2/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithObjectACL ( ObjectACL &&  value)
inline

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

Definition at line 300 of file UpdateSMBFileShareRequest.h.

◆ WithOplocksEnabled()

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithOplocksEnabled ( bool  value)
inline

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

Definition at line 1079 of file UpdateSMBFileShareRequest.h.

◆ WithReadOnly()

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithReadOnly ( bool  value)
inline

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

Definition at line 333 of file UpdateSMBFileShareRequest.h.

◆ WithRequesterPays()

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithRequesterPays ( bool  value)
inline

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

Definition at line 419 of file UpdateSMBFileShareRequest.h.

◆ WithSMBACLEnabled()

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithSMBACLEnabled ( bool  value)
inline

Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.

For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

Valid Values: true | false

Definition at line 464 of file UpdateSMBFileShareRequest.h.

◆ WithValidUserList() [1/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithValidUserList ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 626 of file UpdateSMBFileShareRequest.h.

◆ WithValidUserList() [2/2]

UpdateSMBFileShareRequest& Aws::StorageGateway::Model::UpdateSMBFileShareRequest::WithValidUserList ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 617 of file UpdateSMBFileShareRequest.h.


The documentation for this class was generated from the following file: