UpdateNFSFileShare - AWS Storage Gateway Service

UpdateNFSFileShare

Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type.

Note

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

Updates the following file share setting:

  • Default storage class for your S3 bucket

  • Metadata defaults for your S3 bucket

  • Allowed NFS clients for your file share

  • Squash settings

  • Write status of your file share

Note

To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.

Request Syntax

{ "CacheAttributes": { "CacheStaleTimeoutInSeconds": number }, "ClientList": [ "string" ], "DefaultStorageClass": "string", "FileShareARN": "string", "FileShareName": "string", "GuessMIMETypeEnabled": boolean, "KMSEncrypted": boolean, "KMSKey": "string", "NFSFileShareDefaults": { "DirectoryMode": "string", "FileMode": "string", "GroupId": number, "OwnerId": number }, "ObjectACL": "string", "ReadOnly": boolean, "RequesterPays": boolean, "Squash": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CacheAttributes

Refresh cache information.

Type: CacheAttributes object

Required: No

ClientList

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))?$

Required: No

DefaultStorageClass

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

Type: String

Length Constraints: Minimum length of 5. Maximum length of 50.

Required: No

FileShareARN

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

FileShareName

The name of the file share. Optional.

Note

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

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

Type: Boolean

Required: No

KMSEncrypted

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

Type: Boolean

Required: No

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.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 2048.

Pattern: (^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)

Required: No

NFSFileShareDefaults

The default values for the file share. Optional.

Type: NFSFileShareDefaults object

Required: No

ObjectACL

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.

Type: String

Valid Values: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read

Required: No

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

Type: Boolean

Required: No

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.

Note

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

Type: Boolean

Required: No

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.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 15.

Required: No

Response Syntax

{ "FileShareARN": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FileShareARN

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

Example

Update an NFS file share's file mode

In the following request, you update the file mode for an NFS file share.

Sample Request

{ "ClientToken": "xy23421", "NFSFileShareDefaults": { "FileMode": "0777", "DirectoryMode": "0777", "GroupId": "500", "OwnerId": "500" }, "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX", "GuessMIMETypeEnabled": "true", "KMSEncrypted": "false", "Role": "arn:aws:iam::111122223333:role/my-role", "ObjectACL": "bucket-owner-full-control", "ReadOnly": "false", "RequesterPays": "false", "LocationARN": "arn:aws:s3:::my-bucket-alpha", "DefaultStorageClass": "S3_INTELLIGENT_TIERING", "Squash": "RootSquash" }

Sample Response

{ "FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-XXXXXXX" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: