Package software.amazon.awssdk.services.storagegateway.model

Interface UpdateNfsFileShareRequest.Builder

    • Method Detail

      • fileShareARN

        UpdateNfsFileShareRequest.Builder fileShareARN​(String fileShareARN)

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

        Parameters:
        fileShareARN - The Amazon Resource Name (ARN) of the file share to be updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsEncrypted

        UpdateNfsFileShareRequest.Builder kmsEncrypted​(Boolean kmsEncrypted)

        Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

        Valid Values: true | false

        Parameters:
        kmsEncrypted - Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

        Valid Values: true | false

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKey

        UpdateNfsFileShareRequest.Builder kmsKey​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nfsFileShareDefaults

        UpdateNfsFileShareRequest.Builder nfsFileShareDefaults​(NFSFileShareDefaults nfsFileShareDefaults)

        The default values for the file share. Optional.

        Parameters:
        nfsFileShareDefaults - The default values for the file share. Optional.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • defaultStorageClass

        UpdateNfsFileShareRequest.Builder defaultStorageClass​(String 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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • objectACL

        UpdateNfsFileShareRequest.Builder objectACL​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ObjectACL, ObjectACL

      • objectACL

        UpdateNfsFileShareRequest.Builder objectACL​(ObjectACL 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ObjectACL, ObjectACL

      • clientList

        UpdateNfsFileShareRequest.Builder clientList​(Collection<String> clientList)

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

        Parameters:
        clientList - The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientList

        UpdateNfsFileShareRequest.Builder clientList​(String... clientList)

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

        Parameters:
        clientList - The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • squash

        UpdateNfsFileShareRequest.Builder squash​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • readOnly

        UpdateNfsFileShareRequest.Builder readOnly​(Boolean 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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • guessMIMETypeEnabled

        UpdateNfsFileShareRequest.Builder guessMIMETypeEnabled​(Boolean 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

        Parameters:
        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • requesterPays

        UpdateNfsFileShareRequest.Builder requesterPays​(Boolean 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.

        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

        Parameters:
        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.

        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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fileShareName

        UpdateNfsFileShareRequest.Builder fileShareName​(String fileShareName)

        The name of the file share. Optional.

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

        Parameters:
        fileShareName - The name of the file share. Optional.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cacheAttributes

        UpdateNfsFileShareRequest.Builder cacheAttributes​(CacheAttributes cacheAttributes)

        Specifies refresh cache information for the file share.

        Parameters:
        cacheAttributes - Specifies refresh cache information for the file share.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notificationPolicy

        UpdateNfsFileShareRequest.Builder notificationPolicy​(String 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.

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

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

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

        The following example sets NotificationPolicy off.

        {}

        Parameters:
        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.

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

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

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

        The following example sets NotificationPolicy off.

        {}

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • auditDestinationARN

        UpdateNfsFileShareRequest.Builder auditDestinationARN​(String auditDestinationARN)

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

        Parameters:
        auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for audit logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.