Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways.
storagegateway_create_smb_file_share(ClientToken, GatewayARN,
KMSEncrypted, KMSKey, Role, LocationARN, DefaultStorageClass, ObjectACL,
ReadOnly, GuessMIMETypeEnabled, RequesterPays, SMBACLEnabled,
AdminUserList, ValidUserList, InvalidUserList, Authentication, Tags)[required] A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
[required] The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
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.
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.
[required] The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
[required] The ARN of the backed storage used for storing file data.
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.
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".
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.
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.
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.
Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
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.
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.
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.
The authentication method that users use to access the file share.
Valid values are ActiveDirectory or GuestAccess. The default is
ActiveDirectory.
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . \_ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
svc$create_smb_file_share(
ClientToken = "string",
GatewayARN = "string",
KMSEncrypted = TRUE|FALSE,
KMSKey = "string",
Role = "string",
LocationARN = "string",
DefaultStorageClass = "string",
ObjectACL = "private"|"public-read"|"public-read-write"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|"aws-exec-read",
ReadOnly = TRUE|FALSE,
GuessMIMETypeEnabled = TRUE|FALSE,
RequesterPays = TRUE|FALSE,
SMBACLEnabled = TRUE|FALSE,
AdminUserList = list(
"string"
),
ValidUserList = list(
"string"
),
InvalidUserList = list(
"string"
),
Authentication = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
File gateways don't support creating hard or symbolic links on a file share.