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

Class: Aws::StorageGateway::Types::NFSFileShareInfo

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

Overview

The Unix file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.

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


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :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 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)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#file_share_arnString

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

Returns:

  • (String)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#file_share_idString

The ID of the file share.

Returns:

  • (String)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#file_share_statusString

The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.

Returns:

  • (String)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#gateway_arnString

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Returns:

  • (String)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :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 KMS key, or false to use a key managed by Amazon S3. Optional.

Returns:

  • (Boolean)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#kms_keyString

The ARN of the KMS key used for Amazon S3 server side encryption.

Returns:

  • (String)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#location_arnString

The ARN of the backend storage used for storing file data.

Returns:

  • (String)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#nfs_file_share_defaultsTypes::NFSFileShareDefaults

Describes file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported in the file gateway architecture.



2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#pathString

The file share path used by the NFS client to identify the mount point.

Returns:

  • (String)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#read_onlyBoolean

A value that indicates whether the write status of a file share is read-only: "true" if write status is read-only, and otherwise "false".

Returns:

  • (Boolean)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end

#roleString

The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

Returns:

  • (String)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :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)


2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 2866

class NFSFileShareInfo < Struct.new(
  :nfs_file_share_defaults,
  :file_share_arn,
  :file_share_id,
  :file_share_status,
  :gateway_arn,
  :kms_encrypted,
  :kms_key,
  :path,
  :role,
  :location_arn,
  :default_storage_class,
  :client_list,
  :squash,
  :read_only)
  include Aws::Structure
end