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

Class: Aws::StorageGateway::Types::UpdateSMBFileShareInput

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

Overview

Note:

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,
  admin_user_list: ["FileShareUser"],
  valid_user_list: ["FileShareUser"],
  invalid_user_list: ["FileShareUser"],
}

UpdateSMBFileShareInput

Instance Attribute Summary collapse

Instance Attribute Details

#admin_user_listArray<String>

A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

  • (Array<String>)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#default_storage_classString

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

Returns:

  • (String)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#file_share_arnString

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

Returns:

  • (String)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#guess_mime_type_enabledBoolean

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, and otherwise to false. The default value is true.

Returns:

  • (Boolean)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#invalid_user_listArray<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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

  • (Array<String>)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#kms_encryptedBoolean

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.

Returns:

  • (Boolean)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#kms_keyString

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Returns:

  • (String)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#object_aclString

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Returns:

  • (String)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#read_onlyBoolean

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

Returns:

  • (Boolean)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#requester_paysBoolean

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.

Returns:

  • (Boolean)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#smbacl_enabledBoolean

Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.

Returns:

  • (Boolean)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end

#valid_user_listArray<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. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Returns:

  • (Array<String>)


5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5686

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list)
  include Aws::Structure
end