Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . storagegateway ]

update-nfs-file-share

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-nfs-file-share
--file-share-arn <value>
[--kms-encrypted | --no-kms-encrypted]
[--kms-key <value>]
[--nfs-file-share-defaults <value>]
[--default-storage-class <value>]
[--object-acl <value>]
[--client-list <value>]
[--squash <value>]
[--read-only | --no-read-only]
[--guess-mime-type-enabled | --no-guess-mime-type-enabled]
[--requester-pays | --no-requester-pays]
[--file-share-name <value>]
[--cache-attributes <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--file-share-arn (string)

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

--kms-encrypted | --no-kms-encrypted (boolean)

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

--kms-key (string)

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.

--nfs-file-share-defaults (structure)

The default values for the file share. Optional.

FileMode -> (string)

The Unix file mode in the form "nnnn". For example, 0666 represents the default file mode inside the file share. The default value is 0666 .

DirectoryMode -> (string)

The Unix directory mode in the form "nnnn". For example, 0666 represents the default access mode for all directories inside the file share. The default value is 0777 .

GroupId -> (long)

The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody .

OwnerId -> (long)

The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody .

Shorthand Syntax:

FileMode=string,DirectoryMode=string,GroupId=long,OwnerId=long

JSON Syntax:

{
  "FileMode": "string",
  "DirectoryMode": "string",
  "GroupId": long,
  "OwnerId": long
}

--default-storage-class (string)

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

--object-acl (string)

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 .

Possible values:

  • private
  • public-read
  • public-read-write
  • authenticated-read
  • bucket-owner-read
  • bucket-owner-full-control
  • aws-exec-read

--client-list (list)

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

(string)

Syntax:

"string" "string" ...

--squash (string)

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.

--read-only | --no-read-only (boolean)

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

--guess-mime-type-enabled | --no-guess-mime-type-enabled (boolean)

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

--requester-pays | --no-requester-pays (boolean)

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

--file-share-name (string)

The name of the file share. Optional.

Note

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

--cache-attributes (structure)

Refresh cache information.

CacheStaleTimeoutInSeconds -> (integer)

Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. The TTL duration is in seconds.

Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)

Shorthand Syntax:

CacheStaleTimeoutInSeconds=integer

JSON Syntax:

{
  "CacheStaleTimeoutInSeconds": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

FileShareARN -> (string)

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