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

#include <CreateSMBFileShareRequest.h>

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

Public Member Functions

 CreateSMBFileShareRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateSMBFileShareRequestWithClientToken (const Aws::String &value)
 
CreateSMBFileShareRequestWithClientToken (Aws::String &&value)
 
CreateSMBFileShareRequestWithClientToken (const char *value)
 
const Aws::StringGetGatewayARN () const
 
bool GatewayARNHasBeenSet () const
 
void SetGatewayARN (const Aws::String &value)
 
void SetGatewayARN (Aws::String &&value)
 
void SetGatewayARN (const char *value)
 
CreateSMBFileShareRequestWithGatewayARN (const Aws::String &value)
 
CreateSMBFileShareRequestWithGatewayARN (Aws::String &&value)
 
CreateSMBFileShareRequestWithGatewayARN (const char *value)
 
bool GetKMSEncrypted () const
 
bool KMSEncryptedHasBeenSet () const
 
void SetKMSEncrypted (bool value)
 
CreateSMBFileShareRequestWithKMSEncrypted (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)
 
CreateSMBFileShareRequestWithKMSKey (const Aws::String &value)
 
CreateSMBFileShareRequestWithKMSKey (Aws::String &&value)
 
CreateSMBFileShareRequestWithKMSKey (const char *value)
 
const Aws::StringGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const Aws::String &value)
 
void SetRole (Aws::String &&value)
 
void SetRole (const char *value)
 
CreateSMBFileShareRequestWithRole (const Aws::String &value)
 
CreateSMBFileShareRequestWithRole (Aws::String &&value)
 
CreateSMBFileShareRequestWithRole (const char *value)
 
const Aws::StringGetLocationARN () const
 
bool LocationARNHasBeenSet () const
 
void SetLocationARN (const Aws::String &value)
 
void SetLocationARN (Aws::String &&value)
 
void SetLocationARN (const char *value)
 
CreateSMBFileShareRequestWithLocationARN (const Aws::String &value)
 
CreateSMBFileShareRequestWithLocationARN (Aws::String &&value)
 
CreateSMBFileShareRequestWithLocationARN (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)
 
CreateSMBFileShareRequestWithDefaultStorageClass (const Aws::String &value)
 
CreateSMBFileShareRequestWithDefaultStorageClass (Aws::String &&value)
 
CreateSMBFileShareRequestWithDefaultStorageClass (const char *value)
 
const ObjectACLGetObjectACL () const
 
bool ObjectACLHasBeenSet () const
 
void SetObjectACL (const ObjectACL &value)
 
void SetObjectACL (ObjectACL &&value)
 
CreateSMBFileShareRequestWithObjectACL (const ObjectACL &value)
 
CreateSMBFileShareRequestWithObjectACL (ObjectACL &&value)
 
bool GetReadOnly () const
 
bool ReadOnlyHasBeenSet () const
 
void SetReadOnly (bool value)
 
CreateSMBFileShareRequestWithReadOnly (bool value)
 
bool GetGuessMIMETypeEnabled () const
 
bool GuessMIMETypeEnabledHasBeenSet () const
 
void SetGuessMIMETypeEnabled (bool value)
 
CreateSMBFileShareRequestWithGuessMIMETypeEnabled (bool value)
 
bool GetRequesterPays () const
 
bool RequesterPaysHasBeenSet () const
 
void SetRequesterPays (bool value)
 
CreateSMBFileShareRequestWithRequesterPays (bool value)
 
bool GetSMBACLEnabled () const
 
bool SMBACLEnabledHasBeenSet () const
 
void SetSMBACLEnabled (bool value)
 
CreateSMBFileShareRequestWithSMBACLEnabled (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)
 
CreateSMBFileShareRequestWithAdminUserList (const Aws::Vector< Aws::String > &value)
 
CreateSMBFileShareRequestWithAdminUserList (Aws::Vector< Aws::String > &&value)
 
CreateSMBFileShareRequestAddAdminUserList (const Aws::String &value)
 
CreateSMBFileShareRequestAddAdminUserList (Aws::String &&value)
 
CreateSMBFileShareRequestAddAdminUserList (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)
 
CreateSMBFileShareRequestWithValidUserList (const Aws::Vector< Aws::String > &value)
 
CreateSMBFileShareRequestWithValidUserList (Aws::Vector< Aws::String > &&value)
 
CreateSMBFileShareRequestAddValidUserList (const Aws::String &value)
 
CreateSMBFileShareRequestAddValidUserList (Aws::String &&value)
 
CreateSMBFileShareRequestAddValidUserList (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)
 
CreateSMBFileShareRequestWithInvalidUserList (const Aws::Vector< Aws::String > &value)
 
CreateSMBFileShareRequestWithInvalidUserList (Aws::Vector< Aws::String > &&value)
 
CreateSMBFileShareRequestAddInvalidUserList (const Aws::String &value)
 
CreateSMBFileShareRequestAddInvalidUserList (Aws::String &&value)
 
CreateSMBFileShareRequestAddInvalidUserList (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)
 
CreateSMBFileShareRequestWithAuditDestinationARN (const Aws::String &value)
 
CreateSMBFileShareRequestWithAuditDestinationARN (Aws::String &&value)
 
CreateSMBFileShareRequestWithAuditDestinationARN (const char *value)
 
const Aws::StringGetAuthentication () const
 
bool AuthenticationHasBeenSet () const
 
void SetAuthentication (const Aws::String &value)
 
void SetAuthentication (Aws::String &&value)
 
void SetAuthentication (const char *value)
 
CreateSMBFileShareRequestWithAuthentication (const Aws::String &value)
 
CreateSMBFileShareRequestWithAuthentication (Aws::String &&value)
 
CreateSMBFileShareRequestWithAuthentication (const char *value)
 
const CaseSensitivityGetCaseSensitivity () const
 
bool CaseSensitivityHasBeenSet () const
 
void SetCaseSensitivity (const CaseSensitivity &value)
 
void SetCaseSensitivity (CaseSensitivity &&value)
 
CreateSMBFileShareRequestWithCaseSensitivity (const CaseSensitivity &value)
 
CreateSMBFileShareRequestWithCaseSensitivity (CaseSensitivity &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateSMBFileShareRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateSMBFileShareRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateSMBFileShareRequestAddTags (const Tag &value)
 
CreateSMBFileShareRequestAddTags (Tag &&value)
 
const Aws::StringGetFileShareName () const
 
bool FileShareNameHasBeenSet () const
 
void SetFileShareName (const Aws::String &value)
 
void SetFileShareName (Aws::String &&value)
 
void SetFileShareName (const char *value)
 
CreateSMBFileShareRequestWithFileShareName (const Aws::String &value)
 
CreateSMBFileShareRequestWithFileShareName (Aws::String &&value)
 
CreateSMBFileShareRequestWithFileShareName (const char *value)
 
const CacheAttributesGetCacheAttributes () const
 
bool CacheAttributesHasBeenSet () const
 
void SetCacheAttributes (const CacheAttributes &value)
 
void SetCacheAttributes (CacheAttributes &&value)
 
CreateSMBFileShareRequestWithCacheAttributes (const CacheAttributes &value)
 
CreateSMBFileShareRequestWithCacheAttributes (CacheAttributes &&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

CreateSMBFileShareInput

See Also:

AWS API Reference

Definition at line 29 of file CreateSMBFileShareRequest.h.

Constructor & Destructor Documentation

◆ CreateSMBFileShareRequest()

Aws::StorageGateway::Model::CreateSMBFileShareRequest::CreateSMBFileShareRequest ( )

Member Function Documentation

◆ AddAdminUserList() [1/3]

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

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN, user1, , and .

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

Definition at line 682 of file CreateSMBFileShareRequest.h.

◆ AddAdminUserList() [2/3]

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

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN, user1, , and .

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

Definition at line 693 of file CreateSMBFileShareRequest.h.

◆ AddAdminUserList() [3/3]

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

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN, user1, , and .

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

Definition at line 704 of file CreateSMBFileShareRequest.h.

◆ AddInvalidUserList() [1/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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, , and . Can only be set if Authentication is set to ActiveDirectory.

Definition at line 850 of file CreateSMBFileShareRequest.h.

◆ AddInvalidUserList() [2/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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, , and . Can only be set if Authentication is set to ActiveDirectory.

Definition at line 859 of file CreateSMBFileShareRequest.h.

◆ AddInvalidUserList() [3/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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, , and . Can only be set if Authentication is set to ActiveDirectory.

Definition at line 868 of file CreateSMBFileShareRequest.h.

◆ AddTags() [1/2]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::AddTags ( const Tag value)
inline

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 1079 of file CreateSMBFileShareRequest.h.

◆ AddTags() [2/2]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::AddTags ( Tag &&  value)
inline

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 1088 of file CreateSMBFileShareRequest.h.

◆ AddValidUserList() [1/3]

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

◆ AddValidUserList() [2/3]

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

◆ AddValidUserList() [3/3]

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

◆ AdminUserListHasBeenSet()

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

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN, user1, , and .

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

Definition at line 627 of file CreateSMBFileShareRequest.h.

◆ AuditDestinationARNHasBeenSet()

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

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

Definition at line 879 of file CreateSMBFileShareRequest.h.

◆ AuthenticationHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::AuthenticationHasBeenSet ( ) const
inline

The authentication method that users use to access the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

Definition at line 924 of file CreateSMBFileShareRequest.h.

◆ CacheAttributesHasBeenSet()

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

Refresh cache information.

Definition at line 1156 of file CreateSMBFileShareRequest.h.

◆ CaseSensitivityHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 983 of file CreateSMBFileShareRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::ClientTokenHasBeenSet ( ) const
inline

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Definition at line 55 of file CreateSMBFileShareRequest.h.

◆ DefaultStorageClassHasBeenSet()

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

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

Definition at line 343 of file CreateSMBFileShareRequest.h.

◆ FileShareNameHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 1103 of file CreateSMBFileShareRequest.h.

◆ GatewayARNHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::GatewayARNHasBeenSet ( ) const
inline

The ARN of the file gateway on which you want to create a file share.

Definition at line 102 of file CreateSMBFileShareRequest.h.

◆ GetAdminUserList()

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

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN, user1, , and .

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

Definition at line 616 of file CreateSMBFileShareRequest.h.

◆ GetAuditDestinationARN()

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

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

Definition at line 874 of file CreateSMBFileShareRequest.h.

◆ GetAuthentication()

const Aws::String& Aws::StorageGateway::Model::CreateSMBFileShareRequest::GetAuthentication ( ) const
inline

The authentication method that users use to access the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

Definition at line 917 of file CreateSMBFileShareRequest.h.

◆ GetCacheAttributes()

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

Refresh cache information.

Definition at line 1151 of file CreateSMBFileShareRequest.h.

◆ GetCaseSensitivity()

const CaseSensitivity& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 975 of file CreateSMBFileShareRequest.h.

◆ GetClientToken()

const Aws::String& Aws::StorageGateway::Model::CreateSMBFileShareRequest::GetClientToken ( ) const
inline

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Definition at line 49 of file CreateSMBFileShareRequest.h.

◆ GetDefaultStorageClass()

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

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

Definition at line 334 of file CreateSMBFileShareRequest.h.

◆ GetFileShareName()

const Aws::String& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 1096 of file CreateSMBFileShareRequest.h.

◆ GetGatewayARN()

const Aws::String& Aws::StorageGateway::Model::CreateSMBFileShareRequest::GetGatewayARN ( ) const
inline

The ARN of the file gateway on which you want to create a file share.

Definition at line 97 of file CreateSMBFileShareRequest.h.

◆ GetGuessMIMETypeEnabled()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 483 of file CreateSMBFileShareRequest.h.

◆ GetInvalidUserList()

const Aws::Vector<Aws::String>& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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, , and . Can only be set if Authentication is set to ActiveDirectory.

Definition at line 796 of file CreateSMBFileShareRequest.h.

◆ GetKMSEncrypted()

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

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

Definition at line 140 of file CreateSMBFileShareRequest.h.

◆ GetKMSKey()

const Aws::String& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 170 of file CreateSMBFileShareRequest.h.

◆ GetLocationARN()

const Aws::String& Aws::StorageGateway::Model::CreateSMBFileShareRequest::GetLocationARN ( ) const
inline

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

Definition at line 282 of file CreateSMBFileShareRequest.h.

◆ GetObjectACL()

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

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.

Definition at line 405 of file CreateSMBFileShareRequest.h.

◆ GetReadOnly()

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

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

Valid Values: true | false

Definition at line 449 of file CreateSMBFileShareRequest.h.

◆ GetRequesterPays()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 523 of file CreateSMBFileShareRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetRole()

const Aws::String& Aws::StorageGateway::Model::CreateSMBFileShareRequest::GetRole ( ) const
inline

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Definition at line 233 of file CreateSMBFileShareRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file CreateSMBFileShareRequest.h.

◆ GetSMBACLEnabled()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 AWS Storage Gateway User Guide.

Valid Values: true | false

Definition at line 571 of file CreateSMBFileShareRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::StorageGateway::Model::CreateSMBFileShareRequest::GetTags ( ) const
inline

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 1025 of file CreateSMBFileShareRequest.h.

◆ GetValidUserList()

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

◆ GuessMIMETypeEnabledHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 492 of file CreateSMBFileShareRequest.h.

◆ InvalidUserListHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::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, , and . Can only be set if Authentication is set to ActiveDirectory.

Definition at line 805 of file CreateSMBFileShareRequest.h.

◆ KMSEncryptedHasBeenSet()

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

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

Definition at line 147 of file CreateSMBFileShareRequest.h.

◆ KMSKeyHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 178 of file CreateSMBFileShareRequest.h.

◆ LocationARNHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::LocationARNHasBeenSet ( ) const
inline

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

Definition at line 288 of file CreateSMBFileShareRequest.h.

◆ ObjectACLHasBeenSet()

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

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.

Definition at line 412 of file CreateSMBFileShareRequest.h.

◆ ReadOnlyHasBeenSet()

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

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

Valid Values: true | false

Definition at line 457 of file CreateSMBFileShareRequest.h.

◆ RequesterPaysHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 535 of file CreateSMBFileShareRequest.h.

◆ RoleHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::RoleHasBeenSet ( ) const
inline

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Definition at line 239 of file CreateSMBFileShareRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAdminUserList() [1/2]

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

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN, user1, , and .

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

Definition at line 638 of file CreateSMBFileShareRequest.h.

◆ SetAdminUserList() [2/2]

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

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN, user1, , and .

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

Definition at line 649 of file CreateSMBFileShareRequest.h.

◆ SetAuditDestinationARN() [1/3]

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

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

Definition at line 884 of file CreateSMBFileShareRequest.h.

◆ SetAuditDestinationARN() [2/3]

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

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

Definition at line 889 of file CreateSMBFileShareRequest.h.

◆ SetAuditDestinationARN() [3/3]

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

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

Definition at line 894 of file CreateSMBFileShareRequest.h.

◆ SetAuthentication() [1/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetAuthentication ( const Aws::String value)
inline

The authentication method that users use to access the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

Definition at line 931 of file CreateSMBFileShareRequest.h.

◆ SetAuthentication() [2/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetAuthentication ( Aws::String &&  value)
inline

The authentication method that users use to access the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

Definition at line 938 of file CreateSMBFileShareRequest.h.

◆ SetAuthentication() [3/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetAuthentication ( const char *  value)
inline

The authentication method that users use to access the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

Definition at line 945 of file CreateSMBFileShareRequest.h.

◆ SetCacheAttributes() [1/2]

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

Refresh cache information.

Definition at line 1161 of file CreateSMBFileShareRequest.h.

◆ SetCacheAttributes() [2/2]

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

Refresh cache information.

Definition at line 1166 of file CreateSMBFileShareRequest.h.

◆ SetCaseSensitivity() [1/2]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 991 of file CreateSMBFileShareRequest.h.

◆ SetCaseSensitivity() [2/2]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 999 of file CreateSMBFileShareRequest.h.

◆ SetClientToken() [1/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetClientToken ( const Aws::String value)
inline

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Definition at line 61 of file CreateSMBFileShareRequest.h.

◆ SetClientToken() [2/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetClientToken ( Aws::String &&  value)
inline

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Definition at line 67 of file CreateSMBFileShareRequest.h.

◆ SetClientToken() [3/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetClientToken ( const char *  value)
inline

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Definition at line 73 of file CreateSMBFileShareRequest.h.

◆ SetDefaultStorageClass() [1/3]

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

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

Definition at line 352 of file CreateSMBFileShareRequest.h.

◆ SetDefaultStorageClass() [2/3]

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

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

Definition at line 361 of file CreateSMBFileShareRequest.h.

◆ SetDefaultStorageClass() [3/3]

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

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

Definition at line 370 of file CreateSMBFileShareRequest.h.

◆ SetFileShareName() [1/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 1110 of file CreateSMBFileShareRequest.h.

◆ SetFileShareName() [2/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 1117 of file CreateSMBFileShareRequest.h.

◆ SetFileShareName() [3/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 1124 of file CreateSMBFileShareRequest.h.

◆ SetGatewayARN() [1/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetGatewayARN ( const Aws::String value)
inline

The ARN of the file gateway on which you want to create a file share.

Definition at line 107 of file CreateSMBFileShareRequest.h.

◆ SetGatewayARN() [2/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetGatewayARN ( Aws::String &&  value)
inline

The ARN of the file gateway on which you want to create a file share.

Definition at line 112 of file CreateSMBFileShareRequest.h.

◆ SetGatewayARN() [3/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetGatewayARN ( const char *  value)
inline

The ARN of the file gateway on which you want to create a file share.

Definition at line 117 of file CreateSMBFileShareRequest.h.

◆ SetGuessMIMETypeEnabled()

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 501 of file CreateSMBFileShareRequest.h.

◆ SetInvalidUserList() [1/2]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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, , and . Can only be set if Authentication is set to ActiveDirectory.

Definition at line 814 of file CreateSMBFileShareRequest.h.

◆ SetInvalidUserList() [2/2]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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, , and . Can only be set if Authentication is set to ActiveDirectory.

Definition at line 823 of file CreateSMBFileShareRequest.h.

◆ SetKMSEncrypted()

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

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

Definition at line 154 of file CreateSMBFileShareRequest.h.

◆ SetKMSKey() [1/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 186 of file CreateSMBFileShareRequest.h.

◆ SetKMSKey() [2/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 194 of file CreateSMBFileShareRequest.h.

◆ SetKMSKey() [3/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 202 of file CreateSMBFileShareRequest.h.

◆ SetLocationARN() [1/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetLocationARN ( const Aws::String value)
inline

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

Definition at line 294 of file CreateSMBFileShareRequest.h.

◆ SetLocationARN() [2/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetLocationARN ( Aws::String &&  value)
inline

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

Definition at line 300 of file CreateSMBFileShareRequest.h.

◆ SetLocationARN() [3/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetLocationARN ( const char *  value)
inline

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

Definition at line 306 of file CreateSMBFileShareRequest.h.

◆ SetObjectACL() [1/2]

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

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.

Definition at line 419 of file CreateSMBFileShareRequest.h.

◆ SetObjectACL() [2/2]

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

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.

Definition at line 426 of file CreateSMBFileShareRequest.h.

◆ SetReadOnly()

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

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

Valid Values: true | false

Definition at line 465 of file CreateSMBFileShareRequest.h.

◆ SetRequesterPays()

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 547 of file CreateSMBFileShareRequest.h.

◆ SetRole() [1/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetRole ( const Aws::String value)
inline

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Definition at line 245 of file CreateSMBFileShareRequest.h.

◆ SetRole() [2/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetRole ( Aws::String &&  value)
inline

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Definition at line 251 of file CreateSMBFileShareRequest.h.

◆ SetRole() [3/3]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetRole ( const char *  value)
inline

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Definition at line 257 of file CreateSMBFileShareRequest.h.

◆ SetSMBACLEnabled()

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 AWS Storage Gateway User Guide.

Valid Values: true | false

Definition at line 593 of file CreateSMBFileShareRequest.h.

◆ SetTags() [1/2]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 1043 of file CreateSMBFileShareRequest.h.

◆ SetTags() [2/2]

void Aws::StorageGateway::Model::CreateSMBFileShareRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 1052 of file CreateSMBFileShareRequest.h.

◆ SetValidUserList() [1/2]

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

◆ SetValidUserList() [2/2]

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

◆ SMBACLEnabledHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 AWS Storage Gateway User Guide.

Valid Values: true | false

Definition at line 582 of file CreateSMBFileShareRequest.h.

◆ TagsHasBeenSet()

bool Aws::StorageGateway::Model::CreateSMBFileShareRequest::TagsHasBeenSet ( ) const
inline

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 1034 of file CreateSMBFileShareRequest.h.

◆ ValidUserListHasBeenSet()

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

◆ WithAdminUserList() [1/2]

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

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN, user1, , and .

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

Definition at line 660 of file CreateSMBFileShareRequest.h.

◆ WithAdminUserList() [2/2]

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

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN, user1, , and .

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

Definition at line 671 of file CreateSMBFileShareRequest.h.

◆ WithAuditDestinationARN() [1/3]

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

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

Definition at line 899 of file CreateSMBFileShareRequest.h.

◆ WithAuditDestinationARN() [2/3]

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

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

Definition at line 904 of file CreateSMBFileShareRequest.h.

◆ WithAuditDestinationARN() [3/3]

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

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

Definition at line 909 of file CreateSMBFileShareRequest.h.

◆ WithAuthentication() [1/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithAuthentication ( const Aws::String value)
inline

The authentication method that users use to access the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

Definition at line 952 of file CreateSMBFileShareRequest.h.

◆ WithAuthentication() [2/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithAuthentication ( Aws::String &&  value)
inline

The authentication method that users use to access the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

Definition at line 959 of file CreateSMBFileShareRequest.h.

◆ WithAuthentication() [3/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithAuthentication ( const char *  value)
inline

The authentication method that users use to access the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

Definition at line 966 of file CreateSMBFileShareRequest.h.

◆ WithCacheAttributes() [1/2]

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

Refresh cache information.

Definition at line 1171 of file CreateSMBFileShareRequest.h.

◆ WithCacheAttributes() [2/2]

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

Refresh cache information.

Definition at line 1176 of file CreateSMBFileShareRequest.h.

◆ WithCaseSensitivity() [1/2]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 1007 of file CreateSMBFileShareRequest.h.

◆ WithCaseSensitivity() [2/2]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 1015 of file CreateSMBFileShareRequest.h.

◆ WithClientToken() [1/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithClientToken ( const Aws::String value)
inline

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Definition at line 79 of file CreateSMBFileShareRequest.h.

◆ WithClientToken() [2/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithClientToken ( Aws::String &&  value)
inline

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Definition at line 85 of file CreateSMBFileShareRequest.h.

◆ WithClientToken() [3/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithClientToken ( const char *  value)
inline

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

Definition at line 91 of file CreateSMBFileShareRequest.h.

◆ WithDefaultStorageClass() [1/3]

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

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

Definition at line 379 of file CreateSMBFileShareRequest.h.

◆ WithDefaultStorageClass() [2/3]

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

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

Definition at line 388 of file CreateSMBFileShareRequest.h.

◆ WithDefaultStorageClass() [3/3]

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

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

Definition at line 397 of file CreateSMBFileShareRequest.h.

◆ WithFileShareName() [1/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 1131 of file CreateSMBFileShareRequest.h.

◆ WithFileShareName() [2/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 1138 of file CreateSMBFileShareRequest.h.

◆ WithFileShareName() [3/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 1145 of file CreateSMBFileShareRequest.h.

◆ WithGatewayARN() [1/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithGatewayARN ( const Aws::String value)
inline

The ARN of the file gateway on which you want to create a file share.

Definition at line 122 of file CreateSMBFileShareRequest.h.

◆ WithGatewayARN() [2/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithGatewayARN ( Aws::String &&  value)
inline

The ARN of the file gateway on which you want to create a file share.

Definition at line 127 of file CreateSMBFileShareRequest.h.

◆ WithGatewayARN() [3/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithGatewayARN ( const char *  value)
inline

The ARN of the file gateway on which you want to create a file share.

Definition at line 132 of file CreateSMBFileShareRequest.h.

◆ WithGuessMIMETypeEnabled()

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 510 of file CreateSMBFileShareRequest.h.

◆ WithInvalidUserList() [1/2]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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, , and . Can only be set if Authentication is set to ActiveDirectory.

Definition at line 832 of file CreateSMBFileShareRequest.h.

◆ WithInvalidUserList() [2/2]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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, , and . Can only be set if Authentication is set to ActiveDirectory.

Definition at line 841 of file CreateSMBFileShareRequest.h.

◆ WithKMSEncrypted()

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

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

Definition at line 161 of file CreateSMBFileShareRequest.h.

◆ WithKMSKey() [1/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 210 of file CreateSMBFileShareRequest.h.

◆ WithKMSKey() [2/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 218 of file CreateSMBFileShareRequest.h.

◆ WithKMSKey() [3/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 226 of file CreateSMBFileShareRequest.h.

◆ WithLocationARN() [1/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithLocationARN ( const Aws::String value)
inline

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

Definition at line 312 of file CreateSMBFileShareRequest.h.

◆ WithLocationARN() [2/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithLocationARN ( Aws::String &&  value)
inline

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

Definition at line 318 of file CreateSMBFileShareRequest.h.

◆ WithLocationARN() [3/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithLocationARN ( const char *  value)
inline

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

Definition at line 324 of file CreateSMBFileShareRequest.h.

◆ WithObjectACL() [1/2]

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

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.

Definition at line 433 of file CreateSMBFileShareRequest.h.

◆ WithObjectACL() [2/2]

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

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.

Definition at line 440 of file CreateSMBFileShareRequest.h.

◆ WithReadOnly()

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

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

Valid Values: true | false

Definition at line 473 of file CreateSMBFileShareRequest.h.

◆ WithRequesterPays()

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 559 of file CreateSMBFileShareRequest.h.

◆ WithRole() [1/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithRole ( const Aws::String value)
inline

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Definition at line 263 of file CreateSMBFileShareRequest.h.

◆ WithRole() [2/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithRole ( Aws::String &&  value)
inline

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Definition at line 269 of file CreateSMBFileShareRequest.h.

◆ WithRole() [3/3]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithRole ( const char *  value)
inline

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Definition at line 275 of file CreateSMBFileShareRequest.h.

◆ WithSMBACLEnabled()

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::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 AWS Storage Gateway User Guide.

Valid Values: true | false

Definition at line 604 of file CreateSMBFileShareRequest.h.

◆ WithTags() [1/2]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 1061 of file CreateSMBFileShareRequest.h.

◆ WithTags() [2/2]

CreateSMBFileShareRequest& Aws::StorageGateway::Model::CreateSMBFileShareRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

Definition at line 1070 of file CreateSMBFileShareRequest.h.

◆ WithValidUserList() [1/2]

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

◆ WithValidUserList() [2/2]

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

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