AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Storage Gateway CreateSMBFileShare API operation.

Syntax

New-SGSMBFileShare
-GatewayARN <String>
-AccessBasedEnumeration <Boolean>
-AdminUserList <String[]>
-AuditDestinationARN <String>
-Authentication <String>
-BucketRegion <String>
-CacheAttributes_CacheStaleTimeoutInSecond <Int32>
-CaseSensitivity <CaseSensitivity>
-DefaultStorageClass <String>
-FileShareName <String>
-GuessMIMETypeEnabled <Boolean>
-InvalidUserList <String[]>
-KMSEncrypted <Boolean>
-KMSKey <String>
-LocationARN <String>
-NotificationPolicy <String>
-ObjectACL <ObjectACL>
-OplocksEnabled <Boolean>
-ReadOnly <Boolean>
-RequesterPay <Boolean>
-Role <String>
-SMBACLEnabled <Boolean>
-Tag <Tag[]>
-ValidUserList <String[]>
-VPCEndpointDNSName <String>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

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.

Parameters

-AccessBasedEnumeration <Boolean>
The files and folders on this share will only be visible to users with read access.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AdminUserList <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AuditDestinationARN <String>
The Amazon Resource Name (ARN) of the storage used for audit logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Authentication <String>
The authentication method that users use to access the file share. The default is ActiveDirectory.Valid Values: ActiveDirectory | GuestAccess
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BucketRegion <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CacheAttributes_CacheStaleTimeoutInSecond <Int32>
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)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCacheAttributes_CacheStaleTimeoutInSeconds
-CaseSensitivity <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FileShareName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-GatewayARN <String>
The ARN of the S3 File Gateway on which you want to create a file share.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InvalidUserList <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KMSEncrypted <Boolean>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KMSKey <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LocationARN <String>
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
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.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.{}
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ObjectACL <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OplocksEnabled <Boolean>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the GatewayARN parameter. The -PassThru parameter is deprecated, use -Select '^GatewayARN' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RequesterPay <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.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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRequesterPays
-Role <String>
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'FileShareARN'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.StorageGateway.Model.CreateSMBFileShareResponse). Specifying the name of a property of type Amazon.StorageGateway.Model.CreateSMBFileShareResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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 Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.Valid Values: true | false
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-ValidUserList <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VPCEndpointDNSName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.StorageGateway.Model.CreateSMBFileShareResponse
This cmdlet returns a System.String object. The service call response (type Amazon.StorageGateway.Model.CreateSMBFileShareResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Service User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z