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

Inherits:

Struct

• Object
• Struct
• Aws::StorageGateway::Types::UpdateNFSFileShareInput

Includes:

Aws::Structure

Defined in:

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",
}

UpdateNFSFileShareInput

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cache_attributes ⇒ Types::CacheAttributes

  Refresh cache information.

• #client_list ⇒ Array<String>

  The list of clients that are allowed to access the file gateway.

• #default_storage_class ⇒ String

  The default storage class for objects put into an Amazon S3 bucket by the file gateway.

• #file_share_arn ⇒ String

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

• #file_share_name ⇒ String

  The name of the file share.

• #guess_mime_type_enabled ⇒ Boolean

  A value that enables guessing of the MIME type for uploaded objects based on file extensions.

• #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.

• #kms_key ⇒ String

  The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.

• #nfs_file_share_defaults ⇒ Types::NFSFileShareDefaults

  The default values for the file share.

• #notification_policy ⇒ String

  The notification policy of the file share.

• #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.

• #read_only ⇒ Boolean

  A value that sets the write status of a file share.

• #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.

• #squash ⇒ String

  The user mapped to anonymous user.

Instance Attribute Details

#cache_attributes ⇒ Types::CacheAttributes

Refresh cache information.

Returns:

• (Types::CacheAttributes)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#client_list ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#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`

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#file_share_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#file_share_name ⇒ String

The name of the file share. Optional.

<note markdown=“1”> ‘FileShareName` must be set if an S3 prefix name is set in `LocationARN`.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#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`

Returns:

• (Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#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`

Returns:

• (Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#nfs_file_share_defaults ⇒ Types::NFSFileShareDefaults

The default values for the file share. Optional.

Returns:

• (Types::NFSFileShareDefaults)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#notification_policy ⇒ String

The notification policy of the file share.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#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`.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#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`

Returns:

• (Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#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 markdown=“1”> ‘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.

</note>

Valid Values: ‘true` | `false`

Returns:

• (Boolean)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 6885

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)
  SENSITIVE = []
  include Aws::Structure
end