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",
  client_list: ["IPV4AddressCIDR"],
  squash: "Squash",
  read_only: 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>)


3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3858

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#default_storage_classString

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

Returns:

  • (String)


3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3858

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#file_share_arnString

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

Returns:

  • (String)


3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3858

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  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)


3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3858

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#kms_keyString

The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

Returns:

  • (String)


3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3858

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#nfs_file_share_defaultsTypes::NFSFileShareDefaults

The default values for the file share. Optional.



3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3858

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#read_onlyBoolean

Sets the write status of a file share: "true" if the write status is read-only, otherwise "false".

Returns:

  • (Boolean)


3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3858

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  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)


3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3858

class UpdateNFSFileShareInput < Struct.new(
  :file_share_arn,
  :kms_encrypted,
  :kms_key,
  :nfs_file_share_defaults,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end