AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateNFSFileShare operation. Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.

To leave a file share field unchanged, set the corresponding input field to null.

Updates the following file share settings:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StorageGateway.AmazonStorageGatewayRequest
      Amazon.StorageGateway.Model.UpdateNFSFileShareRequest

Namespace: Amazon.StorageGateway.Model
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateNFSFileShareRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The UpdateNFSFileShareRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateNFSFileShareRequest()

Properties

NameTypeDescription
Public Property AuditDestinationARN System.String

Gets and sets the property AuditDestinationARN.

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

Public Property CacheAttributes Amazon.StorageGateway.Model.CacheAttributes

Gets and sets the property CacheAttributes.

Specifies refresh cache information for the file share.

Public Property ClientList System.Collections.Generic.List<System.String>

Gets and sets the property ClientList.

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

Public Property DefaultStorageClass System.String

Gets and sets the property DefaultStorageClass.

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

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Public Property FileShareARN System.String

Gets and sets the property FileShareARN.

The Amazon Resource Name (ARN) of the file share to be updated.

Public Property FileShareName System.String

Gets and sets the property FileShareName.

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

Public Property GuessMIMETypeEnabled System.Boolean

Gets and sets the property GuessMIMETypeEnabled.

A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, otherwise set to false. The default value is true.

Valid Values: true | false

Public Property KMSEncrypted System.Boolean

Gets and sets the property KMSEncrypted.

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

Public Property KMSKey System.String

Gets and sets the property KMSKey.

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Public Property NFSFileShareDefaults Amazon.StorageGateway.Model.NFSFileShareDefaults

Gets and sets the property NFSFileShareDefaults.

The default values for the file share. Optional.

Public Property NotificationPolicy System.String

Gets and sets the property NotificationPolicy.

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

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

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

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

The following example sets NotificationPolicy off.

{}

Public Property ObjectACL Amazon.StorageGateway.ObjectACL

Gets and sets the property ObjectACL.

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

Public Property ReadOnly System.Boolean

Gets and sets the property ReadOnly.

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

Public Property RequesterPays System.Boolean

Gets and sets the property RequesterPays.

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Valid Values: true | false

Public Property Squash System.String

Gets and sets the property Squash.

The user mapped 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5