CreateSMBFileShare

Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation is only supported for S3 File Gateways.

Important

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

{
   "AccessBasedEnumeration": boolean,
   "AdminUserList": [ "string" ],
   "AuditDestinationARN": "string",
   "Authentication": "string",
   "BucketRegion": "string",
   "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": number
   },
   "CaseSensitivity": "string",
   "ClientToken": "string",
   "DefaultStorageClass": "string",
   "EncryptionType": "string",
   "FileShareName": "string",
   "GatewayARN": "string",
   "GuessMIMETypeEnabled": boolean,
   "InvalidUserList": [ "string" ],
   "KMSEncrypted": boolean,
   "KMSKey": "string",
   "LocationARN": "string",
   "NotificationPolicy": "string",
   "ObjectACL": "string",
   "OplocksEnabled": boolean,
   "ReadOnly": boolean,
   "RequesterPays": boolean,
   "Role": "string",
   "SMBACLEnabled": boolean,
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "ValidUserList": [ "string" ],
   "VPCEndpointDNSName": "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.

AccessBasedEnumeration

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

Type: Boolean

Required: No

AdminUserList

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.

Important

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

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

AuditDestinationARN

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

Type: String

Length Constraints: Maximum length of 1024.

Required: No

Authentication

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

Valid Values: ActiveDirectory | GuestAccess

Type: String

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

Required: No

BucketRegion

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

Note

This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Type: String

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

Required: No

CacheAttributes

Specifies refresh cache information for the file share.

Type: CacheAttributes object

Required: No

CaseSensitivity

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.

Type: String

Valid Values: ClientSpecified | CaseSensitive

Required: No

ClientToken

A unique string value that you supply that is used by S3 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 S3 File Gateway. The default value is S3_STANDARD. Optional.

Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

Type: String

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

Required: No

EncryptionType

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.

Note

We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

Type: String

Valid Values: SseS3 | SseKms | DsseKms

Required: No

FileShareName

The name of the file share. Optional.

Note

FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

A valid SMB file share name cannot contain the following characters: [,],#,;,<,>,:,",\,/,|,?,*,+, or ASCII control characters 1-31.

Type: String

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

Required: No

GatewayARN

The ARN of the S3 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, otherwise set to false. The default value is true.

Valid Values: true | false

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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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

This parameter has been deprecated.

Optional. Set to true to use Amazon S3 server-side encryption with your own AWS 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.

Note

We recommend using EncryptionType instead of KMSEncrypted to set the file share encryption method. You do not need to provide values for both parameters.

If values for both parameters exist in the same request, then the specified encryption methods must not conflict. For example, if EncryptionType is SseS3, then KMSEncrypted must be false. If EncryptionType is SseKms or DsseKms, then KMSEncrypted must be true.

Valid Values: true | false

Type: Boolean

Required: No

KMSKey

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.

Type: String

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

Pattern: (^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)

Required: No

LocationARN

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

Note

You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.

Bucket ARN:

arn:aws:s3:::amzn-s3-demo-bucket/prefix/

Access point ARN:

arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/

If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

Access point alias:

test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

Type: String

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

Required: Yes

NotificationPolicy

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.

Note

SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

This setting is not meant to specify an exact time at which the notification will be sent. In some cases, the gateway might require more than the specified delay time to generate and send notifications.

The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

{\"Upload\": {\"SettlingTimeInSeconds\": 60}}

The following example sets NotificationPolicy off.

{}

Type: String

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

Pattern: ^\{[\w\s:\{\}\[\]"]*}$

Required: No

ObjectACL

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.

Type: String

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

Required: No

OplocksEnabled

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

Note

Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.

Valid Values: true | false

Type: Boolean

Required: No

ReadOnly

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.

Valid Values: true | 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.

Valid Values: true | false

Type: Boolean

Required: No

Role

The ARN of the AWS Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.

Type: String

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

Pattern: ^arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):iam::([0-9]+):role/(\S+)$

Required: Yes

SMBACLEnabled

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.

For more information, see Using Windows ACLs to limit SMB file share access in the Amazon S3 File Gateway User Guide.

Valid Values: true | false

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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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

VPCEndpointDNSName

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

Note

This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

Type: String

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

Pattern: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$

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

Examples

Create an SMB file share

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

Sample Request

{
    "Authentication": "ActiveDirectory",
    "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": 300
    },
    "CaseSensitivity": "ClientSpecified",
    "ClientToken": "xy23421",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "FileShareName": "my-file-share",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "InvalidList": [
        "user1",
        "user3",
        "@group2"
    ],
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket/prefix-name/",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "ValidUserList": [
        "user2",
        "@group1"
    ]
}           

Sample Response

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

Create an SMB file share with file upload notification on

In the following request, you create an SMB file share using an existing file gateway and with file upload notification turned on and settling time set to 60 seconds.

Sample Request

{
    "Authentication": "ActiveDirectory",
    "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": 300
    },
    "CaseSensitivity": "ClientSpecified",
    "ClientToken": "xy23421",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "FileShareName": "my-file-share",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "InvalidList": [
        "user1",
        "user3",
        "@group2"
    ],
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket/prefix-name/",
    "NotificationPolicy": "{\"Upload\": {\"SettlingTimeInSeconds\": 60}}",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "ValidUserList": [
        "user2",
        "@group1"
    ]
}           

Sample Response

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

Create an SMB file share with file upload notification off

In the following request, you create an SMB file share using an existing file gateway and with file upload notification turned off.

Sample Request

{
    "Authentication": "ActiveDirectory",
    "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": 300
    },
    "CaseSensitivity": "ClientSpecified",
    "ClientToken": "xy23421",
    "DefaultStorageClass": "S3_INTELLIGENT_TIERING",
    "FileShareName": "my-file-share",
    "GatewayARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-XXXXXXX",
    "GuessMIMETypeEnabled": "true",
    "InvalidList": [
        "user1",
        "user3",
        "@group2"
    ],
    "KMSEncrypted": "true",
    "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe",
    "LocationARN": "arn:aws:s3:::amzn-s3-demo-bucket/prefix-name/",
    "NotificationPolicy": "{}",
    "ObjectACL": "bucket-owner-full-control",
    "ReadOnly": "false",
    "RequesterPays": "false",
    "Role": "arn:aws:iam::111122223333:role/my-role",
    "ValidUserList": [
        "user2",
        "@group1"
    ]
}           

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:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3