Class: Aws::StorageGateway::Types::SMBFileShareInfo
- Inherits:
-
Struct
- Object
- Struct
- Aws::StorageGateway::Types::SMBFileShareInfo
- Defined in:
- gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb
Overview
The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_based_enumeration ⇒ Boolean
Indicates whether
AccessBasedEnumeration
is enabled. -
#admin_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that have administrator rights to the file share.
-
#audit_destination_arn ⇒ String
The Amazon Resource Name (ARN) of the storage used for audit logs.
-
#authentication ⇒ String
The authentication method of the file share.
-
#bucket_region ⇒ String
Specifies the Region of the S3 bucket where the SMB file share stores files.
-
#cache_attributes ⇒ Types::CacheAttributes
Refresh cache information for the file share.
-
#case_sensitivity ⇒ String
The case of an object name in an Amazon S3 bucket.
-
#default_storage_class ⇒ String
The default storage class for objects put into an Amazon S3 bucket by the S3 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.
-
#invalid_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that are not allowed to access the file share.
-
#kms_encrypted ⇒ Boolean
Set to
true
to use Amazon S3 server-side encryption with your own KMS key, orfalse
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
A custom ARN for the backend storage used for storing data for file shares.
-
#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 an S3 File Gateway puts objects into.
-
#oplocks_enabled ⇒ Boolean
Specifies whether opportunistic locking is enabled for the SMB file share.
-
#path ⇒ String
The file share path used by the SMB 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 an S3 File Gateway assumes when it accesses the underlying storage.
-
#smbacl_enabled ⇒ Boolean
If this value is set to
true
, it indicates that access control list (ACL) is enabled on the SMB file share. -
#tags ⇒ Array<Types::Tag>
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name.
-
#valid_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that are allowed to access the file share.
-
#vpc_endpoint_dns_name ⇒ String
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
Instance Attribute Details
#access_based_enumeration ⇒ Boolean
Indicates whether AccessBasedEnumeration
is enabled.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#admin_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that have
administrator rights to the file share. A group must be prefixed
with the @ character. Acceptable formats include: DOMAIN\User1
,
user1
, @group1
, and @DOMAIN\group1
. Can only be set if
Authentication is set to ActiveDirectory
.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#audit_destination_arn ⇒ String
The Amazon Resource Name (ARN) of the storage used for audit logs.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#authentication ⇒ String
The authentication method of the file share. The default is
ActiveDirectory
.
Valid Values: ActiveDirectory
| GuestAccess
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#bucket_region ⇒ String
Specifies the Region of the S3 bucket where the SMB file share stores files.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#cache_attributes ⇒ Types::CacheAttributes
Refresh cache information for the file share.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#case_sensitivity ⇒ String
The case of an object name in an Amazon S3 bucket. For
ClientSpecified
, the client determines the case sensitivity. For
CaseSensitive
, the gateway determines the case sensitivity. The
default value is ClientSpecified
.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#default_storage_class ⇒ String
The default storage class for objects put into an Amazon S3 bucket
by the S3 File Gateway. The default value is S3_STANDARD
.
Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|
S3_STANDARD_IA
| S3_ONEZONE_IA
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#file_share_arn ⇒ String
The Amazon Resource Name (ARN) of the file share.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#file_share_id ⇒ String
The ID of the file share.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#file_share_name ⇒ String
The name of the file share. Optional.
FileShareName
must be set if an S3 prefix name is set in
LocationARN
, or if an access point or access point alias is used.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#file_share_status ⇒ String
The status of the file share.
Valid Values: CREATING
| UPDATING
| AVAILABLE
| DELETING
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) 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 Amazon Web Services Region.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) 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
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#invalid_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that are not
allowed to access the file share. A group must be prefixed with the
@ character. Acceptable formats include: DOMAIN\User1
, user1
,
@group1
, and @DOMAIN\group1
. Can only be set if Authentication
is set to ActiveDirectory
.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#kms_encrypted ⇒ Boolean
Set to true
to use Amazon S3 server-side encryption with your own
KMS key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) 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.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#location_arn ⇒ String
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#notification_policy ⇒ String
The notification policy of the file share. SettlingTimeInSeconds
controls the number of seconds to wait after the last point in time
a client wrote to a file before generating an ObjectUploaded
notification. Because clients can make many small writes to files,
it's best to set this parameter for as long as possible to avoid
generating multiple notifications for the same file in a small time
period.
SettlingTimeInSeconds
has no effect on the timing of the object
uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy
on with
SettlingTimeInSeconds
set to 60.
\{"Upload": \{"SettlingTimeInSeconds": 60\}\}
The following example sets NotificationPolicy
off.
\{\}
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) 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 an S3 File Gateway puts objects into.
The default value is private
.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#oplocks_enabled ⇒ Boolean
Specifies whether opportunistic locking is enabled for the SMB file share.
Valid Values: true
| false
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#path ⇒ String
The file share path used by the SMB client to identify the mount point.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) 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
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) 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.
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.
Valid Values: true
| false
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#role ⇒ String
The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#smbacl_enabled ⇒ Boolean
If this value is set to true
, it indicates that access control
list (ACL) is enabled on the SMB file share. If it is set to
false
, it indicates that file and directory permissions are mapped
to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of up to 50 tags assigned to the SMB 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.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#valid_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that are allowed
to access the file share. A group must be prefixed with the @
character. Acceptable formats include: DOMAIN\User1
, user1
,
@group1
, and @DOMAIN\group1
. Can only be set if Authentication
is set to ActiveDirectory
.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |
#vpc_endpoint_dns_name ⇒ String
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5626 class SMBFileShareInfo < Struct.new( :file_share_arn, :file_share_id, :file_share_status, :gateway_arn, :kms_encrypted, :kms_key, :path, :role, :location_arn, :default_storage_class, :object_acl, :read_only, :guess_mime_type_enabled, :requester_pays, :smbacl_enabled, :access_based_enumeration, :admin_user_list, :valid_user_list, :invalid_user_list, :audit_destination_arn, :authentication, :case_sensitivity, :tags, :file_share_name, :cache_attributes, :notification_policy, :vpc_endpoint_dns_name, :bucket_region, :oplocks_enabled) SENSITIVE = [] include Aws::Structure end |