CreateSmbFileShareRequest

CreateSMBFileShareInput

Types

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

Properties

Link copied to clipboard

The files and folders on this share will only be visible to users with read access.

Link copied to clipboard

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1.

Link copied to clipboard

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

Link copied to clipboard

The authentication method that users use to access 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

Specifies 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

A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.

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

A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.

Link copied to clipboard

The name of the file share. Optional.

Link copied to clipboard

The ARN of the S3 File Gateway on which you want to create a file share.

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

Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.

Link copied to clipboard

Optional. 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 must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.

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

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 Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.

Link copied to clipboard

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.

Link copied to clipboard
val tags: List<Tag>?

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

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