Class: Aws::StorageGateway::Types::CreateSMBFileShareInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::StorageGateway::Types::CreateSMBFileShareInput
- Defined in:
- gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb
Overview
CreateSMBFileShareInput
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_based_enumeration ⇒ Boolean
The files and folders on this share will only be visible to users with read access.
-
#admin_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that will be granted administrator privileges on the file share.
-
#audit_destination_arn ⇒ String
The Amazon Resource Name (ARN) of the storage used for audit logs.
-
#authentication ⇒ String
The authentication method that users use to access the file share.
-
#bucket_region ⇒ String
Specifies the Region of the S3 bucket where the SMB file share stores files.
-
#cache_attributes ⇒ Types::CacheAttributes
Specifies refresh cache information for the file share.
-
#case_sensitivity ⇒ String
The case of an object name in an Amazon S3 bucket.
-
#client_token ⇒ String
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
-
#default_storage_class ⇒ String
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.
-
#encryption_type ⇒ String
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.
-
#file_share_name ⇒ String
The name of the file share.
-
#gateway_arn ⇒ String
The ARN of the S3 File Gateway on which you want to create a file share.
-
#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
Optional.
-
#kms_key ⇒ String
Optional.
-
#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 a S3 File Gateway puts objects into.
-
#oplocks_enabled ⇒ Boolean
Specifies whether opportunistic locking is enabled for the SMB file share.
-
#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 Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
-
#smbacl_enabled ⇒ Boolean
Set this value to
true
to enable access control list (ACL) on the SMB file share. -
#tags ⇒ Array<Types::Tag>
A list of up to 50 tags that can be assigned to the NFS file share.
- #valid_user_list ⇒ Array<String>
-
#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
The files and folders on this share will only be visible to users with read access.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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 will be
granted administrator privileges on the file share. These users can
do all file operations as the super-user. Acceptable formats
include: DOMAIN\User1
, user1
, @group1
, and @DOMAIN\group1
.
Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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 that users use to access the file share.
The default is ActiveDirectory
.
Valid Values: ActiveDirectory
| GuestAccess
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
Specifies refresh cache information for the file share.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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 |
#client_token ⇒ String
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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 |
#encryption_type ⇒ String
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.
EncryptionType
instead of KMSEncrypted
to set
the file share encryption method. You do not need to provide values
for both parameters.
If values for both parameters exist in the same request, then the
specified encryption methods must not conflict. For example, if
EncryptionType
is SseS3
, then KMSEncrypted
must be false
. If
EncryptionType
is SseKms
or DsseKms
, then KMSEncrypted
must
be true
.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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.
A valid SMB file share name cannot contain the following characters:
[
,]
,#
,;
,<
,>
,:
,"
,`,
/,
|,
?,
*,
+, or ASCII
control characters
1-31`.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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 ARN of the S3 File Gateway on which you want to create a file share.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
Optional. Set to true
to use Amazon S3 server-side encryption with
your own KMS key (SSE-KMS), or false
to use a key managed by
Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the
EncryptionType
parameter instead.
EncryptionType
instead of KMSEncrypted
to set
the file share encryption method. You do not need to provide values
for both parameters.
If values for both parameters exist in the same request, then the
specified encryption methods must not conflict. For example, if
EncryptionType
is SseS3
, then KMSEncrypted
must be false
. If
EncryptionType
is SseKms
or DsseKms
, then KMSEncrypted
must
be true
.
Valid Values: true
| false
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
Optional. 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 must be set if
KMSEncrypted
is true
, or if EncryptionType
is SseKms
or
DsseKms
.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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:::amzn-s3-demo-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
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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.
This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.
The following example sets NotificationPolicy
on with
SettlingTimeInSeconds
set to 60.
{"Upload": {"SettlingTimeInSeconds": 60}}
The following example sets NotificationPolicy
off.
{}
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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 a S3 File Gateway puts objects into.
The default value is private
.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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 Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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
Set this value to true
to enable access control list (ACL) on the
SMB file share. Set it to false
to map file and directory
permissions to the POSIX permissions.
For more information, see Using Windows ACLs to limit SMB file share access in the Amazon S3 File Gateway User Guide.
Valid Values: true
| false
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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 that can be assigned to the NFS file share. Each tag is a key-value pair.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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>
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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.
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 |
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 1785 class CreateSMBFileShareInput < Struct.new( :client_token, :gateway_arn, :encryption_type, :kms_encrypted, :kms_key, :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 |