import { _NFSFileShareDefaults } from "./_NFSFileShareDefaults"; import { _Tag } from "./_Tag"; import { NodeHttpOptions as __HttpOptions__ } from "@aws-sdk/types"; import * as __aws_sdk_types from "@aws-sdk/types"; /** *

CreateNFSFileShareInput

*/ export interface CreateNFSFileShareInput { /** *

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

*/ ClientToken: string; /** *

File share default values. Optional.

*/ NFSFileShareDefaults?: _NFSFileShareDefaults; /** *

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

*/ GatewayARN: string; /** *

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.

*/ KMSEncrypted?: boolean; /** *

The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

*/ KMSKey?: string; /** *

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

*/ Role: string; /** *

The ARN of the backed storage used for storing file data.

*/ LocationARN: string; /** *

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

*/ DefaultStorageClass?: string; /** *

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

*/ ObjectACL?: "private" | "public-read" | "public-read-write" | "authenticated-read" | "bucket-owner-read" | "bucket-owner-full-control" | "aws-exec-read" | string; /** *

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

*/ ClientList?: Array | Iterable; /** *

A value that maps a user to anonymous user. Valid options are the following:

*/ Squash?: string; /** *

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

*/ ReadOnly?: boolean; /** *

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, and otherwise to false. The default value is true.

*/ GuessMIMETypeEnabled?: boolean; /** *

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.

*/ RequesterPays?: boolean; /** *

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.

*/ Tags?: Array<_Tag> | Iterable<_Tag>; /** * The maximum number of times this operation should be retried. If set, this value will override the `maxRetries` configuration set on the client for this command. */ $maxRetries?: number; /** * An object that may be queried to determine if the underlying operation has been aborted. * * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal */ $abortSignal?: __aws_sdk_types.AbortSignal; /** * Per-request HTTP configuration options. If set, any options specified will override the corresponding HTTP option set on the client for this command. */ $httpOptions?: __HttpOptions__; }