Class: Aws::StorageGateway::Types::NFSFileShareInfo
- Inherits:
-
Struct
- Object
- Struct
- Aws::StorageGateway::Types::NFSFileShareInfo
- Includes:
- Aws::Structure
- Defined in:
- 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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
-
#file_share_id ⇒ String
The ID of the file share.
-
#file_share_name ⇒ String
The name of the file share.
-
#file_share_status ⇒ String
The status of the file share.
-
#gateway_arn ⇒ String
The Amazon Resource Name (ARN) of the gateway.
-
#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.
-
#location_arn ⇒ String
The ARN of the backend storage used for storing file data.
-
#nfs_file_share_defaults ⇒ Types::NFSFileShareDefaults
Describes Network File System (NFS) file share default values.
-
#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.
-
#path ⇒ String
The file share path used by the NFS client to identify the mount point.
-
#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.
-
#role ⇒ String
The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.
-
#squash ⇒ String
The user mapped to anonymous user.
-
#tags ⇒ Array<Types::Tag>
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name.
Instance Attribute Details
#cache_attributes ⇒ Types::CacheAttributes
Refresh cache information.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :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.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :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`
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :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.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#file_share_id ⇒ String
The ID of the file share.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :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>
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#file_share_status ⇒ String
The status of the file share.
Valid Values: ‘CREATING` | `UPDATING` | `AVAILABLE` | `DELETING`
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#gateway_arn ⇒ String
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :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`
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :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`
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :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.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#location_arn ⇒ String
The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a “/”.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#nfs_file_share_defaults ⇒ Types::NFSFileShareDefaults
Describes Network File System (NFS) 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 for file gateways.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#notification_policy ⇒ String
The notification policy of the file share.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :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`.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#path ⇒ String
The file share path used by the NFS client to identify the mount point.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :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`
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :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`
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#role ⇒ String
The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#squash ⇒ String
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.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ‘ListTagsForResource` API operation.
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 5033 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, :object_acl, :client_list, :squash, :read_only, :guess_mime_type_enabled, :requester_pays, :tags, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |