View source: R/storagegateway_operations.R
storagegateway_create_smb_file_share | R Documentation |
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.
See https://www.paws-r-sdk.com/docs/storagegateway_create_smb_file_share/ for full documentation.
storagegateway_create_smb_file_share(
ClientToken,
GatewayARN,
KMSEncrypted = NULL,
KMSKey = NULL,
Role,
LocationARN,
DefaultStorageClass = NULL,
ObjectACL = NULL,
ReadOnly = NULL,
GuessMIMETypeEnabled = NULL,
RequesterPays = NULL,
SMBACLEnabled = NULL,
AccessBasedEnumeration = NULL,
AdminUserList = NULL,
ValidUserList = NULL,
InvalidUserList = NULL,
AuditDestinationARN = NULL,
Authentication = NULL,
CaseSensitivity = NULL,
Tags = NULL,
FileShareName = NULL,
CacheAttributes = NULL,
NotificationPolicy = NULL,
VPCEndpointDNSName = NULL,
BucketRegion = NULL,
OplocksEnabled = NULL
)
ClientToken |
[required] A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation. |
GatewayARN |
[required] The ARN of the S3 File Gateway on which you want to create a file share. |
KMSEncrypted |
Set to Valid Values: |
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 |
Role |
[required] The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage. |
LocationARN |
[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 (/). You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples. Bucket ARN:
Access point ARN:
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:
|
DefaultStorageClass |
The default storage class for objects put into an Amazon S3 bucket by
the S3 File Gateway. The default value is Valid Values: |
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 |
ReadOnly |
A value that sets the write status of a file share. Set this value to
Valid Values: |
GuessMIMETypeEnabled |
A value that enables guessing of the MIME type for uploaded objects
based on file extensions. Set this value to Valid Values: |
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
Valid Values: |
SMBACLEnabled |
Set this value to For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide. Valid Values: |
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 will be granted
administrator privileges on the file share. These users can do all file
operations as the super-user. Acceptable formats include:
Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions. |
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: |
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: |
AuditDestinationARN |
The Amazon Resource Name (ARN) of the storage used for audit logs. |
Authentication |
The authentication method that users use to access the file share. The
default is Valid Values: |
CaseSensitivity |
The case of an object name in an Amazon S3 bucket. For
|
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. |
FileShareName |
The name of the file share. Optional.
|
CacheAttributes |
Specifies refresh cache information for the file share. |
NotificationPolicy |
The notification policy of the file share.
The following example sets
The following example sets
|
VPCEndpointDNSName |
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. |
BucketRegion |
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. |
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: |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.