StorageGateway / Client / create_smb_file_share

create_smb_file_share

StorageGateway.Client.create_smb_file_share(**kwargs)

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.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.create_smb_file_share(
    ClientToken='string',
    GatewayARN='string',
    EncryptionType='SseS3'|'SseKms'|'DsseKms',
    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,
    AccessBasedEnumeration=True|False,
    AdminUserList=[
        'string',
    ],
    ValidUserList=[
        'string',
    ],
    InvalidUserList=[
        'string',
    ],
    AuditDestinationARN='string',
    Authentication='string',
    CaseSensitivity='ClientSpecified'|'CaseSensitive',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    FileShareName='string',
    CacheAttributes={
        'CacheStaleTimeoutInSeconds': 123
    },
    NotificationPolicy='string',
    VPCEndpointDNSName='string',
    BucketRegion='string',
    OplocksEnabled=True|False
)

Parameters:

• ClientToken (string) –

  [REQUIRED]

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

• GatewayARN (string) –

  [REQUIRED]

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

• EncryptionType (string) –

  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.

• KMSEncrypted (boolean) –

  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.

  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

• KMSKey (string) – 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.

• Role (string) –

  [REQUIRED]

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

• LocationARN (string) –

  [REQUIRED]

  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

• DefaultStorageClass (string) –

  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

• ObjectACL (string) – 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.

• ReadOnly (boolean) –

  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

• GuessMIMETypeEnabled (boolean) –

  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

• RequesterPays (boolean) –

  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

• SMBACLEnabled (boolean) –

  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

• AccessBasedEnumeration (boolean) – The files and folders on this share will only be visible to users with read access.

• AdminUserList (list) –

  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.

  Warning

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

  • (string) –

• ValidUserList (list) –

  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.

  • (string) –

• InvalidUserList (list) –

  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.

  • (string) –

• AuditDestinationARN (string) – The Amazon Resource Name (ARN) of the storage used for audit logs.

• Authentication (string) –

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

  Valid Values: ActiveDirectory | GuestAccess

• CaseSensitivity (string) – 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.

• Tags (list) –

  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.

  • (dict) –

    A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

    • Key (string) – [REQUIRED]

      Tag key. The key can’t start with aws:.

    • Value (string) – [REQUIRED]

      Value of the tag key.

• FileShareName (string) –

  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.

• CacheAttributes (dict) –

  Specifies refresh cache information for the file share.

  • CacheStaleTimeoutInSeconds (integer) –

    Refreshes a file share’s cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory’s contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.

    Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)

• NotificationPolicy (string) –

  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.

  {}

• VPCEndpointDNSName (string) –

  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.

• BucketRegion (string) –

  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.

• OplocksEnabled (boolean) –

  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

Return type:

dict

Returns:

Response Syntax

{
    'FileShareARN': 'string'
}

Response Structure

• (dict) –

  CreateSMBFileShareOutput

  • FileShareARN (string) –

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

Exceptions

• StorageGateway.Client.exceptions.InvalidGatewayRequestException

• StorageGateway.Client.exceptions.InternalServerError