AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::StorageGateway::Types::UpdateNFSFileShareInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb

Overview

Note:

When making an API call, you may pass UpdateNFSFileShareInput data as a hash:

{
  file_share_arn: "FileShareARN", # required
  kms_encrypted: false,
  kms_key: "KMSKey",
  nfs_file_share_defaults: {
    file_mode: "PermissionMode",
    directory_mode: "PermissionMode",
    group_id: 1,
    owner_id: 1,
  },
  default_storage_class: "StorageClass",
  object_acl: "private", # accepts private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control, aws-exec-read
  client_list: ["IPV4AddressCIDR"],
  squash: "Squash",
  read_only: false,
  guess_mime_type_enabled: false,
  requester_pays: false,
  file_share_name: "FileShareName",
  cache_attributes: {
    cache_stale_timeout_in_seconds: 1,
  },
  notification_policy: "NotificationPolicy",
  audit_destination_arn: "AuditDestinationARN",
}

UpdateNFSFileShareInput

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#audit_destination_arnString

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

Returns:

  • (String)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#cache_attributesTypes::CacheAttributes

Specifies refresh cache information for the file share.



7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#client_listArray<String>

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:

  • (Array<String>)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#default_storage_classString

The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Returns:

  • (String)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#file_share_arnString

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

Returns:

  • (String)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#file_share_nameString

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:

  • (String)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#guess_mime_type_enabledBoolean

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:

  • (Boolean)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_encryptedBoolean

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:

  • (Boolean)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#kms_keyString

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:

  • (String)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#nfs_file_share_defaultsTypes::NFSFileShareDefaults

The default values for the file share. Optional.



7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#notification_policyString

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:

  • (String)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#object_aclString

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:

  • (String)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#read_onlyBoolean

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:

  • (Boolean)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#requester_paysBoolean

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:

  • (Boolean)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#squashString

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:

  • (String)


7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 7753

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :object_acl,
  :client_list,
  :squash,
  :read_only,
  :guess_mime_type_enabled,
  :requester_pays,
  :file_share_name,
  :cache_attributes,
  :notification_policy,
  :audit_destination_arn)
  SENSITIVE = []
  include Aws::Structure
end