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

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.

Instance Attribute Summary collapse

#admin_user_list ⇒ Array<String>
A list of users or groups in the Active Directory that have administrator rights to the file share.
#authentication ⇒ String
The authentication method of the file share.
#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_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
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 the AWS KMS key used for Amazon S3 server side encryption.
#location_arn ⇒ String
The ARN of the backend storage used for storing file data.
#object_acl ⇒ String
A value that sets the access control list 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", indicates that ACL (access control list) 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

#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. For example @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 4534

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

#authentication ⇒ `String`

The authentication method of the file share.

Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

Returns:

(String)

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

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

#default_storage_class ⇒ `String`

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)

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

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  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 4534

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  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 4534

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

#file_share_status ⇒ `String`

The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.

Returns:

(String)

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

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  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 4534

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  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, and otherwise to false. The default value is true.

Returns:

(Boolean)

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

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  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. For example @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 4534

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

#kms_encrypted ⇒ `Boolean`

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)

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

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

#kms_key ⇒ `String`

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)

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

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

#location_arn ⇒ `String`

The ARN of the backend storage used for storing file data.

Returns:

(String)

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

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

#object_acl ⇒ `String`

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)

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

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  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 4534

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

#read_only ⇒ `Boolean`

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)

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

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  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.

Returns:

(Boolean)

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

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  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 4534

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

#smbacl_enabled ⇒ `Boolean`

If this value is set to "true", indicates that ACL (access control list) 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 https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.

Returns:

(Boolean)

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

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  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 4534

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,
  :admin_user_list,
  :valid_user_list,
  :invalid_user_list,
  :authentication,
  :tags)
  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. For example @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 4534

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

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#admin_user_list ⇒ Array<String>

#authentication ⇒ String

#default_storage_class ⇒ String

#file_share_arn ⇒ String

#file_share_id ⇒ 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

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

#admin_user_list ⇒ `Array<String>`

#authentication ⇒ `String`

#default_storage_class ⇒ `String`

#file_share_arn ⇒ `String`

#file_share_id ⇒ `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`

#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>`