/AWS1/CL_STG=>CREATESMBFILESHARE()

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

S3 File Gateways require Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure that Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services Region in the Identity and Access Management User Guide.

File gateways don't support creating hard or symbolic links on a file share.

Method Signature

IMPORTING

Required arguments:

IV_CLIENTTOKEN TYPE /AWS1/STGCLIENTTOKEN /AWS1/STGCLIENTTOKEN

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

IV_GATEWAYARN TYPE /AWS1/STGGATEWAYARN /AWS1/STGGATEWAYARN

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

IV_ROLE TYPE /AWS1/STGROLE /AWS1/STGROLE

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

IV_LOCATIONARN TYPE /AWS1/STGLOCATIONARN /AWS1/STGLOCATIONARN

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

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

Optional arguments:

IV_KMSENCRYPTED TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

IV_KMSKEY TYPE /AWS1/STGKMSKEY /AWS1/STGKMSKEY

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 can only be set when KMSEncrypted is true. Optional.

IV_DEFAULTSTORAGECLASS TYPE /AWS1/STGSTORAGECLASS /AWS1/STGSTORAGECLASS

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

IV_OBJECTACL TYPE /AWS1/STGOBJECTACL /AWS1/STGOBJECTACL

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.

IV_READONLY TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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

IV_GUESSMIMETYPEENABLED TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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

IV_REQUESTERPAYS TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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.

Valid Values: true | false

IV_SMBACLENABLED TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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 Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

Valid Values: true | false

IV_ACCESSBASEDENUMERATION TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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

IT_ADMINUSERLIST TYPE /AWS1/CL_STGUSERLIST_W=>TT_USERLIST TT_USERLIST

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.

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

IT_VALIDUSERLIST TYPE /AWS1/CL_STGUSERLIST_W=>TT_USERLIST TT_USERLIST

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.

IT_INVALIDUSERLIST TYPE /AWS1/CL_STGUSERLIST_W=>TT_USERLIST TT_USERLIST

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.

IV_AUDITDESTINATIONARN TYPE /AWS1/STGAUDITDESTINATIONARN /AWS1/STGAUDITDESTINATIONARN

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

IV_AUTHENTICATION TYPE /AWS1/STGAUTHENTICATION /AWS1/STGAUTHENTICATION

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

Valid Values: ActiveDirectory | GuestAccess

IV_CASESENSITIVITY TYPE /AWS1/STGCASESENSITIVITY /AWS1/STGCASESENSITIVITY

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.

IT_TAGS TYPE /AWS1/CL_STGTAG=>TT_TAGS TT_TAGS

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.

IV_FILESHARENAME TYPE /AWS1/STGFILESHARENAME /AWS1/STGFILESHARENAME

The name of the file share. Optional.

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

IO_CACHEATTRIBUTES TYPE REF TO /AWS1/CL_STGCACHEATTRIBUTES /AWS1/CL_STGCACHEATTRIBUTES

Specifies refresh cache information for the file share.

IV_NOTIFICATIONPOLICY TYPE /AWS1/STGNOTIFICATIONPOLICY /AWS1/STGNOTIFICATIONPOLICY

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.

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

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

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

The following example sets NotificationPolicy off.

{}

IV_VPCENDPOINTDNSNAME TYPE /AWS1/STGDNSHOSTNAME /AWS1/STGDNSHOSTNAME

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

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.

IV_BUCKETREGION TYPE /AWS1/STGREGIONID /AWS1/STGREGIONID

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

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.

IV_OPLOCKSENABLED TYPE /AWS1/STGBOOLEAN /AWS1/STGBOOLEAN

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

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_STGCRESMBFILESHAREOUT /AWS1/CL_STGCRESMBFILESHAREOUT