SmbFileShareInfo

The Windows file permissions and ownership information assigned, by default, to native S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 File Gateways.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Indicates whether AccessBasedEnumeration is enabled.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Specifies the Region of the S3 bucket where the SMB file share stores files.

Link copied to clipboard

Refresh cache information for the file share.

Link copied to clipboard

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.

Link copied to clipboard

The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

Link copied to clipboard

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

Link copied to clipboard

The ID of the file share.

Link copied to clipboard

The name of the file share. Optional.

Link copied to clipboard

The status of the file share.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

A value that sets the access control list (ACL) permission for objects in the S3 bucket that an S3 File Gateway puts objects into. The default value is private.

Link copied to clipboard

Specifies whether opportunistic locking is enabled for the SMB file share.

Link copied to clipboard
val path: String?

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val role: String?

The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.

Link copied to clipboard

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.

Link copied to clipboard
val tags: List<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.

Link copied to clipboard

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.

Link copied to clipboard

Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.

Functions

Link copied to clipboard
inline fun copy(block: SmbFileShareInfo.Builder.() -> Unit = {}): SmbFileShareInfo
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String