AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

CreateSMBFileShare

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.

Important

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.

Request Syntax

{ "AdminUserList": [ "string" ], "Authentication": "string", "ClientToken": "string", "DefaultStorageClass": "string", "GatewayARN": "string", "GuessMIMETypeEnabled": boolean, "InvalidUserList": [ "string" ], "KMSEncrypted": boolean, "KMSKey": "string", "LocationARN": "string", "ObjectACL": "string", "ReadOnly": boolean, "RequesterPays": boolean, "Role": "string", "SMBACLEnabled": boolean, "Tags": [ { "Key": "string", "Value": "string" } ], "ValidUserList": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AdminUserList

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

Authentication

The authentication method that users use to access the file share.

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

Type: String

Length Constraints: Minimum length of 5. Maximum length of 15.

Required: No

ClientToken

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

Type: String

Length Constraints: Minimum length of 5. Maximum length of 100.

Required: Yes

DefaultStorageClass

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.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 20.

Required: No

GatewayARN

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

GuessMIMETypeEnabled

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.

Type: Boolean

Required: No

InvalidUserList

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

KMSEncrypted

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.

Type: Boolean

Required: No

KMSKey

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.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 2048.

Required: No

LocationARN

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

Type: String

Length Constraints: Minimum length of 16. Maximum length of 310.

Required: Yes

ObjectACL

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

Type: String

Valid Values: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read

Required: No

ReadOnly

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.

Type: Boolean

Required: No

RequesterPays

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.

Note

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.

Type: Boolean

Required: No

Role

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

SMBACLEnabled

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 Using Microsoft Windows ACLs to Control Access to an SMB File Share in the Storage Gateway User Guide.

Type: Boolean

Required: No

Tags

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

Note

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.

Type: Array of Tag objects

Required: No

ValidUserList

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

Response Syntax

{ "FileShareARN": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FileShareARN

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

Example

Create a File Share

In the following request, you create a SMB file share using an existing file gateway and use your own AWS KMS key to perform server-side encryption of the contents of the file share.

Sample Request

{ "Authentication": "ActiveDirectory", "ClientToken": "xy23421", "DefaultStorageClass": "S3_STANDARD", "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX", "GuessMIMETypeEnabled": "true", "InvalidList": ["user1", "@group1"], "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "LocationARN": "arn:aws:s3:::my-bucket-alpha", "ObjectACL":"bucket-owner-full-control", "ReadOnly": "false", "RequesterPays": "false", "Role": "arn:aws:iam::111122223333:role/my-role", "ValidUserList": ["user2", "@group2"] }

Sample Response

{"FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: