View source: R/storagegateway_operations.R
storagegateway_create_nfs_file_share | R Documentation |
Creates a Network File System (NFS) 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 NFS interface. This operation is only supported for S3 File Gateways.
See https://www.paws-r-sdk.com/docs/storagegateway_create_nfs_file_share/ for full documentation.
storagegateway_create_nfs_file_share(
ClientToken,
NFSFileShareDefaults = NULL,
GatewayARN,
KMSEncrypted = NULL,
KMSKey = NULL,
Role,
LocationARN,
DefaultStorageClass = NULL,
ObjectACL = NULL,
ClientList = NULL,
Squash = NULL,
ReadOnly = NULL,
GuessMIMETypeEnabled = NULL,
RequesterPays = NULL,
Tags = NULL,
FileShareName = NULL,
CacheAttributes = NULL,
NotificationPolicy = NULL,
VPCEndpointDNSName = NULL,
BucketRegion = NULL,
AuditDestinationARN = NULL
)
ClientToken |
[required] A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation. |
NFSFileShareDefaults |
File share default values. Optional. |
GatewayARN |
[required] The Amazon Resource Name (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 |
ClientList |
The list of clients that are allowed to access the S3 File Gateway. The list must contain either valid IP addresses or valid CIDR blocks. |
Squash |
A value that maps a user to anonymous user. Valid values are the following:
|
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: |
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 NFS file share uses to connect to Amazon S3. This parameter is required for NFS 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 NFS file share stores files. This parameter is required for NFS 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. |
AuditDestinationARN |
The Amazon Resource Name (ARN) of the storage used for audit logs. |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.