Update Smb File Share

storagegateway_update_smb_file_share

R Documentation

Description¶

Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.

To leave a file share field unchanged, set the corresponding input field to null.

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

Usage¶

storagegateway_update_smb_file_share(FileShareARN, KMSEncrypted, KMSKey,
  DefaultStorageClass, ObjectACL, ReadOnly, GuessMIMETypeEnabled,
  RequesterPays, SMBACLEnabled, AccessBasedEnumeration, AdminUserList,
  ValidUserList, InvalidUserList, AuditDestinationARN, CaseSensitivity,
  FileShareName, CacheAttributes, NotificationPolicy, OplocksEnabled)

Arguments¶

FileShareARN

[required] The Amazon Resource Name (ARN) of the SMB file share that you want to update.

KMSEncrypted

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

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.

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

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.

ReadOnly

A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false.

Valid Values: true | false

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

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.

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

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

AccessBasedEnumeration

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

AdminUserList

A list of users or groups in the Active Directory that have administrator rights to 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.

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.

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.

AuditDestinationARN

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

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.

FileShareName

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.

CacheAttributes

Specifies refresh cache information for the file share.

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.

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.

{}

OplocksEnabled

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

Value¶

A list with the following syntax:

list(
  FileShareARN = "string"
)

Request syntax¶

svc$update_smb_file_share(
  FileShareARN = "string",
  KMSEncrypted = TRUE|FALSE,
  KMSKey = "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 = list(
    "string"
  ),
  ValidUserList = list(
    "string"
  ),
  InvalidUserList = list(
    "string"
  ),
  AuditDestinationARN = "string",
  CaseSensitivity = "ClientSpecified"|"CaseSensitive",
  FileShareName = "string",
  CacheAttributes = list(
    CacheStaleTimeoutInSeconds = 123
  ),
  NotificationPolicy = "string",
  OplocksEnabled = TRUE|FALSE
)

Update Smb File Share

Updates a Server Message Block (SMB) file share¶

Description¶

Usage¶

Arguments¶

Value¶

Request syntax¶