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

#include <NFSFileShareInfo.h>

Public Member Functions

 NFSFileShareInfo ()
 
 NFSFileShareInfo (Aws::Utils::Json::JsonView jsonValue)
 
NFSFileShareInfooperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const NFSFileShareDefaultsGetNFSFileShareDefaults () const
 
bool NFSFileShareDefaultsHasBeenSet () const
 
void SetNFSFileShareDefaults (const NFSFileShareDefaults &value)
 
void SetNFSFileShareDefaults (NFSFileShareDefaults &&value)
 
NFSFileShareInfoWithNFSFileShareDefaults (const NFSFileShareDefaults &value)
 
NFSFileShareInfoWithNFSFileShareDefaults (NFSFileShareDefaults &&value)
 
const Aws::StringGetFileShareARN () const
 
bool FileShareARNHasBeenSet () const
 
void SetFileShareARN (const Aws::String &value)
 
void SetFileShareARN (Aws::String &&value)
 
void SetFileShareARN (const char *value)
 
NFSFileShareInfoWithFileShareARN (const Aws::String &value)
 
NFSFileShareInfoWithFileShareARN (Aws::String &&value)
 
NFSFileShareInfoWithFileShareARN (const char *value)
 
const Aws::StringGetFileShareId () const
 
bool FileShareIdHasBeenSet () const
 
void SetFileShareId (const Aws::String &value)
 
void SetFileShareId (Aws::String &&value)
 
void SetFileShareId (const char *value)
 
NFSFileShareInfoWithFileShareId (const Aws::String &value)
 
NFSFileShareInfoWithFileShareId (Aws::String &&value)
 
NFSFileShareInfoWithFileShareId (const char *value)
 
const Aws::StringGetFileShareStatus () const
 
bool FileShareStatusHasBeenSet () const
 
void SetFileShareStatus (const Aws::String &value)
 
void SetFileShareStatus (Aws::String &&value)
 
void SetFileShareStatus (const char *value)
 
NFSFileShareInfoWithFileShareStatus (const Aws::String &value)
 
NFSFileShareInfoWithFileShareStatus (Aws::String &&value)
 
NFSFileShareInfoWithFileShareStatus (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)
 
NFSFileShareInfoWithGatewayARN (const Aws::String &value)
 
NFSFileShareInfoWithGatewayARN (Aws::String &&value)
 
NFSFileShareInfoWithGatewayARN (const char *value)
 
bool GetKMSEncrypted () const
 
bool KMSEncryptedHasBeenSet () const
 
void SetKMSEncrypted (bool value)
 
NFSFileShareInfoWithKMSEncrypted (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)
 
NFSFileShareInfoWithKMSKey (const Aws::String &value)
 
NFSFileShareInfoWithKMSKey (Aws::String &&value)
 
NFSFileShareInfoWithKMSKey (const char *value)
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
NFSFileShareInfoWithPath (const Aws::String &value)
 
NFSFileShareInfoWithPath (Aws::String &&value)
 
NFSFileShareInfoWithPath (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)
 
NFSFileShareInfoWithRole (const Aws::String &value)
 
NFSFileShareInfoWithRole (Aws::String &&value)
 
NFSFileShareInfoWithRole (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)
 
NFSFileShareInfoWithLocationARN (const Aws::String &value)
 
NFSFileShareInfoWithLocationARN (Aws::String &&value)
 
NFSFileShareInfoWithLocationARN (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)
 
NFSFileShareInfoWithDefaultStorageClass (const Aws::String &value)
 
NFSFileShareInfoWithDefaultStorageClass (Aws::String &&value)
 
NFSFileShareInfoWithDefaultStorageClass (const char *value)
 
const ObjectACLGetObjectACL () const
 
bool ObjectACLHasBeenSet () const
 
void SetObjectACL (const ObjectACL &value)
 
void SetObjectACL (ObjectACL &&value)
 
NFSFileShareInfoWithObjectACL (const ObjectACL &value)
 
NFSFileShareInfoWithObjectACL (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)
 
NFSFileShareInfoWithClientList (const Aws::Vector< Aws::String > &value)
 
NFSFileShareInfoWithClientList (Aws::Vector< Aws::String > &&value)
 
NFSFileShareInfoAddClientList (const Aws::String &value)
 
NFSFileShareInfoAddClientList (Aws::String &&value)
 
NFSFileShareInfoAddClientList (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)
 
NFSFileShareInfoWithSquash (const Aws::String &value)
 
NFSFileShareInfoWithSquash (Aws::String &&value)
 
NFSFileShareInfoWithSquash (const char *value)
 
bool GetReadOnly () const
 
bool ReadOnlyHasBeenSet () const
 
void SetReadOnly (bool value)
 
NFSFileShareInfoWithReadOnly (bool value)
 
bool GetGuessMIMETypeEnabled () const
 
bool GuessMIMETypeEnabledHasBeenSet () const
 
void SetGuessMIMETypeEnabled (bool value)
 
NFSFileShareInfoWithGuessMIMETypeEnabled (bool value)
 
bool GetRequesterPays () const
 
bool RequesterPaysHasBeenSet () const
 
void SetRequesterPays (bool value)
 
NFSFileShareInfoWithRequesterPays (bool value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
NFSFileShareInfoWithTags (const Aws::Vector< Tag > &value)
 
NFSFileShareInfoWithTags (Aws::Vector< Tag > &&value)
 
NFSFileShareInfoAddTags (const Tag &value)
 
NFSFileShareInfoAddTags (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)
 
NFSFileShareInfoWithFileShareName (const Aws::String &value)
 
NFSFileShareInfoWithFileShareName (Aws::String &&value)
 
NFSFileShareInfoWithFileShareName (const char *value)
 
const CacheAttributesGetCacheAttributes () const
 
bool CacheAttributesHasBeenSet () const
 
void SetCacheAttributes (const CacheAttributes &value)
 
void SetCacheAttributes (CacheAttributes &&value)
 
NFSFileShareInfoWithCacheAttributes (const CacheAttributes &value)
 
NFSFileShareInfoWithCacheAttributes (CacheAttributes &&value)
 
const Aws::StringGetNotificationPolicy () const
 
bool NotificationPolicyHasBeenSet () const
 
void SetNotificationPolicy (const Aws::String &value)
 
void SetNotificationPolicy (Aws::String &&value)
 
void SetNotificationPolicy (const char *value)
 
NFSFileShareInfoWithNotificationPolicy (const Aws::String &value)
 
NFSFileShareInfoWithNotificationPolicy (Aws::String &&value)
 
NFSFileShareInfoWithNotificationPolicy (const char *value)
 
const Aws::StringGetVPCEndpointDNSName () const
 
bool VPCEndpointDNSNameHasBeenSet () const
 
void SetVPCEndpointDNSName (const Aws::String &value)
 
void SetVPCEndpointDNSName (Aws::String &&value)
 
void SetVPCEndpointDNSName (const char *value)
 
NFSFileShareInfoWithVPCEndpointDNSName (const Aws::String &value)
 
NFSFileShareInfoWithVPCEndpointDNSName (Aws::String &&value)
 
NFSFileShareInfoWithVPCEndpointDNSName (const char *value)
 
const Aws::StringGetBucketRegion () const
 
bool BucketRegionHasBeenSet () const
 
void SetBucketRegion (const Aws::String &value)
 
void SetBucketRegion (Aws::String &&value)
 
void SetBucketRegion (const char *value)
 
NFSFileShareInfoWithBucketRegion (const Aws::String &value)
 
NFSFileShareInfoWithBucketRegion (Aws::String &&value)
 
NFSFileShareInfoWithBucketRegion (const char *value)
 

Detailed Description

The Unix file permissions and ownership information assigned, by default, to native S3 objects when an S3 File Gateway discovers them in S3 buckets. This operation is only supported in S3 File Gateways.

See Also:

AWS API Reference

Definition at line 38 of file NFSFileShareInfo.h.

Constructor & Destructor Documentation

◆ NFSFileShareInfo() [1/2]

Aws::StorageGateway::Model::NFSFileShareInfo::NFSFileShareInfo ( )

◆ NFSFileShareInfo() [2/2]

Aws::StorageGateway::Model::NFSFileShareInfo::NFSFileShareInfo ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddClientList() [1/3]

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

Definition at line 409 of file NFSFileShareInfo.h.

◆ AddClientList() [2/3]

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

Definition at line 406 of file NFSFileShareInfo.h.

◆ AddClientList() [3/3]

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

Definition at line 412 of file NFSFileShareInfo.h.

◆ AddTags() [1/2]

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

A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Definition at line 613 of file NFSFileShareInfo.h.

◆ AddTags() [2/2]

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

A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Definition at line 621 of file NFSFileShareInfo.h.

◆ BucketRegionHasBeenSet()

bool Aws::StorageGateway::Model::NFSFileShareInfo::BucketRegionHasBeenSet ( ) const
inline

Specifies the Region of the S3 bucket where the NFS file share stores files.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 920 of file NFSFileShareInfo.h.

◆ CacheAttributesHasBeenSet()

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

Refresh cache information for the file share.

Definition at line 689 of file NFSFileShareInfo.h.

◆ ClientListHasBeenSet()

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

Definition at line 391 of file NFSFileShareInfo.h.

◆ DefaultStorageClassHasBeenSet()

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

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 311 of file NFSFileShareInfo.h.

◆ FileShareARNHasBeenSet()

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

Definition at line 70 of file NFSFileShareInfo.h.

◆ FileShareIdHasBeenSet()

bool Aws::StorageGateway::Model::NFSFileShareInfo::FileShareIdHasBeenSet ( ) const
inline

Definition at line 95 of file NFSFileShareInfo.h.

◆ FileShareNameHasBeenSet()

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

◆ FileShareStatusHasBeenSet()

bool Aws::StorageGateway::Model::NFSFileShareInfo::FileShareStatusHasBeenSet ( ) const
inline

Definition at line 120 of file NFSFileShareInfo.h.

◆ GatewayARNHasBeenSet()

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

Definition at line 145 of file NFSFileShareInfo.h.

◆ GetBucketRegion()

const Aws::String& Aws::StorageGateway::Model::NFSFileShareInfo::GetBucketRegion ( ) const
inline

Specifies the Region of the S3 bucket where the NFS file share stores files.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 912 of file NFSFileShareInfo.h.

◆ GetCacheAttributes()

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

Refresh cache information for the file share.

Definition at line 684 of file NFSFileShareInfo.h.

◆ GetClientList()

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

Definition at line 388 of file NFSFileShareInfo.h.

◆ GetDefaultStorageClass()

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

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 302 of file NFSFileShareInfo.h.

◆ GetFileShareARN()

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

Definition at line 67 of file NFSFileShareInfo.h.

◆ GetFileShareId()

const Aws::String& Aws::StorageGateway::Model::NFSFileShareInfo::GetFileShareId ( ) const
inline

Definition at line 92 of file NFSFileShareInfo.h.

◆ GetFileShareName()

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

◆ GetFileShareStatus()

const Aws::String& Aws::StorageGateway::Model::NFSFileShareInfo::GetFileShareStatus ( ) const
inline

Definition at line 117 of file NFSFileShareInfo.h.

◆ GetGatewayARN()

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

Definition at line 142 of file NFSFileShareInfo.h.

◆ GetGuessMIMETypeEnabled()

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

◆ GetKMSEncrypted()

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

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

Valid Values: true | false

Definition at line 171 of file NFSFileShareInfo.h.

◆ GetKMSKey()

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

Definition at line 196 of file NFSFileShareInfo.h.

◆ GetLocationARN()

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

Definition at line 271 of file NFSFileShareInfo.h.

◆ GetNFSFileShareDefaults()

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

Definition at line 48 of file NFSFileShareInfo.h.

◆ GetNotificationPolicy()

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

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{"Upload": {"SettlingTimeInSeconds": 60}}

The following example sets NotificationPolicy off.

{}

Definition at line 726 of file NFSFileShareInfo.h.

◆ GetObjectACL()

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

Definition at line 369 of file NFSFileShareInfo.h.

◆ GetPath()

const Aws::String& Aws::StorageGateway::Model::NFSFileShareInfo::GetPath ( ) const
inline

Definition at line 221 of file NFSFileShareInfo.h.

◆ GetReadOnly()

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

◆ GetRequesterPays()

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

◆ GetRole()

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

Definition at line 246 of file NFSFileShareInfo.h.

◆ GetSquash()

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

Definition at line 416 of file NFSFileShareInfo.h.

◆ GetTags()

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

A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Definition at line 565 of file NFSFileShareInfo.h.

◆ GetVPCEndpointDNSName()

const Aws::String& Aws::StorageGateway::Model::NFSFileShareInfo::GetVPCEndpointDNSName ( ) const
inline

Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 847 of file NFSFileShareInfo.h.

◆ GuessMIMETypeEnabledHasBeenSet()

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

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::StorageGateway::Model::NFSFileShareInfo::Jsonize ( ) const

◆ KMSEncryptedHasBeenSet()

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

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

Valid Values: true | false

Definition at line 178 of file NFSFileShareInfo.h.

◆ KMSKeyHasBeenSet()

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

Definition at line 199 of file NFSFileShareInfo.h.

◆ LocationARNHasBeenSet()

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

Definition at line 274 of file NFSFileShareInfo.h.

◆ NFSFileShareDefaultsHasBeenSet()

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

Definition at line 51 of file NFSFileShareInfo.h.

◆ NotificationPolicyHasBeenSet()

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

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{"Upload": {"SettlingTimeInSeconds": 60}}

The following example sets NotificationPolicy off.

{}

Definition at line 742 of file NFSFileShareInfo.h.

◆ ObjectACLHasBeenSet()

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

Definition at line 372 of file NFSFileShareInfo.h.

◆ operator=()

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PathHasBeenSet()

bool Aws::StorageGateway::Model::NFSFileShareInfo::PathHasBeenSet ( ) const
inline

Definition at line 224 of file NFSFileShareInfo.h.

◆ ReadOnlyHasBeenSet()

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

◆ RequesterPaysHasBeenSet()

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

◆ RoleHasBeenSet()

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

Definition at line 249 of file NFSFileShareInfo.h.

◆ SetBucketRegion() [1/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetBucketRegion ( Aws::String &&  value)
inline

Specifies the Region of the S3 bucket where the NFS file share stores files.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 936 of file NFSFileShareInfo.h.

◆ SetBucketRegion() [2/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetBucketRegion ( const Aws::String value)
inline

Specifies the Region of the S3 bucket where the NFS file share stores files.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 928 of file NFSFileShareInfo.h.

◆ SetBucketRegion() [3/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetBucketRegion ( const char *  value)
inline

Specifies the Region of the S3 bucket where the NFS file share stores files.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 944 of file NFSFileShareInfo.h.

◆ SetCacheAttributes() [1/2]

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

Refresh cache information for the file share.

Definition at line 699 of file NFSFileShareInfo.h.

◆ SetCacheAttributes() [2/2]

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

Refresh cache information for the file share.

Definition at line 694 of file NFSFileShareInfo.h.

◆ SetClientList() [1/2]

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

Definition at line 397 of file NFSFileShareInfo.h.

◆ SetClientList() [2/2]

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

Definition at line 394 of file NFSFileShareInfo.h.

◆ SetDefaultStorageClass() [1/3]

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

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 329 of file NFSFileShareInfo.h.

◆ SetDefaultStorageClass() [2/3]

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

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 320 of file NFSFileShareInfo.h.

◆ SetDefaultStorageClass() [3/3]

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

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 338 of file NFSFileShareInfo.h.

◆ SetFileShareARN() [1/3]

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

Definition at line 76 of file NFSFileShareInfo.h.

◆ SetFileShareARN() [2/3]

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

Definition at line 73 of file NFSFileShareInfo.h.

◆ SetFileShareARN() [3/3]

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

Definition at line 79 of file NFSFileShareInfo.h.

◆ SetFileShareId() [1/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetFileShareId ( Aws::String &&  value)
inline

Definition at line 101 of file NFSFileShareInfo.h.

◆ SetFileShareId() [2/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetFileShareId ( const Aws::String value)
inline

Definition at line 98 of file NFSFileShareInfo.h.

◆ SetFileShareId() [3/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetFileShareId ( const char *  value)
inline

Definition at line 104 of file NFSFileShareInfo.h.

◆ SetFileShareName() [1/3]

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

◆ SetFileShareName() [2/3]

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

◆ SetFileShareName() [3/3]

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

◆ SetFileShareStatus() [1/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetFileShareStatus ( Aws::String &&  value)
inline

Definition at line 126 of file NFSFileShareInfo.h.

◆ SetFileShareStatus() [2/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetFileShareStatus ( const Aws::String value)
inline

Definition at line 123 of file NFSFileShareInfo.h.

◆ SetFileShareStatus() [3/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetFileShareStatus ( const char *  value)
inline

Definition at line 129 of file NFSFileShareInfo.h.

◆ SetGatewayARN() [1/3]

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

Definition at line 151 of file NFSFileShareInfo.h.

◆ SetGatewayARN() [2/3]

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

Definition at line 148 of file NFSFileShareInfo.h.

◆ SetGatewayARN() [3/3]

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

Definition at line 154 of file NFSFileShareInfo.h.

◆ SetGuessMIMETypeEnabled()

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

◆ SetKMSEncrypted()

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

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

Valid Values: true | false

Definition at line 185 of file NFSFileShareInfo.h.

◆ SetKMSKey() [1/3]

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

Definition at line 205 of file NFSFileShareInfo.h.

◆ SetKMSKey() [2/3]

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

Definition at line 202 of file NFSFileShareInfo.h.

◆ SetKMSKey() [3/3]

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

Definition at line 208 of file NFSFileShareInfo.h.

◆ SetLocationARN() [1/3]

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

Definition at line 280 of file NFSFileShareInfo.h.

◆ SetLocationARN() [2/3]

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

Definition at line 277 of file NFSFileShareInfo.h.

◆ SetLocationARN() [3/3]

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

Definition at line 283 of file NFSFileShareInfo.h.

◆ SetNFSFileShareDefaults() [1/2]

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

Definition at line 54 of file NFSFileShareInfo.h.

◆ SetNFSFileShareDefaults() [2/2]

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

Definition at line 57 of file NFSFileShareInfo.h.

◆ SetNotificationPolicy() [1/3]

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

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{"Upload": {"SettlingTimeInSeconds": 60}}

The following example sets NotificationPolicy off.

{}

Definition at line 774 of file NFSFileShareInfo.h.

◆ SetNotificationPolicy() [2/3]

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

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{"Upload": {"SettlingTimeInSeconds": 60}}

The following example sets NotificationPolicy off.

{}

Definition at line 758 of file NFSFileShareInfo.h.

◆ SetNotificationPolicy() [3/3]

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

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{"Upload": {"SettlingTimeInSeconds": 60}}

The following example sets NotificationPolicy off.

{}

Definition at line 790 of file NFSFileShareInfo.h.

◆ SetObjectACL() [1/2]

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

Definition at line 375 of file NFSFileShareInfo.h.

◆ SetObjectACL() [2/2]

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

Definition at line 378 of file NFSFileShareInfo.h.

◆ SetPath() [1/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetPath ( Aws::String &&  value)
inline

Definition at line 230 of file NFSFileShareInfo.h.

◆ SetPath() [2/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetPath ( const Aws::String value)
inline

Definition at line 227 of file NFSFileShareInfo.h.

◆ SetPath() [3/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetPath ( const char *  value)
inline

Definition at line 233 of file NFSFileShareInfo.h.

◆ SetReadOnly()

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

◆ SetRequesterPays()

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

◆ SetRole() [1/3]

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

Definition at line 255 of file NFSFileShareInfo.h.

◆ SetRole() [2/3]

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

Definition at line 252 of file NFSFileShareInfo.h.

◆ SetRole() [3/3]

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

Definition at line 258 of file NFSFileShareInfo.h.

◆ SetSquash() [1/3]

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

Definition at line 425 of file NFSFileShareInfo.h.

◆ SetSquash() [2/3]

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

Definition at line 422 of file NFSFileShareInfo.h.

◆ SetSquash() [3/3]

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

Definition at line 428 of file NFSFileShareInfo.h.

◆ SetTags() [1/2]

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

A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Definition at line 589 of file NFSFileShareInfo.h.

◆ SetTags() [2/2]

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

A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Definition at line 581 of file NFSFileShareInfo.h.

◆ SetVPCEndpointDNSName() [1/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetVPCEndpointDNSName ( Aws::String &&  value)
inline

Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 871 of file NFSFileShareInfo.h.

◆ SetVPCEndpointDNSName() [2/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetVPCEndpointDNSName ( const Aws::String value)
inline

Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 863 of file NFSFileShareInfo.h.

◆ SetVPCEndpointDNSName() [3/3]

void Aws::StorageGateway::Model::NFSFileShareInfo::SetVPCEndpointDNSName ( const char *  value)
inline

Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 879 of file NFSFileShareInfo.h.

◆ SquashHasBeenSet()

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

Definition at line 419 of file NFSFileShareInfo.h.

◆ TagsHasBeenSet()

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

A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Definition at line 573 of file NFSFileShareInfo.h.

◆ VPCEndpointDNSNameHasBeenSet()

bool Aws::StorageGateway::Model::NFSFileShareInfo::VPCEndpointDNSNameHasBeenSet ( ) const
inline

Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 855 of file NFSFileShareInfo.h.

◆ WithBucketRegion() [1/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithBucketRegion ( Aws::String &&  value)
inline

Specifies the Region of the S3 bucket where the NFS file share stores files.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 960 of file NFSFileShareInfo.h.

◆ WithBucketRegion() [2/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithBucketRegion ( const Aws::String value)
inline

Specifies the Region of the S3 bucket where the NFS file share stores files.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 952 of file NFSFileShareInfo.h.

◆ WithBucketRegion() [3/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithBucketRegion ( const char *  value)
inline

Specifies the Region of the S3 bucket where the NFS file share stores files.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 968 of file NFSFileShareInfo.h.

◆ WithCacheAttributes() [1/2]

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

Refresh cache information for the file share.

Definition at line 709 of file NFSFileShareInfo.h.

◆ WithCacheAttributes() [2/2]

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

Refresh cache information for the file share.

Definition at line 704 of file NFSFileShareInfo.h.

◆ WithClientList() [1/2]

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

Definition at line 403 of file NFSFileShareInfo.h.

◆ WithClientList() [2/2]

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

Definition at line 400 of file NFSFileShareInfo.h.

◆ WithDefaultStorageClass() [1/3]

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

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 356 of file NFSFileShareInfo.h.

◆ WithDefaultStorageClass() [2/3]

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

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 347 of file NFSFileShareInfo.h.

◆ WithDefaultStorageClass() [3/3]

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

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Definition at line 365 of file NFSFileShareInfo.h.

◆ WithFileShareARN() [1/3]

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

Definition at line 85 of file NFSFileShareInfo.h.

◆ WithFileShareARN() [2/3]

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

Definition at line 82 of file NFSFileShareInfo.h.

◆ WithFileShareARN() [3/3]

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

Definition at line 88 of file NFSFileShareInfo.h.

◆ WithFileShareId() [1/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithFileShareId ( Aws::String &&  value)
inline

Definition at line 110 of file NFSFileShareInfo.h.

◆ WithFileShareId() [2/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithFileShareId ( const Aws::String value)
inline

Definition at line 107 of file NFSFileShareInfo.h.

◆ WithFileShareId() [3/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithFileShareId ( const char *  value)
inline

Definition at line 113 of file NFSFileShareInfo.h.

◆ WithFileShareName() [1/3]

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

◆ WithFileShareName() [2/3]

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

◆ WithFileShareName() [3/3]

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

◆ WithFileShareStatus() [1/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithFileShareStatus ( Aws::String &&  value)
inline

Definition at line 135 of file NFSFileShareInfo.h.

◆ WithFileShareStatus() [2/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithFileShareStatus ( const Aws::String value)
inline

Definition at line 132 of file NFSFileShareInfo.h.

◆ WithFileShareStatus() [3/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithFileShareStatus ( const char *  value)
inline

Definition at line 138 of file NFSFileShareInfo.h.

◆ WithGatewayARN() [1/3]

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

Definition at line 160 of file NFSFileShareInfo.h.

◆ WithGatewayARN() [2/3]

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

Definition at line 157 of file NFSFileShareInfo.h.

◆ WithGatewayARN() [3/3]

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

Definition at line 163 of file NFSFileShareInfo.h.

◆ WithGuessMIMETypeEnabled()

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

◆ WithKMSEncrypted()

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

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

Valid Values: true | false

Definition at line 192 of file NFSFileShareInfo.h.

◆ WithKMSKey() [1/3]

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

Definition at line 214 of file NFSFileShareInfo.h.

◆ WithKMSKey() [2/3]

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

Definition at line 211 of file NFSFileShareInfo.h.

◆ WithKMSKey() [3/3]

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

Definition at line 217 of file NFSFileShareInfo.h.

◆ WithLocationARN() [1/3]

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

Definition at line 289 of file NFSFileShareInfo.h.

◆ WithLocationARN() [2/3]

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

Definition at line 286 of file NFSFileShareInfo.h.

◆ WithLocationARN() [3/3]

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

Definition at line 292 of file NFSFileShareInfo.h.

◆ WithNFSFileShareDefaults() [1/2]

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

Definition at line 60 of file NFSFileShareInfo.h.

◆ WithNFSFileShareDefaults() [2/2]

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

Definition at line 63 of file NFSFileShareInfo.h.

◆ WithNotificationPolicy() [1/3]

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

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{"Upload": {"SettlingTimeInSeconds": 60}}

The following example sets NotificationPolicy off.

{}

Definition at line 822 of file NFSFileShareInfo.h.

◆ WithNotificationPolicy() [2/3]

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

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{"Upload": {"SettlingTimeInSeconds": 60}}

The following example sets NotificationPolicy off.

{}

Definition at line 806 of file NFSFileShareInfo.h.

◆ WithNotificationPolicy() [3/3]

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

The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{"Upload": {"SettlingTimeInSeconds": 60}}

The following example sets NotificationPolicy off.

{}

Definition at line 838 of file NFSFileShareInfo.h.

◆ WithObjectACL() [1/2]

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

Definition at line 381 of file NFSFileShareInfo.h.

◆ WithObjectACL() [2/2]

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

Definition at line 384 of file NFSFileShareInfo.h.

◆ WithPath() [1/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithPath ( Aws::String &&  value)
inline

Definition at line 239 of file NFSFileShareInfo.h.

◆ WithPath() [2/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithPath ( const Aws::String value)
inline

Definition at line 236 of file NFSFileShareInfo.h.

◆ WithPath() [3/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithPath ( const char *  value)
inline

Definition at line 242 of file NFSFileShareInfo.h.

◆ WithReadOnly()

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

◆ WithRequesterPays()

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

◆ WithRole() [1/3]

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

Definition at line 264 of file NFSFileShareInfo.h.

◆ WithRole() [2/3]

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

Definition at line 261 of file NFSFileShareInfo.h.

◆ WithRole() [3/3]

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

Definition at line 267 of file NFSFileShareInfo.h.

◆ WithSquash() [1/3]

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

Definition at line 434 of file NFSFileShareInfo.h.

◆ WithSquash() [2/3]

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

Definition at line 431 of file NFSFileShareInfo.h.

◆ WithSquash() [3/3]

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

Definition at line 437 of file NFSFileShareInfo.h.

◆ WithTags() [1/2]

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

A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Definition at line 605 of file NFSFileShareInfo.h.

◆ WithTags() [2/2]

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

A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

Definition at line 597 of file NFSFileShareInfo.h.

◆ WithVPCEndpointDNSName() [1/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithVPCEndpointDNSName ( Aws::String &&  value)
inline

Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 895 of file NFSFileShareInfo.h.

◆ WithVPCEndpointDNSName() [2/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithVPCEndpointDNSName ( const Aws::String value)
inline

Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 887 of file NFSFileShareInfo.h.

◆ WithVPCEndpointDNSName() [3/3]

NFSFileShareInfo& Aws::StorageGateway::Model::NFSFileShareInfo::WithVPCEndpointDNSName ( const char *  value)
inline

Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.

This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Definition at line 903 of file NFSFileShareInfo.h.


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