Class: Aws::StorageGateway::Types::SMBFileShareInfo

Inherits:

Struct

Object
Struct
Aws::StorageGateway::Types::SMBFileShareInfo

show all

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 file gateway discovers them in S3 buckets. This operation is only supported for 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 the audit logs.
#authentication ⇒ String
The authentication method of the file share.
#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 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 AWS KMS key, or false to use a key managed by Amazon S3.
#kms_key ⇒ String
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption.
#location_arn ⇒ String
The ARN of the backend storage used for storing file data.
#notification_policy ⇒ String
The notification policy of the file share.
#object_acl ⇒ String
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into.
#path ⇒ String
The file share path used by the 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 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.

Instance Attribute Details

#access_based_enumeration ⇒ `Boolean`

Indicates whether AccessBasedEnumeration is enabled.

Returns:

(Boolean)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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.

Returns:

(Array<String>)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#audit_destination_arn ⇒ `String`

The Amazon Resource Name (ARN) of the storage used for the audit logs.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#authentication ⇒ `String`

The authentication method of the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#cache_attributes ⇒ `Types::CacheAttributes`

Refresh cache information.

Returns:

(Types::CacheAttributes)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#file_share_arn ⇒ `String`

The Amazon Resource Name (ARN) of the file share.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#file_share_id ⇒ `String`

The ID of the file share.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#file_share_status ⇒ `String`

The status of the file share.

Valid Values: CREATING | UPDATING | AVAILABLE | DELETING

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_arn ⇒ `String`

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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

Returns:

(Boolean)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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.

Returns:

(Array<String>)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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

Returns:

(Boolean)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#location_arn ⇒ `String`

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#notification_policy ⇒ `String`

The notification policy of the file share.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ `String`

The file share path used by the SMB client to identify the mount point.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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

Returns:

(Boolean)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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

Returns:

(Boolean)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ `String`

The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

Returns:

(String)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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 AWS Storage Gateway User Guide.

Returns:

(Boolean)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  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.

Returns:

(Array<String>)

# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 5603

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)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::StorageGateway::Types::SMBFileShareInfo

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#access_based_enumeration ⇒ Boolean

#admin_user_list ⇒ Array<String>

#audit_destination_arn ⇒ String

#authentication ⇒ String

#cache_attributes ⇒ Types::CacheAttributes

#case_sensitivity ⇒ String

#default_storage_class ⇒ String

#file_share_arn ⇒ String

#file_share_id ⇒ String

#file_share_name ⇒ String

#file_share_status ⇒ String

#gateway_arn ⇒ String

#guess_mime_type_enabled ⇒ Boolean

#invalid_user_list ⇒ Array<String>

#kms_encrypted ⇒ Boolean

#kms_key ⇒ String

#location_arn ⇒ String

#notification_policy ⇒ String

#object_acl ⇒ String

#path ⇒ String

#read_only ⇒ Boolean

#requester_pays ⇒ Boolean

#role ⇒ String

#smbacl_enabled ⇒ Boolean

#tags ⇒ Array<Types::Tag>

#valid_user_list ⇒ Array<String>

#access_based_enumeration ⇒ `Boolean`

#admin_user_list ⇒ `Array<String>`

#audit_destination_arn ⇒ `String`

#authentication ⇒ `String`

#cache_attributes ⇒ `Types::CacheAttributes`

#case_sensitivity ⇒ `String`

#default_storage_class ⇒ `String`

#file_share_arn ⇒ `String`

#file_share_id ⇒ `String`

#file_share_name ⇒ `String`

#file_share_status ⇒ `String`

#gateway_arn ⇒ `String`

#guess_mime_type_enabled ⇒ `Boolean`

#invalid_user_list ⇒ `Array<String>`

#kms_encrypted ⇒ `Boolean`

#kms_key ⇒ `String`

#location_arn ⇒ `String`

#notification_policy ⇒ `String`

#object_acl ⇒ `String`

#path ⇒ `String`

#read_only ⇒ `Boolean`

#requester_pays ⇒ `Boolean`

#role ⇒ `String`

#smbacl_enabled ⇒ `Boolean`

#tags ⇒ `Array<Types::Tag>`

#valid_user_list ⇒ `Array<String>`