CreateSmbFileShareRequest
CreateSMBFileShareInput
Types
Properties
The files and folders on this share will only be visible to users with read access.
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
.
The Amazon Resource Name (ARN) of the storage used for audit logs.
The authentication method that users use to access the file share. The default is ActiveDirectory
.
Specifies the Region of the S3 bucket where the SMB file share stores files.
Specifies refresh cache information for the file share.
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
.
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD
. Optional.
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.
The name of the file share. Optional.
The ARN of the S3 File Gateway on which you want to create a file share.
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
.
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
.
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.
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 (/).
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.
Specifies whether opportunistic locking is enabled for the SMB file share.
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.
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.
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
.
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.