createSMBFileShare method
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 exposes file shares using an SMB interface. This operation is only supported for file gateways.
File gateways don't support creating hard or symbolic links on a file share.
May throw InvalidGatewayRequestException. May throw InternalServerError.
Parameter clientToken :
A unique string value that you supply that is used by file gateway to
ensure idempotent file share creation.
Parameter gatewayARN :
The ARN of the file gateway on which you want to create a file share.
Parameter locationARN :
The ARN of the backend storage used for storing file data. A prefix name
can be added to the S3 bucket name. It must end with a "/".
Parameter role :
The ARN of the AWS Identity and Access Management (IAM) role that a file
gateway assumes when it accesses the underlying storage.
Parameter accessBasedEnumeration :
The files and folders on this share will only be visible to users with
read access.
Parameter 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.
Parameter auditDestinationARN :
The Amazon Resource Name (ARN) of the storage used for the audit logs.
Parameter authentication :
The authentication method that users use to access the file share. The
default is ActiveDirectory.
Valid Values: ActiveDirectory | GuestAccess
Parameter cacheAttributes :
Refresh cache information.
Parameter 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.
Parameter defaultStorageClass :
The default storage class for objects put into an Amazon S3 bucket by the
file gateway. The default value is S3_INTELLIGENT_TIERING.
Optional.
Valid Values: S3_STANDARD |
S3_INTELLIGENT_TIERING | S3_STANDARD_IA |
S3_ONEZONE_IA
Parameter fileShareName :
The name of the file share. Optional.
Parameter 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
Parameter 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.
Parameter kMSEncrypted :
Set to 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.
Valid Values: true | false
Parameter kMSKey :
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.
Parameter notificationPolicy :
The notification policy of the file share.
Parameter objectACL :
A value that sets the access control list (ACL) permission for objects in
the S3 bucket that a file gateway puts objects into. The default value is
private.
Parameter 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
Parameter 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.
Valid Values: true | false
Parameter 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 Microsoft Windows ACLs to control access to an SMB file share in the AWS Storage Gateway User Guide.
Valid Values: true | false
Parameter tags :
A list of up to 50 tags that can be assigned to the NFS file share. Each
tag is a key-value pair.
Parameter 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.
Implementation
Future<CreateSMBFileShareOutput> createSMBFileShare({
required String clientToken,
required String gatewayARN,
required String locationARN,
required String role,
bool? accessBasedEnumeration,
List<String>? adminUserList,
String? auditDestinationARN,
String? authentication,
CacheAttributes? cacheAttributes,
CaseSensitivity? caseSensitivity,
String? defaultStorageClass,
String? fileShareName,
bool? guessMIMETypeEnabled,
List<String>? invalidUserList,
bool? kMSEncrypted,
String? kMSKey,
String? notificationPolicy,
ObjectACL? objectACL,
bool? readOnly,
bool? requesterPays,
bool? sMBACLEnabled,
List<Tag>? tags,
List<String>? validUserList,
}) async {
ArgumentError.checkNotNull(clientToken, 'clientToken');
_s.validateStringLength(
'clientToken',
clientToken,
5,
100,
isRequired: true,
);
ArgumentError.checkNotNull(gatewayARN, 'gatewayARN');
_s.validateStringLength(
'gatewayARN',
gatewayARN,
50,
500,
isRequired: true,
);
ArgumentError.checkNotNull(locationARN, 'locationARN');
_s.validateStringLength(
'locationARN',
locationARN,
16,
1400,
isRequired: true,
);
ArgumentError.checkNotNull(role, 'role');
_s.validateStringLength(
'role',
role,
20,
2048,
isRequired: true,
);
_s.validateStringLength(
'auditDestinationARN',
auditDestinationARN,
0,
1024,
);
_s.validateStringLength(
'authentication',
authentication,
5,
15,
);
_s.validateStringLength(
'defaultStorageClass',
defaultStorageClass,
5,
50,
);
_s.validateStringLength(
'fileShareName',
fileShareName,
1,
255,
);
_s.validateStringLength(
'kMSKey',
kMSKey,
7,
2048,
);
_s.validateStringLength(
'notificationPolicy',
notificationPolicy,
2,
100,
);
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target': 'StorageGateway_20130630.CreateSMBFileShare'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
'ClientToken': clientToken,
'GatewayARN': gatewayARN,
'LocationARN': locationARN,
'Role': role,
if (accessBasedEnumeration != null)
'AccessBasedEnumeration': accessBasedEnumeration,
if (adminUserList != null) 'AdminUserList': adminUserList,
if (auditDestinationARN != null)
'AuditDestinationARN': auditDestinationARN,
if (authentication != null) 'Authentication': authentication,
if (cacheAttributes != null) 'CacheAttributes': cacheAttributes,
if (caseSensitivity != null)
'CaseSensitivity': caseSensitivity.toValue(),
if (defaultStorageClass != null)
'DefaultStorageClass': defaultStorageClass,
if (fileShareName != null) 'FileShareName': fileShareName,
if (guessMIMETypeEnabled != null)
'GuessMIMETypeEnabled': guessMIMETypeEnabled,
if (invalidUserList != null) 'InvalidUserList': invalidUserList,
if (kMSEncrypted != null) 'KMSEncrypted': kMSEncrypted,
if (kMSKey != null) 'KMSKey': kMSKey,
if (notificationPolicy != null)
'NotificationPolicy': notificationPolicy,
if (objectACL != null) 'ObjectACL': objectACL.toValue(),
if (readOnly != null) 'ReadOnly': readOnly,
if (requesterPays != null) 'RequesterPays': requesterPays,
if (sMBACLEnabled != null) 'SMBACLEnabled': sMBACLEnabled,
if (tags != null) 'Tags': tags,
if (validUserList != null) 'ValidUserList': validUserList,
},
);
return CreateSMBFileShareOutput.fromJson(jsonResponse.body);
}