Class: Aws::StorageGateway::Types::UpdateSMBFileShareInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::StorageGateway::Types::UpdateSMBFileShareInput
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-storagegateway/types.rb
Overview
When making an API call, you may pass UpdateSMBFileShareInput data as a hash:
{
file_share_arn: "FileShareARN", # required
kms_encrypted: false,
kms_key: "KMSKey",
default_storage_class: "StorageClass",
object_acl: "private", # accepts private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control, aws-exec-read
read_only: false,
guess_mime_type_enabled: false,
requester_pays: false,
smbacl_enabled: false,
access_based_enumeration: false,
admin_user_list: ["FileShareUser"],
valid_user_list: ["FileShareUser"],
invalid_user_list: ["FileShareUser"],
audit_destination_arn: "AuditDestinationARN",
case_sensitivity: "ClientSpecified", # accepts ClientSpecified, CaseSensitive
file_share_name: "FileShareName",
cache_attributes: {
cache_stale_timeout_in_seconds: 1,
},
notification_policy: "NotificationPolicy",
}
UpdateSMBFileShareInput
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 have administrator rights to the file share.
-
#audit_destination_arn ⇒ String
The Amazon Resource Name (ARN) of the storage used for the audit logs.
-
#cache_attributes ⇒ Types::CacheAttributes
Refresh cache information.
-
#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 file gateway.
-
#file_share_arn ⇒ String
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
-
#file_share_name ⇒ String
The name of the 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
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.
-
#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.
-
#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.
-
#smbacl_enabled ⇒ Boolean
Set this value to ‘true` to enable access control list (ACL) on the SMB file share.
-
#valid_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that are allowed to access the file share.
Instance Attribute Details
#access_based_enumeration ⇒ Boolean
The files and folders on this share will only be visible to users with read access.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :file_share_name, :cache_attributes, :notification_policy) 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: ‘DOMAINUser1`, `user1`, `@group1`, and `@DOMAINgroup1`. Can only be set if Authentication is set to `ActiveDirectory`.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#audit_destination_arn ⇒ String
The Amazon Resource Name (ARN) of the storage used for the audit logs.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#cache_attributes ⇒ Types::CacheAttributes
Refresh cache information.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :file_share_name, :cache_attributes, :notification_policy) 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`.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :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`
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#file_share_arn ⇒ String
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :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>
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :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`
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :file_share_name, :cache_attributes, :notification_policy) 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: ‘DOMAINUser1`, `user1`, `@group1`, and `@DOMAINgroup1`. Can only be set if Authentication is set to `ActiveDirectory`.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :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`
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :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.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |
#notification_policy ⇒ String
The notification policy of the file share.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :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`.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :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 write status to read-only, otherwise set to `false`.
Valid Values: ‘true` | `false`
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :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`
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :file_share_name, :cache_attributes, :notification_policy) 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 Microsoft Windows ACLs to control access to an SMB file share] in the *AWS Storage Gateway User Guide*.
Valid Values: ‘true` | `false`
[1]: docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :file_share_name, :cache_attributes, :notification_policy) 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: ‘DOMAINUser1`, `user1`, `@group1`, and `@DOMAINgroup1`. Can only be set if Authentication is set to `ActiveDirectory`.
7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 |
# File 'lib/aws-sdk-storagegateway/types.rb', line 7089 class UpdateSMBFileShareInput < Struct.new( :file_share_arn, :kms_encrypted, :kms_key, :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, :case_sensitivity, :file_share_name, :cache_attributes, :notification_policy) SENSITIVE = [] include Aws::Structure end |