AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

NFSFileShareInfo

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

Contents

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. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Type: String

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

Required: No

FileShareARN

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

Type: String

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

Required: No

FileShareId

The ID of the file share.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 30.

Required: No

FileShareStatus

The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.

Type: String

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

Required: No

GatewayARN

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Type: String

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

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, and otherwise to false. The default value is true.

Type: Boolean

Required: No

KMSEncrypted

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.

Type: Boolean

Required: No

KMSKey

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Type: String

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

Required: No

LocationARN

The ARN of the backend storage used for storing file data.

Type: String

Length Constraints: Minimum length of 16. Maximum length of 310.

Required: No

NFSFileShareDefaults

Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for file gateways.

Type: NFSFileShareDefaults object

Required: No

ObjectACL

A value that sets the access control list 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

Path

The file share path used by the NFS client to identify the mount point.

Type: String

Required: No

ReadOnly

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise 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.

Type: Boolean

Required: No

Role

The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

Type: String

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

Required: No

Squash

The user mapped to anonymous user. Valid options 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

Tags

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.

Type: Array of Tag objects

Required: No

See Also

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

On this page: