:doc:`StorageGateway <../../storagegateway>` / Client / update_nfs_file_share

*********************
update_nfs_file_share
*********************



.. py:method:: StorageGateway.Client.update_nfs_file_share(**kwargs)

  

  Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.

   

  .. note::

    

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

    

   

  Updates the following file share settings:

   

  
  * 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
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateNFSFileShare>`_  


  **Request Syntax**
  ::

    response = client.update_nfs_file_share(
        FileShareARN='string',
        EncryptionType='SseS3'|'SseKms'|'DsseKms',
        KMSEncrypted=True|False,
        KMSKey='string',
        NFSFileShareDefaults={
            'FileMode': 'string',
            'DirectoryMode': 'string',
            'GroupId': 123,
            'OwnerId': 123
        },
        DefaultStorageClass='string',
        ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
        ClientList=[
            'string',
        ],
        Squash='string',
        ReadOnly=True|False,
        GuessMIMETypeEnabled=True|False,
        RequesterPays=True|False,
        FileShareName='string',
        CacheAttributes={
            'CacheStaleTimeoutInSeconds': 123
        },
        NotificationPolicy='string',
        AuditDestinationARN='string'
    )
    
  :type FileShareARN: string
  :param FileShareARN: **[REQUIRED]** 

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

    

  
  :type EncryptionType: string
  :param EncryptionType: 

    A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.

     

    .. note::

      

      We recommend using ``EncryptionType`` instead of ``KMSEncrypted`` to set the file share encryption method. You do not need to provide values for both parameters.

       

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if ``EncryptionType`` is ``SseS3``, then ``KMSEncrypted`` must be ``false``. If ``EncryptionType`` is ``SseKms`` or ``DsseKms``, then ``KMSEncrypted`` must be ``true``.

      

    

  
  :type KMSEncrypted: boolean
  :param KMSEncrypted: 

    Optional. Set to ``true`` to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or ``false`` to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the ``EncryptionType`` parameter instead.

     

    .. note::

      

      We recommend using ``EncryptionType`` instead of ``KMSEncrypted`` to set the file share encryption method. You do not need to provide values for both parameters.

       

      If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if ``EncryptionType`` is ``SseS3``, then ``KMSEncrypted`` must be ``false``. If ``EncryptionType`` is ``SseKms`` or ``DsseKms``, then ``KMSEncrypted`` must be ``true``.

      

     

    Valid Values: ``true`` | ``false``

    

  
  :type KMSKey: string
  :param KMSKey: 

    Optional. 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 must be set if ``KMSEncrypted`` is ``true``, or if ``EncryptionType`` is ``SseKms`` or ``DsseKms``.

    

  
  :type NFSFileShareDefaults: dict
  :param NFSFileShareDefaults: 

    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** *(integer) --* 

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

      

    
    - **OwnerId** *(integer) --* 

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

      

    
  
  :type DefaultStorageClass: string
  :param 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``

    

  
  :type ObjectACL: string
  :param 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``.

    

  
  :type ClientList: list
  :param ClientList: 

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

    

  
    - *(string) --* 

    

  :type Squash: string
  :param 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 ReadOnly: boolean
  :param 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 GuessMIMETypeEnabled: boolean
  :param 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 RequesterPays: boolean
  :param 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 FileShareName: string
  :param FileShareName: 

    The name of the file share. Optional.

     

    .. note::

      

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

       

      A valid NFS file share name can only contain the following characters: ``a``- ``z``, ``A``- ``Z``, ``0``- ``9``, ``-``, ``.``, and ``_``.

      

    

  
  :type CacheAttributes: dict
  :param CacheAttributes: 

    Specifies refresh cache information for the file share.

    

  
    - **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)

      

    
  
  :type NotificationPolicy: string
  :param 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.

     

    .. note::

      

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

       

      This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.

      

     

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

     

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

     

    The following example sets ``NotificationPolicy`` off.

     

    ``{}``

    

  
  :type AuditDestinationARN: string
  :param AuditDestinationARN: 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'FileShareARN': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      UpdateNFSFileShareOutput

      
      

      - **FileShareARN** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`StorageGateway.Client.exceptions.InvalidGatewayRequestException`

  
  *   :py:class:`StorageGateway.Client.exceptions.InternalServerError`

  