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

#include <CreateNFSFileShareRequest.h>

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

Public Member Functions

 CreateNFSFileShareRequest ()
 
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)
 
CreateNFSFileShareRequestWithClientToken (const Aws::String &value)
 
CreateNFSFileShareRequestWithClientToken (Aws::String &&value)
 
CreateNFSFileShareRequestWithClientToken (const char *value)
 
const NFSFileShareDefaultsGetNFSFileShareDefaults () const
 
bool NFSFileShareDefaultsHasBeenSet () const
 
void SetNFSFileShareDefaults (const NFSFileShareDefaults &value)
 
void SetNFSFileShareDefaults (NFSFileShareDefaults &&value)
 
CreateNFSFileShareRequestWithNFSFileShareDefaults (const NFSFileShareDefaults &value)
 
CreateNFSFileShareRequestWithNFSFileShareDefaults (NFSFileShareDefaults &&value)
 
const Aws::StringGetGatewayARN () const
 
bool GatewayARNHasBeenSet () const
 
void SetGatewayARN (const Aws::String &value)
 
void SetGatewayARN (Aws::String &&value)
 
void SetGatewayARN (const char *value)
 
CreateNFSFileShareRequestWithGatewayARN (const Aws::String &value)
 
CreateNFSFileShareRequestWithGatewayARN (Aws::String &&value)
 
CreateNFSFileShareRequestWithGatewayARN (const char *value)
 
bool GetKMSEncrypted () const
 
bool KMSEncryptedHasBeenSet () const
 
void SetKMSEncrypted (bool value)
 
CreateNFSFileShareRequestWithKMSEncrypted (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)
 
CreateNFSFileShareRequestWithKMSKey (const Aws::String &value)
 
CreateNFSFileShareRequestWithKMSKey (Aws::String &&value)
 
CreateNFSFileShareRequestWithKMSKey (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)
 
CreateNFSFileShareRequestWithRole (const Aws::String &value)
 
CreateNFSFileShareRequestWithRole (Aws::String &&value)
 
CreateNFSFileShareRequestWithRole (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)
 
CreateNFSFileShareRequestWithLocationARN (const Aws::String &value)
 
CreateNFSFileShareRequestWithLocationARN (Aws::String &&value)
 
CreateNFSFileShareRequestWithLocationARN (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)
 
CreateNFSFileShareRequestWithDefaultStorageClass (const Aws::String &value)
 
CreateNFSFileShareRequestWithDefaultStorageClass (Aws::String &&value)
 
CreateNFSFileShareRequestWithDefaultStorageClass (const char *value)
 
const ObjectACLGetObjectACL () const
 
bool ObjectACLHasBeenSet () const
 
void SetObjectACL (const ObjectACL &value)
 
void SetObjectACL (ObjectACL &&value)
 
CreateNFSFileShareRequestWithObjectACL (const ObjectACL &value)
 
CreateNFSFileShareRequestWithObjectACL (ObjectACL &&value)
 
const Aws::Vector< Aws::String > & GetClientList () const
 
bool ClientListHasBeenSet () const
 
void SetClientList (const Aws::Vector< Aws::String > &value)
 
void SetClientList (Aws::Vector< Aws::String > &&value)
 
CreateNFSFileShareRequestWithClientList (const Aws::Vector< Aws::String > &value)
 
CreateNFSFileShareRequestWithClientList (Aws::Vector< Aws::String > &&value)
 
CreateNFSFileShareRequestAddClientList (const Aws::String &value)
 
CreateNFSFileShareRequestAddClientList (Aws::String &&value)
 
CreateNFSFileShareRequestAddClientList (const char *value)
 
const Aws::StringGetSquash () const
 
bool SquashHasBeenSet () const
 
void SetSquash (const Aws::String &value)
 
void SetSquash (Aws::String &&value)
 
void SetSquash (const char *value)
 
CreateNFSFileShareRequestWithSquash (const Aws::String &value)
 
CreateNFSFileShareRequestWithSquash (Aws::String &&value)
 
CreateNFSFileShareRequestWithSquash (const char *value)
 
bool GetReadOnly () const
 
bool ReadOnlyHasBeenSet () const
 
void SetReadOnly (bool value)
 
CreateNFSFileShareRequestWithReadOnly (bool value)
 
bool GetGuessMIMETypeEnabled () const
 
bool GuessMIMETypeEnabledHasBeenSet () const
 
void SetGuessMIMETypeEnabled (bool value)
 
CreateNFSFileShareRequestWithGuessMIMETypeEnabled (bool value)
 
bool GetRequesterPays () const
 
bool RequesterPaysHasBeenSet () const
 
void SetRequesterPays (bool value)
 
CreateNFSFileShareRequestWithRequesterPays (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateNFSFileShareRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateNFSFileShareRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateNFSFileShareRequestAddTags (const Tag &value)
 
CreateNFSFileShareRequestAddTags (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)
 
CreateNFSFileShareRequestWithFileShareName (const Aws::String &value)
 
CreateNFSFileShareRequestWithFileShareName (Aws::String &&value)
 
CreateNFSFileShareRequestWithFileShareName (const char *value)
 
const CacheAttributesGetCacheAttributes () const
 
bool CacheAttributesHasBeenSet () const
 
void SetCacheAttributes (const CacheAttributes &value)
 
void SetCacheAttributes (CacheAttributes &&value)
 
CreateNFSFileShareRequestWithCacheAttributes (const CacheAttributes &value)
 
CreateNFSFileShareRequestWithCacheAttributes (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

CreateNFSFileShareInput

See Also:

AWS API Reference

Definition at line 29 of file CreateNFSFileShareRequest.h.

Constructor & Destructor Documentation

◆ CreateNFSFileShareRequest()

Aws::StorageGateway::Model::CreateNFSFileShareRequest::CreateNFSFileShareRequest ( )

Member Function Documentation

◆ AddClientList() [1/3]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::AddClientList ( const Aws::String value)
inline

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Definition at line 522 of file CreateNFSFileShareRequest.h.

◆ AddClientList() [2/3]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::AddClientList ( Aws::String &&  value)
inline

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Definition at line 528 of file CreateNFSFileShareRequest.h.

◆ AddClientList() [3/3]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::AddClientList ( const char *  value)
inline

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Definition at line 534 of file CreateNFSFileShareRequest.h.

◆ AddTags() [1/2]

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

◆ AddTags() [2/2]

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

◆ CacheAttributesHasBeenSet()

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

Refresh cache information.

Definition at line 867 of file CreateNFSFileShareRequest.h.

◆ ClientListHasBeenSet()

bool Aws::StorageGateway::Model::CreateNFSFileShareRequest::ClientListHasBeenSet ( ) const
inline

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Definition at line 492 of file CreateNFSFileShareRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::StorageGateway::Model::CreateNFSFileShareRequest::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 CreateNFSFileShareRequest.h.

◆ DefaultStorageClassHasBeenSet()

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

◆ FileShareNameHasBeenSet()

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

◆ GatewayARNHasBeenSet()

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

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Definition at line 135 of file CreateNFSFileShareRequest.h.

◆ GetCacheAttributes()

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

Refresh cache information.

Definition at line 862 of file CreateNFSFileShareRequest.h.

◆ GetClientList()

const Aws::Vector<Aws::String>& Aws::StorageGateway::Model::CreateNFSFileShareRequest::GetClientList ( ) const
inline

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Definition at line 486 of file CreateNFSFileShareRequest.h.

◆ GetClientToken()

const Aws::String& Aws::StorageGateway::Model::CreateNFSFileShareRequest::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 CreateNFSFileShareRequest.h.

◆ GetDefaultStorageClass()

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

◆ GetFileShareName()

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

◆ GetGatewayARN()

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

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Definition at line 129 of file CreateNFSFileShareRequest.h.

◆ GetGuessMIMETypeEnabled()

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

◆ GetKMSEncrypted()

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

◆ GetKMSKey()

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

◆ GetLocationARN()

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

◆ GetNFSFileShareDefaults()

const NFSFileShareDefaults& Aws::StorageGateway::Model::CreateNFSFileShareRequest::GetNFSFileShareDefaults ( ) const
inline

File share default values. Optional.

Definition at line 97 of file CreateNFSFileShareRequest.h.

◆ GetObjectACL()

const ObjectACL& Aws::StorageGateway::Model::CreateNFSFileShareRequest::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 444 of file CreateNFSFileShareRequest.h.

◆ GetReadOnly()

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

◆ GetRequesterPays()

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

◆ GetRequestSpecificHeaders()

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

◆ GetRole()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file CreateNFSFileShareRequest.h.

◆ GetSquash()

const Aws::String& Aws::StorageGateway::Model::CreateNFSFileShareRequest::GetSquash ( ) const
inline

A value that maps a user to anonymous user.

Valid values are the following:

  • RootSquash: Only root is mapped to anonymous user.

  • NoSquash: No one is mapped to anonymous user.

  • AllSquash: Everyone is mapped to anonymous user.

Definition at line 544 of file CreateNFSFileShareRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::StorageGateway::Model::CreateNFSFileShareRequest::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 736 of file CreateNFSFileShareRequest.h.

◆ GuessMIMETypeEnabledHasBeenSet()

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

◆ KMSEncryptedHasBeenSet()

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

◆ KMSKeyHasBeenSet()

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

◆ LocationARNHasBeenSet()

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

◆ NFSFileShareDefaultsHasBeenSet()

bool Aws::StorageGateway::Model::CreateNFSFileShareRequest::NFSFileShareDefaultsHasBeenSet ( ) const
inline

File share default values. Optional.

Definition at line 102 of file CreateNFSFileShareRequest.h.

◆ ObjectACLHasBeenSet()

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

◆ ReadOnlyHasBeenSet()

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

◆ RequesterPaysHasBeenSet()

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

◆ RoleHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCacheAttributes() [1/2]

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

Refresh cache information.

Definition at line 872 of file CreateNFSFileShareRequest.h.

◆ SetCacheAttributes() [2/2]

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

Refresh cache information.

Definition at line 877 of file CreateNFSFileShareRequest.h.

◆ SetClientList() [1/2]

void Aws::StorageGateway::Model::CreateNFSFileShareRequest::SetClientList ( const Aws::Vector< Aws::String > &  value)
inline

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Definition at line 498 of file CreateNFSFileShareRequest.h.

◆ SetClientList() [2/2]

void Aws::StorageGateway::Model::CreateNFSFileShareRequest::SetClientList ( Aws::Vector< Aws::String > &&  value)
inline

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Definition at line 504 of file CreateNFSFileShareRequest.h.

◆ SetClientToken() [1/3]

void Aws::StorageGateway::Model::CreateNFSFileShareRequest::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 CreateNFSFileShareRequest.h.

◆ SetClientToken() [2/3]

void Aws::StorageGateway::Model::CreateNFSFileShareRequest::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 CreateNFSFileShareRequest.h.

◆ SetClientToken() [3/3]

void Aws::StorageGateway::Model::CreateNFSFileShareRequest::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 CreateNFSFileShareRequest.h.

◆ SetDefaultStorageClass() [1/3]

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

◆ SetDefaultStorageClass() [2/3]

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

◆ SetDefaultStorageClass() [3/3]

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

◆ SetFileShareName() [1/3]

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

◆ SetFileShareName() [2/3]

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

◆ SetFileShareName() [3/3]

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

◆ SetGatewayARN() [1/3]

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

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Definition at line 141 of file CreateNFSFileShareRequest.h.

◆ SetGatewayARN() [2/3]

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

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Definition at line 147 of file CreateNFSFileShareRequest.h.

◆ SetGatewayARN() [3/3]

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

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Definition at line 153 of file CreateNFSFileShareRequest.h.

◆ SetGuessMIMETypeEnabled()

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

◆ SetKMSEncrypted()

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

◆ SetKMSKey() [1/3]

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

◆ SetKMSKey() [2/3]

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

◆ SetKMSKey() [3/3]

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

◆ SetLocationARN() [1/3]

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

◆ SetLocationARN() [2/3]

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

◆ SetLocationARN() [3/3]

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

◆ SetNFSFileShareDefaults() [1/2]

void Aws::StorageGateway::Model::CreateNFSFileShareRequest::SetNFSFileShareDefaults ( const NFSFileShareDefaults value)
inline

File share default values. Optional.

Definition at line 107 of file CreateNFSFileShareRequest.h.

◆ SetNFSFileShareDefaults() [2/2]

void Aws::StorageGateway::Model::CreateNFSFileShareRequest::SetNFSFileShareDefaults ( NFSFileShareDefaults &&  value)
inline

File share default values. Optional.

Definition at line 112 of file CreateNFSFileShareRequest.h.

◆ SetObjectACL() [1/2]

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

◆ SetObjectACL() [2/2]

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

◆ SetReadOnly()

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

◆ SetRequesterPays()

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

◆ SetRole() [1/3]

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

◆ SetRole() [2/3]

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

◆ SetRole() [3/3]

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

◆ SetSquash() [1/3]

void Aws::StorageGateway::Model::CreateNFSFileShareRequest::SetSquash ( const Aws::String value)
inline

A value that maps a user to anonymous user.

Valid values are the following:

  • RootSquash: Only root is mapped to anonymous user.

  • NoSquash: No one is mapped to anonymous user.

  • AllSquash: Everyone is mapped to anonymous user.

Definition at line 562 of file CreateNFSFileShareRequest.h.

◆ SetSquash() [2/3]

void Aws::StorageGateway::Model::CreateNFSFileShareRequest::SetSquash ( Aws::String &&  value)
inline

A value that maps a user to anonymous user.

Valid values are the following:

  • RootSquash: Only root is mapped to anonymous user.

  • NoSquash: No one is mapped to anonymous user.

  • AllSquash: Everyone is mapped to anonymous user.

Definition at line 571 of file CreateNFSFileShareRequest.h.

◆ SetSquash() [3/3]

void Aws::StorageGateway::Model::CreateNFSFileShareRequest::SetSquash ( const char *  value)
inline

A value that maps a user to anonymous user.

Valid values are the following:

  • RootSquash: Only root is mapped to anonymous user.

  • NoSquash: No one is mapped to anonymous user.

  • AllSquash: Everyone is mapped to anonymous user.

Definition at line 580 of file CreateNFSFileShareRequest.h.

◆ SetTags() [1/2]

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

◆ SetTags() [2/2]

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

◆ SquashHasBeenSet()

bool Aws::StorageGateway::Model::CreateNFSFileShareRequest::SquashHasBeenSet ( ) const
inline

A value that maps a user to anonymous user.

Valid values are the following:

  • RootSquash: Only root is mapped to anonymous user.

  • NoSquash: No one is mapped to anonymous user.

  • AllSquash: Everyone is mapped to anonymous user.

Definition at line 553 of file CreateNFSFileShareRequest.h.

◆ TagsHasBeenSet()

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

◆ WithCacheAttributes() [1/2]

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

Refresh cache information.

Definition at line 882 of file CreateNFSFileShareRequest.h.

◆ WithCacheAttributes() [2/2]

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

Refresh cache information.

Definition at line 887 of file CreateNFSFileShareRequest.h.

◆ WithClientList() [1/2]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::WithClientList ( const Aws::Vector< Aws::String > &  value)
inline

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Definition at line 510 of file CreateNFSFileShareRequest.h.

◆ WithClientList() [2/2]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::WithClientList ( Aws::Vector< Aws::String > &&  value)
inline

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

Definition at line 516 of file CreateNFSFileShareRequest.h.

◆ WithClientToken() [1/3]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::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 CreateNFSFileShareRequest.h.

◆ WithClientToken() [2/3]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::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 CreateNFSFileShareRequest.h.

◆ WithClientToken() [3/3]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::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 CreateNFSFileShareRequest.h.

◆ WithDefaultStorageClass() [1/3]

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

◆ WithDefaultStorageClass() [2/3]

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

◆ WithDefaultStorageClass() [3/3]

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

◆ WithFileShareName() [1/3]

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

◆ WithFileShareName() [2/3]

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

◆ WithFileShareName() [3/3]

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

◆ WithGatewayARN() [1/3]

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

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Definition at line 159 of file CreateNFSFileShareRequest.h.

◆ WithGatewayARN() [2/3]

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

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Definition at line 165 of file CreateNFSFileShareRequest.h.

◆ WithGatewayARN() [3/3]

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

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Definition at line 171 of file CreateNFSFileShareRequest.h.

◆ WithGuessMIMETypeEnabled()

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

◆ WithKMSEncrypted()

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

◆ WithKMSKey() [1/3]

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

◆ WithKMSKey() [2/3]

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

◆ WithKMSKey() [3/3]

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

◆ WithLocationARN() [1/3]

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

◆ WithLocationARN() [2/3]

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

◆ WithLocationARN() [3/3]

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

◆ WithNFSFileShareDefaults() [1/2]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::WithNFSFileShareDefaults ( const NFSFileShareDefaults value)
inline

File share default values. Optional.

Definition at line 117 of file CreateNFSFileShareRequest.h.

◆ WithNFSFileShareDefaults() [2/2]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::WithNFSFileShareDefaults ( NFSFileShareDefaults &&  value)
inline

File share default values. Optional.

Definition at line 122 of file CreateNFSFileShareRequest.h.

◆ WithObjectACL() [1/2]

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

◆ WithObjectACL() [2/2]

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

◆ WithReadOnly()

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

◆ WithRequesterPays()

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

◆ WithRole() [1/3]

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

◆ WithRole() [2/3]

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

◆ WithRole() [3/3]

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

◆ WithSquash() [1/3]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::WithSquash ( const Aws::String value)
inline

A value that maps a user to anonymous user.

Valid values are the following:

  • RootSquash: Only root is mapped to anonymous user.

  • NoSquash: No one is mapped to anonymous user.

  • AllSquash: Everyone is mapped to anonymous user.

Definition at line 589 of file CreateNFSFileShareRequest.h.

◆ WithSquash() [2/3]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::WithSquash ( Aws::String &&  value)
inline

A value that maps a user to anonymous user.

Valid values are the following:

  • RootSquash: Only root is mapped to anonymous user.

  • NoSquash: No one is mapped to anonymous user.

  • AllSquash: Everyone is mapped to anonymous user.

Definition at line 598 of file CreateNFSFileShareRequest.h.

◆ WithSquash() [3/3]

CreateNFSFileShareRequest& Aws::StorageGateway::Model::CreateNFSFileShareRequest::WithSquash ( const char *  value)
inline

A value that maps a user to anonymous user.

Valid values are the following:

  • RootSquash: Only root is mapped to anonymous user.

  • NoSquash: No one is mapped to anonymous user.

  • AllSquash: Everyone is mapped to anonymous user.

Definition at line 607 of file CreateNFSFileShareRequest.h.

◆ WithTags() [1/2]

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

◆ WithTags() [2/2]

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


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