CreateNFSFileShareRequest Class | AWS SDK for .NET V3

Container for the parameters to the CreateNFSFileShare operation. 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.

S3 File gateway requires Security Token Service (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure 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 the 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.

S3 File Gateways do not support creating hard or symbolic links on a file share.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StorageGateway.AmazonStorageGatewayRequest
      Amazon.StorageGateway.Model.CreateNFSFileShareRequest

Namespace: Amazon.StorageGateway.Model
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

public class CreateNFSFileShareRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The CreateNFSFileShareRequest type exposes the following members

Constructors

	Name	Description
	CreateNFSFileShareRequest()

Properties

Name	Type	Description
AuditDestinationARN	System.String	Gets and sets the property AuditDestinationARN. The Amazon Resource Name (ARN) of the storage used for audit logs.
BucketRegion	System.String	Gets and sets the property 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.
CacheAttributes	Amazon.StorageGateway.Model.CacheAttributes	Gets and sets the property CacheAttributes. Specifies refresh cache information for the file share.
ClientList	System.Collections.Generic.List<System.String>	Gets and sets the property 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.
ClientToken	System.String	Gets and sets the property ClientToken. A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
DefaultStorageClass	System.String	Gets and sets the property 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`
FileShareName	System.String	Gets and sets the property 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.
GatewayARN	System.String	Gets and sets the property GatewayARN. The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
GuessMIMETypeEnabled	System.Boolean	Gets and sets the property 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`
KMSEncrypted	System.Boolean	Gets and sets the property 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	System.String	Gets and sets the property 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.
LocationARN	System.String	Gets and sets the property LocationARN. 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`
NFSFileShareDefaults	Amazon.StorageGateway.Model.NFSFileShareDefaults	Gets and sets the property NFSFileShareDefaults. File share default values. Optional.
NotificationPolicy	System.String	Gets and sets the property 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. `{}`
ObjectACL	Amazon.StorageGateway.ObjectACL	Gets and sets the property 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	System.Boolean	Gets and sets the property 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`
RequesterPays	System.Boolean	Gets and sets the property 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`
Role	System.String	Gets and sets the property Role. The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
Squash	System.String	Gets and sets the property Squash. A value that maps a user to anonymous user. Valid values are the following: `RootSquash`: Only root is mapped to anonymous user. `NoSquash`: No one is mapped to anonymous user. `AllSquash`: Everyone is mapped to anonymous user.
Tags	System.Collections.Generic.List<Amazon.StorageGateway.Model.Tag>	Gets and sets the property 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.
VPCEndpointDNSName	System.String	Gets and sets the property 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5