You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

UpdateNFSFileShareInput

Instance Attribute Summary collapse

Instance Attribute Details

#client_listArray<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>)


4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  include Aws::Structure
end

#default_storage_classString

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Returns:

  • (String)


4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  include Aws::Structure
end

#file_share_arnString

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

Returns:

  • (String)


4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  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, and otherwise to false. The default value is true.

Returns:

  • (Boolean)


4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  include Aws::Structure
end

#kms_encryptedBoolean

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.

Returns:

  • (Boolean)


4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  include Aws::Structure
end

#kms_keyString

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Returns:

  • (String)


4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  include Aws::Structure
end

#nfs_file_share_defaultsTypes::NFSFileShareDefaults

The default values for the file share. Optional.



4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  include Aws::Structure
end

#object_aclString

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Returns:

  • (String)


4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  include Aws::Structure
end

#read_onlyBoolean

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

Returns:

  • (Boolean)


4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  include Aws::Structure
end

#requester_paysBoolean

A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is private.

Returns:

  • (Boolean)


4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  include Aws::Structure
end

#squashString

The user mapped to anonymous user. Valid options 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)


4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 4536

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)
  include Aws::Structure
end