[ aws . storagegateway ]



Updates a file system association. This operation is only supported in the FSx File Gateways.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--file-system-association-arn <value>
[--user-name <value>]
[--password <value>]
[--audit-destination-arn <value>]
[--cache-attributes <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--file-system-association-arn (string)

The Amazon Resource Name (ARN) of the file system association that you want to update.

--user-name (string)

The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

--password (string)

The password of the user credential.

--audit-destination-arn (string)

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

--cache-attributes (structure)

The refresh cache information for the file share or FSx file systems.

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 or Amazon FSx file system. The TTL duration is in seconds.

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

Shorthand Syntax:


JSON Syntax:

  "CacheStaleTimeoutInSeconds": integer

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.


FileSystemAssociationARN -> (string)

The ARN of the updated file system association.