We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.FSx

Inherits:
AWS.Service show all
Identifier:
fsx
API Version:
2018-03-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

Sending a Request Using FSx

var fsx = new AWS.FSx();
fsx.associateFileSystemAliases(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the FSx object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var fsx = new AWS.FSx({apiVersion: '2018-03-01'});

You can also set the API version globally in AWS.config.apiVersions using the fsx service identifier:

AWS.config.apiVersions = {
  fsx: '2018-03-01',
  // other service API versions
};

var fsx = new AWS.FSx();

Version:

  • 2018-03-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.FSx(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a FSx object

var fsx = new AWS.FSx({apiVersion: '2018-03-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.FSx.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.FSx.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.FSx.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateFileSystemAliases(params = {}, callback) ⇒ AWS.Request

Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.

Service Reference:

Examples:

Calling the associateFileSystemAliases operation

var params = {
  Aliases: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  FileSystemId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
fsx.associateFileSystemAliases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientRequestToken — (String)

      (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • FileSystemId — (String)

      Specifies the file system with which you want to associate one or more DNS aliases.

    • Aliases — (Array<String>)

      An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:

      • Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.corp.example.com.

      • Can contain alphanumeric characters and the hyphen (-).

      • Cannot start or end with a hyphen.

      • Can start with a numeric.

      For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Aliases — (Array<map>)

        An array of the DNS aliases that Amazon FSx is associating with the file system.

        • Name — (String)

          The name of the DNS alias. The alias name has to meet the following requirements:

          • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

          • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

          • Cannot start or end with a hyphen.

          • Can start with a numeric.

          For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

        • Lifecycle — (String)

          Describes the state of the DNS alias.

          • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

          • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

          • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

          • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

          • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "DELETING"
          • "CREATE_FAILED"
          • "DELETE_FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

cancelDataRepositoryTask(params = {}, callback) ⇒ AWS.Request

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel am export task, Amazon FSx does the following.

  • Any files that FSx has already exported are not reverted.

  • FSx continues to export any files that are in-flight when the cancel operation is received.

  • FSx does not export any files that have not yet been exported.

For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.

Service Reference:

Examples:

Calling the cancelDataRepositoryTask operation

var params = {
  TaskId: 'STRING_VALUE' /* required */
};
fsx.cancelDataRepositoryTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • TaskId — (String)

      Specifies the data repository task to cancel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Lifecycle — (String)

        The lifecycle status of the data repository task, as follows:

        • PENDING - Amazon FSx has not started the task.

        • EXECUTING - Amazon FSx is processing the task.

        • FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.

        • SUCCEEDED - FSx completed the task successfully.

        • CANCELED - Amazon FSx canceled the task and it did not complete.

        • CANCELING - FSx is in process of canceling the task.

        Possible values include:
        • "PENDING"
        • "EXECUTING"
        • "FAILED"
        • "SUCCEEDED"
        • "CANCELED"
        • "CANCELING"
      • TaskId — (String)

        The ID of the task being canceled.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

copyBackup(params = {}, callback) ⇒ AWS.Request

Copies an existing backup within the same Amazon Web Services account to another Amazon Web Services Region (cross-Region copy) or within the same Amazon Web Services Region (in-Region copy). You can have up to five backup copy requests in progress to a single destination Region per account.

You can use cross-Region backup copies for cross-Region disaster recovery. You can periodically take backups and copy them to another Region so that in the event of a disaster in the primary Region, you can restore from backup and recover availability quickly in the other Region. You can make cross-Region copies only within your Amazon Web Services partition. A partition is a grouping of Regions. Amazon Web Services currently has three partitions: aws (Standard Regions), aws-cn (China Regions), and aws-us-gov (Amazon Web Services GovCloud [US] Regions).

You can also use backup copies to clone your file dataset to another Region or within the same Region.

You can use the SourceRegion parameter to specify the Amazon Web Services Region from which the backup will be copied. For example, if you make the call from the us-west-1 Region and want to copy a backup from the us-east-2 Region, you specify us-east-2 in the SourceRegion parameter to make a cross-Region copy. If you don't specify a Region, the backup copy is created in the same Region where the request is sent from (in-Region copy).

For more information about creating backup copies, see Copying backups in the Amazon FSx for Windows User Guide, Copying backups in the Amazon FSx for Lustre User Guide, and Copying backups in the Amazon FSx for OpenZFS User Guide.

Service Reference:

Examples:

To copy a backup


/* This operation copies an Amazon FSx backup. */

 var params = {
  SourceBackupId: "backup-03e3c82e0183b7b6b", 
  SourceRegion: "us-east-2"
 };
 fsx.copyBackup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Backup: {
     BackupId: "backup-0a3364eded1014b28", 
     CreationTime: <Date Representation>, 
     FileSystem: {
      FileSystemId: "fs-0498eed5fe91001ec", 
      FileSystemType: "LUSTRE", 
      LustreConfiguration: {
       AutomaticBackupRetentionDays: 0, 
       DeploymentType: "PERSISTENT_1", 
       PerUnitStorageThroughput: 50, 
       WeeklyMaintenanceStartTime: "1:05:00"
      }, 
      ResourceARN: "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0f5179e395f597e66", 
      StorageCapacity: 2400, 
      StorageType: "SSD"
     }, 
     KmsKeyId: "arn:aws:fsx:us-east-1:012345678912:key/d1234e22-543a-12b7-a98f-e12c2b54001a", 
     Lifecycle: "COPYING", 
     OwnerId: "123456789012", 
     ResourceARN: "arn:aws:fsx:us-east-1:012345678912:backup/backup-0a3364eded1014b28", 
     Tags: [
        {
       Key: "Name", 
       Value: "MyBackup"
      }
     ], 
     Type: "USER_INITIATED"
    }
   }
   */
 });

Calling the copyBackup operation

var params = {
  SourceBackupId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  CopyTags: true || false,
  KmsKeyId: 'STRING_VALUE',
  SourceRegion: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
fsx.copyBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientRequestToken — (String)

      (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • SourceBackupId — (String)

      The ID of the source backup. Specifies the ID of the backup that's being copied.

    • SourceRegion — (String)

      The source Amazon Web Services Region of the backup. Specifies the Amazon Web Services Region from which the backup is being copied. The source and destination Regions must be in the same Amazon Web Services partition. If you don't specify a Region, SourceRegion defaults to the Region where the request is sent from (in-Region copy).

    • KmsKeyId — (String)

      Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:

      • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

        SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

      • Amazon FSx for NetApp ONTAP

      • Amazon FSx for OpenZFS

      • Amazon FSx for Windows File Server

      If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

    • CopyTags — (Boolean)

      A Boolean flag indicating whether tags from the source backup should be copied to the backup copy. This value defaults to false.

      If you set CopyTags to true and the source backup has existing tags, you can use the Tags parameter to create new tags, provided that the sum of the source backup tags and the new tags doesn't exceed 50. Both sets of tags are merged. If there are tag conflicts (for example, two tags with the same key but different values), the tags created with the Tags parameter take precedence.

    • Tags — (Array<map>)

      A list of Tag values, with a maximum of 50 elements.

      • Keyrequired — (String)

        A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

      • Valuerequired — (String)

        A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Backup — (map)

        A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.

        • BackupIdrequired — (String)

          The ID of the backup.

        • Lifecyclerequired — (String)

          The lifecycle status of the backup.

          • AVAILABLE - The backup is fully available.

          • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.

          • CREATING - Amazon FSx is creating the backup.

          • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.

          • COPYING - Amazon FSx is copying the backup.

          • DELETED - Amazon FSx deleted the backup and it's no longer available.

          • FAILED - Amazon FSx couldn't finish the backup.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "TRANSFERRING"
          • "DELETED"
          • "FAILED"
          • "PENDING"
          • "COPYING"
        • FailureDetails — (map)

          Details explaining any failures that occurred when creating a backup.

          • Message — (String)

            A message describing the backup-creation failure.

        • Typerequired — (String)

          The type of the file-system backup.

          Possible values include:
          • "AUTOMATIC"
          • "USER_INITIATED"
          • "AWS_BACKUP"
        • ProgressPercent — (Integer)

          Displays the current percent of progress of an asynchronous task.

        • CreationTimerequired — (Date)

          The time when a particular backup was created.

        • KmsKeyId — (String)

          The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

        • ResourceARN — (String)

          The Amazon Resource Name (ARN) for the backup resource.

        • Tags — (Array<map>)

          The tags associated with a particular file system.

          • Keyrequired — (String)

            A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

          • Valuerequired — (String)

            A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

        • FileSystemrequired — (map)

          The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

          • OwnerId — (String)

            The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

          • CreationTime — (Date)

            The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

          • FileSystemId — (String)

            The system-generated, unique 17-digit ID of the file system.

          • FileSystemType — (String)

            The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

            Possible values include:
            • "WINDOWS"
            • "LUSTRE"
            • "ONTAP"
            • "OPENZFS"
          • Lifecycle — (String)

            The lifecycle status of the file system. The following are the possible values and what they mean:

            • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

            • CREATING - Amazon FSx is creating the new file system.

            • DELETING - Amazon FSx is deleting an existing file system.

            • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

            • MISCONFIGURED - The file system is in a failed but recoverable state.

            • MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

            • UPDATING - The file system is undergoing a customer-initiated update.

            Possible values include:
            • "AVAILABLE"
            • "CREATING"
            • "FAILED"
            • "DELETING"
            • "MISCONFIGURED"
            • "UPDATING"
            • "MISCONFIGURED_UNAVAILABLE"
          • FailureDetails — (map)

            A structure providing details of any failures that occurred.

            • Message — (String)

              A message describing any failures that occurred.

          • StorageCapacity — (Integer)

            The storage capacity of the file system in gibibytes (GiB).

            Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

          • StorageType — (String)

            The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

            Possible values include:
            • "SSD"
            • "HDD"
          • VpcId — (String)

            The ID of the primary virtual private cloud (VPC) for the file system.

          • SubnetIds — (Array<String>)

            Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

            For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

          • NetworkInterfaceIds — (Array<String>)

            The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

            For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

          • DNSName — (String)

            The Domain Name System (DNS) name for the file system.

          • KmsKeyId — (String)

            The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

            • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

              SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

            • Amazon FSx for NetApp ONTAP

            • Amazon FSx for OpenZFS

            • Amazon FSx for Windows File Server

          • ResourceARN — (String)

            The Amazon Resource Name (ARN) of the file system resource.

          • Tags — (Array<map>)

            The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

            • Keyrequired — (String)

              A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

            • Valuerequired — (String)

              A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

          • WindowsConfiguration — (map)

            The configuration for this Amazon FSx for Windows File Server file system.

            • ActiveDirectoryId — (String)

              The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

            • SelfManagedActiveDirectoryConfiguration — (map)

              The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

              • DomainName — (String)

                The fully qualified domain name of the self-managed AD directory.

              • OrganizationalUnitDistinguishedName — (String)

                The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

              • FileSystemAdministratorsGroup — (String)

                The name of the domain group whose members have administrative privileges for the FSx file system.

              • UserName — (String)

                The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

              • DnsIps — (Array<String>)

                A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

            • DeploymentType — (String)

              Specifies the file system deployment type, valid values are the following:

              • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

              • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

              • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

              For more information, see Single-AZ and Multi-AZ File Systems.

              Possible values include:
              • "MULTI_AZ_1"
              • "SINGLE_AZ_1"
              • "SINGLE_AZ_2"
            • RemoteAdministrationEndpoint — (String)

              For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

              For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

              This endpoint is temporarily unavailable when the file system is undergoing maintenance.

            • PreferredSubnetId — (String)

              For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

              For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

            • PreferredFileServerIp — (String)

              For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

              Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

            • ThroughputCapacity — (Integer)

              The throughput of the Amazon FSx file system, measured in megabytes per second.

            • MaintenanceOperationsInProgress — (Array<String>)

              The list of maintenance operations in progress for this file system.

            • WeeklyMaintenanceStartTime — (String)

              The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

            • DailyAutomaticBackupStartTime — (String)

              The preferred time to take daily automatic backups, in the UTC time zone.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

            • CopyTagsToBackups — (Boolean)

              A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

            • Aliases — (Array<map>)

              An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

              • Name — (String)

                The name of the DNS alias. The alias name has to meet the following requirements:

                • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

                • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

                • Cannot start or end with a hyphen.

                • Can start with a numeric.

                For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

              • Lifecycle — (String)

                Describes the state of the DNS alias.

                • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

                • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

                • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

                • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

                • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

                Possible values include:
                • "AVAILABLE"
                • "CREATING"
                • "DELETING"
                • "CREATE_FAILED"
                • "DELETE_FAILED"
            • AuditLogConfiguration — (map)

              The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

              • FileAccessAuditLogLevelrequired — (String)

                Sets which attempt type is logged by Amazon FSx for file and folder accesses.

                • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

                • FAILURE_ONLY - only failed attempts to access files or folders are logged.

                • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

                • DISABLED - access auditing of files and folders is turned off.

                Possible values include:
                • "DISABLED"
                • "SUCCESS_ONLY"
                • "FAILURE_ONLY"
                • "SUCCESS_AND_FAILURE"
              • FileShareAccessAuditLogLevelrequired — (String)

                Sets which attempt type is logged by Amazon FSx for file share accesses.

                • SUCCESS_ONLY - only successful attempts to access file shares are logged.

                • FAILURE_ONLY - only failed attempts to access file shares are logged.

                • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

                • DISABLED - access auditing of file shares is turned off.

                Possible values include:
                • "DISABLED"
                • "SUCCESS_ONLY"
                • "FAILURE_ONLY"
                • "SUCCESS_AND_FAILURE"
              • AuditLogDestination — (String)

                The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

                The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

                The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

            • DiskIopsConfiguration — (map)

              The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

              • Mode — (String)

                Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
              • Iops — (Integer)

                The total number of SSD IOPS provisioned for the file system.

                The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

          • LustreConfiguration — (map)

            The configuration for the Amazon FSx for Lustre file system.

            • WeeklyMaintenanceStartTime — (String)

              The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

            • DataRepositoryConfiguration — (map)

              The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

              This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

              • Lifecycle — (String)

                Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

                • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

                • AVAILABLE - The data repository is available for use.

                • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

                • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

                • FAILED - The data repository is in a terminal state that cannot be recovered.

                Possible values include:
                • "CREATING"
                • "AVAILABLE"
                • "MISCONFIGURED"
                • "UPDATING"
                • "DELETING"
                • "FAILED"
              • ImportPath — (String)

                The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

              • ExportPath — (String)

                The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

              • ImportedFileChunkSize — (Integer)

                For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

                The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

              • AutoImportPolicy — (String)

                Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

                • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

                • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

                • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

                • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

                Possible values include:
                • "NONE"
                • "NEW"
                • "NEW_CHANGED"
                • "NEW_CHANGED_DELETED"
              • FailureDetails — (map)

                Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

                • Message — (String)

                  A detailed error message.

            • DeploymentType — (String)

              The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

              SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

              The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

              The default is SCRATCH_1.

              Possible values include:
              • "SCRATCH_1"
              • "SCRATCH_2"
              • "PERSISTENT_1"
              • "PERSISTENT_2"
            • PerUnitStorageThroughput — (Integer)

              Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

              Valid values:

              • For PERSISTENT_1 SSD storage: 50, 100, 200.

              • For PERSISTENT_1 HDD storage: 12, 40.

              • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

            • MountName — (String)

              You use the MountName value when mounting the file system.

              For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

            • DailyAutomaticBackupStartTime — (String)

              A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

            • CopyTagsToBackups — (Boolean)

              A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

            • DriveCacheType — (String)

              The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

              This parameter is required when StorageType is set to HDD.

              Possible values include:
              • "NONE"
              • "READ"
            • DataCompressionType — (String)

              The data compression configuration for the file system. DataCompressionType can have the following values:

              • NONE - Data compression is turned off for the file system.

              • LZ4 - Data compression is turned on with the LZ4 algorithm.

              For more information, see Lustre data compression.

              Possible values include:
              • "NONE"
              • "LZ4"
            • LogConfiguration — (map)

              The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

              • Levelrequired — (String)

                The data repository events that are logged by Amazon FSx.

                • WARN_ONLY - only warning events are logged.

                • ERROR_ONLY - only error events are logged.

                • WARN_ERROR - both warning events and error events are logged.

                • DISABLED - logging of data repository events is turned off.

                Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

                Possible values include:
                • "DISABLED"
                • "WARN_ONLY"
                • "ERROR_ONLY"
                • "WARN_ERROR"
              • Destination — (String)

                The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

            • RootSquashConfiguration — (map)

              The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

              • RootSquash — (String)

                You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

                • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

                • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

                When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

              • NoSquashNids — (Array<String>)

                When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

                • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

                • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

            • MetadataConfiguration — (map)

              The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

              • Iops — (Integer)

                The number of Metadata IOPS provisioned for the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

              • Moderequired — (String)

                The metadata configuration mode for provisioning Metadata IOPS for the file system.

                • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity.

                • In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
          • AdministrativeActions — (Array<map>)

            A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the UpdateFileSystem operation.

            • AdministrativeActionType — (String)

              Describes the type of administrative action, as follows:

              • FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

              • THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

              • STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

                • For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

                • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

                You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

              • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

              • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

              • IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

              • STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

              • VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

              • VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

              • SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

              • RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

              • DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

              • VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

              • VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

              Possible values include:
              • "FILE_SYSTEM_UPDATE"
              • "STORAGE_OPTIMIZATION"
              • "FILE_SYSTEM_ALIAS_ASSOCIATION"
              • "FILE_SYSTEM_ALIAS_DISASSOCIATION"
              • "VOLUME_UPDATE"
              • "SNAPSHOT_UPDATE"
              • "RELEASE_NFS_V3_LOCKS"
              • "VOLUME_RESTORE"
              • "THROUGHPUT_OPTIMIZATION"
              • "IOPS_OPTIMIZATION"
              • "STORAGE_TYPE_OPTIMIZATION"
              • "MISCONFIGURED_STATE_RECOVERY"
              • "VOLUME_UPDATE_WITH_SNAPSHOT"
              • "VOLUME_INITIALIZE_WITH_SNAPSHOT"
              • "DOWNLOAD_DATA_FROM_BACKUP"
            • ProgressPercent — (Integer)

              The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

            • RequestTime — (Date)

              The time that the administrative action request was received.

            • Status — (String)

              The status of the administrative action, as follows:

              • FAILED - Amazon FSx failed to process the administrative action successfully.

              • IN_PROGRESS - Amazon FSx is processing the administrative action.

              • PENDING - Amazon FSx is waiting to process the administrative action.

              • COMPLETED - Amazon FSx has finished processing the administrative task.

                For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

              • UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

              • PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

              • IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

              Possible values include:
              • "FAILED"
              • "IN_PROGRESS"
              • "PENDING"
              • "COMPLETED"
              • "UPDATED_OPTIMIZING"
              • "OPTIMIZING"
            • FailureDetails — (map)

              Provides information about a failed administrative action.

              • Message — (String)

                Error message providing details about the failed administrative action.

            • TargetVolumeValues — (map)

              Describes an Amazon FSx volume.

              • CreationTime — (Date)

                The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

              • FileSystemId — (String)

                The globally unique ID of the file system, assigned by Amazon FSx.

              • Lifecycle — (String)

                The lifecycle status of the volume.

                • AVAILABLE - The volume is fully available for use.

                • CREATED - The volume has been created.

                • CREATING - Amazon FSx is creating the new volume.

                • DELETING - Amazon FSx is deleting an existing volume.

                • FAILED - Amazon FSx was unable to create the volume.

                • MISCONFIGURED - The volume is in a failed but recoverable state.

                • PENDING - Amazon FSx hasn't started creating the volume.

                Possible values include:
                • "CREATING"
                • "CREATED"
                • "DELETING"
                • "FAILED"
                • "MISCONFIGURED"
                • "PENDING"
                • "AVAILABLE"
              • Name — (String)

                The name of the volume.

              • OntapConfiguration — (map)

                The configuration of an Amazon FSx for NetApp ONTAP volume.

                • FlexCacheEndpointType — (String)

                  Specifies the FlexCache endpoint type of the volume. Valid values are the following:

                  • NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

                  • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

                  • CACHE specifies that the volume is a FlexCache volume.

                  Possible values include:
                  • "NONE"
                  • "ORIGIN"
                  • "CACHE"
                • JunctionPath — (String)

                  Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

                • SecurityStyle — (String)

                  The security style for the volume, which can be UNIX, NTFS, or MIXED.

                  Possible values include:
                  • "UNIX"
                  • "NTFS"
                  • "MIXED"
                • SizeInMegabytes — (Integer)

                  The configured size of the volume, in megabytes (MBs).

                • StorageEfficiencyEnabled — (Boolean)

                  The volume's storage efficiency setting.

                • StorageVirtualMachineId — (String)

                  The ID of the volume's storage virtual machine.

                • StorageVirtualMachineRoot — (Boolean)

                  A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

                  This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

                • TieringPolicy — (map)

                  The volume's TieringPolicy setting.

                  • CoolingPeriod — (Integer)

                    Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.

                  • Name — (String)

                    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

                    • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

                    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

                    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

                    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

                    Possible values include:
                    • "SNAPSHOT_ONLY"
                    • "AUTO"
                    • "ALL"
                    • "NONE"
                • UUID — (String)

                  The volume's universally unique identifier (UUID).

                • OntapVolumeType — (String)

                  Specifies the type of volume. Valid values are the following:

                  • RW specifies a read/write volume. RW is the default.

                  • DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

                  • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

                  Possible values include:
                  • "RW"
                  • "DP"
                  • "LS"
                • SnapshotPolicy — (String)

                  Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

                  • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.

                  • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.

                  • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

                  You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

                  For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

                • CopyTagsToBackups — (Boolean)

                  A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

                • SnaplockConfiguration — (map)

                  The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

                  • AuditLogVolume — (Boolean)

                    Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

                    For more information, see SnapLock audit log volumes.

                  • AutocommitPeriod — (map)

                    The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

                    • Typerequired — (String)

                      Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.

                      Possible values include:
                      • "MINUTES"
                      • "HOURS"
                      • "DAYS"
                      • "MONTHS"
                      • "YEARS"
                      • "NONE"
                    • Value — (Integer)

                      Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

                      • Minutes: 5 - 65,535

                      • Hours: 1 - 65,535

                      • Days: 1 - 3,650

                      • Months: 1 - 120

                      • Years: 1 - 10

                  • PrivilegedDelete — (String)

                    Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

                    For more information, see Privileged delete.

                    Possible values include:
                    • "DISABLED"
                    • "ENABLED"
                    • "PERMANENTLY_DISABLED"
                  • RetentionPeriod — (map)

                    Specifies the retention period of an FSx for ONTAP SnapLock volume.

                    • DefaultRetentionrequired — (map)

                      The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

                      • Typerequired — (String)

                        Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                        Possible values include:
                        • "SECONDS"
                        • "MINUTES"
                        • "HOURS"
                        • "DAYS"
                        • "MONTHS"
                        • "YEARS"
                        • "INFINITE"
                        • "UNSPECIFIED"
                      • Value — (Integer)

                        Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                        • Seconds: 0 - 65,535

                        • Minutes: 0 - 65,535

                        • Hours: 0 - 24

                        • Days: 0 - 365

                        • Months: 0 - 12

                        • Years: 0 - 100

                    • MinimumRetentionrequired — (map)

                      The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                      • Typerequired — (String)

                        Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                        Possible values include:
                        • "SECONDS"
                        • "MINUTES"
                        • "HOURS"
                        • "DAYS"
                        • "MONTHS"
                        • "YEARS"
                        • "INFINITE"
                        • "UNSPECIFIED"
                      • Value — (Integer)

                        Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                        • Seconds: 0 - 65,535

                        • Minutes: 0 - 65,535

                        • Hours: 0 - 24

                        • Days: 0 - 365

                        • Months: 0 - 12

                        • Years: 0 - 100

                    • MaximumRetentionrequired — (map)

                      The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                      • Typerequired — (String)

                        Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                        Possible values include:
                        • "SECONDS"
                        • "MINUTES"
                        • "HOURS"
                        • "DAYS"
                        • "MONTHS"
                        • "YEARS"
                        • "INFINITE"
                        • "UNSPECIFIED"
                      • Value — (Integer)

                        Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                        • Seconds: 0 - 65,535

                        • Minutes: 0 - 65,535

                        • Hours: 0 - 24

                        • Days: 0 - 365

                        • Months: 0 - 12

                        • Years: 0 - 100

                  • SnaplockType — (String)

                    Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

                    • COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

                    • ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

                    Possible values include:
                    • "COMPLIANCE"
                    • "ENTERPRISE"
                  • VolumeAppendModeEnabled — (Boolean)

                    Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

                    For more information, see Volume-append mode.

                • VolumeStyle — (String)

                  Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

                  Possible values include:
                  • "FLEXVOL"
                  • "FLEXGROUP"
                • AggregateConfiguration — (map)

                  This structure specifies configuration options for a volume’s storage aggregate or aggregates.

                  • Aggregates — (Array<String>)

                    The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

                    Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                    • The strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 12.

                    • The value of Aggregates contains aggregates that are not present.

                    • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.

                  • TotalConstituents — (Integer)

                    The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.

                • SizeInBytes — (Integer)

                  The configured size of the volume, in bytes.

              • ResourceARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • Tags — (Array<map>)

                A list of Tag values, with a maximum of 50 elements.

                • Keyrequired — (String)

                  A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

                • Valuerequired — (String)

                  A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

              • VolumeId — (String)

                The system-generated, unique ID of the volume.

              • VolumeType — (String)

                The type of the volume.

                Possible values include:
                • "ONTAP"
                • "OPENZFS"
              • LifecycleTransitionReason — (map)

                The reason why the volume lifecycle status changed.

                • Message — (String)

                  A detailed error message.

              • OpenZFSConfiguration — (map)

                The configuration of an Amazon FSx for OpenZFS volume.

                • ParentVolumeId — (String)

                  The ID of the parent volume.

                • VolumePath — (String)

                  The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

                • StorageCapacityReservationGiB — (Integer)

                  The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

                • StorageCapacityQuotaGiB — (Integer)

                  The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

                • RecordSizeKiB — (Integer)

                  The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

                • DataCompressionType — (String)

                  Specifies the method used to compress the data on the volume. The compression type is NONE by default.

                  • NONE - Doesn't compress the data on the volume. NONE is the default.

                  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

                  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

                  Possible values include:
                  • "NONE"
                  • "ZSTD"
                  • "LZ4"
                • CopyTagsToSnapshots — (Boolean)

                  A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

                • OriginSnapshot — (map)

                  The configuration object that specifies the snapshot to use as the origin of the data for the volume.

                  • SnapshotARN — (String)

                    The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

                  • CopyStrategy — (String)

                    The strategy used when copying data from the snapshot to the new volume.

                    • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                    • FULL_COPY - Copies all data from the snapshot to the new volume.

                    Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                    Possible values include:
                    • "CLONE"
                    • "FULL_COPY"
                    • "INCREMENTAL_COPY"
                • ReadOnly — (Boolean)

                  A Boolean value indicating whether the volume is read-only.

                • NfsExports — (Array<map>)

                  The configuration object for mounting a Network File System (NFS) file system.

                  • ClientConfigurationsrequired — (Array<map>)

                    A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

                    • Clientsrequired — (String)

                      A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.

                    • Optionsrequired — (Array<String>)

                      The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:

                      • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.

                      • sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

                • UserAndGroupQuotas — (Array<map>)

                  An object specifying how much storage users or groups can use on the volume.

                  • Typerequired — (String)

                    Specifies whether the quota applies to a user or group.

                    Possible values include:
                    • "USER"
                    • "GROUP"
                  • Idrequired — (Integer)

                    The ID of the user or group that the quota applies to.

                  • StorageCapacityQuotaGiBrequired — (Integer)

                    The user or group's storage quota, in gibibytes (GiB).

                • RestoreToSnapshot — (String)

                  Specifies the ID of the snapshot to which the volume was restored.

                • DeleteIntermediateSnaphots — (Boolean)

                  A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

                • DeleteClonedVolumes — (Boolean)

                  A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

                • DeleteIntermediateData — (Boolean)

                  A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

                • SourceSnapshotARN — (String)

                  The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

                • DestinationSnapshot — (String)

                  The ID of the snapshot that's being copied or was most recently copied to the destination volume.

                • CopyStrategy — (String)

                  Specifies the strategy used when copying data from the snapshot to the new volume.

                  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                  • FULL_COPY - Copies all data from the snapshot to the new volume.

                    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

                  Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                  Possible values include:
                  • "CLONE"
                  • "FULL_COPY"
                  • "INCREMENTAL_COPY"
            • TargetSnapshotValues — (map)

              A snapshot of an Amazon FSx for OpenZFS volume.

              • ResourceARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • SnapshotId — (String)

                The ID of the snapshot.

              • Name — (String)

                The name of the snapshot.

              • VolumeId — (String)

                The ID of the volume that the snapshot is of.

              • CreationTime — (Date)

                The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

              • Lifecycle — (String)

                The lifecycle status of the snapshot.

                • PENDING - Amazon FSx hasn't started creating the snapshot.

                • CREATING - Amazon FSx is creating the snapshot.

                • DELETING - Amazon FSx is deleting the snapshot.

                • AVAILABLE - The snapshot is fully available.

                Possible values include:
                • "PENDING"
                • "CREATING"
                • "DELETING"
                • "AVAILABLE"
              • LifecycleTransitionReason — (map)

                Describes why a resource lifecycle state changed.

                • Message — (String)

                  A detailed error message.

              • Tags — (Array<map>)

                A list of Tag values, with a maximum of 50 elements.

                • Keyrequired — (String)

                  A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

                • Valuerequired — (String)

                  A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

            • TotalTransferBytes — (Integer)

              The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

            • RemainingTransferBytes — (Integer)

              The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

          • OntapConfiguration — (map)

            The configuration for this Amazon FSx for NetApp ONTAP file system.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

            • DailyAutomaticBackupStartTime — (String)

              A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

            • DeploymentType — (String)

              Specifies the FSx for ONTAP file system deployment type in use in the file system.

              • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

              • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

              • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

              • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

              For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

              Possible values include:
              • "MULTI_AZ_1"
              • "SINGLE_AZ_1"
              • "SINGLE_AZ_2"
              • "MULTI_AZ_2"
            • EndpointIpAddressRange — (String)

              (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

            • Endpoints — (map)

              The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

              • Intercluster — (map)

                An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

                • DNSName — (String)

                  The file system's DNS name. You can mount your file system using its DNS name.

                • IpAddresses — (Array<String>)

                  IP addresses of the file system endpoint.

              • Management — (map)

                An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

                • DNSName — (String)

                  The file system's DNS name. You can mount your file system using its DNS name.

                • IpAddresses — (Array<String>)

                  IP addresses of the file system endpoint.

            • DiskIopsConfiguration — (map)

              The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

              • Mode — (String)

                Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
              • Iops — (Integer)

                The total number of SSD IOPS provisioned for the file system.

                The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

            • PreferredSubnetId — (String)

              The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

            • RouteTableIds — (Array<String>)

              (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

            • ThroughputCapacity — (Integer)

              The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

            • WeeklyMaintenanceStartTime — (String)

              A recurring weekly time, in the format D:HH:MM.

              D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

              HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

              For example, 1:05:00 specifies maintenance at 5 AM Monday.

            • FsxAdminPassword — (String)

              You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.

            • HAPairs — (Integer)

              Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

              Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

              • The value of HAPairs is less than 1 or greater than 12.

              • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.

            • ThroughputCapacityPerHAPair — (Integer)

              Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

              This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

              This field and ThroughputCapacity are the same for file systems with one HA pair.

              • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

              • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

              • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

              Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

              • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

              • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

              • The value of ThroughputCapacityPerHAPair is not a valid value.

          • FileSystemTypeVersion — (String)

            The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

          • OpenZFSConfiguration — (map)

            The configuration for this Amazon FSx for OpenZFS file system.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

            • CopyTagsToBackups — (Boolean)

              A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

            • CopyTagsToVolumes — (Boolean)

              A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

            • DailyAutomaticBackupStartTime — (String)

              A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

            • DeploymentType — (String)

              Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

              Possible values include:
              • "SINGLE_AZ_1"
              • "SINGLE_AZ_2"
              • "SINGLE_AZ_HA_1"
              • "SINGLE_AZ_HA_2"
              • "MULTI_AZ_1"
            • ThroughputCapacity — (Integer)

              The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

            • WeeklyMaintenanceStartTime — (String)

              A recurring weekly time, in the format D:HH:MM.

              D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

              HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

              For example, 1:05:00 specifies maintenance at 5 AM Monday.

            • DiskIopsConfiguration — (map)

              The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

              • Mode — (String)

                Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
              • Iops — (Integer)

                The total number of SSD IOPS provisioned for the file system.

                The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

            • RootVolumeId — (String)

              The ID of the root volume of the OpenZFS file system.

            • PreferredSubnetId — (String)

              Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

            • EndpointIpAddressRange — (String)

              (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

            • RouteTableIds — (Array<String>)

              (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

            • EndpointIpAddress — (String)

              The IP address of the endpoint that is used to access data or to manage the file system.

        • DirectoryInformation — (map)

          The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.

          • DomainName — (String)

            The fully qualified domain name of the self-managed Active Directory directory.

          • ActiveDirectoryId — (String)

            The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.

          • ResourceARN — (String)

            The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

        • OwnerId — (String)

          An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

        • SourceBackupId — (String)

          The ID of the source backup. Specifies the backup that you are copying.

        • SourceBackupRegion — (String)

          The source Region of the backup. Specifies the Region from where this backup is copied.

        • ResourceType — (String)

          Specifies the resource type that's backed up.

          Possible values include:
          • "FILE_SYSTEM"
          • "VOLUME"
        • Volume — (map)

          Describes an Amazon FSx volume.

          • CreationTime — (Date)

            The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

          • FileSystemId — (String)

            The globally unique ID of the file system, assigned by Amazon FSx.

          • Lifecycle — (String)

            The lifecycle status of the volume.

            • AVAILABLE - The volume is fully available for use.

            • CREATED - The volume has been created.

            • CREATING - Amazon FSx is creating the new volume.

            • DELETING - Amazon FSx is deleting an existing volume.

            • FAILED - Amazon FSx was unable to create the volume.

            • MISCONFIGURED - The volume is in a failed but recoverable state.

            • PENDING - Amazon FSx hasn't started creating the volume.

            Possible values include:
            • "CREATING"
            • "CREATED"
            • "DELETING"
            • "FAILED"
            • "MISCONFIGURED"
            • "PENDING"
            • "AVAILABLE"
          • Name — (String)

            The name of the volume.

          • OntapConfiguration — (map)

            The configuration of an Amazon FSx for NetApp ONTAP volume.

            • FlexCacheEndpointType — (String)

              Specifies the FlexCache endpoint type of the volume. Valid values are the following:

              • NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

              • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

              • CACHE specifies that the volume is a FlexCache volume.

              Possible values include:
              • "NONE"
              • "ORIGIN"
              • "CACHE"
            • JunctionPath — (String)

              Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

            • SecurityStyle — (String)

              The security style for the volume, which can be UNIX, NTFS, or MIXED.

              Possible values include:
              • "UNIX"
              • "NTFS"
              • "MIXED"
            • SizeInMegabytes — (Integer)

              The configured size of the volume, in megabytes (MBs).

            • StorageEfficiencyEnabled — (Boolean)

              The volume's storage efficiency setting.

            • StorageVirtualMachineId — (String)

              The ID of the volume's storage virtual machine.

            • StorageVirtualMachineRoot — (Boolean)

              A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

              This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

            • TieringPolicy — (map)

              The volume's TieringPolicy setting.

              • CoolingPeriod — (Integer)

                Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.

              • Name — (String)

                Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

                • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

                • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

                • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

                • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

                Possible values include:
                • "SNAPSHOT_ONLY"
                • "AUTO"
                • "ALL"
                • "NONE"
            • UUID — (String)

              The volume's universally unique identifier (UUID).

            • OntapVolumeType — (String)

              Specifies the type of volume. Valid values are the following:

              • RW specifies a read/write volume. RW is the default.

              • DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

              • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

              Possible values include:
              • "RW"
              • "DP"
              • "LS"
            • SnapshotPolicy — (String)

              Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

              • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.

              • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.

              • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

              You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

              For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

            • CopyTagsToBackups — (Boolean)

              A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

            • SnaplockConfiguration — (map)

              The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

              • AuditLogVolume — (Boolean)

                Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

                For more information, see SnapLock audit log volumes.

              • AutocommitPeriod — (map)

                The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

                • Typerequired — (String)

                  Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.

                  Possible values include:
                  • "MINUTES"
                  • "HOURS"
                  • "DAYS"
                  • "MONTHS"
                  • "YEARS"
                  • "NONE"
                • Value — (Integer)

                  Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

                  • Minutes: 5 - 65,535

                  • Hours: 1 - 65,535

                  • Days: 1 - 3,650

                  • Months: 1 - 120

                  • Years: 1 - 10

              • PrivilegedDelete — (String)

                Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

                For more information, see Privileged delete.

                Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "PERMANENTLY_DISABLED"
              • RetentionPeriod — (map)

                Specifies the retention period of an FSx for ONTAP SnapLock volume.

                • DefaultRetentionrequired — (map)

                  The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

                  • Typerequired — (String)

                    Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                    Possible values include:
                    • "SECONDS"
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "INFINITE"
                    • "UNSPECIFIED"
                  • Value — (Integer)

                    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                    • Seconds: 0 - 65,535

                    • Minutes: 0 - 65,535

                    • Hours: 0 - 24

                    • Days: 0 - 365

                    • Months: 0 - 12

                    • Years: 0 - 100

                • MinimumRetentionrequired — (map)

                  The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                  • Typerequired — (String)

                    Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                    Possible values include:
                    • "SECONDS"
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "INFINITE"
                    • "UNSPECIFIED"
                  • Value — (Integer)

                    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                    • Seconds: 0 - 65,535

                    • Minutes: 0 - 65,535

                    • Hours: 0 - 24

                    • Days: 0 - 365

                    • Months: 0 - 12

                    • Years: 0 - 100

                • MaximumRetentionrequired — (map)

                  The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                  • Typerequired — (String)

                    Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                    Possible values include:
                    • "SECONDS"
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "INFINITE"
                    • "UNSPECIFIED"
                  • Value — (Integer)

                    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                    • Seconds: 0 - 65,535

                    • Minutes: 0 - 65,535

                    • Hours: 0 - 24

                    • Days: 0 - 365

                    • Months: 0 - 12

                    • Years: 0 - 100

              • SnaplockType — (String)

                Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

                • COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

                • ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

                Possible values include:
                • "COMPLIANCE"
                • "ENTERPRISE"
              • VolumeAppendModeEnabled — (Boolean)

                Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

                For more information, see Volume-append mode.

            • VolumeStyle — (String)

              Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

              Possible values include:
              • "FLEXVOL"
              • "FLEXGROUP"
            • AggregateConfiguration — (map)

              This structure specifies configuration options for a volume’s storage aggregate or aggregates.

              • Aggregates — (Array<String>)

                The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                • The strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 12.

                • The value of Aggregates contains aggregates that are not present.

                • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.

              • TotalConstituents — (Integer)

                The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.

            • SizeInBytes — (Integer)

              The configured size of the volume, in bytes.

          • ResourceARN — (String)

            The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

          • Tags — (Array<map>)

            A list of Tag values, with a maximum of 50 elements.

            • Keyrequired — (String)

              A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

            • Valuerequired — (String)

              A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

          • VolumeId — (String)

            The system-generated, unique ID of the volume.

          • VolumeType — (String)

            The type of the volume.

            Possible values include:
            • "ONTAP"
            • "OPENZFS"
          • LifecycleTransitionReason — (map)

            The reason why the volume lifecycle status changed.

            • Message — (String)

              A detailed error message.

          • AdministrativeActions — (Array<map>)

            A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

            • AdministrativeActionType — (String)

              Describes the type of administrative action, as follows:

              • FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

              • THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

              • STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

                • For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

                • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

                You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

              • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

              • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

              • IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

              • STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

              • VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

              • VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

              • SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

              • RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

              • DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

              • VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

              • VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

              Possible values include:
              • "FILE_SYSTEM_UPDATE"
              • "STORAGE_OPTIMIZATION"
              • "FILE_SYSTEM_ALIAS_ASSOCIATION"
              • "FILE_SYSTEM_ALIAS_DISASSOCIATION"
              • "VOLUME_UPDATE"
              • "SNAPSHOT_UPDATE"
              • "RELEASE_NFS_V3_LOCKS"
              • "VOLUME_RESTORE"
              • "THROUGHPUT_OPTIMIZATION"
              • "IOPS_OPTIMIZATION"
              • "STORAGE_TYPE_OPTIMIZATION"
              • "MISCONFIGURED_STATE_RECOVERY"
              • "VOLUME_UPDATE_WITH_SNAPSHOT"
              • "VOLUME_INITIALIZE_WITH_SNAPSHOT"
              • "DOWNLOAD_DATA_FROM_BACKUP"
            • ProgressPercent — (Integer)

              The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

            • RequestTime — (Date)

              The time that the administrative action request was received.

            • Status — (String)

              The status of the administrative action, as follows:

              • FAILED - Amazon FSx failed to process the administrative action successfully.

              • IN_PROGRESS - Amazon FSx is processing the administrative action.

              • PENDING - Amazon FSx is waiting to process the administrative action.

              • COMPLETED - Amazon FSx has finished processing the administrative task.

                For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

              • UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

              • PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

              • IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

              Possible values include:
              • "FAILED"
              • "IN_PROGRESS"
              • "PENDING"
              • "COMPLETED"
              • "UPDATED_OPTIMIZING"
              • "OPTIMIZING"
            • TargetFileSystemValues — (map)

              The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

              • OwnerId — (String)

                The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

              • CreationTime — (Date)

                The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

              • FileSystemId — (String)

                The system-generated, unique 17-digit ID of the file system.

              • FileSystemType — (String)

                The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

                Possible values include:
                • "WINDOWS"
                • "LUSTRE"
                • "ONTAP"
                • "OPENZFS"
              • Lifecycle — (String)

                The lifecycle status of the file system. The following are the possible values and what they mean:

                • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

                • CREATING - Amazon FSx is creating the new file system.

                • DELETING - Amazon FSx is deleting an existing file system.

                • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

                • MISCONFIGURED - The file system is in a failed but recoverable state.

                • MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

                • UPDATING - The file system is undergoing a customer-initiated update.

                Possible values include:
                • "AVAILABLE"
                • "CREATING"
                • "FAILED"
                • "DELETING"
                • "MISCONFIGURED"
                • "UPDATING"
                • "MISCONFIGURED_UNAVAILABLE"
              • FailureDetails — (map)

                A structure providing details of any failures that occurred.

                • Message — (String)

                  A message describing any failures that occurred.

              • StorageCapacity — (Integer)

                The storage capacity of the file system in gibibytes (GiB).

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

              • StorageType — (String)

                The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

                Possible values include:
                • "SSD"
                • "HDD"
              • VpcId — (String)

                The ID of the primary virtual private cloud (VPC) for the file system.

              • SubnetIds — (Array<String>)

                Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

                For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

              • NetworkInterfaceIds — (Array<String>)

                The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

                For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

              • DNSName — (String)

                The Domain Name System (DNS) name for the file system.

              • KmsKeyId — (String)

                The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

                • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

                  SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

                • Amazon FSx for NetApp ONTAP

                • Amazon FSx for OpenZFS

                • Amazon FSx for Windows File Server

              • ResourceARN — (String)

                The Amazon Resource Name (ARN) of the file system resource.

              • Tags — (Array<map>)

                The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

                • Keyrequired — (String)

                  A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

                • Valuerequired — (String)

                  A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

              • WindowsConfiguration — (map)

                The configuration for this Amazon FSx for Windows File Server file system.

                • ActiveDirectoryId — (String)

                  The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

                • SelfManagedActiveDirectoryConfiguration — (map)

                  The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

                  • DomainName — (String)

                    The fully qualified domain name of the self-managed AD directory.

                  • OrganizationalUnitDistinguishedName — (String)

                    The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

                  • FileSystemAdministratorsGroup — (String)

                    The name of the domain group whose members have administrative privileges for the FSx file system.

                  • UserName — (String)

                    The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

                  • DnsIps — (Array<String>)

                    A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

                • DeploymentType — (String)

                  Specifies the file system deployment type, valid values are the following:

                  • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

                  • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

                  • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

                  For more information, see Single-AZ and Multi-AZ File Systems.

                  Possible values include:
                  • "MULTI_AZ_1"
                  • "SINGLE_AZ_1"
                  • "SINGLE_AZ_2"
                • RemoteAdministrationEndpoint — (String)

                  For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

                  For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

                  This endpoint is temporarily unavailable when the file system is undergoing maintenance.

                • PreferredSubnetId — (String)

                  For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

                  For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

                • PreferredFileServerIp — (String)

                  For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

                  Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

                • ThroughputCapacity — (Integer)

                  The throughput of the Amazon FSx file system, measured in megabytes per second.

                • MaintenanceOperationsInProgress — (Array<String>)

                  The list of maintenance operations in progress for this file system.

                • WeeklyMaintenanceStartTime — (String)

                  The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

                • DailyAutomaticBackupStartTime — (String)

                  The preferred time to take daily automatic backups, in the UTC time zone.

                • AutomaticBackupRetentionDays — (Integer)

                  The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

                • CopyTagsToBackups — (Boolean)

                  A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

                • Aliases — (Array<map>)

                  An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

                  • Name — (String)

                    The name of the DNS alias. The alias name has to meet the following requirements:

                    • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

                    • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

                    • Cannot start or end with a hyphen.

                    • Can start with a numeric.

                    For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

                  • Lifecycle — (String)

                    Describes the state of the DNS alias.

                    • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

                    • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

                    • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

                    • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

                    • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

                    Possible values include:
                    • "AVAILABLE"
                    • "CREATING"
                    • "DELETING"
                    • "CREATE_FAILED"
                    • "DELETE_FAILED"
                • AuditLogConfiguration — (map)

                  The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

                  • FileAccessAuditLogLevelrequired — (String)

                    Sets which attempt type is logged by Amazon FSx for file and folder accesses.

                    • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

                    • FAILURE_ONLY - only failed attempts to access files or folders are logged.

                    • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

                    • DISABLED - access auditing of files and folders is turned off.

                    Possible values include:
                    • "DISABLED"
                    • "SUCCESS_ONLY"
                    • "FAILURE_ONLY"
                    • "SUCCESS_AND_FAILURE"
                  • FileShareAccessAuditLogLevelrequired — (String)

                    Sets which attempt type is logged by Amazon FSx for file share accesses.

                    • SUCCESS_ONLY - only successful attempts to access file shares are logged.

                    • FAILURE_ONLY - only failed attempts to access file shares are logged.

                    • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

                    • DISABLED - access auditing of file shares is turned off.

                    Possible values include:
                    • "DISABLED"
                    • "SUCCESS_ONLY"
                    • "FAILURE_ONLY"
                    • "SUCCESS_AND_FAILURE"
                  • AuditLogDestination — (String)

                    The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

                    The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

                    The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

                • DiskIopsConfiguration — (map)

                  The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

                  • Mode — (String)

                    Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                    Possible values include:
                    • "AUTOMATIC"
                    • "USER_PROVISIONED"
                  • Iops — (Integer)

                    The total number of SSD IOPS provisioned for the file system.

                    The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                    Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

              • LustreConfiguration — (map)

                The configuration for the Amazon FSx for Lustre file system.

                • WeeklyMaintenanceStartTime — (String)

                  The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

                • DataRepositoryConfiguration — (map)

                  The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

                  This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

                  • Lifecycle — (String)

                    Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

                    • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

                    • AVAILABLE - The data repository is available for use.

                    • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

                    • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

                    • FAILED - The data repository is in a terminal state that cannot be recovered.

                    Possible values include:
                    • "CREATING"
                    • "AVAILABLE"
                    • "MISCONFIGURED"
                    • "UPDATING"
                    • "DELETING"
                    • "FAILED"
                  • ImportPath — (String)

                    The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

                  • ExportPath — (String)

                    The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

                  • ImportedFileChunkSize — (Integer)

                    For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

                    The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

                  • AutoImportPolicy — (String)

                    Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

                    • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

                    • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

                    • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

                    • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

                    Possible values include:
                    • "NONE"
                    • "NEW"
                    • "NEW_CHANGED"
                    • "NEW_CHANGED_DELETED"
                  • FailureDetails — (map)

                    Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

                    • Message — (String)

                      A detailed error message.

                • DeploymentType — (String)

                  The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

                  SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

                  The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

                  The default is SCRATCH_1.

                  Possible values include:
                  • "SCRATCH_1"
                  • "SCRATCH_2"
                  • "PERSISTENT_1"
                  • "PERSISTENT_2"
                • PerUnitStorageThroughput — (Integer)

                  Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

                  Valid values:

                  • For PERSISTENT_1 SSD storage: 50, 100, 200.

                  • For PERSISTENT_1 HDD storage: 12, 40.

                  • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

                • MountName — (String)

                  You use the MountName value when mounting the file system.

                  For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

                • DailyAutomaticBackupStartTime — (String)

                  A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

                • AutomaticBackupRetentionDays — (Integer)

                  The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

                • CopyTagsToBackups — (Boolean)

                  A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

                • DriveCacheType — (String)

                  The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

                  This parameter is required when StorageType is set to HDD.

                  Possible values include:
                  • "NONE"
                  • "READ"
                • DataCompressionType — (String)

                  The data compression configuration for the file system. DataCompressionType can have the following values:

                  • NONE - Data compression is turned off for the file system.

                  • LZ4 - Data compression is turned on with the LZ4 algorithm.

                  For more information, see Lustre data compression.

                  Possible values include:
                  • "NONE"
                  • "LZ4"
                • LogConfiguration — (map)

                  The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

                  • Levelrequired — (String)

                    The data repository events that are logged by Amazon FSx.

                    • WARN_ONLY - only warning events are logged.

                    • ERROR_ONLY - only error events are logged.

                    • WARN_ERROR - both warning events and error events are logged.

                    • DISABLED - logging of data repository events is turned off.

                    Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

                    Possible values include:
                    • "DISABLED"
                    • "WARN_ONLY"
                    • "ERROR_ONLY"
                    • "WARN_ERROR"
                  • Destination — (String)

                    The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

                • RootSquashConfiguration — (map)

                  The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

                  • RootSquash — (String)

                    You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

                    • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

                    • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

                    When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

                  • NoSquashNids — (Array<String>)

                    When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

                    • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

                    • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

                • MetadataConfiguration — (map)

                  The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

                  • Iops — (Integer)

                    The number of Metadata IOPS provisioned for the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

                  • Moderequired — (String)

                    The metadata configuration mode for provisioning Metadata IOPS for the file system.

                    • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity.

                    • In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system.

                    Possible values include:
                    • "AUTOMATIC"
                    • "USER_PROVISIONED"
              • OntapConfiguration — (map)

                The configuration for this Amazon FSx for NetApp ONTAP file system.

                • AutomaticBackupRetentionDays — (Integer)

                  The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

                • DailyAutomaticBackupStartTime — (String)

                  A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

                • DeploymentType — (String)

                  Specifies the FSx for ONTAP file system deployment type in use in the file system.

                  • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

                  • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

                  • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

                  • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

                  For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

                  Possible values include:
                  • "MULTI_AZ_1"
                  • "SINGLE_AZ_1"
                  • "SINGLE_AZ_2"
                  • "MULTI_AZ_2"
                • EndpointIpAddressRange — (String)

                  (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

                • Endpoints — (map)

                  The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

                  • Intercluster — (map)

                    An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

                    • DNSName — (String)

                      The file system's DNS name. You can mount your file system using its DNS name.

                    • IpAddresses — (Array<String>)

                      IP addresses of the file system endpoint.

                  • Management — (map)

                    An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

                    • DNSName — (String)

                      The file system's DNS name. You can mount your file system using its DNS name.

                    • IpAddresses — (Array<String>)

                      IP addresses of the file system endpoint.

                • DiskIopsConfiguration — (map)

                  The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

                  • Mode — (String)

                    Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                    Possible values include:
                    • "AUTOMATIC"
                    • "USER_PROVISIONED"
                  • Iops — (Integer)

                    The total number of SSD IOPS provisioned for the file system.

                    The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                    Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

                • PreferredSubnetId — (String)

                  The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

                • RouteTableIds — (Array<String>)

                  (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

                • ThroughputCapacity — (Integer)

                  The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

                • WeeklyMaintenanceStartTime — (String)

                  A recurring weekly time, in the format D:HH:MM.

                  D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

                  HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

                  For example, 1:05:00 specifies maintenance at 5 AM Monday.

                • FsxAdminPassword — (String)

                  You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.

                • HAPairs — (Integer)

                  Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                  • The value of HAPairs is less than 1 or greater than 12.

                  • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.

                • ThroughputCapacityPerHAPair — (Integer)

                  Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

                  This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

                  This field and ThroughputCapacity are the same for file systems with one HA pair.

                  • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

                  • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

                  • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                  • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

                  • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

                  • The value of ThroughputCapacityPerHAPair is not a valid value.

              • FileSystemTypeVersion — (String)

                The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

              • OpenZFSConfiguration — (map)

                The configuration for this Amazon FSx for OpenZFS file system.

                • AutomaticBackupRetentionDays — (Integer)

                  The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

                • CopyTagsToBackups — (Boolean)

                  A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

                • CopyTagsToVolumes — (Boolean)

                  A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

                • DailyAutomaticBackupStartTime — (String)

                  A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

                • DeploymentType — (String)

                  Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

                  Possible values include:
                  • "SINGLE_AZ_1"
                  • "SINGLE_AZ_2"
                  • "SINGLE_AZ_HA_1"
                  • "SINGLE_AZ_HA_2"
                  • "MULTI_AZ_1"
                • ThroughputCapacity — (Integer)

                  The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

                • WeeklyMaintenanceStartTime — (String)

                  A recurring weekly time, in the format D:HH:MM.

                  D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

                  HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

                  For example, 1:05:00 specifies maintenance at 5 AM Monday.

                • DiskIopsConfiguration — (map)

                  The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

                  • Mode — (String)

                    Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                    Possible values include:
                    • "AUTOMATIC"
                    • "USER_PROVISIONED"
                  • Iops — (Integer)

                    The total number of SSD IOPS provisioned for the file system.

                    The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                    Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

                • RootVolumeId — (String)

                  The ID of the root volume of the OpenZFS file system.

                • PreferredSubnetId — (String)

                  Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

                • EndpointIpAddressRange — (String)

                  (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

                • RouteTableIds — (Array<String>)

                  (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

                • EndpointIpAddress — (String)

                  The IP address of the endpoint that is used to access data or to manage the file system.

            • FailureDetails — (map)

              Provides information about a failed administrative action.

              • Message — (String)

                Error message providing details about the failed administrative action.

            • TargetSnapshotValues — (map)

              A snapshot of an Amazon FSx for OpenZFS volume.

              • ResourceARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • SnapshotId — (String)

                The ID of the snapshot.

              • Name — (String)

                The name of the snapshot.

              • VolumeId — (String)

                The ID of the volume that the snapshot is of.

              • CreationTime — (Date)

                The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

              • Lifecycle — (String)

                The lifecycle status of the snapshot.

                • PENDING - Amazon FSx hasn't started creating the snapshot.

                • CREATING - Amazon FSx is creating the snapshot.

                • DELETING - Amazon FSx is deleting the snapshot.

                • AVAILABLE - The snapshot is fully available.

                Possible values include:
                • "PENDING"
                • "CREATING"
                • "DELETING"
                • "AVAILABLE"
              • LifecycleTransitionReason — (map)

                Describes why a resource lifecycle state changed.

                • Message — (String)

                  A detailed error message.

              • Tags — (Array<map>)

                A list of Tag values, with a maximum of 50 elements.

                • Keyrequired — (String)

                  A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

                • Valuerequired — (String)

                  A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

            • TotalTransferBytes — (Integer)

              The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

            • RemainingTransferBytes — (Integer)

              The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

          • OpenZFSConfiguration — (map)

            The configuration of an Amazon FSx for OpenZFS volume.

            • ParentVolumeId — (String)

              The ID of the parent volume.

            • VolumePath — (String)

              The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

            • StorageCapacityReservationGiB — (Integer)

              The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

            • StorageCapacityQuotaGiB — (Integer)

              The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

            • RecordSizeKiB — (Integer)

              The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

            • DataCompressionType — (String)

              Specifies the method used to compress the data on the volume. The compression type is NONE by default.

              • NONE - Doesn't compress the data on the volume. NONE is the default.

              • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

              • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

              Possible values include:
              • "NONE"
              • "ZSTD"
              • "LZ4"
            • CopyTagsToSnapshots — (Boolean)

              A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

            • OriginSnapshot — (map)

              The configuration object that specifies the snapshot to use as the origin of the data for the volume.

              • SnapshotARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • CopyStrategy — (String)

                The strategy used when copying data from the snapshot to the new volume.

                • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                • FULL_COPY - Copies all data from the snapshot to the new volume.

                Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                Possible values include:
                • "CLONE"
                • "FULL_COPY"
                • "INCREMENTAL_COPY"
            • ReadOnly — (Boolean)

              A Boolean value indicating whether the volume is read-only.

            • NfsExports — (Array<map>)

              The configuration object for mounting a Network File System (NFS) file system.

              • ClientConfigurationsrequired — (Array<map>)

                A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

                • Clientsrequired — (String)

                  A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.

                • Optionsrequired — (Array<String>)

                  The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:

                  • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.

                  • sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

            • UserAndGroupQuotas — (Array<map>)

              An object specifying how much storage users or groups can use on the volume.

              • Typerequired — (String)

                Specifies whether the quota applies to a user or group.

                Possible values include:
                • "USER"
                • "GROUP"
              • Idrequired — (Integer)

                The ID of the user or group that the quota applies to.

              • StorageCapacityQuotaGiBrequired — (Integer)

                The user or group's storage quota, in gibibytes (GiB).

            • RestoreToSnapshot — (String)

              Specifies the ID of the snapshot to which the volume was restored.

            • DeleteIntermediateSnaphots — (Boolean)

              A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

            • DeleteClonedVolumes — (Boolean)

              A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

            • DeleteIntermediateData — (Boolean)

              A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

            • SourceSnapshotARN — (String)

              The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

            • DestinationSnapshot — (String)

              The ID of the snapshot that's being copied or was most recently copied to the destination volume.

            • CopyStrategy — (String)

              Specifies the strategy used when copying data from the snapshot to the new volume.

              • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

              • FULL_COPY - Copies all data from the snapshot to the new volume.

                Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

              Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
              Possible values include:
              • "CLONE"
              • "FULL_COPY"
              • "INCREMENTAL_COPY"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

copySnapshotAndUpdateVolume(params = {}, callback) ⇒ AWS.Request

Updates an existing volume by using a snapshot from another Amazon FSx for OpenZFS file system. For more information, see on-demand data replication in the Amazon FSx for OpenZFS User Guide.

Service Reference:

Examples:

Calling the copySnapshotAndUpdateVolume operation

var params = {
  SourceSnapshotARN: 'STRING_VALUE', /* required */
  VolumeId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  CopyStrategy: CLONE | FULL_COPY | INCREMENTAL_COPY,
  Options: [
    DELETE_INTERMEDIATE_SNAPSHOTS | DELETE_CLONED_VOLUMES | DELETE_INTERMEDIATE_DATA,
    /* more items */
  ]
};
fsx.copySnapshotAndUpdateVolume(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientRequestToken — (String)

      (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • VolumeId — (String)

      Specifies the ID of the volume that you are copying the snapshot to.

    • SourceSnapshotARN — (String)

      The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

    • CopyStrategy — (String)

      Specifies the strategy to use when copying data from a snapshot to the volume.

      • FULL_COPY - Copies all data from the snapshot to the volume.

      • INCREMENTAL_COPY - Copies only the snapshot data that's changed since the previous replication.

      Note: CLONE isn't a valid copy strategy option for the CopySnapshotAndUpdateVolume operation.
      Possible values include:
      • "CLONE"
      • "FULL_COPY"
      • "INCREMENTAL_COPY"
    • Options — (Array<String>)

      Confirms that you want to delete data on the destination volume that wasn’t there during the previous snapshot replication.

      Your replication will fail if you don’t include an option for a specific type of data and that data is on your destination. For example, if you don’t include DELETE_INTERMEDIATE_SNAPSHOTS and there are intermediate snapshots on the destination, you can’t copy the snapshot.

      • DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots on the destination volume that aren’t on the source volume.

      • DELETE_CLONED_VOLUMES - Deletes snapshot clones on the destination volume that aren't on the source volume.

      • DELETE_INTERMEDIATE_DATA - Overwrites snapshots on the destination volume that don’t match the source snapshot that you’re copying.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • VolumeId — (String)

        The ID of the volume that you copied the snapshot to.

      • Lifecycle — (String)

        The lifecycle state of the destination volume.

        Possible values include:
        • "CREATING"
        • "CREATED"
        • "DELETING"
        • "FAILED"
        • "MISCONFIGURED"
        • "PENDING"
        • "AVAILABLE"
      • AdministrativeActions — (Array<map>)

        A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

        • AdministrativeActionType — (String)

          Describes the type of administrative action, as follows:

          • FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

          • THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.

            You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

          • STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

            • For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

            • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

            You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

          • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

          • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

          • IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.

            You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

          • STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.

            You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

          • VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

          • VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

          • SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

          • RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

          • DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

          • VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

          • VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

          Possible values include:
          • "FILE_SYSTEM_UPDATE"
          • "STORAGE_OPTIMIZATION"
          • "FILE_SYSTEM_ALIAS_ASSOCIATION"
          • "FILE_SYSTEM_ALIAS_DISASSOCIATION"
          • "VOLUME_UPDATE"
          • "SNAPSHOT_UPDATE"
          • "RELEASE_NFS_V3_LOCKS"
          • "VOLUME_RESTORE"
          • "THROUGHPUT_OPTIMIZATION"
          • "IOPS_OPTIMIZATION"
          • "STORAGE_TYPE_OPTIMIZATION"
          • "MISCONFIGURED_STATE_RECOVERY"
          • "VOLUME_UPDATE_WITH_SNAPSHOT"
          • "VOLUME_INITIALIZE_WITH_SNAPSHOT"
          • "DOWNLOAD_DATA_FROM_BACKUP"
        • ProgressPercent — (Integer)

          The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

        • RequestTime — (Date)

          The time that the administrative action request was received.

        • Status — (String)

          The status of the administrative action, as follows:

          • FAILED - Amazon FSx failed to process the administrative action successfully.

          • IN_PROGRESS - Amazon FSx is processing the administrative action.

          • PENDING - Amazon FSx is waiting to process the administrative action.

          • COMPLETED - Amazon FSx has finished processing the administrative task.

            For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

          • UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

          • PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

          • IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

          Possible values include:
          • "FAILED"
          • "IN_PROGRESS"
          • "PENDING"
          • "COMPLETED"
          • "UPDATED_OPTIMIZING"
          • "OPTIMIZING"
        • TargetFileSystemValues — (map)

          The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

          • OwnerId — (String)

            The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

          • CreationTime — (Date)

            The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

          • FileSystemId — (String)

            The system-generated, unique 17-digit ID of the file system.

          • FileSystemType — (String)

            The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

            Possible values include:
            • "WINDOWS"
            • "LUSTRE"
            • "ONTAP"
            • "OPENZFS"
          • Lifecycle — (String)

            The lifecycle status of the file system. The following are the possible values and what they mean:

            • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

            • CREATING - Amazon FSx is creating the new file system.

            • DELETING - Amazon FSx is deleting an existing file system.

            • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

            • MISCONFIGURED - The file system is in a failed but recoverable state.

            • MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

            • UPDATING - The file system is undergoing a customer-initiated update.

            Possible values include:
            • "AVAILABLE"
            • "CREATING"
            • "FAILED"
            • "DELETING"
            • "MISCONFIGURED"
            • "UPDATING"
            • "MISCONFIGURED_UNAVAILABLE"
          • FailureDetails — (map)

            A structure providing details of any failures that occurred.

            • Message — (String)

              A message describing any failures that occurred.

          • StorageCapacity — (Integer)

            The storage capacity of the file system in gibibytes (GiB).

            Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

          • StorageType — (String)

            The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

            Possible values include:
            • "SSD"
            • "HDD"
          • VpcId — (String)

            The ID of the primary virtual private cloud (VPC) for the file system.

          • SubnetIds — (Array<String>)

            Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

            For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

          • NetworkInterfaceIds — (Array<String>)

            The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

            For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

          • DNSName — (String)

            The Domain Name System (DNS) name for the file system.

          • KmsKeyId — (String)

            The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

            • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

              SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

            • Amazon FSx for NetApp ONTAP

            • Amazon FSx for OpenZFS

            • Amazon FSx for Windows File Server

          • ResourceARN — (String)

            The Amazon Resource Name (ARN) of the file system resource.

          • Tags — (Array<map>)

            The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

            • Keyrequired — (String)

              A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

            • Valuerequired — (String)

              A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

          • WindowsConfiguration — (map)

            The configuration for this Amazon FSx for Windows File Server file system.

            • ActiveDirectoryId — (String)

              The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

            • SelfManagedActiveDirectoryConfiguration — (map)

              The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

              • DomainName — (String)

                The fully qualified domain name of the self-managed AD directory.

              • OrganizationalUnitDistinguishedName — (String)

                The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

              • FileSystemAdministratorsGroup — (String)

                The name of the domain group whose members have administrative privileges for the FSx file system.

              • UserName — (String)

                The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

              • DnsIps — (Array<String>)

                A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

            • DeploymentType — (String)

              Specifies the file system deployment type, valid values are the following:

              • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

              • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

              • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

              For more information, see Single-AZ and Multi-AZ File Systems.

              Possible values include:
              • "MULTI_AZ_1"
              • "SINGLE_AZ_1"
              • "SINGLE_AZ_2"
            • RemoteAdministrationEndpoint — (String)

              For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

              For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

              This endpoint is temporarily unavailable when the file system is undergoing maintenance.

            • PreferredSubnetId — (String)

              For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

              For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

            • PreferredFileServerIp — (String)

              For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

              Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

            • ThroughputCapacity — (Integer)

              The throughput of the Amazon FSx file system, measured in megabytes per second.

            • MaintenanceOperationsInProgress — (Array<String>)

              The list of maintenance operations in progress for this file system.

            • WeeklyMaintenanceStartTime — (String)

              The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

            • DailyAutomaticBackupStartTime — (String)

              The preferred time to take daily automatic backups, in the UTC time zone.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

            • CopyTagsToBackups — (Boolean)

              A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

            • Aliases — (Array<map>)

              An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

              • Name — (String)

                The name of the DNS alias. The alias name has to meet the following requirements:

                • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

                • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

                • Cannot start or end with a hyphen.

                • Can start with a numeric.

                For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

              • Lifecycle — (String)

                Describes the state of the DNS alias.

                • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

                • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

                • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

                • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

                • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

                Possible values include:
                • "AVAILABLE"
                • "CREATING"
                • "DELETING"
                • "CREATE_FAILED"
                • "DELETE_FAILED"
            • AuditLogConfiguration — (map)

              The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

              • FileAccessAuditLogLevelrequired — (String)

                Sets which attempt type is logged by Amazon FSx for file and folder accesses.

                • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

                • FAILURE_ONLY - only failed attempts to access files or folders are logged.

                • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

                • DISABLED - access auditing of files and folders is turned off.

                Possible values include:
                • "DISABLED"
                • "SUCCESS_ONLY"
                • "FAILURE_ONLY"
                • "SUCCESS_AND_FAILURE"
              • FileShareAccessAuditLogLevelrequired — (String)

                Sets which attempt type is logged by Amazon FSx for file share accesses.

                • SUCCESS_ONLY - only successful attempts to access file shares are logged.

                • FAILURE_ONLY - only failed attempts to access file shares are logged.

                • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

                • DISABLED - access auditing of file shares is turned off.

                Possible values include:
                • "DISABLED"
                • "SUCCESS_ONLY"
                • "FAILURE_ONLY"
                • "SUCCESS_AND_FAILURE"
              • AuditLogDestination — (String)

                The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

                The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

                The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

            • DiskIopsConfiguration — (map)

              The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

              • Mode — (String)

                Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
              • Iops — (Integer)

                The total number of SSD IOPS provisioned for the file system.

                The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

          • LustreConfiguration — (map)

            The configuration for the Amazon FSx for Lustre file system.

            • WeeklyMaintenanceStartTime — (String)

              The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

            • DataRepositoryConfiguration — (map)

              The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

              This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

              • Lifecycle — (String)

                Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

                • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

                • AVAILABLE - The data repository is available for use.

                • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

                • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

                • FAILED - The data repository is in a terminal state that cannot be recovered.

                Possible values include:
                • "CREATING"
                • "AVAILABLE"
                • "MISCONFIGURED"
                • "UPDATING"
                • "DELETING"
                • "FAILED"
              • ImportPath — (String)

                The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

              • ExportPath — (String)

                The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

              • ImportedFileChunkSize — (Integer)

                For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

                The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

              • AutoImportPolicy — (String)

                Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

                • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

                • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

                • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

                • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

                Possible values include:
                • "NONE"
                • "NEW"
                • "NEW_CHANGED"
                • "NEW_CHANGED_DELETED"
              • FailureDetails — (map)

                Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

                • Message — (String)

                  A detailed error message.

            • DeploymentType — (String)

              The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

              SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

              The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

              The default is SCRATCH_1.

              Possible values include:
              • "SCRATCH_1"
              • "SCRATCH_2"
              • "PERSISTENT_1"
              • "PERSISTENT_2"
            • PerUnitStorageThroughput — (Integer)

              Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

              Valid values:

              • For PERSISTENT_1 SSD storage: 50, 100, 200.

              • For PERSISTENT_1 HDD storage: 12, 40.

              • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

            • MountName — (String)

              You use the MountName value when mounting the file system.

              For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

            • DailyAutomaticBackupStartTime — (String)

              A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

            • CopyTagsToBackups — (Boolean)

              A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

            • DriveCacheType — (String)

              The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

              This parameter is required when StorageType is set to HDD.

              Possible values include:
              • "NONE"
              • "READ"
            • DataCompressionType — (String)

              The data compression configuration for the file system. DataCompressionType can have the following values:

              • NONE - Data compression is turned off for the file system.

              • LZ4 - Data compression is turned on with the LZ4 algorithm.

              For more information, see Lustre data compression.

              Possible values include:
              • "NONE"
              • "LZ4"
            • LogConfiguration — (map)

              The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

              • Levelrequired — (String)

                The data repository events that are logged by Amazon FSx.

                • WARN_ONLY - only warning events are logged.

                • ERROR_ONLY - only error events are logged.

                • WARN_ERROR - both warning events and error events are logged.

                • DISABLED - logging of data repository events is turned off.

                Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

                Possible values include:
                • "DISABLED"
                • "WARN_ONLY"
                • "ERROR_ONLY"
                • "WARN_ERROR"
              • Destination — (String)

                The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

            • RootSquashConfiguration — (map)

              The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

              • RootSquash — (String)

                You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

                • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

                • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

                When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

              • NoSquashNids — (Array<String>)

                When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

                • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

                • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

            • MetadataConfiguration — (map)

              The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

              • Iops — (Integer)

                The number of Metadata IOPS provisioned for the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

              • Moderequired — (String)

                The metadata configuration mode for provisioning Metadata IOPS for the file system.

                • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity.

                • In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
          • AdministrativeActions — (Array<map>)

            A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the UpdateFileSystem operation.

          • OntapConfiguration — (map)

            The configuration for this Amazon FSx for NetApp ONTAP file system.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

            • DailyAutomaticBackupStartTime — (String)

              A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

            • DeploymentType — (String)

              Specifies the FSx for ONTAP file system deployment type in use in the file system.

              • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

              • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

              • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

              • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

              For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

              Possible values include:
              • "MULTI_AZ_1"
              • "SINGLE_AZ_1"
              • "SINGLE_AZ_2"
              • "MULTI_AZ_2"
            • EndpointIpAddressRange — (String)

              (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

            • Endpoints — (map)

              The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

              • Intercluster — (map)

                An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

                • DNSName — (String)

                  The file system's DNS name. You can mount your file system using its DNS name.

                • IpAddresses — (Array<String>)

                  IP addresses of the file system endpoint.

              • Management — (map)

                An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

                • DNSName — (String)

                  The file system's DNS name. You can mount your file system using its DNS name.

                • IpAddresses — (Array<String>)

                  IP addresses of the file system endpoint.

            • DiskIopsConfiguration — (map)

              The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

              • Mode — (String)

                Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
              • Iops — (Integer)

                The total number of SSD IOPS provisioned for the file system.

                The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

            • PreferredSubnetId — (String)

              The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

            • RouteTableIds — (Array<String>)

              (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

            • ThroughputCapacity — (Integer)

              The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

            • WeeklyMaintenanceStartTime — (String)

              A recurring weekly time, in the format D:HH:MM.

              D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

              HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

              For example, 1:05:00 specifies maintenance at 5 AM Monday.

            • FsxAdminPassword — (String)

              You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.

            • HAPairs — (Integer)

              Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

              Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

              • The value of HAPairs is less than 1 or greater than 12.

              • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.

            • ThroughputCapacityPerHAPair — (Integer)

              Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

              This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

              This field and ThroughputCapacity are the same for file systems with one HA pair.

              • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

              • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

              • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

              Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

              • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

              • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

              • The value of ThroughputCapacityPerHAPair is not a valid value.

          • FileSystemTypeVersion — (String)

            The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

          • OpenZFSConfiguration — (map)

            The configuration for this Amazon FSx for OpenZFS file system.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

            • CopyTagsToBackups — (Boolean)

              A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

            • CopyTagsToVolumes — (Boolean)

              A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

            • DailyAutomaticBackupStartTime — (String)

              A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

            • DeploymentType — (String)

              Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

              Possible values include:
              • "SINGLE_AZ_1"
              • "SINGLE_AZ_2"
              • "SINGLE_AZ_HA_1"
              • "SINGLE_AZ_HA_2"
              • "MULTI_AZ_1"
            • ThroughputCapacity — (Integer)

              The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

            • WeeklyMaintenanceStartTime — (String)

              A recurring weekly time, in the format D:HH:MM.

              D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

              HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

              For example, 1:05:00 specifies maintenance at 5 AM Monday.

            • DiskIopsConfiguration — (map)

              The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

              • Mode — (String)

                Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
              • Iops — (Integer)

                The total number of SSD IOPS provisioned for the file system.

                The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

            • RootVolumeId — (String)

              The ID of the root volume of the OpenZFS file system.

            • PreferredSubnetId — (String)

              Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

            • EndpointIpAddressRange — (String)

              (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

            • RouteTableIds — (Array<String>)

              (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

            • EndpointIpAddress — (String)

              The IP address of the endpoint that is used to access data or to manage the file system.

        • FailureDetails — (map)

          Provides information about a failed administrative action.

          • Message — (String)

            Error message providing details about the failed administrative action.

        • TargetVolumeValues — (map)

          Describes an Amazon FSx volume.

          • CreationTime — (Date)

            The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

          • FileSystemId — (String)

            The globally unique ID of the file system, assigned by Amazon FSx.

          • Lifecycle — (String)

            The lifecycle status of the volume.

            • AVAILABLE - The volume is fully available for use.

            • CREATED - The volume has been created.

            • CREATING - Amazon FSx is creating the new volume.

            • DELETING - Amazon FSx is deleting an existing volume.

            • FAILED - Amazon FSx was unable to create the volume.

            • MISCONFIGURED - The volume is in a failed but recoverable state.

            • PENDING - Amazon FSx hasn't started creating the volume.

            Possible values include:
            • "CREATING"
            • "CREATED"
            • "DELETING"
            • "FAILED"
            • "MISCONFIGURED"
            • "PENDING"
            • "AVAILABLE"
          • Name — (String)

            The name of the volume.

          • OntapConfiguration — (map)

            The configuration of an Amazon FSx for NetApp ONTAP volume.

            • FlexCacheEndpointType — (String)

              Specifies the FlexCache endpoint type of the volume. Valid values are the following:

              • NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

              • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

              • CACHE specifies that the volume is a FlexCache volume.

              Possible values include:
              • "NONE"
              • "ORIGIN"
              • "CACHE"
            • JunctionPath — (String)

              Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

            • SecurityStyle — (String)

              The security style for the volume, which can be UNIX, NTFS, or MIXED.

              Possible values include:
              • "UNIX"
              • "NTFS"
              • "MIXED"
            • SizeInMegabytes — (Integer)

              The configured size of the volume, in megabytes (MBs).

            • StorageEfficiencyEnabled — (Boolean)

              The volume's storage efficiency setting.

            • StorageVirtualMachineId — (String)

              The ID of the volume's storage virtual machine.

            • StorageVirtualMachineRoot — (Boolean)

              A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

              This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

            • TieringPolicy — (map)

              The volume's TieringPolicy setting.

              • CoolingPeriod — (Integer)

                Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.

              • Name — (String)

                Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

                • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

                • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

                • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

                • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

                Possible values include:
                • "SNAPSHOT_ONLY"
                • "AUTO"
                • "ALL"
                • "NONE"
            • UUID — (String)

              The volume's universally unique identifier (UUID).

            • OntapVolumeType — (String)

              Specifies the type of volume. Valid values are the following:

              • RW specifies a read/write volume. RW is the default.

              • DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

              • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

              Possible values include:
              • "RW"
              • "DP"
              • "LS"
            • SnapshotPolicy — (String)

              Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

              • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.

              • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.

              • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

              You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

              For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

            • CopyTagsToBackups — (Boolean)

              A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

            • SnaplockConfiguration — (map)

              The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

              • AuditLogVolume — (Boolean)

                Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

                For more information, see SnapLock audit log volumes.

              • AutocommitPeriod — (map)

                The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

                • Typerequired — (String)

                  Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.

                  Possible values include:
                  • "MINUTES"
                  • "HOURS"
                  • "DAYS"
                  • "MONTHS"
                  • "YEARS"
                  • "NONE"
                • Value — (Integer)

                  Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

                  • Minutes: 5 - 65,535

                  • Hours: 1 - 65,535

                  • Days: 1 - 3,650

                  • Months: 1 - 120

                  • Years: 1 - 10

              • PrivilegedDelete — (String)

                Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

                For more information, see Privileged delete.

                Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "PERMANENTLY_DISABLED"
              • RetentionPeriod — (map)

                Specifies the retention period of an FSx for ONTAP SnapLock volume.

                • DefaultRetentionrequired — (map)

                  The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

                  • Typerequired — (String)

                    Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                    Possible values include:
                    • "SECONDS"
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "INFINITE"
                    • "UNSPECIFIED"
                  • Value — (Integer)

                    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                    • Seconds: 0 - 65,535

                    • Minutes: 0 - 65,535

                    • Hours: 0 - 24

                    • Days: 0 - 365

                    • Months: 0 - 12

                    • Years: 0 - 100

                • MinimumRetentionrequired — (map)

                  The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                  • Typerequired — (String)

                    Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                    Possible values include:
                    • "SECONDS"
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "INFINITE"
                    • "UNSPECIFIED"
                  • Value — (Integer)

                    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                    • Seconds: 0 - 65,535

                    • Minutes: 0 - 65,535

                    • Hours: 0 - 24

                    • Days: 0 - 365

                    • Months: 0 - 12

                    • Years: 0 - 100

                • MaximumRetentionrequired — (map)

                  The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                  • Typerequired — (String)

                    Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                    Possible values include:
                    • "SECONDS"
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "INFINITE"
                    • "UNSPECIFIED"
                  • Value — (Integer)

                    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                    • Seconds: 0 - 65,535

                    • Minutes: 0 - 65,535

                    • Hours: 0 - 24

                    • Days: 0 - 365

                    • Months: 0 - 12

                    • Years: 0 - 100

              • SnaplockType — (String)

                Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

                • COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

                • ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

                Possible values include:
                • "COMPLIANCE"
                • "ENTERPRISE"
              • VolumeAppendModeEnabled — (Boolean)

                Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

                For more information, see Volume-append mode.

            • VolumeStyle — (String)

              Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

              Possible values include:
              • "FLEXVOL"
              • "FLEXGROUP"
            • AggregateConfiguration — (map)

              This structure specifies configuration options for a volume’s storage aggregate or aggregates.

              • Aggregates — (Array<String>)

                The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                • The strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 12.

                • The value of Aggregates contains aggregates that are not present.

                • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.

              • TotalConstituents — (Integer)

                The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.

            • SizeInBytes — (Integer)

              The configured size of the volume, in bytes.

          • ResourceARN — (String)

            The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

          • Tags — (Array<map>)

            A list of Tag values, with a maximum of 50 elements.

            • Keyrequired — (String)

              A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

            • Valuerequired — (String)

              A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

          • VolumeId — (String)

            The system-generated, unique ID of the volume.

          • VolumeType — (String)

            The type of the volume.

            Possible values include:
            • "ONTAP"
            • "OPENZFS"
          • LifecycleTransitionReason — (map)

            The reason why the volume lifecycle status changed.

            • Message — (String)

              A detailed error message.

          • AdministrativeActions — (Array<map>)

            A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

          • OpenZFSConfiguration — (map)

            The configuration of an Amazon FSx for OpenZFS volume.

            • ParentVolumeId — (String)

              The ID of the parent volume.

            • VolumePath — (String)

              The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

            • StorageCapacityReservationGiB — (Integer)

              The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

            • StorageCapacityQuotaGiB — (Integer)

              The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

            • RecordSizeKiB — (Integer)

              The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

            • DataCompressionType — (String)

              Specifies the method used to compress the data on the volume. The compression type is NONE by default.

              • NONE - Doesn't compress the data on the volume. NONE is the default.

              • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

              • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

              Possible values include:
              • "NONE"
              • "ZSTD"
              • "LZ4"
            • CopyTagsToSnapshots — (Boolean)

              A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

            • OriginSnapshot — (map)

              The configuration object that specifies the snapshot to use as the origin of the data for the volume.

              • SnapshotARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • CopyStrategy — (String)

                The strategy used when copying data from the snapshot to the new volume.

                • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                • FULL_COPY - Copies all data from the snapshot to the new volume.

                Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                Possible values include:
                • "CLONE"
                • "FULL_COPY"
                • "INCREMENTAL_COPY"
            • ReadOnly — (Boolean)

              A Boolean value indicating whether the volume is read-only.

            • NfsExports — (Array<map>)

              The configuration object for mounting a Network File System (NFS) file system.

              • ClientConfigurationsrequired — (Array<map>)

                A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

                • Clientsrequired — (String)

                  A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.

                • Optionsrequired — (Array<String>)

                  The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:

                  • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.

                  • sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

            • UserAndGroupQuotas — (Array<map>)

              An object specifying how much storage users or groups can use on the volume.

              • Typerequired — (String)

                Specifies whether the quota applies to a user or group.

                Possible values include:
                • "USER"
                • "GROUP"
              • Idrequired — (Integer)

                The ID of the user or group that the quota applies to.

              • StorageCapacityQuotaGiBrequired — (Integer)

                The user or group's storage quota, in gibibytes (GiB).

            • RestoreToSnapshot — (String)

              Specifies the ID of the snapshot to which the volume was restored.

            • DeleteIntermediateSnaphots — (Boolean)

              A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

            • DeleteClonedVolumes — (Boolean)

              A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

            • DeleteIntermediateData — (Boolean)

              A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

            • SourceSnapshotARN — (String)

              The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

            • DestinationSnapshot — (String)

              The ID of the snapshot that's being copied or was most recently copied to the destination volume.

            • CopyStrategy — (String)

              Specifies the strategy used when copying data from the snapshot to the new volume.

              • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

              • FULL_COPY - Copies all data from the snapshot to the new volume.

                Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

              Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
              Possible values include:
              • "CLONE"
              • "FULL_COPY"
              • "INCREMENTAL_COPY"
        • TargetSnapshotValues — (map)

          A snapshot of an Amazon FSx for OpenZFS volume.

          • ResourceARN — (String)

            The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

          • SnapshotId — (String)

            The ID of the snapshot.

          • Name — (String)

            The name of the snapshot.

          • VolumeId — (String)

            The ID of the volume that the snapshot is of.

          • CreationTime — (Date)

            The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

          • Lifecycle — (String)

            The lifecycle status of the snapshot.

            • PENDING - Amazon FSx hasn't started creating the snapshot.

            • CREATING - Amazon FSx is creating the snapshot.

            • DELETING - Amazon FSx is deleting the snapshot.

            • AVAILABLE - The snapshot is fully available.

            Possible values include:
            • "PENDING"
            • "CREATING"
            • "DELETING"
            • "AVAILABLE"
          • LifecycleTransitionReason — (map)

            Describes why a resource lifecycle state changed.

            • Message — (String)

              A detailed error message.

          • Tags — (Array<map>)

            A list of Tag values, with a maximum of 50 elements.

            • Keyrequired — (String)

              A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

            • Valuerequired — (String)

              A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

          • AdministrativeActions — (Array<map>)

            A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

        • TotalTransferBytes — (Integer)

          The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

        • RemainingTransferBytes — (Integer)

          The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createBackup(params = {}, callback) ⇒ AWS.Request

Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system. We recommend creating regular backups so that you can restore a file system or volume from a backup if an issue arises with the original file system or volume.

For Amazon FSx for Lustre file systems, you can create a backup only for file systems that have the following configuration:

  • A Persistent deployment type

  • Are not linked to a data repository

For more information about backups, see the following:

If a backup with the specified client request token exists and the parameters match, this operation returns the description of the existing backup. If a backup with the specified client request token exists and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:

  • Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the backup.

By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.

The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

Service Reference:

Examples:

To create a new backup


/* This operation creates a new backup. */

 var params = {
  FileSystemId: "fs-0498eed5fe91001ec", 
  Tags: [
     {
    Key: "Name", 
    Value: "MyBackup"
   }
  ]
 };
 fsx.createBackup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Backup: {
     BackupId: "backup-03e3c82e0183b7b6b", 
     CreationTime: <Date Representation>, 
     FileSystem: {
      FileSystemId: "fs-0498eed5fe91001ec", 
      OwnerId: "012345678912", 
      StorageCapacity: 300, 
      WindowsConfiguration: {
       ActiveDirectoryId: "d-1234abcd12", 
       AutomaticBackupRetentionDays: 30, 
       DailyAutomaticBackupStartTime: "05:00", 
       WeeklyMaintenanceStartTime: "1:05:00"
      }
     }, 
     Lifecycle: "CREATING", 
     ProgressPercent: 0, 
     ResourceARN: "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b", 
     Tags: [
        {
       Key: "Name", 
       Value: "MyBackup"
      }
     ], 
     Type: "USER_INITIATED"
    }
   }
   */
 });

Calling the createBackup operation

var params = {
  ClientRequestToken: 'STRING_VALUE',
  FileSystemId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VolumeId: 'STRING_VALUE'
};
fsx.createBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      The ID of the file system to back up.

    • ClientRequestToken — (String)

      (Optional) A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      (Optional) The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup operation, no existing file system tags are copied from the file system to the backup.

      • Keyrequired — (String)

        A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

      • Valuerequired — (String)

        A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

    • VolumeId — (String)

      (Optional) The ID of the FSx for ONTAP volume to back up.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Backup — (map)

        A description of the backup.

        • BackupIdrequired — (String)

          The ID of the backup.

        • Lifecyclerequired — (String)

          The lifecycle status of the backup.

          • AVAILABLE - The backup is fully available.

          • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.

          • CREATING - Amazon FSx is creating the backup.

          • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.

          • COPYING - Amazon FSx is copying the backup.

          • DELETED - Amazon FSx deleted the backup and it's no longer available.

          • FAILED - Amazon FSx couldn't finish the backup.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "TRANSFERRING"
          • "DELETED"
          • "FAILED"
          • "PENDING"
          • "COPYING"
        • FailureDetails — (map)

          Details explaining any failures that occurred when creating a backup.

          • Message — (String)

            A message describing the backup-creation failure.

        • Typerequired — (String)

          The type of the file-system backup.

          Possible values include:
          • "AUTOMATIC"
          • "USER_INITIATED"
          • "AWS_BACKUP"
        • ProgressPercent — (Integer)

          Displays the current percent of progress of an asynchronous task.

        • CreationTimerequired — (Date)

          The time when a particular backup was created.

        • KmsKeyId — (String)

          The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

        • ResourceARN — (String)

          The Amazon Resource Name (ARN) for the backup resource.

        • Tags — (Array<map>)

          The tags associated with a particular file system.

          • Keyrequired — (String)

            A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

          • Valuerequired — (String)

            A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

        • FileSystemrequired — (map)

          The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

          • OwnerId — (String)

            The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

          • CreationTime — (Date)

            The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

          • FileSystemId — (String)

            The system-generated, unique 17-digit ID of the file system.

          • FileSystemType — (String)

            The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

            Possible values include:
            • "WINDOWS"
            • "LUSTRE"
            • "ONTAP"
            • "OPENZFS"
          • Lifecycle — (String)

            The lifecycle status of the file system. The following are the possible values and what they mean:

            • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

            • CREATING - Amazon FSx is creating the new file system.

            • DELETING - Amazon FSx is deleting an existing file system.

            • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

            • MISCONFIGURED - The file system is in a failed but recoverable state.

            • MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

            • UPDATING - The file system is undergoing a customer-initiated update.

            Possible values include:
            • "AVAILABLE"
            • "CREATING"
            • "FAILED"
            • "DELETING"
            • "MISCONFIGURED"
            • "UPDATING"
            • "MISCONFIGURED_UNAVAILABLE"
          • FailureDetails — (map)

            A structure providing details of any failures that occurred.

            • Message — (String)

              A message describing any failures that occurred.

          • StorageCapacity — (Integer)

            The storage capacity of the file system in gibibytes (GiB).

            Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

          • StorageType — (String)

            The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

            Possible values include:
            • "SSD"
            • "HDD"
          • VpcId — (String)

            The ID of the primary virtual private cloud (VPC) for the file system.

          • SubnetIds — (Array<String>)

            Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

            For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

          • NetworkInterfaceIds — (Array<String>)

            The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

            For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

          • DNSName — (String)

            The Domain Name System (DNS) name for the file system.

          • KmsKeyId — (String)

            The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

            • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

              SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

            • Amazon FSx for NetApp ONTAP

            • Amazon FSx for OpenZFS

            • Amazon FSx for Windows File Server

          • ResourceARN — (String)

            The Amazon Resource Name (ARN) of the file system resource.

          • Tags — (Array<map>)

            The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

            • Keyrequired — (String)

              A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

            • Valuerequired — (String)

              A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

          • WindowsConfiguration — (map)

            The configuration for this Amazon FSx for Windows File Server file system.

            • ActiveDirectoryId — (String)

              The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

            • SelfManagedActiveDirectoryConfiguration — (map)

              The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

              • DomainName — (String)

                The fully qualified domain name of the self-managed AD directory.

              • OrganizationalUnitDistinguishedName — (String)

                The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

              • FileSystemAdministratorsGroup — (String)

                The name of the domain group whose members have administrative privileges for the FSx file system.

              • UserName — (String)

                The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

              • DnsIps — (Array<String>)

                A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

            • DeploymentType — (String)

              Specifies the file system deployment type, valid values are the following:

              • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

              • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

              • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

              For more information, see Single-AZ and Multi-AZ File Systems.

              Possible values include:
              • "MULTI_AZ_1"
              • "SINGLE_AZ_1"
              • "SINGLE_AZ_2"
            • RemoteAdministrationEndpoint — (String)

              For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

              For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

              This endpoint is temporarily unavailable when the file system is undergoing maintenance.

            • PreferredSubnetId — (String)

              For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

              For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

            • PreferredFileServerIp — (String)

              For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

              Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

            • ThroughputCapacity — (Integer)

              The throughput of the Amazon FSx file system, measured in megabytes per second.

            • MaintenanceOperationsInProgress — (Array<String>)

              The list of maintenance operations in progress for this file system.

            • WeeklyMaintenanceStartTime — (String)

              The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

            • DailyAutomaticBackupStartTime — (String)

              The preferred time to take daily automatic backups, in the UTC time zone.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

            • CopyTagsToBackups — (Boolean)

              A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

            • Aliases — (Array<map>)

              An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

              • Name — (String)

                The name of the DNS alias. The alias name has to meet the following requirements:

                • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

                • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

                • Cannot start or end with a hyphen.

                • Can start with a numeric.

                For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

              • Lifecycle — (String)

                Describes the state of the DNS alias.

                • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

                • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

                • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

                • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

                • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

                Possible values include:
                • "AVAILABLE"
                • "CREATING"
                • "DELETING"
                • "CREATE_FAILED"
                • "DELETE_FAILED"
            • AuditLogConfiguration — (map)

              The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

              • FileAccessAuditLogLevelrequired — (String)

                Sets which attempt type is logged by Amazon FSx for file and folder accesses.

                • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

                • FAILURE_ONLY - only failed attempts to access files or folders are logged.

                • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

                • DISABLED - access auditing of files and folders is turned off.

                Possible values include:
                • "DISABLED"
                • "SUCCESS_ONLY"
                • "FAILURE_ONLY"
                • "SUCCESS_AND_FAILURE"
              • FileShareAccessAuditLogLevelrequired — (String)

                Sets which attempt type is logged by Amazon FSx for file share accesses.

                • SUCCESS_ONLY - only successful attempts to access file shares are logged.

                • FAILURE_ONLY - only failed attempts to access file shares are logged.

                • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

                • DISABLED - access auditing of file shares is turned off.

                Possible values include:
                • "DISABLED"
                • "SUCCESS_ONLY"
                • "FAILURE_ONLY"
                • "SUCCESS_AND_FAILURE"
              • AuditLogDestination — (String)

                The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

                The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

                The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

            • DiskIopsConfiguration — (map)

              The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

              • Mode — (String)

                Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
              • Iops — (Integer)

                The total number of SSD IOPS provisioned for the file system.

                The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

          • LustreConfiguration — (map)

            The configuration for the Amazon FSx for Lustre file system.

            • WeeklyMaintenanceStartTime — (String)

              The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

            • DataRepositoryConfiguration — (map)

              The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

              This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

              • Lifecycle — (String)

                Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

                • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

                • AVAILABLE - The data repository is available for use.

                • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

                • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

                • FAILED - The data repository is in a terminal state that cannot be recovered.

                Possible values include:
                • "CREATING"
                • "AVAILABLE"
                • "MISCONFIGURED"
                • "UPDATING"
                • "DELETING"
                • "FAILED"
              • ImportPath — (String)

                The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

              • ExportPath — (String)

                The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

              • ImportedFileChunkSize — (Integer)

                For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

                The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

              • AutoImportPolicy — (String)

                Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

                • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

                • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

                • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

                • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

                Possible values include:
                • "NONE"
                • "NEW"
                • "NEW_CHANGED"
                • "NEW_CHANGED_DELETED"
              • FailureDetails — (map)

                Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

                • Message — (String)

                  A detailed error message.

            • DeploymentType — (String)

              The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

              SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

              The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

              The default is SCRATCH_1.

              Possible values include:
              • "SCRATCH_1"
              • "SCRATCH_2"
              • "PERSISTENT_1"
              • "PERSISTENT_2"
            • PerUnitStorageThroughput — (Integer)

              Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

              Valid values:

              • For PERSISTENT_1 SSD storage: 50, 100, 200.

              • For PERSISTENT_1 HDD storage: 12, 40.

              • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

            • MountName — (String)

              You use the MountName value when mounting the file system.

              For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

            • DailyAutomaticBackupStartTime — (String)

              A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

            • CopyTagsToBackups — (Boolean)

              A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

            • DriveCacheType — (String)

              The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

              This parameter is required when StorageType is set to HDD.

              Possible values include:
              • "NONE"
              • "READ"
            • DataCompressionType — (String)

              The data compression configuration for the file system. DataCompressionType can have the following values:

              • NONE - Data compression is turned off for the file system.

              • LZ4 - Data compression is turned on with the LZ4 algorithm.

              For more information, see Lustre data compression.

              Possible values include:
              • "NONE"
              • "LZ4"
            • LogConfiguration — (map)

              The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

              • Levelrequired — (String)

                The data repository events that are logged by Amazon FSx.

                • WARN_ONLY - only warning events are logged.

                • ERROR_ONLY - only error events are logged.

                • WARN_ERROR - both warning events and error events are logged.

                • DISABLED - logging of data repository events is turned off.

                Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

                Possible values include:
                • "DISABLED"
                • "WARN_ONLY"
                • "ERROR_ONLY"
                • "WARN_ERROR"
              • Destination — (String)

                The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

            • RootSquashConfiguration — (map)

              The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

              • RootSquash — (String)

                You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

                • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

                • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

                When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

              • NoSquashNids — (Array<String>)

                When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

                • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

                • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

            • MetadataConfiguration — (map)

              The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

              • Iops — (Integer)

                The number of Metadata IOPS provisioned for the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

              • Moderequired — (String)

                The metadata configuration mode for provisioning Metadata IOPS for the file system.

                • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity.

                • In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
          • AdministrativeActions — (Array<map>)

            A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the UpdateFileSystem operation.

            • AdministrativeActionType — (String)

              Describes the type of administrative action, as follows:

              • FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

              • THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

              • STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

                • For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

                • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

                You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

              • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

              • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

              • IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

              • STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

              • VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

              • VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

              • SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

              • RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

              • DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

              • VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

              • VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

              Possible values include:
              • "FILE_SYSTEM_UPDATE"
              • "STORAGE_OPTIMIZATION"
              • "FILE_SYSTEM_ALIAS_ASSOCIATION"
              • "FILE_SYSTEM_ALIAS_DISASSOCIATION"
              • "VOLUME_UPDATE"
              • "SNAPSHOT_UPDATE"
              • "RELEASE_NFS_V3_LOCKS"
              • "VOLUME_RESTORE"
              • "THROUGHPUT_OPTIMIZATION"
              • "IOPS_OPTIMIZATION"
              • "STORAGE_TYPE_OPTIMIZATION"
              • "MISCONFIGURED_STATE_RECOVERY"
              • "VOLUME_UPDATE_WITH_SNAPSHOT"
              • "VOLUME_INITIALIZE_WITH_SNAPSHOT"
              • "DOWNLOAD_DATA_FROM_BACKUP"
            • ProgressPercent — (Integer)

              The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

            • RequestTime — (Date)

              The time that the administrative action request was received.

            • Status — (String)

              The status of the administrative action, as follows:

              • FAILED - Amazon FSx failed to process the administrative action successfully.

              • IN_PROGRESS - Amazon FSx is processing the administrative action.

              • PENDING - Amazon FSx is waiting to process the administrative action.

              • COMPLETED - Amazon FSx has finished processing the administrative task.

                For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

              • UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

              • PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

              • IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

              Possible values include:
              • "FAILED"
              • "IN_PROGRESS"
              • "PENDING"
              • "COMPLETED"
              • "UPDATED_OPTIMIZING"
              • "OPTIMIZING"
            • FailureDetails — (map)

              Provides information about a failed administrative action.

              • Message — (String)

                Error message providing details about the failed administrative action.

            • TargetVolumeValues — (map)

              Describes an Amazon FSx volume.

              • CreationTime — (Date)

                The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

              • FileSystemId — (String)

                The globally unique ID of the file system, assigned by Amazon FSx.

              • Lifecycle — (String)

                The lifecycle status of the volume.

                • AVAILABLE - The volume is fully available for use.

                • CREATED - The volume has been created.

                • CREATING - Amazon FSx is creating the new volume.

                • DELETING - Amazon FSx is deleting an existing volume.

                • FAILED - Amazon FSx was unable to create the volume.

                • MISCONFIGURED - The volume is in a failed but recoverable state.

                • PENDING - Amazon FSx hasn't started creating the volume.

                Possible values include:
                • "CREATING"
                • "CREATED"
                • "DELETING"
                • "FAILED"
                • "MISCONFIGURED"
                • "PENDING"
                • "AVAILABLE"
              • Name — (String)

                The name of the volume.

              • OntapConfiguration — (map)

                The configuration of an Amazon FSx for NetApp ONTAP volume.

                • FlexCacheEndpointType — (String)

                  Specifies the FlexCache endpoint type of the volume. Valid values are the following:

                  • NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

                  • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

                  • CACHE specifies that the volume is a FlexCache volume.

                  Possible values include:
                  • "NONE"
                  • "ORIGIN"
                  • "CACHE"
                • JunctionPath — (String)

                  Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

                • SecurityStyle — (String)

                  The security style for the volume, which can be UNIX, NTFS, or MIXED.

                  Possible values include:
                  • "UNIX"
                  • "NTFS"
                  • "MIXED"
                • SizeInMegabytes — (Integer)

                  The configured size of the volume, in megabytes (MBs).

                • StorageEfficiencyEnabled — (Boolean)

                  The volume's storage efficiency setting.

                • StorageVirtualMachineId — (String)

                  The ID of the volume's storage virtual machine.

                • StorageVirtualMachineRoot — (Boolean)

                  A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

                  This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

                • TieringPolicy — (map)

                  The volume's TieringPolicy setting.

                  • CoolingPeriod — (Integer)

                    Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.

                  • Name — (String)

                    Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

                    • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

                    • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

                    • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

                    • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

                    Possible values include:
                    • "SNAPSHOT_ONLY"
                    • "AUTO"
                    • "ALL"
                    • "NONE"
                • UUID — (String)

                  The volume's universally unique identifier (UUID).

                • OntapVolumeType — (String)

                  Specifies the type of volume. Valid values are the following:

                  • RW specifies a read/write volume. RW is the default.

                  • DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

                  • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

                  Possible values include:
                  • "RW"
                  • "DP"
                  • "LS"
                • SnapshotPolicy — (String)

                  Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

                  • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.

                  • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.

                  • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

                  You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

                  For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

                • CopyTagsToBackups — (Boolean)

                  A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

                • SnaplockConfiguration — (map)

                  The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

                  • AuditLogVolume — (Boolean)

                    Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

                    For more information, see SnapLock audit log volumes.

                  • AutocommitPeriod — (map)

                    The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

                    • Typerequired — (String)

                      Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.

                      Possible values include:
                      • "MINUTES"
                      • "HOURS"
                      • "DAYS"
                      • "MONTHS"
                      • "YEARS"
                      • "NONE"
                    • Value — (Integer)

                      Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

                      • Minutes: 5 - 65,535

                      • Hours: 1 - 65,535

                      • Days: 1 - 3,650

                      • Months: 1 - 120

                      • Years: 1 - 10

                  • PrivilegedDelete — (String)

                    Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

                    For more information, see Privileged delete.

                    Possible values include:
                    • "DISABLED"
                    • "ENABLED"
                    • "PERMANENTLY_DISABLED"
                  • RetentionPeriod — (map)

                    Specifies the retention period of an FSx for ONTAP SnapLock volume.

                    • DefaultRetentionrequired — (map)

                      The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

                      • Typerequired — (String)

                        Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                        Possible values include:
                        • "SECONDS"
                        • "MINUTES"
                        • "HOURS"
                        • "DAYS"
                        • "MONTHS"
                        • "YEARS"
                        • "INFINITE"
                        • "UNSPECIFIED"
                      • Value — (Integer)

                        Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                        • Seconds: 0 - 65,535

                        • Minutes: 0 - 65,535

                        • Hours: 0 - 24

                        • Days: 0 - 365

                        • Months: 0 - 12

                        • Years: 0 - 100

                    • MinimumRetentionrequired — (map)

                      The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                      • Typerequired — (String)

                        Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                        Possible values include:
                        • "SECONDS"
                        • "MINUTES"
                        • "HOURS"
                        • "DAYS"
                        • "MONTHS"
                        • "YEARS"
                        • "INFINITE"
                        • "UNSPECIFIED"
                      • Value — (Integer)

                        Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                        • Seconds: 0 - 65,535

                        • Minutes: 0 - 65,535

                        • Hours: 0 - 24

                        • Days: 0 - 365

                        • Months: 0 - 12

                        • Years: 0 - 100

                    • MaximumRetentionrequired — (map)

                      The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                      • Typerequired — (String)

                        Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                        Possible values include:
                        • "SECONDS"
                        • "MINUTES"
                        • "HOURS"
                        • "DAYS"
                        • "MONTHS"
                        • "YEARS"
                        • "INFINITE"
                        • "UNSPECIFIED"
                      • Value — (Integer)

                        Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                        • Seconds: 0 - 65,535

                        • Minutes: 0 - 65,535

                        • Hours: 0 - 24

                        • Days: 0 - 365

                        • Months: 0 - 12

                        • Years: 0 - 100

                  • SnaplockType — (String)

                    Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

                    • COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

                    • ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

                    Possible values include:
                    • "COMPLIANCE"
                    • "ENTERPRISE"
                  • VolumeAppendModeEnabled — (Boolean)

                    Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

                    For more information, see Volume-append mode.

                • VolumeStyle — (String)

                  Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

                  Possible values include:
                  • "FLEXVOL"
                  • "FLEXGROUP"
                • AggregateConfiguration — (map)

                  This structure specifies configuration options for a volume’s storage aggregate or aggregates.

                  • Aggregates — (Array<String>)

                    The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

                    Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                    • The strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 12.

                    • The value of Aggregates contains aggregates that are not present.

                    • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.

                  • TotalConstituents — (Integer)

                    The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.

                • SizeInBytes — (Integer)

                  The configured size of the volume, in bytes.

              • ResourceARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • Tags — (Array<map>)

                A list of Tag values, with a maximum of 50 elements.

                • Keyrequired — (String)

                  A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

                • Valuerequired — (String)

                  A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

              • VolumeId — (String)

                The system-generated, unique ID of the volume.

              • VolumeType — (String)

                The type of the volume.

                Possible values include:
                • "ONTAP"
                • "OPENZFS"
              • LifecycleTransitionReason — (map)

                The reason why the volume lifecycle status changed.

                • Message — (String)

                  A detailed error message.

              • OpenZFSConfiguration — (map)

                The configuration of an Amazon FSx for OpenZFS volume.

                • ParentVolumeId — (String)

                  The ID of the parent volume.

                • VolumePath — (String)

                  The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

                • StorageCapacityReservationGiB — (Integer)

                  The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

                • StorageCapacityQuotaGiB — (Integer)

                  The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

                • RecordSizeKiB — (Integer)

                  The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

                • DataCompressionType — (String)

                  Specifies the method used to compress the data on the volume. The compression type is NONE by default.

                  • NONE - Doesn't compress the data on the volume. NONE is the default.

                  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

                  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

                  Possible values include:
                  • "NONE"
                  • "ZSTD"
                  • "LZ4"
                • CopyTagsToSnapshots — (Boolean)

                  A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

                • OriginSnapshot — (map)

                  The configuration object that specifies the snapshot to use as the origin of the data for the volume.

                  • SnapshotARN — (String)

                    The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

                  • CopyStrategy — (String)

                    The strategy used when copying data from the snapshot to the new volume.

                    • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                    • FULL_COPY - Copies all data from the snapshot to the new volume.

                    Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                    Possible values include:
                    • "CLONE"
                    • "FULL_COPY"
                    • "INCREMENTAL_COPY"
                • ReadOnly — (Boolean)

                  A Boolean value indicating whether the volume is read-only.

                • NfsExports — (Array<map>)

                  The configuration object for mounting a Network File System (NFS) file system.

                  • ClientConfigurationsrequired — (Array<map>)

                    A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

                    • Clientsrequired — (String)

                      A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.

                    • Optionsrequired — (Array<String>)

                      The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:

                      • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.

                      • sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

                • UserAndGroupQuotas — (Array<map>)

                  An object specifying how much storage users or groups can use on the volume.

                  • Typerequired — (String)

                    Specifies whether the quota applies to a user or group.

                    Possible values include:
                    • "USER"
                    • "GROUP"
                  • Idrequired — (Integer)

                    The ID of the user or group that the quota applies to.

                  • StorageCapacityQuotaGiBrequired — (Integer)

                    The user or group's storage quota, in gibibytes (GiB).

                • RestoreToSnapshot — (String)

                  Specifies the ID of the snapshot to which the volume was restored.

                • DeleteIntermediateSnaphots — (Boolean)

                  A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

                • DeleteClonedVolumes — (Boolean)

                  A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

                • DeleteIntermediateData — (Boolean)

                  A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

                • SourceSnapshotARN — (String)

                  The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

                • DestinationSnapshot — (String)

                  The ID of the snapshot that's being copied or was most recently copied to the destination volume.

                • CopyStrategy — (String)

                  Specifies the strategy used when copying data from the snapshot to the new volume.

                  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                  • FULL_COPY - Copies all data from the snapshot to the new volume.

                    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

                  Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                  Possible values include:
                  • "CLONE"
                  • "FULL_COPY"
                  • "INCREMENTAL_COPY"
            • TargetSnapshotValues — (map)

              A snapshot of an Amazon FSx for OpenZFS volume.

              • ResourceARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • SnapshotId — (String)

                The ID of the snapshot.

              • Name — (String)

                The name of the snapshot.

              • VolumeId — (String)

                The ID of the volume that the snapshot is of.

              • CreationTime — (Date)

                The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

              • Lifecycle — (String)

                The lifecycle status of the snapshot.

                • PENDING - Amazon FSx hasn't started creating the snapshot.

                • CREATING - Amazon FSx is creating the snapshot.

                • DELETING - Amazon FSx is deleting the snapshot.

                • AVAILABLE - The snapshot is fully available.

                Possible values include:
                • "PENDING"
                • "CREATING"
                • "DELETING"
                • "AVAILABLE"
              • LifecycleTransitionReason — (map)

                Describes why a resource lifecycle state changed.

                • Message — (String)

                  A detailed error message.

              • Tags — (Array<map>)

                A list of Tag values, with a maximum of 50 elements.

                • Keyrequired — (String)

                  A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

                • Valuerequired — (String)

                  A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

            • TotalTransferBytes — (Integer)

              The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

            • RemainingTransferBytes — (Integer)

              The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

          • OntapConfiguration — (map)

            The configuration for this Amazon FSx for NetApp ONTAP file system.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

            • DailyAutomaticBackupStartTime — (String)

              A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

            • DeploymentType — (String)

              Specifies the FSx for ONTAP file system deployment type in use in the file system.

              • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

              • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

              • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

              • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

              For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

              Possible values include:
              • "MULTI_AZ_1"
              • "SINGLE_AZ_1"
              • "SINGLE_AZ_2"
              • "MULTI_AZ_2"
            • EndpointIpAddressRange — (String)

              (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

            • Endpoints — (map)

              The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

              • Intercluster — (map)

                An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

                • DNSName — (String)

                  The file system's DNS name. You can mount your file system using its DNS name.

                • IpAddresses — (Array<String>)

                  IP addresses of the file system endpoint.

              • Management — (map)

                An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

                • DNSName — (String)

                  The file system's DNS name. You can mount your file system using its DNS name.

                • IpAddresses — (Array<String>)

                  IP addresses of the file system endpoint.

            • DiskIopsConfiguration — (map)

              The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

              • Mode — (String)

                Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
              • Iops — (Integer)

                The total number of SSD IOPS provisioned for the file system.

                The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

            • PreferredSubnetId — (String)

              The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

            • RouteTableIds — (Array<String>)

              (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

            • ThroughputCapacity — (Integer)

              The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

            • WeeklyMaintenanceStartTime — (String)

              A recurring weekly time, in the format D:HH:MM.

              D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

              HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

              For example, 1:05:00 specifies maintenance at 5 AM Monday.

            • FsxAdminPassword — (String)

              You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.

            • HAPairs — (Integer)

              Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

              Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

              • The value of HAPairs is less than 1 or greater than 12.

              • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.

            • ThroughputCapacityPerHAPair — (Integer)

              Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

              This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

              This field and ThroughputCapacity are the same for file systems with one HA pair.

              • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

              • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

              • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

              Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

              • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

              • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

              • The value of ThroughputCapacityPerHAPair is not a valid value.

          • FileSystemTypeVersion — (String)

            The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

          • OpenZFSConfiguration — (map)

            The configuration for this Amazon FSx for OpenZFS file system.

            • AutomaticBackupRetentionDays — (Integer)

              The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

            • CopyTagsToBackups — (Boolean)

              A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

            • CopyTagsToVolumes — (Boolean)

              A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

            • DailyAutomaticBackupStartTime — (String)

              A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

            • DeploymentType — (String)

              Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

              Possible values include:
              • "SINGLE_AZ_1"
              • "SINGLE_AZ_2"
              • "SINGLE_AZ_HA_1"
              • "SINGLE_AZ_HA_2"
              • "MULTI_AZ_1"
            • ThroughputCapacity — (Integer)

              The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

            • WeeklyMaintenanceStartTime — (String)

              A recurring weekly time, in the format D:HH:MM.

              D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

              HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

              For example, 1:05:00 specifies maintenance at 5 AM Monday.

            • DiskIopsConfiguration — (map)

              The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

              • Mode — (String)

                Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                Possible values include:
                • "AUTOMATIC"
                • "USER_PROVISIONED"
              • Iops — (Integer)

                The total number of SSD IOPS provisioned for the file system.

                The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

            • RootVolumeId — (String)

              The ID of the root volume of the OpenZFS file system.

            • PreferredSubnetId — (String)

              Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

            • EndpointIpAddressRange — (String)

              (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

            • RouteTableIds — (Array<String>)

              (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

            • EndpointIpAddress — (String)

              The IP address of the endpoint that is used to access data or to manage the file system.

        • DirectoryInformation — (map)

          The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.

          • DomainName — (String)

            The fully qualified domain name of the self-managed Active Directory directory.

          • ActiveDirectoryId — (String)

            The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.

          • ResourceARN — (String)

            The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

        • OwnerId — (String)

          An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

        • SourceBackupId — (String)

          The ID of the source backup. Specifies the backup that you are copying.

        • SourceBackupRegion — (String)

          The source Region of the backup. Specifies the Region from where this backup is copied.

        • ResourceType — (String)

          Specifies the resource type that's backed up.

          Possible values include:
          • "FILE_SYSTEM"
          • "VOLUME"
        • Volume — (map)

          Describes an Amazon FSx volume.

          • CreationTime — (Date)

            The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

          • FileSystemId — (String)

            The globally unique ID of the file system, assigned by Amazon FSx.

          • Lifecycle — (String)

            The lifecycle status of the volume.

            • AVAILABLE - The volume is fully available for use.

            • CREATED - The volume has been created.

            • CREATING - Amazon FSx is creating the new volume.

            • DELETING - Amazon FSx is deleting an existing volume.

            • FAILED - Amazon FSx was unable to create the volume.

            • MISCONFIGURED - The volume is in a failed but recoverable state.

            • PENDING - Amazon FSx hasn't started creating the volume.

            Possible values include:
            • "CREATING"
            • "CREATED"
            • "DELETING"
            • "FAILED"
            • "MISCONFIGURED"
            • "PENDING"
            • "AVAILABLE"
          • Name — (String)

            The name of the volume.

          • OntapConfiguration — (map)

            The configuration of an Amazon FSx for NetApp ONTAP volume.

            • FlexCacheEndpointType — (String)

              Specifies the FlexCache endpoint type of the volume. Valid values are the following:

              • NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

              • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

              • CACHE specifies that the volume is a FlexCache volume.

              Possible values include:
              • "NONE"
              • "ORIGIN"
              • "CACHE"
            • JunctionPath — (String)

              Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

            • SecurityStyle — (String)

              The security style for the volume, which can be UNIX, NTFS, or MIXED.

              Possible values include:
              • "UNIX"
              • "NTFS"
              • "MIXED"
            • SizeInMegabytes — (Integer)

              The configured size of the volume, in megabytes (MBs).

            • StorageEfficiencyEnabled — (Boolean)

              The volume's storage efficiency setting.

            • StorageVirtualMachineId — (String)

              The ID of the volume's storage virtual machine.

            • StorageVirtualMachineRoot — (Boolean)

              A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

              This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

            • TieringPolicy — (map)

              The volume's TieringPolicy setting.

              • CoolingPeriod — (Integer)

                Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.

              • Name — (String)

                Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

                • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

                • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

                • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

                • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

                Possible values include:
                • "SNAPSHOT_ONLY"
                • "AUTO"
                • "ALL"
                • "NONE"
            • UUID — (String)

              The volume's universally unique identifier (UUID).

            • OntapVolumeType — (String)

              Specifies the type of volume. Valid values are the following:

              • RW specifies a read/write volume. RW is the default.

              • DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

              • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

              Possible values include:
              • "RW"
              • "DP"
              • "LS"
            • SnapshotPolicy — (String)

              Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

              • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.

              • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.

              • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

              You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

              For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

            • CopyTagsToBackups — (Boolean)

              A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

            • SnaplockConfiguration — (map)

              The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

              • AuditLogVolume — (Boolean)

                Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

                For more information, see SnapLock audit log volumes.

              • AutocommitPeriod — (map)

                The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

                • Typerequired — (String)

                  Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.

                  Possible values include:
                  • "MINUTES"
                  • "HOURS"
                  • "DAYS"
                  • "MONTHS"
                  • "YEARS"
                  • "NONE"
                • Value — (Integer)

                  Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

                  • Minutes: 5 - 65,535

                  • Hours: 1 - 65,535

                  • Days: 1 - 3,650

                  • Months: 1 - 120

                  • Years: 1 - 10

              • PrivilegedDelete — (String)

                Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

                For more information, see Privileged delete.

                Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "PERMANENTLY_DISABLED"
              • RetentionPeriod — (map)

                Specifies the retention period of an FSx for ONTAP SnapLock volume.

                • DefaultRetentionrequired — (map)

                  The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

                  • Typerequired — (String)

                    Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                    Possible values include:
                    • "SECONDS"
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "INFINITE"
                    • "UNSPECIFIED"
                  • Value — (Integer)

                    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                    • Seconds: 0 - 65,535

                    • Minutes: 0 - 65,535

                    • Hours: 0 - 24

                    • Days: 0 - 365

                    • Months: 0 - 12

                    • Years: 0 - 100

                • MinimumRetentionrequired — (map)

                  The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                  • Typerequired — (String)

                    Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                    Possible values include:
                    • "SECONDS"
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "INFINITE"
                    • "UNSPECIFIED"
                  • Value — (Integer)

                    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                    • Seconds: 0 - 65,535

                    • Minutes: 0 - 65,535

                    • Hours: 0 - 24

                    • Days: 0 - 365

                    • Months: 0 - 12

                    • Years: 0 - 100

                • MaximumRetentionrequired — (map)

                  The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                  • Typerequired — (String)

                    Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                    Possible values include:
                    • "SECONDS"
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "INFINITE"
                    • "UNSPECIFIED"
                  • Value — (Integer)

                    Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                    • Seconds: 0 - 65,535

                    • Minutes: 0 - 65,535

                    • Hours: 0 - 24

                    • Days: 0 - 365

                    • Months: 0 - 12

                    • Years: 0 - 100

              • SnaplockType — (String)

                Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

                • COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

                • ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

                Possible values include:
                • "COMPLIANCE"
                • "ENTERPRISE"
              • VolumeAppendModeEnabled — (Boolean)

                Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

                For more information, see Volume-append mode.

            • VolumeStyle — (String)

              Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

              Possible values include:
              • "FLEXVOL"
              • "FLEXGROUP"
            • AggregateConfiguration — (map)

              This structure specifies configuration options for a volume’s storage aggregate or aggregates.

              • Aggregates — (Array<String>)

                The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                • The strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 12.

                • The value of Aggregates contains aggregates that are not present.

                • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.

              • TotalConstituents — (Integer)

                The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.

            • SizeInBytes — (Integer)

              The configured size of the volume, in bytes.

          • ResourceARN — (String)

            The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

          • Tags — (Array<map>)

            A list of Tag values, with a maximum of 50 elements.

            • Keyrequired — (String)

              A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

            • Valuerequired — (String)

              A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

          • VolumeId — (String)

            The system-generated, unique ID of the volume.

          • VolumeType — (String)

            The type of the volume.

            Possible values include:
            • "ONTAP"
            • "OPENZFS"
          • LifecycleTransitionReason — (map)

            The reason why the volume lifecycle status changed.

            • Message — (String)

              A detailed error message.

          • AdministrativeActions — (Array<map>)

            A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

            • AdministrativeActionType — (String)

              Describes the type of administrative action, as follows:

              • FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

              • THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

              • STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

                • For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

                • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

                You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

              • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

              • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

              • IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

              • STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.

                You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

              • VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

              • VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

              • SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

              • RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

              • DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

              • VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

              • VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

              Possible values include:
              • "FILE_SYSTEM_UPDATE"
              • "STORAGE_OPTIMIZATION"
              • "FILE_SYSTEM_ALIAS_ASSOCIATION"
              • "FILE_SYSTEM_ALIAS_DISASSOCIATION"
              • "VOLUME_UPDATE"
              • "SNAPSHOT_UPDATE"
              • "RELEASE_NFS_V3_LOCKS"
              • "VOLUME_RESTORE"
              • "THROUGHPUT_OPTIMIZATION"
              • "IOPS_OPTIMIZATION"
              • "STORAGE_TYPE_OPTIMIZATION"
              • "MISCONFIGURED_STATE_RECOVERY"
              • "VOLUME_UPDATE_WITH_SNAPSHOT"
              • "VOLUME_INITIALIZE_WITH_SNAPSHOT"
              • "DOWNLOAD_DATA_FROM_BACKUP"
            • ProgressPercent — (Integer)

              The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

            • RequestTime — (Date)

              The time that the administrative action request was received.

            • Status — (String)

              The status of the administrative action, as follows:

              • FAILED - Amazon FSx failed to process the administrative action successfully.

              • IN_PROGRESS - Amazon FSx is processing the administrative action.

              • PENDING - Amazon FSx is waiting to process the administrative action.

              • COMPLETED - Amazon FSx has finished processing the administrative task.

                For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

              • UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

              • PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

              • IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

              Possible values include:
              • "FAILED"
              • "IN_PROGRESS"
              • "PENDING"
              • "COMPLETED"
              • "UPDATED_OPTIMIZING"
              • "OPTIMIZING"
            • TargetFileSystemValues — (map)

              The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

              • OwnerId — (String)

                The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

              • CreationTime — (Date)

                The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

              • FileSystemId — (String)

                The system-generated, unique 17-digit ID of the file system.

              • FileSystemType — (String)

                The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

                Possible values include:
                • "WINDOWS"
                • "LUSTRE"
                • "ONTAP"
                • "OPENZFS"
              • Lifecycle — (String)

                The lifecycle status of the file system. The following are the possible values and what they mean:

                • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

                • CREATING - Amazon FSx is creating the new file system.

                • DELETING - Amazon FSx is deleting an existing file system.

                • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

                • MISCONFIGURED - The file system is in a failed but recoverable state.

                • MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

                • UPDATING - The file system is undergoing a customer-initiated update.

                Possible values include:
                • "AVAILABLE"
                • "CREATING"
                • "FAILED"
                • "DELETING"
                • "MISCONFIGURED"
                • "UPDATING"
                • "MISCONFIGURED_UNAVAILABLE"
              • FailureDetails — (map)

                A structure providing details of any failures that occurred.

                • Message — (String)

                  A message describing any failures that occurred.

              • StorageCapacity — (Integer)

                The storage capacity of the file system in gibibytes (GiB).

                Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

              • StorageType — (String)

                The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

                Possible values include:
                • "SSD"
                • "HDD"
              • VpcId — (String)

                The ID of the primary virtual private cloud (VPC) for the file system.

              • SubnetIds — (Array<String>)

                Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

                For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

              • NetworkInterfaceIds — (Array<String>)

                The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

                For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

              • DNSName — (String)

                The Domain Name System (DNS) name for the file system.

              • KmsKeyId — (String)

                The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

                • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

                  SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

                • Amazon FSx for NetApp ONTAP

                • Amazon FSx for OpenZFS

                • Amazon FSx for Windows File Server

              • ResourceARN — (String)

                The Amazon Resource Name (ARN) of the file system resource.

              • Tags — (Array<map>)

                The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

                • Keyrequired — (String)

                  A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

                • Valuerequired — (String)

                  A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

              • WindowsConfiguration — (map)

                The configuration for this Amazon FSx for Windows File Server file system.

                • ActiveDirectoryId — (String)

                  The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

                • SelfManagedActiveDirectoryConfiguration — (map)

                  The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

                  • DomainName — (String)

                    The fully qualified domain name of the self-managed AD directory.

                  • OrganizationalUnitDistinguishedName — (String)

                    The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

                  • FileSystemAdministratorsGroup — (String)

                    The name of the domain group whose members have administrative privileges for the FSx file system.

                  • UserName — (String)

                    The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

                  • DnsIps — (Array<String>)

                    A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

                • DeploymentType — (String)

                  Specifies the file system deployment type, valid values are the following:

                  • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

                  • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

                  • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

                  For more information, see Single-AZ and Multi-AZ File Systems.

                  Possible values include:
                  • "MULTI_AZ_1"
                  • "SINGLE_AZ_1"
                  • "SINGLE_AZ_2"
                • RemoteAdministrationEndpoint — (String)

                  For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

                  For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

                  This endpoint is temporarily unavailable when the file system is undergoing maintenance.

                • PreferredSubnetId — (String)

                  For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

                  For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

                • PreferredFileServerIp — (String)

                  For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

                  Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

                • ThroughputCapacity — (Integer)

                  The throughput of the Amazon FSx file system, measured in megabytes per second.

                • MaintenanceOperationsInProgress — (Array<String>)

                  The list of maintenance operations in progress for this file system.

                • WeeklyMaintenanceStartTime — (String)

                  The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

                • DailyAutomaticBackupStartTime — (String)

                  The preferred time to take daily automatic backups, in the UTC time zone.

                • AutomaticBackupRetentionDays — (Integer)

                  The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

                • CopyTagsToBackups — (Boolean)

                  A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

                • Aliases — (Array<map>)

                  An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

                  • Name — (String)

                    The name of the DNS alias. The alias name has to meet the following requirements:

                    • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

                    • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

                    • Cannot start or end with a hyphen.

                    • Can start with a numeric.

                    For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

                  • Lifecycle — (String)

                    Describes the state of the DNS alias.

                    • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

                    • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

                    • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

                    • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

                    • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

                    Possible values include:
                    • "AVAILABLE"
                    • "CREATING"
                    • "DELETING"
                    • "CREATE_FAILED"
                    • "DELETE_FAILED"
                • AuditLogConfiguration — (map)

                  The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

                  • FileAccessAuditLogLevelrequired — (String)

                    Sets which attempt type is logged by Amazon FSx for file and folder accesses.

                    • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

                    • FAILURE_ONLY - only failed attempts to access files or folders are logged.

                    • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

                    • DISABLED - access auditing of files and folders is turned off.

                    Possible values include:
                    • "DISABLED"
                    • "SUCCESS_ONLY"
                    • "FAILURE_ONLY"
                    • "SUCCESS_AND_FAILURE"
                  • FileShareAccessAuditLogLevelrequired — (String)

                    Sets which attempt type is logged by Amazon FSx for file share accesses.

                    • SUCCESS_ONLY - only successful attempts to access file shares are logged.

                    • FAILURE_ONLY - only failed attempts to access file shares are logged.

                    • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

                    • DISABLED - access auditing of file shares is turned off.

                    Possible values include:
                    • "DISABLED"
                    • "SUCCESS_ONLY"
                    • "FAILURE_ONLY"
                    • "SUCCESS_AND_FAILURE"
                  • AuditLogDestination — (String)

                    The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

                    The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

                    The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

                • DiskIopsConfiguration — (map)

                  The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

                  • Mode — (String)

                    Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                    Possible values include:
                    • "AUTOMATIC"
                    • "USER_PROVISIONED"
                  • Iops — (Integer)

                    The total number of SSD IOPS provisioned for the file system.

                    The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                    Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

              • LustreConfiguration — (map)

                The configuration for the Amazon FSx for Lustre file system.

                • WeeklyMaintenanceStartTime — (String)

                  The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

                • DataRepositoryConfiguration — (map)

                  The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

                  This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

                  • Lifecycle — (String)

                    Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

                    • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

                    • AVAILABLE - The data repository is available for use.

                    • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

                    • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

                    • FAILED - The data repository is in a terminal state that cannot be recovered.

                    Possible values include:
                    • "CREATING"
                    • "AVAILABLE"
                    • "MISCONFIGURED"
                    • "UPDATING"
                    • "DELETING"
                    • "FAILED"
                  • ImportPath — (String)

                    The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

                  • ExportPath — (String)

                    The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

                  • ImportedFileChunkSize — (Integer)

                    For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

                    The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

                  • AutoImportPolicy — (String)

                    Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

                    • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

                    • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

                    • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

                    • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

                    Possible values include:
                    • "NONE"
                    • "NEW"
                    • "NEW_CHANGED"
                    • "NEW_CHANGED_DELETED"
                  • FailureDetails — (map)

                    Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

                    • Message — (String)

                      A detailed error message.

                • DeploymentType — (String)

                  The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

                  SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

                  The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

                  The default is SCRATCH_1.

                  Possible values include:
                  • "SCRATCH_1"
                  • "SCRATCH_2"
                  • "PERSISTENT_1"
                  • "PERSISTENT_2"
                • PerUnitStorageThroughput — (Integer)

                  Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

                  Valid values:

                  • For PERSISTENT_1 SSD storage: 50, 100, 200.

                  • For PERSISTENT_1 HDD storage: 12, 40.

                  • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

                • MountName — (String)

                  You use the MountName value when mounting the file system.

                  For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

                • DailyAutomaticBackupStartTime — (String)

                  A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

                • AutomaticBackupRetentionDays — (Integer)

                  The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

                • CopyTagsToBackups — (Boolean)

                  A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

                • DriveCacheType — (String)

                  The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

                  This parameter is required when StorageType is set to HDD.

                  Possible values include:
                  • "NONE"
                  • "READ"
                • DataCompressionType — (String)

                  The data compression configuration for the file system. DataCompressionType can have the following values:

                  • NONE - Data compression is turned off for the file system.

                  • LZ4 - Data compression is turned on with the LZ4 algorithm.

                  For more information, see Lustre data compression.

                  Possible values include:
                  • "NONE"
                  • "LZ4"
                • LogConfiguration — (map)

                  The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

                  • Levelrequired — (String)

                    The data repository events that are logged by Amazon FSx.

                    • WARN_ONLY - only warning events are logged.

                    • ERROR_ONLY - only error events are logged.

                    • WARN_ERROR - both warning events and error events are logged.

                    • DISABLED - logging of data repository events is turned off.

                    Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

                    Possible values include:
                    • "DISABLED"
                    • "WARN_ONLY"
                    • "ERROR_ONLY"
                    • "WARN_ERROR"
                  • Destination — (String)

                    The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

                • RootSquashConfiguration — (map)

                  The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

                  • RootSquash — (String)

                    You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

                    • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

                    • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

                    When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

                  • NoSquashNids — (Array<String>)

                    When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

                    • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

                    • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

                • MetadataConfiguration — (map)

                  The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

                  • Iops — (Integer)

                    The number of Metadata IOPS provisioned for the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

                  • Moderequired — (String)

                    The metadata configuration mode for provisioning Metadata IOPS for the file system.

                    • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity.

                    • In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system.

                    Possible values include:
                    • "AUTOMATIC"
                    • "USER_PROVISIONED"
              • OntapConfiguration — (map)

                The configuration for this Amazon FSx for NetApp ONTAP file system.

                • AutomaticBackupRetentionDays — (Integer)

                  The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

                • DailyAutomaticBackupStartTime — (String)

                  A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

                • DeploymentType — (String)

                  Specifies the FSx for ONTAP file system deployment type in use in the file system.

                  • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

                  • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

                  • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

                  • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

                  For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

                  Possible values include:
                  • "MULTI_AZ_1"
                  • "SINGLE_AZ_1"
                  • "SINGLE_AZ_2"
                  • "MULTI_AZ_2"
                • EndpointIpAddressRange — (String)

                  (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

                • Endpoints — (map)

                  The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

                  • Intercluster — (map)

                    An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

                    • DNSName — (String)

                      The file system's DNS name. You can mount your file system using its DNS name.

                    • IpAddresses — (Array<String>)

                      IP addresses of the file system endpoint.

                  • Management — (map)

                    An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

                    • DNSName — (String)

                      The file system's DNS name. You can mount your file system using its DNS name.

                    • IpAddresses — (Array<String>)

                      IP addresses of the file system endpoint.

                • DiskIopsConfiguration — (map)

                  The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

                  • Mode — (String)

                    Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                    Possible values include:
                    • "AUTOMATIC"
                    • "USER_PROVISIONED"
                  • Iops — (Integer)

                    The total number of SSD IOPS provisioned for the file system.

                    The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                    Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

                • PreferredSubnetId — (String)

                  The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

                • RouteTableIds — (Array<String>)

                  (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

                • ThroughputCapacity — (Integer)

                  The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

                • WeeklyMaintenanceStartTime — (String)

                  A recurring weekly time, in the format D:HH:MM.

                  D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

                  HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

                  For example, 1:05:00 specifies maintenance at 5 AM Monday.

                • FsxAdminPassword — (String)

                  You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.

                • HAPairs — (Integer)

                  Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                  • The value of HAPairs is less than 1 or greater than 12.

                  • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.

                • ThroughputCapacityPerHAPair — (Integer)

                  Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

                  This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

                  This field and ThroughputCapacity are the same for file systems with one HA pair.

                  • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

                  • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

                  • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                  • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

                  • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

                  • The value of ThroughputCapacityPerHAPair is not a valid value.

              • FileSystemTypeVersion — (String)

                The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

              • OpenZFSConfiguration — (map)

                The configuration for this Amazon FSx for OpenZFS file system.

                • AutomaticBackupRetentionDays — (Integer)

                  The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

                • CopyTagsToBackups — (Boolean)

                  A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

                • CopyTagsToVolumes — (Boolean)

                  A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

                • DailyAutomaticBackupStartTime — (String)

                  A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

                • DeploymentType — (String)

                  Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

                  Possible values include:
                  • "SINGLE_AZ_1"
                  • "SINGLE_AZ_2"
                  • "SINGLE_AZ_HA_1"
                  • "SINGLE_AZ_HA_2"
                  • "MULTI_AZ_1"
                • ThroughputCapacity — (Integer)

                  The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

                • WeeklyMaintenanceStartTime — (String)

                  A recurring weekly time, in the format D:HH:MM.

                  D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

                  HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

                  For example, 1:05:00 specifies maintenance at 5 AM Monday.

                • DiskIopsConfiguration — (map)

                  The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

                  • Mode — (String)

                    Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                    Possible values include:
                    • "AUTOMATIC"
                    • "USER_PROVISIONED"
                  • Iops — (Integer)

                    The total number of SSD IOPS provisioned for the file system.

                    The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                    Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

                • RootVolumeId — (String)

                  The ID of the root volume of the OpenZFS file system.

                • PreferredSubnetId — (String)

                  Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

                • EndpointIpAddressRange — (String)

                  (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

                • RouteTableIds — (Array<String>)

                  (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

                • EndpointIpAddress — (String)

                  The IP address of the endpoint that is used to access data or to manage the file system.

            • FailureDetails — (map)

              Provides information about a failed administrative action.

              • Message — (String)

                Error message providing details about the failed administrative action.

            • TargetSnapshotValues — (map)

              A snapshot of an Amazon FSx for OpenZFS volume.

              • ResourceARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • SnapshotId — (String)

                The ID of the snapshot.

              • Name — (String)

                The name of the snapshot.

              • VolumeId — (String)

                The ID of the volume that the snapshot is of.

              • CreationTime — (Date)

                The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

              • Lifecycle — (String)

                The lifecycle status of the snapshot.

                • PENDING - Amazon FSx hasn't started creating the snapshot.

                • CREATING - Amazon FSx is creating the snapshot.

                • DELETING - Amazon FSx is deleting the snapshot.

                • AVAILABLE - The snapshot is fully available.

                Possible values include:
                • "PENDING"
                • "CREATING"
                • "DELETING"
                • "AVAILABLE"
              • LifecycleTransitionReason — (map)

                Describes why a resource lifecycle state changed.

                • Message — (String)

                  A detailed error message.

              • Tags — (Array<map>)

                A list of Tag values, with a maximum of 50 elements.

                • Keyrequired — (String)

                  A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

                • Valuerequired — (String)

                  A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

            • TotalTransferBytes — (Integer)

              The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

            • RemainingTransferBytes — (Integer)

              The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

          • OpenZFSConfiguration — (map)

            The configuration of an Amazon FSx for OpenZFS volume.

            • ParentVolumeId — (String)

              The ID of the parent volume.

            • VolumePath — (String)

              The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

            • StorageCapacityReservationGiB — (Integer)

              The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

            • StorageCapacityQuotaGiB — (Integer)

              The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

            • RecordSizeKiB — (Integer)

              The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

            • DataCompressionType — (String)

              Specifies the method used to compress the data on the volume. The compression type is NONE by default.

              • NONE - Doesn't compress the data on the volume. NONE is the default.

              • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

              • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

              Possible values include:
              • "NONE"
              • "ZSTD"
              • "LZ4"
            • CopyTagsToSnapshots — (Boolean)

              A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

            • OriginSnapshot — (map)

              The configuration object that specifies the snapshot to use as the origin of the data for the volume.

              • SnapshotARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • CopyStrategy — (String)

                The strategy used when copying data from the snapshot to the new volume.

                • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                • FULL_COPY - Copies all data from the snapshot to the new volume.

                Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                Possible values include:
                • "CLONE"
                • "FULL_COPY"
                • "INCREMENTAL_COPY"
            • ReadOnly — (Boolean)

              A Boolean value indicating whether the volume is read-only.

            • NfsExports — (Array<map>)

              The configuration object for mounting a Network File System (NFS) file system.

              • ClientConfigurationsrequired — (Array<map>)

                A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

                • Clientsrequired — (String)

                  A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.

                • Optionsrequired — (Array<String>)

                  The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:

                  • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.

                  • sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

            • UserAndGroupQuotas — (Array<map>)

              An object specifying how much storage users or groups can use on the volume.

              • Typerequired — (String)

                Specifies whether the quota applies to a user or group.

                Possible values include:
                • "USER"
                • "GROUP"
              • Idrequired — (Integer)

                The ID of the user or group that the quota applies to.

              • StorageCapacityQuotaGiBrequired — (Integer)

                The user or group's storage quota, in gibibytes (GiB).

            • RestoreToSnapshot — (String)

              Specifies the ID of the snapshot to which the volume was restored.

            • DeleteIntermediateSnaphots — (Boolean)

              A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

            • DeleteClonedVolumes — (Boolean)

              A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

            • DeleteIntermediateData — (Boolean)

              A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

            • SourceSnapshotARN — (String)

              The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

            • DestinationSnapshot — (String)

              The ID of the snapshot that's being copied or was most recently copied to the destination volume.

            • CopyStrategy — (String)

              Specifies the strategy used when copying data from the snapshot to the new volume.

              • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

              • FULL_COPY - Copies all data from the snapshot to the new volume.

                Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

              Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
              Possible values include:
              • "CLONE"
              • "FULL_COPY"
              • "INCREMENTAL_COPY"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDataRepositoryAssociation(params = {}, callback) ⇒ AWS.Request

Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

Note: CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.

Service Reference:

Examples:

Calling the createDataRepositoryAssociation operation

var params = {
  DataRepositoryPath: 'STRING_VALUE', /* required */
  FileSystemId: 'STRING_VALUE', /* required */
  BatchImportMetaDataOnCreate: true || false,
  ClientRequestToken: 'STRING_VALUE',
  FileSystemPath: 'STRING_VALUE',
  ImportedFileChunkSize: 'NUMBER_VALUE',
  S3: {
    AutoExportPolicy: {
      Events: [
        NEW | CHANGED | DELETED,
        /* more items */
      ]
    },
    AutoImportPolicy: {
      Events: [
        NEW | CHANGED | DELETED,
        /* more items */
      ]
    }
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
fsx.createDataRepositoryAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      The globally unique ID of the file system, assigned by Amazon FSx.

    • FileSystemPath — (String)

      A path on the file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.

      This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

      Note: If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.
    • DataRepositoryPath — (String)

      The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to.

    • BatchImportMetaDataOnCreate — (Boolean)

      Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is false.

    • ImportedFileChunkSize — (Integer)

      For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

      The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

    • S3 — (map)

      The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

      • AutoImportPolicy — (map)

        Specifies the type of updated objects (new, changed, deleted) that will be automatically imported from the linked S3 bucket to your file system.

        • Events — (Array<String>)

          The AutoImportPolicy can have the following event values:

          • NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.

          • CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.

          • DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.

          You can define any combination of event types for your AutoImportPolicy.

      • AutoExportPolicy — (map)

        Specifies the type of updated objects (new, changed, deleted) that will be automatically exported from your file system to the linked S3 bucket.

        • Events — (Array<String>)

          The AutoExportPolicy can have the following event values:

          • NEW - New files and directories are automatically exported to the data repository as they are added to the file system.

          • CHANGED - Changes to files and directories on the file system are automatically exported to the data repository.

          • DELETED - Files and directories are automatically deleted on the data repository when they are deleted on the file system.

          You can define any combination of event types for your AutoExportPolicy.

    • ClientRequestToken — (String)

      (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      A list of Tag values, with a maximum of 50 elements.

      • Keyrequired — (String)

        A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

      • Valuerequired — (String)

        A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Association — (map)

        The response object returned after the data repository association is created.

        • AssociationId — (String)

          The system-generated, unique ID of the data repository association.

        • ResourceARN — (String)

          The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

        • FileSystemId — (String)

          The globally unique ID of the file system, assigned by Amazon FSx.

        • Lifecycle — (String)

          Describes the state of a data repository association. The lifecycle can have the following values:

          • CREATING - The data repository association between the file system or cache and the data repository is being created. The data repository is unavailable.

          • AVAILABLE - The data repository association is available for use.

          • MISCONFIGURED - The data repository association is misconfigured. Until the configuration is corrected, automatic import and automatic export will not work (only for Amazon FSx for Lustre).

          • UPDATING - The data repository association is undergoing a customer initiated update that might affect its availability.

          • DELETING - The data repository association is undergoing a customer initiated deletion.

          • FAILED - The data repository association is in a terminal state that cannot be recovered.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "MISCONFIGURED"
          • "UPDATING"
          • "DELETING"
          • "FAILED"
        • FailureDetails — (map)

          Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

          • Message — (String)

            A detailed error message.

        • FileSystemPath — (String)

          A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2.

          This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.

          Note: If you specify only a forward slash (/) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.
        • DataRepositoryPath — (String)

          The path to the data repository that will be linked to the cache or file system.

          • For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats:

            • If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.

            • If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.

          • For Amazon File Cache, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

          • For Amazon FSx for Lustre, the path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

        • BatchImportMetaDataOnCreate — (Boolean)

          A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true.

          Note: BatchImportMetaDataOnCreate is not supported for data repositories linked to an Amazon File Cache resource.
        • ImportedFileChunkSize — (Integer)

          For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.

          The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

        • S3 — (map)

          The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association.

          • AutoImportPolicy — (map)

            Specifies the type of updated objects (new, changed, deleted) that will be automatically imported from the linked S3 bucket to your file system.

            • Events — (Array<String>)

              The AutoImportPolicy can have the following event values:

              • NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.

              • CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.

              • DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.

              You can define any combination of event types for your AutoImportPolicy.

          • AutoExportPolicy — (map)

            Specifies the type of updated objects (new, changed, deleted) that will be automatically exported from your file system to the linked S3 bucket.

            • Events — (Array<String>)

              The AutoExportPolicy can have the following event values:

              • NEW - New files and directories are automatically exported to the data repository as they are added to the file system.

              • CHANGED - Changes to files and directories on the file system are automatically exported to the data repository.

              • DELETED - Files and directories are automatically deleted on the data repository when they are deleted on the file system.

              You can define any combination of event types for your AutoExportPolicy.

        • Tags — (Array<map>)

          A list of Tag values, with a maximum of 50 elements.

          • Keyrequired — (String)

            A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

          • Valuerequired — (String)

            A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

        • CreationTime — (Date)

          The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

        • FileCacheId — (String)

          The globally unique ID of the Amazon File Cache resource.

        • FileCachePath — (String)

          A path on the Amazon File Cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the path is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.

          This path specifies the directory in your cache where files will be exported from. This cache directory can be linked to only one data repository (S3 or NFS) and no other data repository can be linked to the directory.

          Note: The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache. The cache path cannot be set to root (/) for an S3 DRA.
        • DataRepositorySubdirectories — (Array<String>)

          For Amazon File Cache, a list of NFS Exports that will be linked with an NFS data repository association. All the subdirectories must be on a single NFS file system. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.

        • NFS — (map)

          The configuration for an NFS data repository linked to an Amazon File Cache resource with a data repository association.

          • Versionrequired — (String)

            The version of the NFS (Network File System) protocol of the NFS data repository. Currently, the only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol.

            Possible values include:
            • "NFS3"
          • DnsIps — (Array<String>)

            A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.

          • AutoExportPolicy — (map)

            This parameter is not supported for Amazon File Cache.

            • Events — (Array<String>)

              The AutoExportPolicy can have the following event values:

              • NEW - New files and directories are automatically exported to the data repository as they are added to the file system.

              • CHANGED - Changes to files and directories on the file system are automatically exported to the data repository.

              • DELETED - Files and directories are automatically deleted on the data repository when they are deleted on the file system.

              You can define any combination of event types for your AutoExportPolicy.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDataRepositoryTask(params = {}, callback) ⇒ AWS.Request

Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system.

You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository.

You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre file system.

To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.

Service Reference:

Examples:

Calling the createDataRepositoryTask operation

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  Report: { /* required */
    Enabled: true || false, /* required */
    Format: REPORT_CSV_20191124,
    Path: 'STRING_VALUE',
    Scope: FAILED_FILES_ONLY
  },
  Type: EXPORT_TO_REPOSITORY | IMPORT_METADATA_FROM_REPOSITORY | RELEASE_DATA_FROM_FILESYSTEM | AUTO_RELEASE_DATA, /* required */
  CapacityToRelease: 'NUMBER_VALUE',
  ClientRequestToken: 'STRING_VALUE',
  Paths: [
    'STRING_VALUE',
    /* more items */
  ],
  ReleaseConfiguration: {
    DurationSinceLastAccess: {
      Unit: DAYS,
      Value: 'NUMBER_VALUE'
    }
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
fsx.createDataRepositoryTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Type — (String)

      Specifies the type of data repository task to create.

      • EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data repository.

      • IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.

      • RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.

      • AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

      Possible values include:
      • "EXPORT_TO_REPOSITORY"
      • "IMPORT_METADATA_FROM_REPOSITORY"
      • "RELEASE_DATA_FROM_FILESYSTEM"
      • "AUTO_RELEASE_DATA"
    • Paths — (Array<String>)

      A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).

      • For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. If the mount point is /mnt/fsx and /mnt/fsx/path1 is a directory or file on the file system you want to export, then the path to provide is path1.

      • For import tasks, the list contains paths in the Amazon S3 bucket from which POSIX metadata changes are imported to the FSx for Lustre file system. The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix (where myPrefix is optional).

      • For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.

        Note: A file must also meet the last accessed time criteria specified in for the file to be released.
    • FileSystemId — (String)

      The globally unique ID of the file system, assigned by Amazon FSx.

    • Report — (map)

      Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the Scope parameter. For more information, see Working with Task Completion Reports.

      • Enabledrequired — (Boolean)

        Set Enabled to True to generate a CompletionReport when the task completes. If set to true, then you need to provide a report Scope, Path, and Format. Set Enabled to False if you do not want a CompletionReport generated when the task completes.

      • Path — (String)

        Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The Path you provide must be located within the file system’s ExportPath. An example Path value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.

      • Format — (String)

        Required if Enabled is set to true. Specifies the format of the CompletionReport. REPORT_CSV_20191124 is the only format currently supported. When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in CSV format, and is delivered to {path}/task-{id}/failures.csv.

        Possible values include:
        • "REPORT_CSV_20191124"
      • Scope — (String)

        Required if Enabled is set to true. Specifies the scope of the CompletionReport; FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to FAILED_FILES_ONLY, the CompletionReport only contains information about files that the data repository task failed to process.

        Possible values include:
        • "FAILED_FILES_ONLY"
    • ClientRequestToken — (String)

      (Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      A list of Tag values, with a maximum of 50 elements.

      • Keyrequired — (String)

        A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

      • Valuerequired — (String)

        A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

    • CapacityToRelease — (Integer)

      Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

    • ReleaseConfiguration — (map)

      The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.

      • DurationSinceLastAccess — (map)

        Defines the point-in-time since an exported file was last accessed, in order for that file to be eligible for release. Only files that were last accessed before this point-in-time are eligible to be released from the file system.

        • Unit — (String)

          The unit of time used by the Value parameter to determine if a file can be released, based on when it was last accessed. DAYS is the only supported value. This is a required parameter.

          Possible values include:
          • "DAYS"
        • Value — (Integer)

          An integer that represents the minimum amount of time (in days) since a file was last accessed in the file system. Only exported files with a MAX(atime, ctime, mtime) timestamp that is more than this amount of time in the past (relative to the task create time) will be released. The default of Value is 0. This is a required parameter.

          Note: If an exported file meets the last accessed time criteria, its file or directory path must also be specified in the Paths parameter of the operation in order for the file to be released.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataRepositoryTask — (map)

        The description of the data repository task that you just created.

        • TaskIdrequired — (String)

          The system-generated, unique 17-digit ID of the data repository task.

        • Lifecyclerequired — (String)

          The lifecycle status of the data repository task, as follows:

          • PENDING - The task has not started.

          • EXECUTING - The task is in process.

          • FAILED - The task was not able to be completed. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.

          • SUCCEEDED - The task has completed successfully.

          • CANCELED - The task was canceled and it did not complete.

          • CANCELING - The task is in process of being canceled.

          Note: You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the PENDING or EXECUTING states. Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.
          Possible values include:
          • "PENDING"
          • "EXECUTING"
          • "FAILED"
          • "SUCCEEDED"
          • "CANCELED"
          • "CANCELING"
        • Typerequired — (String)

          The type of data repository task.

          • EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data repository.

          • IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.

          • RELEASE_DATA_FROM_FILESYSTEM tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.

          • AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

          Possible values include:
          • "EXPORT_TO_REPOSITORY"
          • "IMPORT_METADATA_FROM_REPOSITORY"
          • "RELEASE_DATA_FROM_FILESYSTEM"
          • "AUTO_RELEASE_DATA"
        • CreationTimerequired — (Date)

          The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

        • StartTime — (Date)

          The time the system began processing the task.

        • EndTime — (Date)

          The time the system completed processing the task, populated after the task is complete.

        • ResourceARN — (String)

          The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

        • Tags — (Array<map>)

          A list of Tag values, with a maximum of 50 elements.

          • Keyrequired — (String)

            A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

          • Valuerequired — (String)

            A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

        • FileSystemId — (String)

          The globally unique ID of the file system.

        • Paths — (Array<String>)

          An array of paths that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.

          (Default) If Paths is not specified, Amazon FSx uses the file system root directory.

        • FailureDetails — (map)

          Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.

          • Message — (String)

            A detailed error message.

        • Status — (map)

          Provides the status of the number of files that the task has processed successfully and failed to process.

          • TotalCount — (Integer)

            The total number of files that the task will process. While a task is executing, the sum of SucceededCount plus FailedCount may not equal TotalCount. When the task is complete, TotalCount equals the sum of SucceededCount plus FailedCount.

          • SucceededCount — (Integer)

            A running total of the number of files that the task has successfully processed.

          • FailedCount — (Integer)

            A running total of the number of files that the task failed to process.

          • LastUpdatedTime — (Date)

            The time at which the task status was last updated.

          • ReleasedCapacity — (Integer)

            The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

        • Report — (map)

          Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.

          • Enabledrequired — (Boolean)

            Set Enabled to True to generate a CompletionReport when the task completes. If set to true, then you need to provide a report Scope, Path, and Format. Set Enabled to False if you do not want a CompletionReport generated when the task completes.

          • Path — (String)

            Required if Enabled is set to true. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. The Path you provide must be located within the file system’s ExportPath. An example Path value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.

          • Format — (String)

            Required if Enabled is set to true. Specifies the format of the CompletionReport. REPORT_CSV_20191124 is the only format currently supported. When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in CSV format, and is delivered to {path}/task-{id}/failures.csv.

            Possible values include:
            • "REPORT_CSV_20191124"
          • Scope — (String)

            Required if Enabled is set to true. Specifies the scope of the CompletionReport; FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to FAILED_FILES_ONLY, the CompletionReport only contains information about files that the data repository task failed to process.

            Possible values include:
            • "FAILED_FILES_ONLY"
        • CapacityToRelease — (Integer)

          Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

        • FileCacheId — (String)

          The system-generated, unique ID of the cache.

        • ReleaseConfiguration — (map)

          The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.

          • DurationSinceLastAccess — (map)

            Defines the point-in-time since an exported file was last accessed, in order for that file to be eligible for release. Only files that were last accessed before this point-in-time are eligible to be released from the file system.

            • Unit — (String)

              The unit of time used by the Value parameter to determine if a file can be released, based on when it was last accessed. DAYS is the only supported value. This is a required parameter.

              Possible values include:
              • "DAYS"
            • Value — (Integer)

              An integer that represents the minimum amount of time (in days) since a file was last accessed in the file system. Only exported files with a MAX(atime, ctime, mtime) timestamp that is more than this amount of time in the past (relative to the task create time) will be released. The default of Value is 0. This is a required parameter.

              Note: If an exported file meets the last accessed time criteria, its file or directory path must also be specified in the Paths parameter of the operation in order for the file to be released.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFileCache(params = {}, callback) ⇒ AWS.Request

Creates a new Amazon File Cache resource.

You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn't exist, CreateFileCache does the following:

  • Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the cache in JSON format.

Note: The CreateFileCache call returns while the cache's lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.

Service Reference:

Examples:

Calling the createFileCache operation

var params = {
  FileCacheType: LUSTRE, /* required */
  FileCacheTypeVersion: 'STRING_VALUE', /* required */
  StorageCapacity: 'NUMBER_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  CopyTagsToDataRepositoryAssociations: true || false,
  DataRepositoryAssociations: [
    {
      DataRepositoryPath: 'STRING_VALUE', /* required */
      FileCachePath: 'STRING_VALUE', /* required */
      DataRepositorySubdirectories: [
        'STRING_VALUE',
        /* more items */
      ],
      NFS: {
        Version: NFS3, /* required */
        DnsIps: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    /* more items */
  ],
  KmsKeyId: 'STRING_VALUE',
  LustreConfiguration: {
    DeploymentType: CACHE_1, /* required */
    MetadataConfiguration: { /* required */
      StorageCapacity: 'NUMBER_VALUE' /* required */
    },
    PerUnitStorageThroughput: 'NUMBER_VALUE', /* required */
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  },
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
fsx.createFileCache(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientRequestToken — (String)

      An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

      By using the idempotent operation, you can retry a CreateFileCache operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.

      If a token is not provided, the SDK will use a version 4 UUID.
    • FileCacheType — (String)

      The type of cache that you're creating, which must be LUSTRE.

      Possible values include:
      • "LUSTRE"
    • FileCacheTypeVersion — (String)

      Sets the Lustre version for the cache that you're creating, which must be 2.12.

    • StorageCapacity — (Integer)

      The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

    • SubnetIds — (Array<String>)

      A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the CreateFileCache operation.

    • SecurityGroupIds — (Array<String>)

      A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.

    • Tags — (Array<map>)

      A list of Tag values, with a maximum of 50 elements.

      • Keyrequired — (String)

        A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

      • Valuerequired — (String)

        A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

    • CopyTagsToDataRepositoryAssociations — (Boolean)

      A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.

    • KmsKeyId — (String)

      Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

    • LustreConfiguration — (map)

      The configuration for the Amazon File Cache resource being created.

      • PerUnitStorageThroughputrequired — (Integer)

        Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.

      • DeploymentTyperequired — (String)

        Specifies the cache deployment type, which must be CACHE_1.

        Possible values include:
        • "CACHE_1"
      • WeeklyMaintenanceStartTime — (String)

        A recurring weekly time, in the format D:HH:MM.

        D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

        HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

        For example, 1:05:00 specifies maintenance at 5 AM Monday.

      • MetadataConfigurationrequired — (map)

        The configuration for a Lustre MDT (Metadata Target) storage volume.

        • StorageCapacityrequired — (Integer)

          The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.

    • DataRepositoryAssociations — (Array<map>)

      A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.

      The DRA configurations must meet the following requirements:

      • All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.

      • An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.

      DRA automatic import and automatic export is not supported.

      • FileCachePathrequired — (String)

        A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.

        This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory.

        Note: The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache. The cache path cannot be set to root (/) for an S3 DRA.
      • DataRepositoryPathrequired — (String)

        The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:

        • The path can be an NFS data repository that links to the cache. The path can be in one of two formats:

          • If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nfs://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.

          • If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.

        • The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/.

      • DataRepositorySubdirectories — (Array<String>)

        A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.

      • NFS — (map)

        The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

        • Versionrequired — (String)

          The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol.

          Possible values include:
          • "NFS3"
        • DnsIps — (Array<String>)

          A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FileCache — (map)

        A description of the cache that was created.

        • OwnerId — (String)

          An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

        • CreationTime — (Date)

          The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

        • FileCacheId — (String)

          The system-generated, unique ID of the cache.

        • FileCacheType — (String)

          The type of cache, which must be LUSTRE.

          Possible values include:
          • "LUSTRE"
        • FileCacheTypeVersion — (String)

          The Lustre version of the cache, which must be 2.12.

        • Lifecycle — (String)

          The lifecycle status of the cache. The following are the possible values and what they mean:

          • AVAILABLE - The cache is in a healthy state, and is reachable and available for use.

          • CREATING - The new cache is being created.

          • DELETING - An existing cache is being deleted.

          • UPDATING - The cache is undergoing a customer-initiated update.

          • FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "DELETING"
          • "UPDATING"
          • "FAILED"
        • FailureDetails — (map)

          A structure providing details of any failures that occurred in creating a cache.

          • Message — (String)

            A message describing any failures that occurred.

        • StorageCapacity — (Integer)

          The storage capacity of the cache in gibibytes (GiB).

        • VpcId — (String)

          The ID of your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

        • SubnetIds — (Array<String>)

          A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the CreateFileCache operation.

        • NetworkInterfaceIds — (Array<String>)

          A list of network interface IDs.

        • DNSName — (String)

          The Domain Name System (DNS) name for the cache.

        • KmsKeyId — (String)

          Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

        • ResourceARN — (String)

          The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

        • Tags — (Array<map>)

          A list of Tag values, with a maximum of 50 elements.

          • Keyrequired — (String)

            A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

          • Valuerequired — (String)

            A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

        • CopyTagsToDataRepositoryAssociations — (Boolean)

          A boolean flag indicating whether tags for the cache should be copied to data repository associations.

        • LustreConfiguration — (map)

          The configuration for the Amazon File Cache resource.

          • PerUnitStorageThroughput — (Integer)

            Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. Cache throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). The only supported value is 1000.

          • DeploymentType — (String)

            The deployment type of the Amazon File Cache resource, which must be CACHE_1.

            Possible values include:
            • "CACHE_1"
          • MountName — (String)

            You use the MountName value when mounting the cache. If you pass a cache ID to the DescribeFileCaches operation, it returns the the MountName value as part of the cache's description.

          • WeeklyMaintenanceStartTime — (String)

            A recurring weekly time, in the format D:HH:MM.

            D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

            HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

            For example, 1:05:00 specifies maintenance at 5 AM Monday.

          • MetadataConfiguration — (map)

            The configuration for a Lustre MDT (Metadata Target) storage volume.

            • StorageCapacityrequired — (Integer)

              The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.

          • LogConfiguration — (map)

            The configuration for Lustre logging used to write the enabled logging events for your Amazon File Cache resource to Amazon CloudWatch Logs.

            • Levelrequired — (String)

              The data repository events that are logged by Amazon FSx.

              • WARN_ONLY - only warning events are logged.

              • ERROR_ONLY - only error events are logged.

              • WARN_ERROR - both warning events and error events are logged.

              • DISABLED - logging of data repository events is turned off.

              Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

              Possible values include:
              • "DISABLED"
              • "WARN_ONLY"
              • "ERROR_ONLY"
              • "WARN_ERROR"
            • Destination — (String)

              The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

        • DataRepositoryAssociationIds — (Array<String>)

          A list of IDs of data repository associations that are associated with this cache.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFileSystem(params = {}, callback) ⇒ AWS.Request

Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:

  • Amazon FSx for Lustre

  • Amazon FSx for NetApp ONTAP

  • Amazon FSx for OpenZFS

  • Amazon FSx for Windows File Server

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:

  • Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system in JSON format.

Note: The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

Service Reference:

Examples:

To create a new file system


/* This operation creates a new Amazon FSx for Windows File Server file system. */

 var params = {
  ClientRequestToken: "a8ca07e4-61ec-4399-99f4-19853801bcd5", 
  FileSystemType: "WINDOWS", 
  KmsKeyId: "arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff", 
  SecurityGroupIds: [
     "sg-edcd9784"
  ], 
  StorageCapacity: 3200, 
  StorageType: "HDD", 
  SubnetIds: [
     "subnet-1234abcd"
  ], 
  Tags: [
     {
    Key: "Name", 
    Value: "MyFileSystem"
   }
  ], 
  WindowsConfiguration: {
   ActiveDirectoryId: "d-1234abcd12", 
   Aliases: [
      "accounting.corp.example.com"
   ], 
   AutomaticBackupRetentionDays: 30, 
   DailyAutomaticBackupStartTime: "05:00", 
   ThroughputCapacity: 32, 
   WeeklyMaintenanceStartTime: "1:05:00"
  }
 };
 fsx.createFileSystem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FileSystem: {
     CreationTime: <Date Representation>, 
     DNSName: "fs-0123456789abcdef0.fsx.com", 
     FileSystemId: "fs-0123456789abcdef0", 
     KmsKeyId: "arn:aws:kms:us-east-1:012345678912:key/1111abcd-2222-3333-4444-55556666eeff", 
     Lifecycle: "CREATING", 
     OwnerId: "012345678912", 
     ResourceARN: "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0123456789abcdef0", 
     StorageCapacity: 3200, 
     StorageType: "HDD", 
     SubnetIds: [
        "subnet-1234abcd"
     ], 
     Tags: [
        {
       Key: "Name", 
       Value: "MyFileSystem"
      }
     ], 
     VpcId: "vpc-ab1234cd", 
     WindowsConfiguration: {
      ActiveDirectoryId: "d-1234abcd12", 
      Aliases: [
         {
        Lifecycle: "CREATING", 
        Name: "accounting.corp.example.com"
       }
      ], 
      AutomaticBackupRetentionDays: 30, 
      DailyAutomaticBackupStartTime: "05:00", 
      ThroughputCapacity: 32, 
      WeeklyMaintenanceStartTime: "1:05:00"
     }
    }
   }
   */
 });

Calling the createFileSystem operation

var params = {
  FileSystemType: WINDOWS | LUSTRE | ONTAP | OPENZFS, /* required */
  StorageCapacity: 'NUMBER_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  FileSystemTypeVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  LustreConfiguration: {
    AutoImportPolicy: NONE | NEW | NEW_CHANGED | NEW_CHANGED_DELETED,
    AutomaticBackupRetentionDays: 'NUMBER_VALUE',
    CopyTagsToBackups: true || false,
    DailyAutomaticBackupStartTime: 'STRING_VALUE',
    DataCompressionType: NONE | LZ4,
    DeploymentType: SCRATCH_1 | SCRATCH_2 | PERSISTENT_1 | PERSISTENT_2,
    DriveCacheType: NONE | READ,
    ExportPath: 'STRING_VALUE',
    ImportPath: 'STRING_VALUE',
    ImportedFileChunkSize: 'NUMBER_VALUE',
    LogConfiguration: {
      Level: DISABLED | WARN_ONLY | ERROR_ONLY | WARN_ERROR, /* required */
      Destination: 'STRING_VALUE'
    },
    MetadataConfiguration: {
      Mode: AUTOMATIC | USER_PROVISIONED, /* required */
      Iops: 'NUMBER_VALUE'
    },
    PerUnitStorageThroughput: 'NUMBER_VALUE',
    RootSquashConfiguration: {
      NoSquashNids: [
        'STRING_VALUE',
        /* more items */
      ],
      RootSquash: 'STRING_VALUE'
    },
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  },
  OntapConfiguration: {
    DeploymentType: MULTI_AZ_1 | SINGLE_AZ_1 | SINGLE_AZ_2 | MULTI_AZ_2, /* required */
    AutomaticBackupRetentionDays: 'NUMBER_VALUE',
    DailyAutomaticBackupStartTime: 'STRING_VALUE',
    DiskIopsConfiguration: {
      Iops: 'NUMBER_VALUE',
      Mode: AUTOMATIC | USER_PROVISIONED
    },
    EndpointIpAddressRange: 'STRING_VALUE',
    FsxAdminPassword: 'STRING_VALUE',
    HAPairs: 'NUMBER_VALUE',
    PreferredSubnetId: 'STRING_VALUE',
    RouteTableIds: [
      'STRING_VALUE',
      /* more items */
    ],
    ThroughputCapacity: 'NUMBER_VALUE',
    ThroughputCapacityPerHAPair: 'NUMBER_VALUE',
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  },
  OpenZFSConfiguration: {
    DeploymentType: SINGLE_AZ_1 | SINGLE_AZ_2 | SINGLE_AZ_HA_1 | SINGLE_AZ_HA_2 | MULTI_AZ_1, /* required */
    ThroughputCapacity: 'NUMBER_VALUE', /* required */
    AutomaticBackupRetentionDays: 'NUMBER_VALUE',
    CopyTagsToBackups: true || false,
    CopyTagsToVolumes: true || false,
    DailyAutomaticBackupStartTime: 'STRING_VALUE',
    DiskIopsConfiguration: {
      Iops: 'NUMBER_VALUE',
      Mode: AUTOMATIC | USER_PROVISIONED
    },
    EndpointIpAddressRange: 'STRING_VALUE',
    PreferredSubnetId: 'STRING_VALUE',
    RootVolumeConfiguration: {
      CopyTagsToSnapshots: true || false,
      DataCompressionType: NONE | ZSTD | LZ4,
      NfsExports: [
        {
          ClientConfigurations: [ /* required */
            {
              Clients: 'STRING_VALUE', /* required */
              Options: [ /* required */
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      ReadOnly: true || false,
      RecordSizeKiB: 'NUMBER_VALUE',
      UserAndGroupQuotas: [
        {
          Id: 'NUMBER_VALUE', /* required */
          StorageCapacityQuotaGiB: 'NUMBER_VALUE', /* required */
          Type: USER | GROUP /* required */
        },
        /* more items */
      ]
    },
    RouteTableIds: [
      'STRING_VALUE',
      /* more items */
    ],
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  },
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  StorageType: SSD | HDD,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  WindowsConfiguration: {
    ThroughputCapacity: 'NUMBER_VALUE', /* required */
    ActiveDirectoryId: 'STRING_VALUE',
    Aliases: [
      'STRING_VALUE',
      /* more items */
    ],
    AuditLogConfiguration: {
      FileAccessAuditLogLevel: DISABLED | SUCCESS_ONLY | FAILURE_ONLY | SUCCESS_AND_FAILURE, /* required */
      FileShareAccessAuditLogLevel: DISABLED | SUCCESS_ONLY | FAILURE_ONLY | SUCCESS_AND_FAILURE, /* required */
      AuditLogDestination: 'STRING_VALUE'
    },
    AutomaticBackupRetentionDays: 'NUMBER_VALUE',
    CopyTagsToBackups: true || false,
    DailyAutomaticBackupStartTime: 'STRING_VALUE',
    DeploymentType: MULTI_AZ_1 | SINGLE_AZ_1 | SINGLE_AZ_2,
    DiskIopsConfiguration: {
      Iops: 'NUMBER_VALUE',
      Mode: AUTOMATIC | USER_PROVISIONED
    },
    PreferredSubnetId: 'STRING_VALUE',
    SelfManagedActiveDirectoryConfiguration: {
      DnsIps: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      DomainName: 'STRING_VALUE', /* required */
      Password: 'STRING_VALUE', /* required */
      UserName: 'STRING_VALUE', /* required */
      FileSystemAdministratorsGroup: 'STRING_VALUE',
      OrganizationalUnitDistinguishedName: 'STRING_VALUE'
    },
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  }
};
fsx.createFileSystem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientRequestToken — (String)

      A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • FileSystemType — (String)

      The type of Amazon FSx file system to create. Valid values are WINDOWS, LUSTRE, ONTAP, and OPENZFS.

      Possible values include:
      • "WINDOWS"
      • "LUSTRE"
      • "ONTAP"
      • "OPENZFS"
    • StorageCapacity — (Integer)

      Sets the storage capacity of the file system that you're creating, in gibibytes (GiB).

      FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType, as follows:

      • For SCRATCH_2, PERSISTENT_2, and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

      • For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.

      • For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.

      FSx for ONTAP file systems - The amount of storage capacity that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 * HAPairs and the maximum is calculated as 524,288 * HAPairs.

      FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).

      FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:

      • For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).

      • For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).

    • StorageType — (String)

      Sets the storage type for the file system that you're creating. Valid values are SSD and HDD.

      • Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.

      • Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types.

      Default value is SSD. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide.

      Possible values include:
      • "SSD"
      • "HDD"
    • SubnetIds — (Array<String>)

      Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP MULTI_AZ_1 deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID or OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide.

      For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

    • SecurityGroupIds — (Array<String>)

      A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

      You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.

    • Tags — (Array<map>)

      The tags to apply to the file system that's being created. The key value of the Name tag appears in the console as the file system name.

      • Keyrequired — (String)

        A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

      • Valuerequired — (String)

        A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

    • KmsKeyId — (String)

      Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:

      • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

        SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

      • Amazon FSx for NetApp ONTAP

      • Amazon FSx for OpenZFS

      • Amazon FSx for Windows File Server

      If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

    • WindowsConfiguration — (map)

      The Microsoft Windows configuration for the file system that's being created.

      • ActiveDirectoryId — (String)

        The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.

      • SelfManagedActiveDirectoryConfiguration — (map)

        The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs.

        • DomainNamerequired — (String)

          The fully qualified domain name of the self-managed AD directory, such as corp.example.com.

        • OrganizationalUnitDistinguishedName — (String)

          (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.

          Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.

        • FileSystemAdministratorsGroup — (String)

          (Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.

        • UserNamerequired — (String)

          The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.

        • Passwordrequired — (String)

          The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

        • DnsIpsrequired — (Array<String>)

          A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

      • DeploymentType — (String)

        Specifies the file system deployment type, valid values are the following:

        • MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage type

        • SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.

        • SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.

        For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.

        Possible values include:
        • "MULTI_AZ_1"
        • "SINGLE_AZ_1"
        • "SINGLE_AZ_2"
      • PreferredSubnetId — (String)

        Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-Amazon Web Services applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.

      • ThroughputCapacityrequired — (Integer)

        Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the nth increments, between 23 (8) and 211 (2048).

      • WeeklyMaintenanceStartTime — (String)

        The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

      • DailyAutomaticBackupStartTime — (String)

        The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.

      • AutomaticBackupRetentionDays — (Integer)

        The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

      • CopyTagsToBackups — (Boolean)

        A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

      • Aliases — (Array<String>)

        An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.

        For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

        An alias name has to meet the following requirements:

        • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

        • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

        • Cannot start or end with a hyphen.

        • Can start with a numeric.

        For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

      • AuditLogConfiguration — (map)

        The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

        • FileAccessAuditLogLevelrequired — (String)

          Sets which attempt type is logged by Amazon FSx for file and folder accesses.

          • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

          • FAILURE_ONLY - only failed attempts to access files or folders are logged.

          • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

          • DISABLED - access auditing of files and folders is turned off.

          Possible values include:
          • "DISABLED"
          • "SUCCESS_ONLY"
          • "FAILURE_ONLY"
          • "SUCCESS_AND_FAILURE"
        • FileShareAccessAuditLogLevelrequired — (String)

          Sets which attempt type is logged by Amazon FSx for file share accesses.

          • SUCCESS_ONLY - only successful attempts to access file shares are logged.

          • FAILURE_ONLY - only failed attempts to access file shares are logged.

          • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

          • DISABLED - access auditing of file shares is turned off.

          Possible values include:
          • "DISABLED"
          • "SUCCESS_ONLY"
          • "FAILURE_ONLY"
          • "SUCCESS_AND_FAILURE"
        • AuditLogDestination — (String)

          The Amazon Resource Name (ARN) that specifies the destination of the audit logs.

          The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN, with the following requirements:

          • The destination ARN that you provide (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

          • The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

          • If you do not provide a destination in AuditLogDestination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.

          • If AuditLogDestination is provided and the resource does not exist, the request will fail with a BadRequest error.

          • If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel are both set to DISABLED, you cannot specify a destination in AuditLogDestination.

      • DiskIopsConfiguration — (map)

        The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

        • Mode — (String)

          Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

          Possible values include:
          • "AUTOMATIC"
          • "USER_PROVISIONED"
        • Iops — (Integer)

          The total number of SSD IOPS provisioned for the file system.

          The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

          Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

    • LustreConfiguration — (map)

      The Lustre configuration for the file system being created.

      Note: The following parameters are not supported for file systems with a data repository association created with .
      • AutoImportPolicy
      • ExportPath
      • ImportedFileChunkSize
      • ImportPath
      • WeeklyMaintenanceStartTime — (String)

        (Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

      • ImportPath — (String)

        (Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

        Note: This parameter is not supported for file systems with a data repository association.
      • ExportPath — (String)

        (Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.

        The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you specify only a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.

        Note: This parameter is not supported for file systems with a data repository association.
      • ImportedFileChunkSize — (Integer)

        (Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

        The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

        Note: This parameter is not supported for file systems with a data repository association.
      • DeploymentType — (String)

        (Optional) Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

        Choose PERSISTENT_1 for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1 supports encryption of data in transit, and is available in all Amazon Web Services Regions in which FSx for Lustre is available.

        Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2 supports SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). You can optionally specify a metadata configuration mode for PERSISTENT_2 which supports increasing metadata performance. PERSISTENT_2 is available in a limited number of Amazon Web Services Regions. For more information, and an up-to-date list of Amazon Web Services Regions in which PERSISTENT_2 is available, see File system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.

        Note: If you choose PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the CreateFileSystem operation fails.

        Encryption of data in transit is automatically turned on when you access SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 file systems from Amazon EC2 instances that support automatic encryption in the Amazon Web Services Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide.

        (Default = SCRATCH_1)

        Possible values include:
        • "SCRATCH_1"
        • "SCRATCH_2"
        • "PERSISTENT_1"
        • "PERSISTENT_2"
      • AutoImportPolicy — (String)

        (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this parameter to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

        • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

        • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

        • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

        • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

        For more information, see Automatically import updates from your S3 bucket.

        Note: This parameter is not supported for file systems with a data repository association.
        Possible values include:
        • "NONE"
        • "NEW"
        • "NEW_CHANGED"
        • "NEW_CHANGED_DELETED"
      • PerUnitStorageThroughput — (Integer)

        Required with PERSISTENT_1 and PERSISTENT_2 deployment types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.

        Valid values:

        • For PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB.

        • For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB.

        • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.

      • DailyAutomaticBackupStartTime — (String)

        A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

      • AutomaticBackupRetentionDays — (Integer)

        The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.

      • CopyTagsToBackups — (Boolean)

        (Optional) Not available for use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If CopyTagsToBackups is set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If CopyTagsToBackups is set to true and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

        (Default = false)

        For more information, see Working with backups in the Amazon FSx for Lustre User Guide.

      • DriveCacheType — (String)

        The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set this property to READ to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system.

        This parameter is required when StorageType is set to HDD.

        Possible values include:
        • "NONE"
        • "READ"
      • DataCompressionType — (String)

        Sets the data compression configuration for the file system. DataCompressionType can have the following values:

        • NONE - (Default) Data compression is turned off when the file system is created.

        • LZ4 - Data compression is turned on with the LZ4 algorithm.

        For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide.

        Possible values include:
        • "NONE"
        • "LZ4"
      • LogConfiguration — (map)

        The Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.

        • Levelrequired — (String)

          Sets which data repository events are logged by Amazon FSx.

          • WARN_ONLY - only warning events are logged.

          • ERROR_ONLY - only error events are logged.

          • WARN_ERROR - both warning events and error events are logged.

          • DISABLED - logging of data repository events is turned off.

          Possible values include:
          • "DISABLED"
          • "WARN_ONLY"
          • "ERROR_ONLY"
          • "WARN_ERROR"
        • Destination — (String)

          The Amazon Resource Name (ARN) that specifies the destination of the logs.

          The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:

          • The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

          • The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.

          • If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon File Cache).

          • If Destination is provided and the resource does not exist, the request will fail with a BadRequest error.

          • If Level is set to DISABLED, you cannot specify a destination in Destination.

      • RootSquashConfiguration — (map)

        The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

        • RootSquash — (String)

          You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

          • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

          • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

          When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

        • NoSquashNids — (Array<String>)

          When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

          • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

          • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

      • MetadataConfiguration — (map)

        The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using a PERSISTENT_2 deployment type.

        • Iops — (Integer)

          (USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision for the file system. This parameter sets the maximum rate of metadata disk IOPS supported by the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

          Note: Iops doesn’t have a default value. If you're using USER_PROVISIONED mode, you can choose to specify a valid value. If you're using AUTOMATIC mode, you cannot specify a value because FSx for Lustre automatically sets the value based on your file system storage capacity.
        • Moderequired — (String)

          The metadata configuration mode for provisioning Metadata IOPS for an FSx for Lustre file system using a PERSISTENT_2 deployment type.

          • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS for your file system based on your file system storage capacity.

          • In USER_PROVISIONED mode, you specify the number of Metadata IOPS to provision for your file system.

          Possible values include:
          • "AUTOMATIC"
          • "USER_PROVISIONED"
    • OntapConfiguration — (map)

      The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

      • AutomaticBackupRetentionDays — (Integer)

        The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

      • DailyAutomaticBackupStartTime — (String)

        A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

      • DeploymentTyperequired — (String)

        Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

        • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

        • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

        • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

        • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

        For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

        Possible values include:
        • "MULTI_AZ_1"
        • "SINGLE_AZ_1"
        • "SINGLE_AZ_2"
        • "MULTI_AZ_2"
      • EndpointIpAddressRange — (String)

        (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

      • FsxAdminPassword — (String)

        The ONTAP administrative password for the fsxadmin user with which you administer your file system using the NetApp ONTAP CLI and REST API.

      • DiskIopsConfiguration — (map)

        The SSD IOPS configuration for the FSx for ONTAP file system.

        • Mode — (String)

          Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

          Possible values include:
          • "AUTOMATIC"
          • "USER_PROVISIONED"
        • Iops — (Integer)

          The total number of SSD IOPS provisioned for the file system.

          The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

          Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

      • PreferredSubnetId — (String)

        Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2. This specifies the subnet in which you want the preferred file server to be located.

      • RouteTableIds — (Array<String>)

        (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

        Note: Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.
      • ThroughputCapacity — (Integer)

        Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps). For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.

        Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

        • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

        • The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity.

      • WeeklyMaintenanceStartTime — (String)

        A recurring weekly time, in the format D:HH:MM.

        D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

        HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

        For example, 1:05:00 specifies maintenance at 5 AM Monday.

      • HAPairs — (Integer)

        Specifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.

        Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

        • The value of HAPairs is less than 1 or greater than 12.

        • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.

      • ThroughputCapacityPerHAPair — (Integer)

        Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.

        You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.

        This field and ThroughputCapacity are the same for file systems powered by one HA pair.

        • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

        • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

        • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

        Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

        • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.

        • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

        • The value of ThroughputCapacityPerHAPair is not a valid value.

    • FileSystemTypeVersion — (String)

      For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. Valid values are 2.10, 2.12, and 2.15:

      • 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.

      • 2.12 is supported by all Lustre deployment types, except for PERSISTENT_2 with a metadata configuration mode.

      • 2.15 is supported by all Lustre deployment types and is recommended for all new file systems.

      Default value is 2.10, except for the following deployments:

      • Default value is 2.12 when DeploymentType is set to PERSISTENT_2 without a metadata configuration mode.

      • Default value is 2.15 when DeploymentType is set to PERSISTENT_2 with a metadata configuration mode.

    • OpenZFSConfiguration — (map)

      The OpenZFS configuration for the file system that's being created.

      • AutomaticBackupRetentionDays — (Integer)

        The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

      • CopyTagsToBackups — (Boolean)

        A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

      • CopyTagsToVolumes — (Boolean)

        A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false. If it's set to true, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

      • DailyAutomaticBackupStartTime — (String)

        A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

      • DeploymentTyperequired — (String)

        Specifies the file system deployment type. Valid values are the following:

        • MULTI_AZ_1- Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same Amazon Web Services Region.

        • SINGLE_AZ_HA_2- Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone.

        • SINGLE_AZ_HA_1- Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone.

        • SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache that automatically recover within a single Availability Zone.

        • SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone.

        For a list of which Amazon Web Services Regions each deployment type is available in, see Deployment type availability. For more information on the differences in performance between deployment types, see File system performance in the Amazon FSx for OpenZFS User Guide.

        Possible values include:
        • "SINGLE_AZ_1"
        • "SINGLE_AZ_2"
        • "SINGLE_AZ_HA_1"
        • "SINGLE_AZ_HA_2"
        • "MULTI_AZ_1"
      • ThroughputCapacityrequired — (Integer)

        Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:

        • For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.

        • For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.

        You pay for additional throughput capacity that you provision.

      • WeeklyMaintenanceStartTime — (String)

        A recurring weekly time, in the format D:HH:MM.

        D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

        HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

        For example, 1:05:00 specifies maintenance at 5 AM Monday.

      • DiskIopsConfiguration — (map)

        The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

        • Mode — (String)

          Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

          Possible values include:
          • "AUTOMATIC"
          • "USER_PROVISIONED"
        • Iops — (Integer)

          The total number of SSD IOPS provisioned for the file system.

          The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

          Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

      • RootVolumeConfiguration — (map)

        The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.

        • RecordSizeKiB — (Integer)

          Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

        • DataCompressionType — (String)

          Specifies the method used to compress the data on the volume. The compression type is NONE by default.

          • NONE - Doesn't compress the data on the volume. NONE is the default.

          • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

          • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

          Possible values include:
          • "NONE"
          • "ZSTD"
          • "LZ4"
        • NfsExports — (Array<map>)

          The configuration object for mounting a file system.

          • ClientConfigurationsrequired — (Array<map>)

            A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

            • Clientsrequired — (String)

              A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.

            • Optionsrequired — (Array<String>)

              The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:

              • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.

              • sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

        • UserAndGroupQuotas — (Array<map>)

          An object specifying how much storage users or groups can use on the volume.

          • Typerequired — (String)

            Specifies whether the quota applies to a user or group.

            Possible values include:
            • "USER"
            • "GROUP"
          • Idrequired — (Integer)

            The ID of the user or group that the quota applies to.

          • StorageCapacityQuotaGiBrequired — (Integer)

            The user or group's storage quota, in gibibytes (GiB).

        • CopyTagsToSnapshots — (Boolean)

          A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

        • ReadOnly — (Boolean)

          A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

      • PreferredSubnetId — (String)

        Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

      • EndpointIpAddressRange — (String)

        (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

      • RouteTableIds — (Array<String>)

        (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FileSystem — (map)

        The configuration of the file system that was created.

        • OwnerId — (String)

          The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

        • CreationTime — (Date)

          The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

        • FileSystemId — (String)

          The system-generated, unique 17-digit ID of the file system.

        • FileSystemType — (String)

          The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

          Possible values include:
          • "WINDOWS"
          • "LUSTRE"
          • "ONTAP"
          • "OPENZFS"
        • Lifecycle — (String)

          The lifecycle status of the file system. The following are the possible values and what they mean:

          • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

          • CREATING - Amazon FSx is creating the new file system.

          • DELETING - Amazon FSx is deleting an existing file system.

          • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

          • MISCONFIGURED - The file system is in a failed but recoverable state.

          • MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

          • UPDATING - The file system is undergoing a customer-initiated update.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "FAILED"
          • "DELETING"
          • "MISCONFIGURED"
          • "UPDATING"
          • "MISCONFIGURED_UNAVAILABLE"
        • FailureDetails — (map)

          A structure providing details of any failures that occurred.

          • Message — (String)

            A message describing any failures that occurred.

        • StorageCapacity — (Integer)

          The storage capacity of the file system in gibibytes (GiB).

          Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

        • StorageType — (String)

          The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

          Possible values include:
          • "SSD"
          • "HDD"
        • VpcId — (String)

          The ID of the primary virtual private cloud (VPC) for the file system.

        • SubnetIds — (Array<String>)

          Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

          For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

        • NetworkInterfaceIds — (Array<String>)

          The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

          For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

        • DNSName — (String)

          The Domain Name System (DNS) name for the file system.

        • KmsKeyId — (String)

          The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

          • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

            SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

          • Amazon FSx for NetApp ONTAP

          • Amazon FSx for OpenZFS

          • Amazon FSx for Windows File Server

        • ResourceARN — (String)

          The Amazon Resource Name (ARN) of the file system resource.

        • Tags — (Array<map>)

          The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

          • Keyrequired — (String)

            A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

          • Valuerequired — (String)

            A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

        • WindowsConfiguration — (map)

          The configuration for this Amazon FSx for Windows File Server file system.

          • ActiveDirectoryId — (String)

            The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

          • SelfManagedActiveDirectoryConfiguration — (map)

            The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

            • DomainName — (String)

              The fully qualified domain name of the self-managed AD directory.

            • OrganizationalUnitDistinguishedName — (String)

              The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

            • FileSystemAdministratorsGroup — (String)

              The name of the domain group whose members have administrative privileges for the FSx file system.

            • UserName — (String)

              The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

            • DnsIps — (Array<String>)

              A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

          • DeploymentType — (String)

            Specifies the file system deployment type, valid values are the following:

            • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

            • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

            • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

            For more information, see Single-AZ and Multi-AZ File Systems.

            Possible values include:
            • "MULTI_AZ_1"
            • "SINGLE_AZ_1"
            • "SINGLE_AZ_2"
          • RemoteAdministrationEndpoint — (String)

            For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

            For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

            This endpoint is temporarily unavailable when the file system is undergoing maintenance.

          • PreferredSubnetId — (String)

            For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

            For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

          • PreferredFileServerIp — (String)

            For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

            Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

          • ThroughputCapacity — (Integer)

            The throughput of the Amazon FSx file system, measured in megabytes per second.

          • MaintenanceOperationsInProgress — (Array<String>)

            The list of maintenance operations in progress for this file system.

          • WeeklyMaintenanceStartTime — (String)

            The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

          • DailyAutomaticBackupStartTime — (String)

            The preferred time to take daily automatic backups, in the UTC time zone.

          • AutomaticBackupRetentionDays — (Integer)

            The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

          • CopyTagsToBackups — (Boolean)

            A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

          • Aliases — (Array<map>)

            An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

            • Name — (String)

              The name of the DNS alias. The alias name has to meet the following requirements:

              • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

              • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

              • Cannot start or end with a hyphen.

              • Can start with a numeric.

              For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

            • Lifecycle — (String)

              Describes the state of the DNS alias.

              • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

              • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

              • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

              • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

              • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

              Possible values include:
              • "AVAILABLE"
              • "CREATING"
              • "DELETING"
              • "CREATE_FAILED"
              • "DELETE_FAILED"
          • AuditLogConfiguration — (map)

            The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

            • FileAccessAuditLogLevelrequired — (String)

              Sets which attempt type is logged by Amazon FSx for file and folder accesses.

              • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

              • FAILURE_ONLY - only failed attempts to access files or folders are logged.

              • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

              • DISABLED - access auditing of files and folders is turned off.

              Possible values include:
              • "DISABLED"
              • "SUCCESS_ONLY"
              • "FAILURE_ONLY"
              • "SUCCESS_AND_FAILURE"
            • FileShareAccessAuditLogLevelrequired — (String)

              Sets which attempt type is logged by Amazon FSx for file share accesses.

              • SUCCESS_ONLY - only successful attempts to access file shares are logged.

              • FAILURE_ONLY - only failed attempts to access file shares are logged.

              • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

              • DISABLED - access auditing of file shares is turned off.

              Possible values include:
              • "DISABLED"
              • "SUCCESS_ONLY"
              • "FAILURE_ONLY"
              • "SUCCESS_AND_FAILURE"
            • AuditLogDestination — (String)

              The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

              The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

              The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

          • DiskIopsConfiguration — (map)

            The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

            • Mode — (String)

              Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

              Possible values include:
              • "AUTOMATIC"
              • "USER_PROVISIONED"
            • Iops — (Integer)

              The total number of SSD IOPS provisioned for the file system.

              The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

              Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

        • LustreConfiguration — (map)

          The configuration for the Amazon FSx for Lustre file system.

          • WeeklyMaintenanceStartTime — (String)

            The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

          • DataRepositoryConfiguration — (map)

            The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

            This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

            • Lifecycle — (String)

              Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

              • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

              • AVAILABLE - The data repository is available for use.

              • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

              • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

              • FAILED - The data repository is in a terminal state that cannot be recovered.

              Possible values include:
              • "CREATING"
              • "AVAILABLE"
              • "MISCONFIGURED"
              • "UPDATING"
              • "DELETING"
              • "FAILED"
            • ImportPath — (String)

              The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

            • ExportPath — (String)

              The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

            • ImportedFileChunkSize — (Integer)

              For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

              The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

            • AutoImportPolicy — (String)

              Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

              • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

              • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

              • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

              • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

              Possible values include:
              • "NONE"
              • "NEW"
              • "NEW_CHANGED"
              • "NEW_CHANGED_DELETED"
            • FailureDetails — (map)

              Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

              • Message — (String)

                A detailed error message.

          • DeploymentType — (String)

            The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

            SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

            The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

            The default is SCRATCH_1.

            Possible values include:
            • "SCRATCH_1"
            • "SCRATCH_2"
            • "PERSISTENT_1"
            • "PERSISTENT_2"
          • PerUnitStorageThroughput — (Integer)

            Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

            Valid values:

            • For PERSISTENT_1 SSD storage: 50, 100, 200.

            • For PERSISTENT_1 HDD storage: 12, 40.

            • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

          • MountName — (String)

            You use the MountName value when mounting the file system.

            For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

          • DailyAutomaticBackupStartTime — (String)

            A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

          • AutomaticBackupRetentionDays — (Integer)

            The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

          • CopyTagsToBackups — (Boolean)

            A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

          • DriveCacheType — (String)

            The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

            This parameter is required when StorageType is set to HDD.

            Possible values include:
            • "NONE"
            • "READ"
          • DataCompressionType — (String)

            The data compression configuration for the file system. DataCompressionType can have the following values:

            • NONE - Data compression is turned off for the file system.

            • LZ4 - Data compression is turned on with the LZ4 algorithm.

            For more information, see Lustre data compression.

            Possible values include:
            • "NONE"
            • "LZ4"
          • LogConfiguration — (map)

            The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

            • Levelrequired — (String)

              The data repository events that are logged by Amazon FSx.

              • WARN_ONLY - only warning events are logged.

              • ERROR_ONLY - only error events are logged.

              • WARN_ERROR - both warning events and error events are logged.

              • DISABLED - logging of data repository events is turned off.

              Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

              Possible values include:
              • "DISABLED"
              • "WARN_ONLY"
              • "ERROR_ONLY"
              • "WARN_ERROR"
            • Destination — (String)

              The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

          • RootSquashConfiguration — (map)

            The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

            • RootSquash — (String)

              You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

              • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

              • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

              When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

            • NoSquashNids — (Array<String>)

              When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

              • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

              • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

          • MetadataConfiguration — (map)

            The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

            • Iops — (Integer)

              The number of Metadata IOPS provisioned for the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

            • Moderequired — (String)

              The metadata configuration mode for provisioning Metadata IOPS for the file system.

              • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity.

              • In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system.

              Possible values include:
              • "AUTOMATIC"
              • "USER_PROVISIONED"
        • AdministrativeActions — (Array<map>)

          A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the UpdateFileSystem operation.

          • AdministrativeActionType — (String)

            Describes the type of administrative action, as follows:

            • FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

            • THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.

              You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

            • STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

              • For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

              • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

              You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

            • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

            • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

            • IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.

              You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

            • STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.

              You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

            • VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

            • VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

            • SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

            • RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

            • DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

            • VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

            • VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

            Possible values include:
            • "FILE_SYSTEM_UPDATE"
            • "STORAGE_OPTIMIZATION"
            • "FILE_SYSTEM_ALIAS_ASSOCIATION"
            • "FILE_SYSTEM_ALIAS_DISASSOCIATION"
            • "VOLUME_UPDATE"
            • "SNAPSHOT_UPDATE"
            • "RELEASE_NFS_V3_LOCKS"
            • "VOLUME_RESTORE"
            • "THROUGHPUT_OPTIMIZATION"
            • "IOPS_OPTIMIZATION"
            • "STORAGE_TYPE_OPTIMIZATION"
            • "MISCONFIGURED_STATE_RECOVERY"
            • "VOLUME_UPDATE_WITH_SNAPSHOT"
            • "VOLUME_INITIALIZE_WITH_SNAPSHOT"
            • "DOWNLOAD_DATA_FROM_BACKUP"
          • ProgressPercent — (Integer)

            The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

          • RequestTime — (Date)

            The time that the administrative action request was received.

          • Status — (String)

            The status of the administrative action, as follows:

            • FAILED - Amazon FSx failed to process the administrative action successfully.

            • IN_PROGRESS - Amazon FSx is processing the administrative action.

            • PENDING - Amazon FSx is waiting to process the administrative action.

            • COMPLETED - Amazon FSx has finished processing the administrative task.

              For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

            • UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

            • PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

            • IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

            Possible values include:
            • "FAILED"
            • "IN_PROGRESS"
            • "PENDING"
            • "COMPLETED"
            • "UPDATED_OPTIMIZING"
            • "OPTIMIZING"
          • TargetFileSystemValues — (map)

            The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

            • OwnerId — (String)

              The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

            • CreationTime — (Date)

              The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

            • FileSystemId — (String)

              The system-generated, unique 17-digit ID of the file system.

            • FileSystemType — (String)

              The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

              Possible values include:
              • "WINDOWS"
              • "LUSTRE"
              • "ONTAP"
              • "OPENZFS"
            • Lifecycle — (String)

              The lifecycle status of the file system. The following are the possible values and what they mean:

              • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

              • CREATING - Amazon FSx is creating the new file system.

              • DELETING - Amazon FSx is deleting an existing file system.

              • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

              • MISCONFIGURED - The file system is in a failed but recoverable state.

              • MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

              • UPDATING - The file system is undergoing a customer-initiated update.

              Possible values include:
              • "AVAILABLE"
              • "CREATING"
              • "FAILED"
              • "DELETING"
              • "MISCONFIGURED"
              • "UPDATING"
              • "MISCONFIGURED_UNAVAILABLE"
            • FailureDetails — (map)

              A structure providing details of any failures that occurred.

              • Message — (String)

                A message describing any failures that occurred.

            • StorageCapacity — (Integer)

              The storage capacity of the file system in gibibytes (GiB).

              Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

            • StorageType — (String)

              The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

              Possible values include:
              • "SSD"
              • "HDD"
            • VpcId — (String)

              The ID of the primary virtual private cloud (VPC) for the file system.

            • SubnetIds — (Array<String>)

              Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

              For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

            • NetworkInterfaceIds — (Array<String>)

              The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

              For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

            • DNSName — (String)

              The Domain Name System (DNS) name for the file system.

            • KmsKeyId — (String)

              The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

              • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

                SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

              • Amazon FSx for NetApp ONTAP

              • Amazon FSx for OpenZFS

              • Amazon FSx for Windows File Server

            • ResourceARN — (String)

              The Amazon Resource Name (ARN) of the file system resource.

            • Tags — (Array<map>)

              The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

              • Keyrequired — (String)

                A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

              • Valuerequired — (String)

                A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

            • WindowsConfiguration — (map)

              The configuration for this Amazon FSx for Windows File Server file system.

              • ActiveDirectoryId — (String)

                The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

              • SelfManagedActiveDirectoryConfiguration — (map)

                The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

                • DomainName — (String)

                  The fully qualified domain name of the self-managed AD directory.

                • OrganizationalUnitDistinguishedName — (String)

                  The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

                • FileSystemAdministratorsGroup — (String)

                  The name of the domain group whose members have administrative privileges for the FSx file system.

                • UserName — (String)

                  The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

                • DnsIps — (Array<String>)

                  A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

              • DeploymentType — (String)

                Specifies the file system deployment type, valid values are the following:

                • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

                • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

                • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

                For more information, see Single-AZ and Multi-AZ File Systems.

                Possible values include:
                • "MULTI_AZ_1"
                • "SINGLE_AZ_1"
                • "SINGLE_AZ_2"
              • RemoteAdministrationEndpoint — (String)

                For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

                For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

                This endpoint is temporarily unavailable when the file system is undergoing maintenance.

              • PreferredSubnetId — (String)

                For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

                For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

              • PreferredFileServerIp — (String)

                For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

                Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

              • ThroughputCapacity — (Integer)

                The throughput of the Amazon FSx file system, measured in megabytes per second.

              • MaintenanceOperationsInProgress — (Array<String>)

                The list of maintenance operations in progress for this file system.

              • WeeklyMaintenanceStartTime — (String)

                The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

              • DailyAutomaticBackupStartTime — (String)

                The preferred time to take daily automatic backups, in the UTC time zone.

              • AutomaticBackupRetentionDays — (Integer)

                The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

              • CopyTagsToBackups — (Boolean)

                A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

              • Aliases — (Array<map>)

                An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

                • Name — (String)

                  The name of the DNS alias. The alias name has to meet the following requirements:

                  • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

                  • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

                  • Cannot start or end with a hyphen.

                  • Can start with a numeric.

                  For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

                • Lifecycle — (String)

                  Describes the state of the DNS alias.

                  • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

                  • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

                  • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

                  • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

                  • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

                  Possible values include:
                  • "AVAILABLE"
                  • "CREATING"
                  • "DELETING"
                  • "CREATE_FAILED"
                  • "DELETE_FAILED"
              • AuditLogConfiguration — (map)

                The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

                • FileAccessAuditLogLevelrequired — (String)

                  Sets which attempt type is logged by Amazon FSx for file and folder accesses.

                  • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

                  • FAILURE_ONLY - only failed attempts to access files or folders are logged.

                  • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

                  • DISABLED - access auditing of files and folders is turned off.

                  Possible values include:
                  • "DISABLED"
                  • "SUCCESS_ONLY"
                  • "FAILURE_ONLY"
                  • "SUCCESS_AND_FAILURE"
                • FileShareAccessAuditLogLevelrequired — (String)

                  Sets which attempt type is logged by Amazon FSx for file share accesses.

                  • SUCCESS_ONLY - only successful attempts to access file shares are logged.

                  • FAILURE_ONLY - only failed attempts to access file shares are logged.

                  • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

                  • DISABLED - access auditing of file shares is turned off.

                  Possible values include:
                  • "DISABLED"
                  • "SUCCESS_ONLY"
                  • "FAILURE_ONLY"
                  • "SUCCESS_AND_FAILURE"
                • AuditLogDestination — (String)

                  The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

                  The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

                  The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

              • DiskIopsConfiguration — (map)

                The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

                • Mode — (String)

                  Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                  Possible values include:
                  • "AUTOMATIC"
                  • "USER_PROVISIONED"
                • Iops — (Integer)

                  The total number of SSD IOPS provisioned for the file system.

                  The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

            • LustreConfiguration — (map)

              The configuration for the Amazon FSx for Lustre file system.

              • WeeklyMaintenanceStartTime — (String)

                The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

              • DataRepositoryConfiguration — (map)

                The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

                This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

                • Lifecycle — (String)

                  Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

                  • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

                  • AVAILABLE - The data repository is available for use.

                  • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

                  • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

                  • FAILED - The data repository is in a terminal state that cannot be recovered.

                  Possible values include:
                  • "CREATING"
                  • "AVAILABLE"
                  • "MISCONFIGURED"
                  • "UPDATING"
                  • "DELETING"
                  • "FAILED"
                • ImportPath — (String)

                  The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

                • ExportPath — (String)

                  The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

                • ImportedFileChunkSize — (Integer)

                  For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

                  The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

                • AutoImportPolicy — (String)

                  Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

                  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

                  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

                  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

                  • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

                  Possible values include:
                  • "NONE"
                  • "NEW"
                  • "NEW_CHANGED"
                  • "NEW_CHANGED_DELETED"
                • FailureDetails — (map)

                  Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

                  • Message — (String)

                    A detailed error message.

              • DeploymentType — (String)

                The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

                SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

                The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

                The default is SCRATCH_1.

                Possible values include:
                • "SCRATCH_1"
                • "SCRATCH_2"
                • "PERSISTENT_1"
                • "PERSISTENT_2"
              • PerUnitStorageThroughput — (Integer)

                Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

                Valid values:

                • For PERSISTENT_1 SSD storage: 50, 100, 200.

                • For PERSISTENT_1 HDD storage: 12, 40.

                • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

              • MountName — (String)

                You use the MountName value when mounting the file system.

                For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

              • DailyAutomaticBackupStartTime — (String)

                A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

              • AutomaticBackupRetentionDays — (Integer)

                The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

              • CopyTagsToBackups — (Boolean)

                A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

              • DriveCacheType — (String)

                The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

                This parameter is required when StorageType is set to HDD.

                Possible values include:
                • "NONE"
                • "READ"
              • DataCompressionType — (String)

                The data compression configuration for the file system. DataCompressionType can have the following values:

                • NONE - Data compression is turned off for the file system.

                • LZ4 - Data compression is turned on with the LZ4 algorithm.

                For more information, see Lustre data compression.

                Possible values include:
                • "NONE"
                • "LZ4"
              • LogConfiguration — (map)

                The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

                • Levelrequired — (String)

                  The data repository events that are logged by Amazon FSx.

                  • WARN_ONLY - only warning events are logged.

                  • ERROR_ONLY - only error events are logged.

                  • WARN_ERROR - both warning events and error events are logged.

                  • DISABLED - logging of data repository events is turned off.

                  Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

                  Possible values include:
                  • "DISABLED"
                  • "WARN_ONLY"
                  • "ERROR_ONLY"
                  • "WARN_ERROR"
                • Destination — (String)

                  The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

              • RootSquashConfiguration — (map)

                The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

                • RootSquash — (String)

                  You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

                  • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

                  • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

                  When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

                • NoSquashNids — (Array<String>)

                  When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

                  • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

                  • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

              • MetadataConfiguration — (map)

                The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

                • Iops — (Integer)

                  The number of Metadata IOPS provisioned for the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

                • Moderequired — (String)

                  The metadata configuration mode for provisioning Metadata IOPS for the file system.

                  • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity.

                  • In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system.

                  Possible values include:
                  • "AUTOMATIC"
                  • "USER_PROVISIONED"
            • OntapConfiguration — (map)

              The configuration for this Amazon FSx for NetApp ONTAP file system.

              • AutomaticBackupRetentionDays — (Integer)

                The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

              • DailyAutomaticBackupStartTime — (String)

                A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

              • DeploymentType — (String)

                Specifies the FSx for ONTAP file system deployment type in use in the file system.

                • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

                • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

                • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

                • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

                For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

                Possible values include:
                • "MULTI_AZ_1"
                • "SINGLE_AZ_1"
                • "SINGLE_AZ_2"
                • "MULTI_AZ_2"
              • EndpointIpAddressRange — (String)

                (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

              • Endpoints — (map)

                The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

                • Intercluster — (map)

                  An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

                  • DNSName — (String)

                    The file system's DNS name. You can mount your file system using its DNS name.

                  • IpAddresses — (Array<String>)

                    IP addresses of the file system endpoint.

                • Management — (map)

                  An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

                  • DNSName — (String)

                    The file system's DNS name. You can mount your file system using its DNS name.

                  • IpAddresses — (Array<String>)

                    IP addresses of the file system endpoint.

              • DiskIopsConfiguration — (map)

                The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

                • Mode — (String)

                  Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                  Possible values include:
                  • "AUTOMATIC"
                  • "USER_PROVISIONED"
                • Iops — (Integer)

                  The total number of SSD IOPS provisioned for the file system.

                  The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

              • PreferredSubnetId — (String)

                The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

              • RouteTableIds — (Array<String>)

                (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

              • ThroughputCapacity — (Integer)

                The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

              • WeeklyMaintenanceStartTime — (String)

                A recurring weekly time, in the format D:HH:MM.

                D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

                HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

                For example, 1:05:00 specifies maintenance at 5 AM Monday.

              • FsxAdminPassword — (String)

                You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.

              • HAPairs — (Integer)

                Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                • The value of HAPairs is less than 1 or greater than 12.

                • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.

              • ThroughputCapacityPerHAPair — (Integer)

                Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

                This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

                This field and ThroughputCapacity are the same for file systems with one HA pair.

                • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

                • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

                • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

                • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

                • The value of ThroughputCapacityPerHAPair is not a valid value.

            • FileSystemTypeVersion — (String)

              The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

            • OpenZFSConfiguration — (map)

              The configuration for this Amazon FSx for OpenZFS file system.

              • AutomaticBackupRetentionDays — (Integer)

                The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

              • CopyTagsToBackups — (Boolean)

                A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

              • CopyTagsToVolumes — (Boolean)

                A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

              • DailyAutomaticBackupStartTime — (String)

                A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

              • DeploymentType — (String)

                Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

                Possible values include:
                • "SINGLE_AZ_1"
                • "SINGLE_AZ_2"
                • "SINGLE_AZ_HA_1"
                • "SINGLE_AZ_HA_2"
                • "MULTI_AZ_1"
              • ThroughputCapacity — (Integer)

                The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

              • WeeklyMaintenanceStartTime — (String)

                A recurring weekly time, in the format D:HH:MM.

                D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

                HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

                For example, 1:05:00 specifies maintenance at 5 AM Monday.

              • DiskIopsConfiguration — (map)

                The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

                • Mode — (String)

                  Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                  Possible values include:
                  • "AUTOMATIC"
                  • "USER_PROVISIONED"
                • Iops — (Integer)

                  The total number of SSD IOPS provisioned for the file system.

                  The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

              • RootVolumeId — (String)

                The ID of the root volume of the OpenZFS file system.

              • PreferredSubnetId — (String)

                Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

              • EndpointIpAddressRange — (String)

                (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

              • RouteTableIds — (Array<String>)

                (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

              • EndpointIpAddress — (String)

                The IP address of the endpoint that is used to access data or to manage the file system.

          • FailureDetails — (map)

            Provides information about a failed administrative action.

            • Message — (String)

              Error message providing details about the failed administrative action.

          • TargetVolumeValues — (map)

            Describes an Amazon FSx volume.

            • CreationTime — (Date)

              The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

            • FileSystemId — (String)

              The globally unique ID of the file system, assigned by Amazon FSx.

            • Lifecycle — (String)

              The lifecycle status of the volume.

              • AVAILABLE - The volume is fully available for use.

              • CREATED - The volume has been created.

              • CREATING - Amazon FSx is creating the new volume.

              • DELETING - Amazon FSx is deleting an existing volume.

              • FAILED - Amazon FSx was unable to create the volume.

              • MISCONFIGURED - The volume is in a failed but recoverable state.

              • PENDING - Amazon FSx hasn't started creating the volume.

              Possible values include:
              • "CREATING"
              • "CREATED"
              • "DELETING"
              • "FAILED"
              • "MISCONFIGURED"
              • "PENDING"
              • "AVAILABLE"
            • Name — (String)

              The name of the volume.

            • OntapConfiguration — (map)

              The configuration of an Amazon FSx for NetApp ONTAP volume.

              • FlexCacheEndpointType — (String)

                Specifies the FlexCache endpoint type of the volume. Valid values are the following:

                • NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

                • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

                • CACHE specifies that the volume is a FlexCache volume.

                Possible values include:
                • "NONE"
                • "ORIGIN"
                • "CACHE"
              • JunctionPath — (String)

                Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

              • SecurityStyle — (String)

                The security style for the volume, which can be UNIX, NTFS, or MIXED.

                Possible values include:
                • "UNIX"
                • "NTFS"
                • "MIXED"
              • SizeInMegabytes — (Integer)

                The configured size of the volume, in megabytes (MBs).

              • StorageEfficiencyEnabled — (Boolean)

                The volume's storage efficiency setting.

              • StorageVirtualMachineId — (String)

                The ID of the volume's storage virtual machine.

              • StorageVirtualMachineRoot — (Boolean)

                A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

                This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

              • TieringPolicy — (map)

                The volume's TieringPolicy setting.

                • CoolingPeriod — (Integer)

                  Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.

                • Name — (String)

                  Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

                  • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

                  • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

                  • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

                  • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

                  Possible values include:
                  • "SNAPSHOT_ONLY"
                  • "AUTO"
                  • "ALL"
                  • "NONE"
              • UUID — (String)

                The volume's universally unique identifier (UUID).

              • OntapVolumeType — (String)

                Specifies the type of volume. Valid values are the following:

                • RW specifies a read/write volume. RW is the default.

                • DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

                • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

                Possible values include:
                • "RW"
                • "DP"
                • "LS"
              • SnapshotPolicy — (String)

                Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

                • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.

                • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.

                • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

                You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

                For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

              • CopyTagsToBackups — (Boolean)

                A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

              • SnaplockConfiguration — (map)

                The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

                • AuditLogVolume — (Boolean)

                  Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

                  For more information, see SnapLock audit log volumes.

                • AutocommitPeriod — (map)

                  The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

                  • Typerequired — (String)

                    Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.

                    Possible values include:
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "NONE"
                  • Value — (Integer)

                    Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

                    • Minutes: 5 - 65,535

                    • Hours: 1 - 65,535

                    • Days: 1 - 3,650

                    • Months: 1 - 120

                    • Years: 1 - 10

                • PrivilegedDelete — (String)

                  Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

                  For more information, see Privileged delete.

                  Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                  • "PERMANENTLY_DISABLED"
                • RetentionPeriod — (map)

                  Specifies the retention period of an FSx for ONTAP SnapLock volume.

                  • DefaultRetentionrequired — (map)

                    The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

                    • Typerequired — (String)

                      Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                      Possible values include:
                      • "SECONDS"
                      • "MINUTES"
                      • "HOURS"
                      • "DAYS"
                      • "MONTHS"
                      • "YEARS"
                      • "INFINITE"
                      • "UNSPECIFIED"
                    • Value — (Integer)

                      Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                      • Seconds: 0 - 65,535

                      • Minutes: 0 - 65,535

                      • Hours: 0 - 24

                      • Days: 0 - 365

                      • Months: 0 - 12

                      • Years: 0 - 100

                  • MinimumRetentionrequired — (map)

                    The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                    • Typerequired — (String)

                      Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                      Possible values include:
                      • "SECONDS"
                      • "MINUTES"
                      • "HOURS"
                      • "DAYS"
                      • "MONTHS"
                      • "YEARS"
                      • "INFINITE"
                      • "UNSPECIFIED"
                    • Value — (Integer)

                      Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                      • Seconds: 0 - 65,535

                      • Minutes: 0 - 65,535

                      • Hours: 0 - 24

                      • Days: 0 - 365

                      • Months: 0 - 12

                      • Years: 0 - 100

                  • MaximumRetentionrequired — (map)

                    The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                    • Typerequired — (String)

                      Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                      Possible values include:
                      • "SECONDS"
                      • "MINUTES"
                      • "HOURS"
                      • "DAYS"
                      • "MONTHS"
                      • "YEARS"
                      • "INFINITE"
                      • "UNSPECIFIED"
                    • Value — (Integer)

                      Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                      • Seconds: 0 - 65,535

                      • Minutes: 0 - 65,535

                      • Hours: 0 - 24

                      • Days: 0 - 365

                      • Months: 0 - 12

                      • Years: 0 - 100

                • SnaplockType — (String)

                  Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

                  • COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

                  • ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

                  Possible values include:
                  • "COMPLIANCE"
                  • "ENTERPRISE"
                • VolumeAppendModeEnabled — (Boolean)

                  Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

                  For more information, see Volume-append mode.

              • VolumeStyle — (String)

                Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

                Possible values include:
                • "FLEXVOL"
                • "FLEXGROUP"
              • AggregateConfiguration — (map)

                This structure specifies configuration options for a volume’s storage aggregate or aggregates.

                • Aggregates — (Array<String>)

                  The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                  • The strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 12.

                  • The value of Aggregates contains aggregates that are not present.

                  • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.

                • TotalConstituents — (Integer)

                  The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.

              • SizeInBytes — (Integer)

                The configured size of the volume, in bytes.

            • ResourceARN — (String)

              The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

            • Tags — (Array<map>)

              A list of Tag values, with a maximum of 50 elements.

              • Keyrequired — (String)

                A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

              • Valuerequired — (String)

                A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

            • VolumeId — (String)

              The system-generated, unique ID of the volume.

            • VolumeType — (String)

              The type of the volume.

              Possible values include:
              • "ONTAP"
              • "OPENZFS"
            • LifecycleTransitionReason — (map)

              The reason why the volume lifecycle status changed.

              • Message — (String)

                A detailed error message.

            • OpenZFSConfiguration — (map)

              The configuration of an Amazon FSx for OpenZFS volume.

              • ParentVolumeId — (String)

                The ID of the parent volume.

              • VolumePath — (String)

                The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

              • StorageCapacityReservationGiB — (Integer)

                The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

              • StorageCapacityQuotaGiB — (Integer)

                The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

              • RecordSizeKiB — (Integer)

                The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

              • DataCompressionType — (String)

                Specifies the method used to compress the data on the volume. The compression type is NONE by default.

                • NONE - Doesn't compress the data on the volume. NONE is the default.

                • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

                • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

                Possible values include:
                • "NONE"
                • "ZSTD"
                • "LZ4"
              • CopyTagsToSnapshots — (Boolean)

                A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

              • OriginSnapshot — (map)

                The configuration object that specifies the snapshot to use as the origin of the data for the volume.

                • SnapshotARN — (String)

                  The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

                • CopyStrategy — (String)

                  The strategy used when copying data from the snapshot to the new volume.

                  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                  • FULL_COPY - Copies all data from the snapshot to the new volume.

                  Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                  Possible values include:
                  • "CLONE"
                  • "FULL_COPY"
                  • "INCREMENTAL_COPY"
              • ReadOnly — (Boolean)

                A Boolean value indicating whether the volume is read-only.

              • NfsExports — (Array<map>)

                The configuration object for mounting a Network File System (NFS) file system.

                • ClientConfigurationsrequired — (Array<map>)

                  A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

                  • Clientsrequired — (String)

                    A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.

                  • Optionsrequired — (Array<String>)

                    The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:

                    • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.

                    • sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

              • UserAndGroupQuotas — (Array<map>)

                An object specifying how much storage users or groups can use on the volume.

                • Typerequired — (String)

                  Specifies whether the quota applies to a user or group.

                  Possible values include:
                  • "USER"
                  • "GROUP"
                • Idrequired — (Integer)

                  The ID of the user or group that the quota applies to.

                • StorageCapacityQuotaGiBrequired — (Integer)

                  The user or group's storage quota, in gibibytes (GiB).

              • RestoreToSnapshot — (String)

                Specifies the ID of the snapshot to which the volume was restored.

              • DeleteIntermediateSnaphots — (Boolean)

                A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

              • DeleteClonedVolumes — (Boolean)

                A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

              • DeleteIntermediateData — (Boolean)

                A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

              • SourceSnapshotARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • DestinationSnapshot — (String)

                The ID of the snapshot that's being copied or was most recently copied to the destination volume.

              • CopyStrategy — (String)

                Specifies the strategy used when copying data from the snapshot to the new volume.

                • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                • FULL_COPY - Copies all data from the snapshot to the new volume.

                  Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

                Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                Possible values include:
                • "CLONE"
                • "FULL_COPY"
                • "INCREMENTAL_COPY"
          • TargetSnapshotValues — (map)

            A snapshot of an Amazon FSx for OpenZFS volume.

            • ResourceARN — (String)

              The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

            • SnapshotId — (String)

              The ID of the snapshot.

            • Name — (String)

              The name of the snapshot.

            • VolumeId — (String)

              The ID of the volume that the snapshot is of.

            • CreationTime — (Date)

              The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

            • Lifecycle — (String)

              The lifecycle status of the snapshot.

              • PENDING - Amazon FSx hasn't started creating the snapshot.

              • CREATING - Amazon FSx is creating the snapshot.

              • DELETING - Amazon FSx is deleting the snapshot.

              • AVAILABLE - The snapshot is fully available.

              Possible values include:
              • "PENDING"
              • "CREATING"
              • "DELETING"
              • "AVAILABLE"
            • LifecycleTransitionReason — (map)

              Describes why a resource lifecycle state changed.

              • Message — (String)

                A detailed error message.

            • Tags — (Array<map>)

              A list of Tag values, with a maximum of 50 elements.

              • Keyrequired — (String)

                A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

              • Valuerequired — (String)

                A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

          • TotalTransferBytes — (Integer)

            The number of bytes that have transferred for the FSx for OpenZFS snapshot that you're copying.

          • RemainingTransferBytes — (Integer)

            The remaining bytes to transfer for the FSx for OpenZFS snapshot that you're copying.

        • OntapConfiguration — (map)

          The configuration for this Amazon FSx for NetApp ONTAP file system.

          • AutomaticBackupRetentionDays — (Integer)

            The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

          • DailyAutomaticBackupStartTime — (String)

            A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

          • DeploymentType — (String)

            Specifies the FSx for ONTAP file system deployment type in use in the file system.

            • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

            • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

            • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

            • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

            For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

            Possible values include:
            • "MULTI_AZ_1"
            • "SINGLE_AZ_1"
            • "SINGLE_AZ_2"
            • "MULTI_AZ_2"
          • EndpointIpAddressRange — (String)

            (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

          • Endpoints — (map)

            The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

            • Intercluster — (map)

              An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

              • DNSName — (String)

                The file system's DNS name. You can mount your file system using its DNS name.

              • IpAddresses — (Array<String>)

                IP addresses of the file system endpoint.

            • Management — (map)

              An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

              • DNSName — (String)

                The file system's DNS name. You can mount your file system using its DNS name.

              • IpAddresses — (Array<String>)

                IP addresses of the file system endpoint.

          • DiskIopsConfiguration — (map)

            The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

            • Mode — (String)

              Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

              Possible values include:
              • "AUTOMATIC"
              • "USER_PROVISIONED"
            • Iops — (Integer)

              The total number of SSD IOPS provisioned for the file system.

              The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

              Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

          • PreferredSubnetId — (String)

            The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

          • RouteTableIds — (Array<String>)

            (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

          • ThroughputCapacity — (Integer)

            The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

          • WeeklyMaintenanceStartTime — (String)

            A recurring weekly time, in the format D:HH:MM.

            D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

            HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

            For example, 1:05:00 specifies maintenance at 5 AM Monday.

          • FsxAdminPassword — (String)

            You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.

          • HAPairs — (Integer)

            Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

            Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

            • The value of HAPairs is less than 1 or greater than 12.

            • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.

          • ThroughputCapacityPerHAPair — (Integer)

            Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

            This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

            This field and ThroughputCapacity are the same for file systems with one HA pair.

            • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

            • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

            • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

            Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

            • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

            • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

            • The value of ThroughputCapacityPerHAPair is not a valid value.

        • FileSystemTypeVersion — (String)

          The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

        • OpenZFSConfiguration — (map)

          The configuration for this Amazon FSx for OpenZFS file system.

          • AutomaticBackupRetentionDays — (Integer)

            The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

          • CopyTagsToBackups — (Boolean)

            A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

          • CopyTagsToVolumes — (Boolean)

            A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

          • DailyAutomaticBackupStartTime — (String)

            A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

          • DeploymentType — (String)

            Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

            Possible values include:
            • "SINGLE_AZ_1"
            • "SINGLE_AZ_2"
            • "SINGLE_AZ_HA_1"
            • "SINGLE_AZ_HA_2"
            • "MULTI_AZ_1"
          • ThroughputCapacity — (Integer)

            The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

          • WeeklyMaintenanceStartTime — (String)

            A recurring weekly time, in the format D:HH:MM.

            D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

            HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

            For example, 1:05:00 specifies maintenance at 5 AM Monday.

          • DiskIopsConfiguration — (map)

            The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

            • Mode — (String)

              Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

              Possible values include:
              • "AUTOMATIC"
              • "USER_PROVISIONED"
            • Iops — (Integer)

              The total number of SSD IOPS provisioned for the file system.

              The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

              Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

          • RootVolumeId — (String)

            The ID of the root volume of the OpenZFS file system.

          • PreferredSubnetId — (String)

            Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

          • EndpointIpAddressRange — (String)

            (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

          • RouteTableIds — (Array<String>)

            (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

          • EndpointIpAddress — (String)

            The IP address of the endpoint that is used to access data or to manage the file system.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFileSystemFromBackup(params = {}, callback) ⇒ AWS.Request

Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a file system with the specified client request token exists but the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:

  • Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system.

Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.

Note: The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

Service Reference:

Examples:

To create a new file system from backup


/* This operation creates a new file system from backup. */

 var params = {
  BackupId: "backup-03e3c82e0183b7b6b", 
  ClientRequestToken: "f4c94ed7-238d-4c46-93db-48cd62ec33b7", 
  SecurityGroupIds: [
     "sg-edcd9784"
  ], 
  SubnetIds: [
     "subnet-1234abcd"
  ], 
  Tags: [
     {
    Key: "Name", 
    Value: "MyFileSystem"
   }
  ], 
  WindowsConfiguration: {
   ThroughputCapacity: 8
  }
 };
 fsx.createFileSystemFromBackup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FileSystem: {
     CreationTime: <Date Representation>, 
     DNSName: "fs-0498eed5fe91001ec.fsx.com", 
     FileSystemId: "fs-0498eed5fe91001ec", 
     KmsKeyId: "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6", 
     Lifecycle: "CREATING", 
     OwnerId: "012345678912", 
     ResourceARN: "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", 
     StorageCapacity: 300, 
     SubnetIds: [
        "subnet-1234abcd"
     ], 
     Tags: [
        {
       Key: "Name", 
       Value: "MyFileSystem"
      }
     ], 
     VpcId: "vpc-ab1234cd", 
     WindowsConfiguration: {
      ActiveDirectoryId: "d-1234abcd12", 
      AutomaticBackupRetentionDays: 30, 
      DailyAutomaticBackupStartTime: "05:00", 
      ThroughputCapacity: 8, 
      WeeklyMaintenanceStartTime: "1:05:00"
     }
    }
   }
   */
 });

Calling the createFileSystemFromBackup operation

var params = {
  BackupId: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  FileSystemTypeVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  LustreConfiguration: {
    AutoImportPolicy: NONE | NEW | NEW_CHANGED | NEW_CHANGED_DELETED,
    AutomaticBackupRetentionDays: 'NUMBER_VALUE',
    CopyTagsToBackups: true || false,
    DailyAutomaticBackupStartTime: 'STRING_VALUE',
    DataCompressionType: NONE | LZ4,
    DeploymentType: SCRATCH_1 | SCRATCH_2 | PERSISTENT_1 | PERSISTENT_2,
    DriveCacheType: NONE | READ,
    ExportPath: 'STRING_VALUE',
    ImportPath: 'STRING_VALUE',
    ImportedFileChunkSize: 'NUMBER_VALUE',
    LogConfiguration: {
      Level: DISABLED | WARN_ONLY | ERROR_ONLY | WARN_ERROR, /* required */
      Destination: 'STRING_VALUE'
    },
    MetadataConfiguration: {
      Mode: AUTOMATIC | USER_PROVISIONED, /* required */
      Iops: 'NUMBER_VALUE'
    },
    PerUnitStorageThroughput: 'NUMBER_VALUE',
    RootSquashConfiguration: {
      NoSquashNids: [
        'STRING_VALUE',
        /* more items */
      ],
      RootSquash: 'STRING_VALUE'
    },
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  },
  OpenZFSConfiguration: {
    DeploymentType: SINGLE_AZ_1 | SINGLE_AZ_2 | SINGLE_AZ_HA_1 | SINGLE_AZ_HA_2 | MULTI_AZ_1, /* required */
    ThroughputCapacity: 'NUMBER_VALUE', /* required */
    AutomaticBackupRetentionDays: 'NUMBER_VALUE',
    CopyTagsToBackups: true || false,
    CopyTagsToVolumes: true || false,
    DailyAutomaticBackupStartTime: 'STRING_VALUE',
    DiskIopsConfiguration: {
      Iops: 'NUMBER_VALUE',
      Mode: AUTOMATIC | USER_PROVISIONED
    },
    EndpointIpAddressRange: 'STRING_VALUE',
    PreferredSubnetId: 'STRING_VALUE',
    RootVolumeConfiguration: {
      CopyTagsToSnapshots: true || false,
      DataCompressionType: NONE | ZSTD | LZ4,
      NfsExports: [
        {
          ClientConfigurations: [ /* required */
            {
              Clients: 'STRING_VALUE', /* required */
              Options: [ /* required */
                'STRING_VALUE',
                /* more items */
              ]
            },
            /* more items */
          ]
        },
        /* more items */
      ],
      ReadOnly: true || false,
      RecordSizeKiB: 'NUMBER_VALUE',
      UserAndGroupQuotas: [
        {
          Id: 'NUMBER_VALUE', /* required */
          StorageCapacityQuotaGiB: 'NUMBER_VALUE', /* required */
          Type: USER | GROUP /* required */
        },
        /* more items */
      ]
    },
    RouteTableIds: [
      'STRING_VALUE',
      /* more items */
    ],
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  },
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  StorageCapacity: 'NUMBER_VALUE',
  StorageType: SSD | HDD,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  WindowsConfiguration: {
    ThroughputCapacity: 'NUMBER_VALUE', /* required */
    ActiveDirectoryId: 'STRING_VALUE',
    Aliases: [
      'STRING_VALUE',
      /* more items */
    ],
    AuditLogConfiguration: {
      FileAccessAuditLogLevel: DISABLED | SUCCESS_ONLY | FAILURE_ONLY | SUCCESS_AND_FAILURE, /* required */
      FileShareAccessAuditLogLevel: DISABLED | SUCCESS_ONLY | FAILURE_ONLY | SUCCESS_AND_FAILURE, /* required */
      AuditLogDestination: 'STRING_VALUE'
    },
    AutomaticBackupRetentionDays: 'NUMBER_VALUE',
    CopyTagsToBackups: true || false,
    DailyAutomaticBackupStartTime: 'STRING_VALUE',
    DeploymentType: MULTI_AZ_1 | SINGLE_AZ_1 | SINGLE_AZ_2,
    DiskIopsConfiguration: {
      Iops: 'NUMBER_VALUE',
      Mode: AUTOMATIC | USER_PROVISIONED
    },
    PreferredSubnetId: 'STRING_VALUE',
    SelfManagedActiveDirectoryConfiguration: {
      DnsIps: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      DomainName: 'STRING_VALUE', /* required */
      Password: 'STRING_VALUE', /* required */
      UserName: 'STRING_VALUE', /* required */
      FileSystemAdministratorsGroup: 'STRING_VALUE',
      OrganizationalUnitDistinguishedName: 'STRING_VALUE'
    },
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  }
};
fsx.createFileSystemFromBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupId — (String)

      The ID of the source backup. Specifies the backup that you are copying.

    • ClientRequestToken — (String)

      A string of up to 63 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • SubnetIds — (Array<String>)

      Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID property.

      Windows SINGLE_AZ_1 and SINGLE_AZ_2 file system deployment types, Lustre file systems, and OpenZFS file systems provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

    • SecurityGroupIds — (Array<String>)

      A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later DescribeFileSystem requests.

    • Tags — (Array<map>)

      The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.

      • Keyrequired — (String)

        A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

      • Valuerequired — (String)

        A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

    • WindowsConfiguration — (map)

      The configuration for this Microsoft Windows file system.

      • ActiveDirectoryId — (String)

        The ID for an existing Amazon Web Services Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.

      • SelfManagedActiveDirectoryConfiguration — (map)

        The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs.

        • DomainNamerequired — (String)

          The fully qualified domain name of the self-managed AD directory, such as corp.example.com.

        • OrganizationalUnitDistinguishedName — (String)

          (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.

          Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.

        • FileSystemAdministratorsGroup — (String)

          (Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.

        • UserNamerequired — (String)

          The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.

        • Passwordrequired — (String)

          The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

        • DnsIpsrequired — (Array<String>)

          A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

      • DeploymentType — (String)

        Specifies the file system deployment type, valid values are the following:

        • MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in Amazon Web Services Regions that have a minimum of three Availability Zones. Also supports HDD storage type

        • SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.

        • SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.

        For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems.

        Possible values include:
        • "MULTI_AZ_1"
        • "SINGLE_AZ_1"
        • "SINGLE_AZ_2"
      • PreferredSubnetId — (String)

        Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located. For in-Amazon Web Services applications, we recommend that you launch your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs and minimize latency.

      • ThroughputCapacityrequired — (Integer)

        Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the nth increments, between 23 (8) and 211 (2048).

      • WeeklyMaintenanceStartTime — (String)

        The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

      • DailyAutomaticBackupStartTime — (String)

        The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.

      • AutomaticBackupRetentionDays — (Integer)

        The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

      • CopyTagsToBackups — (Boolean)

        A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

      • Aliases — (Array<String>)

        An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload.

        For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

        An alias name has to meet the following requirements:

        • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

        • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

        • Cannot start or end with a hyphen.

        • Can start with a numeric.

        For DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

      • AuditLogConfiguration — (map)

        The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

        • FileAccessAuditLogLevelrequired — (String)

          Sets which attempt type is logged by Amazon FSx for file and folder accesses.

          • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

          • FAILURE_ONLY - only failed attempts to access files or folders are logged.

          • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

          • DISABLED - access auditing of files and folders is turned off.

          Possible values include:
          • "DISABLED"
          • "SUCCESS_ONLY"
          • "FAILURE_ONLY"
          • "SUCCESS_AND_FAILURE"
        • FileShareAccessAuditLogLevelrequired — (String)

          Sets which attempt type is logged by Amazon FSx for file share accesses.

          • SUCCESS_ONLY - only successful attempts to access file shares are logged.

          • FAILURE_ONLY - only failed attempts to access file shares are logged.

          • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

          • DISABLED - access auditing of file shares is turned off.

          Possible values include:
          • "DISABLED"
          • "SUCCESS_ONLY"
          • "FAILURE_ONLY"
          • "SUCCESS_AND_FAILURE"
        • AuditLogDestination — (String)

          The Amazon Resource Name (ARN) that specifies the destination of the audit logs.

          The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN, with the following requirements:

          • The destination ARN that you provide (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

          • The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

          • If you do not provide a destination in AuditLogDestination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/windows log group.

          • If AuditLogDestination is provided and the resource does not exist, the request will fail with a BadRequest error.

          • If FileAccessAuditLogLevel and FileShareAccessAuditLogLevel are both set to DISABLED, you cannot specify a destination in AuditLogDestination.

      • DiskIopsConfiguration — (map)

        The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

        • Mode — (String)

          Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

          Possible values include:
          • "AUTOMATIC"
          • "USER_PROVISIONED"
        • Iops — (Integer)

          The total number of SSD IOPS provisioned for the file system.

          The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

          Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

    • LustreConfiguration — (map)

      The Lustre configuration for the file system being created.

      Note: The following parameters are not supported for file systems with a data repository association created with .
      • AutoImportPolicy
      • ExportPath
      • ImportedFileChunkSize
      • ImportPath
      • WeeklyMaintenanceStartTime — (String)

        (Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

      • ImportPath — (String)

        (Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

        Note: This parameter is not supported for file systems with a data repository association.
      • ExportPath — (String)

        (Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.

        The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you specify only a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.

        Note: This parameter is not supported for file systems with a data repository association.
      • ImportedFileChunkSize — (Integer)

        (Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

        The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

        Note: This parameter is not supported for file systems with a data repository association.
      • DeploymentType — (String)

        (Optional) Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

        Choose PERSISTENT_1 for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1 supports encryption of data in transit, and is available in all Amazon Web Services Regions in which FSx for Lustre is available.

        Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2 supports SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). You can optionally specify a metadata configuration mode for PERSISTENT_2 which supports increasing metadata performance. PERSISTENT_2 is available in a limited number of Amazon Web Services Regions. For more information, and an up-to-date list of Amazon Web Services Regions in which PERSISTENT_2 is available, see File system deployment options for FSx for Lustre in the Amazon FSx for Lustre User Guide.

        Note: If you choose PERSISTENT_2, and you set FileSystemTypeVersion to 2.10, the CreateFileSystem operation fails.

        Encryption of data in transit is automatically turned on when you access SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 file systems from Amazon EC2 instances that support automatic encryption in the Amazon Web Services Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide.

        (Default = SCRATCH_1)

        Possible values include:
        • "SCRATCH_1"
        • "SCRATCH_2"
        • "PERSISTENT_1"
        • "PERSISTENT_2"
      • AutoImportPolicy — (String)

        (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this parameter to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

        • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

        • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

        • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

        • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

        For more information, see Automatically import updates from your S3 bucket.

        Note: This parameter is not supported for file systems with a data repository association.
        Possible values include:
        • "NONE"
        • "NEW"
        • "NEW_CHANGED"
        • "NEW_CHANGED_DELETED"
      • PerUnitStorageThroughput — (Integer)

        Required with PERSISTENT_1 and PERSISTENT_2 deployment types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file system throughput. You pay for the amount of throughput that you provision.

        Valid values:

        • For PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB.

        • For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB.

        • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.

      • DailyAutomaticBackupStartTime — (String)

        A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

      • AutomaticBackupRetentionDays — (Integer)

        The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0.

      • CopyTagsToBackups — (Boolean)

        (Optional) Not available for use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If CopyTagsToBackups is set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn't specify any backup-specific tags. If CopyTagsToBackups is set to true and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

        (Default = false)

        For more information, see Working with backups in the Amazon FSx for Lustre User Guide.

      • DriveCacheType — (String)

        The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set this property to READ to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system.

        This parameter is required when StorageType is set to HDD.

        Possible values include:
        • "NONE"
        • "READ"
      • DataCompressionType — (String)

        Sets the data compression configuration for the file system. DataCompressionType can have the following values:

        • NONE - (Default) Data compression is turned off when the file system is created.

        • LZ4 - Data compression is turned on with the LZ4 algorithm.

        For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide.

        Possible values include:
        • "NONE"
        • "LZ4"
      • LogConfiguration — (map)

        The Lustre logging configuration used when creating an Amazon FSx for Lustre file system. When logging is enabled, Lustre logs error and warning events for data repositories associated with your file system to Amazon CloudWatch Logs.

        • Levelrequired — (String)

          Sets which data repository events are logged by Amazon FSx.

          • WARN_ONLY - only warning events are logged.

          • ERROR_ONLY - only error events are logged.

          • WARN_ERROR - both warning events and error events are logged.

          • DISABLED - logging of data repository events is turned off.

          Possible values include:
          • "DISABLED"
          • "WARN_ONLY"
          • "ERROR_ONLY"
          • "WARN_ERROR"
        • Destination — (String)

          The Amazon Resource Name (ARN) that specifies the destination of the logs.

          The destination can be any Amazon CloudWatch Logs log group ARN, with the following requirements:

          • The destination ARN that you provide must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

          • The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix.

          • If you do not provide a destination, Amazon FSx will create and use a log stream in the CloudWatch Logs /aws/fsx/lustre log group (for Amazon FSx for Lustre) or /aws/fsx/filecache (for Amazon File Cache).

          • If Destination is provided and the resource does not exist, the request will fail with a BadRequest error.

          • If Level is set to DISABLED, you cannot specify a destination in Destination.

      • RootSquashConfiguration — (map)

        The Lustre root squash configuration used when creating an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

        • RootSquash — (String)

          You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

          • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

          • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

          When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

        • NoSquashNids — (Array<String>)

          When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

          • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

          • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

      • MetadataConfiguration — (map)

        The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using a PERSISTENT_2 deployment type.

        • Iops — (Integer)

          (USER_PROVISIONED mode only) Specifies the number of Metadata IOPS to provision for the file system. This parameter sets the maximum rate of metadata disk IOPS supported by the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

          Note: Iops doesn’t have a default value. If you're using USER_PROVISIONED mode, you can choose to specify a valid value. If you're using AUTOMATIC mode, you cannot specify a value because FSx for Lustre automatically sets the value based on your file system storage capacity.
        • Moderequired — (String)

          The metadata configuration mode for provisioning Metadata IOPS for an FSx for Lustre file system using a PERSISTENT_2 deployment type.

          • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS for your file system based on your file system storage capacity.

          • In USER_PROVISIONED mode, you specify the number of Metadata IOPS to provision for your file system.

          Possible values include:
          • "AUTOMATIC"
          • "USER_PROVISIONED"
    • StorageType — (String)

      Sets the storage type for the Windows or OpenZFS file system that you're creating from a backup. Valid values are SSD and HDD.

      • Set to SSD to use solid state drive storage. SSD is supported on all Windows and OpenZFS deployment types.

      • Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 FSx for Windows File Server file system deployment types.

      The default value is SSD.

      Note: HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage if the original SSD file system had a storage capacity of at least 2000 GiB.
      Possible values include:
      • "SSD"
      • "HDD"
    • KmsKeyId — (String)

      Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on Amazon FSx file systems, as follows:

      • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

        SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

      • Amazon FSx for NetApp ONTAP

      • Amazon FSx for OpenZFS

      • Amazon FSx for Windows File Server

      If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

    • FileSystemTypeVersion — (String)

      Sets the version for the Amazon FSx for Lustre file system that you're creating from a backup. Valid values are 2.10, 2.12, and 2.15.

      You don't need to specify FileSystemTypeVersion because it will be applied using the backup's FileSystemTypeVersion setting. If you choose to specify FileSystemTypeVersion when creating from backup, the value must match the backup's FileSystemTypeVersion setting.

    • OpenZFSConfiguration — (map)

      The OpenZFS configuration for the file system that's being created.

      • AutomaticBackupRetentionDays — (Integer)

        The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

      • CopyTagsToBackups — (Boolean)

        A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

      • CopyTagsToVolumes — (Boolean)

        A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false. If it's set to true, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

      • DailyAutomaticBackupStartTime — (String)

        A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

      • DeploymentTyperequired — (String)

        Specifies the file system deployment type. Valid values are the following:

        • MULTI_AZ_1- Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same Amazon Web Services Region.

        • SINGLE_AZ_HA_2- Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone.

        • SINGLE_AZ_HA_1- Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone.

        • SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache that automatically recover within a single Availability Zone.

        • SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone.

        For a list of which Amazon Web Services Regions each deployment type is available in, see Deployment type availability. For more information on the differences in performance between deployment types, see File system performance in the Amazon FSx for OpenZFS User Guide.

        Possible values include:
        • "SINGLE_AZ_1"
        • "SINGLE_AZ_2"
        • "SINGLE_AZ_HA_1"
        • "SINGLE_AZ_HA_2"
        • "MULTI_AZ_1"
      • ThroughputCapacityrequired — (Integer)

        Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:

        • For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.

        • For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.

        You pay for additional throughput capacity that you provision.

      • WeeklyMaintenanceStartTime — (String)

        A recurring weekly time, in the format D:HH:MM.

        D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

        HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

        For example, 1:05:00 specifies maintenance at 5 AM Monday.

      • DiskIopsConfiguration — (map)

        The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

        • Mode — (String)

          Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

          Possible values include:
          • "AUTOMATIC"
          • "USER_PROVISIONED"
        • Iops — (Integer)

          The total number of SSD IOPS provisioned for the file system.

          The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

          Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

      • RootVolumeConfiguration — (map)

        The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.

        • RecordSizeKiB — (Integer)

          Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

        • DataCompressionType — (String)

          Specifies the method used to compress the data on the volume. The compression type is NONE by default.

          • NONE - Doesn't compress the data on the volume. NONE is the default.

          • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

          • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

          Possible values include:
          • "NONE"
          • "ZSTD"
          • "LZ4"
        • NfsExports — (Array<map>)

          The configuration object for mounting a file system.

          • ClientConfigurationsrequired — (Array<map>)

            A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

            • Clientsrequired — (String)

              A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.

            • Optionsrequired — (Array<String>)

              The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:

              • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.

              • sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

        • UserAndGroupQuotas — (Array<map>)

          An object specifying how much storage users or groups can use on the volume.

          • Typerequired — (String)

            Specifies whether the quota applies to a user or group.

            Possible values include:
            • "USER"
            • "GROUP"
          • Idrequired — (Integer)

            The ID of the user or group that the quota applies to.

          • StorageCapacityQuotaGiBrequired — (Integer)

            The user or group's storage quota, in gibibytes (GiB).

        • CopyTagsToSnapshots — (Boolean)

          A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

        • ReadOnly — (Boolean)

          A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

      • PreferredSubnetId — (String)

        Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

      • EndpointIpAddressRange — (String)

        (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

      • RouteTableIds — (Array<String>)

        (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

    • StorageCapacity — (Integer)

      Sets the storage capacity of the OpenZFS file system that you're creating from a backup, in gibibytes (GiB). Valid values are from 64 GiB up to 524,288 GiB (512 TiB). However, the value that you specify must be equal to or greater than the backup's storage capacity value. If you don't use the StorageCapacity parameter, the default is the backup's StorageCapacity value.

      If used to create a file system other than OpenZFS, you must provide a value that matches the backup's StorageCapacity value. If you provide any other value, Amazon FSx responds with with an HTTP status code 400 Bad Request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FileSystem — (map)

        A description of the file system.

        • OwnerId — (String)

          The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

        • CreationTime — (Date)

          The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

        • FileSystemId — (String)

          The system-generated, unique 17-digit ID of the file system.

        • FileSystemType — (String)

          The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

          Possible values include:
          • "WINDOWS"
          • "LUSTRE"
          • "ONTAP"
          • "OPENZFS"
        • Lifecycle — (String)

          The lifecycle status of the file system. The following are the possible values and what they mean:

          • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

          • CREATING - Amazon FSx is creating the new file system.

          • DELETING - Amazon FSx is deleting an existing file system.

          • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

          • MISCONFIGURED - The file system is in a failed but recoverable state.

          • MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

          • UPDATING - The file system is undergoing a customer-initiated update.

          Possible values include:
          • "AVAILABLE"
          • "CREATING"
          • "FAILED"
          • "DELETING"
          • "MISCONFIGURED"
          • "UPDATING"
          • "MISCONFIGURED_UNAVAILABLE"
        • FailureDetails — (map)

          A structure providing details of any failures that occurred.

          • Message — (String)

            A message describing any failures that occurred.

        • StorageCapacity — (Integer)

          The storage capacity of the file system in gibibytes (GiB).

          Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

        • StorageType — (String)

          The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

          Possible values include:
          • "SSD"
          • "HDD"
        • VpcId — (String)

          The ID of the primary virtual private cloud (VPC) for the file system.

        • SubnetIds — (Array<String>)

          Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

          For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

        • NetworkInterfaceIds — (Array<String>)

          The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

          For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

        • DNSName — (String)

          The Domain Name System (DNS) name for the file system.

        • KmsKeyId — (String)

          The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

          • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

            SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

          • Amazon FSx for NetApp ONTAP

          • Amazon FSx for OpenZFS

          • Amazon FSx for Windows File Server

        • ResourceARN — (String)

          The Amazon Resource Name (ARN) of the file system resource.

        • Tags — (Array<map>)

          The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

          • Keyrequired — (String)

            A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

          • Valuerequired — (String)

            A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

        • WindowsConfiguration — (map)

          The configuration for this Amazon FSx for Windows File Server file system.

          • ActiveDirectoryId — (String)

            The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

          • SelfManagedActiveDirectoryConfiguration — (map)

            The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

            • DomainName — (String)

              The fully qualified domain name of the self-managed AD directory.

            • OrganizationalUnitDistinguishedName — (String)

              The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

            • FileSystemAdministratorsGroup — (String)

              The name of the domain group whose members have administrative privileges for the FSx file system.

            • UserName — (String)

              The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

            • DnsIps — (Array<String>)

              A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

          • DeploymentType — (String)

            Specifies the file system deployment type, valid values are the following:

            • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

            • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

            • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

            For more information, see Single-AZ and Multi-AZ File Systems.

            Possible values include:
            • "MULTI_AZ_1"
            • "SINGLE_AZ_1"
            • "SINGLE_AZ_2"
          • RemoteAdministrationEndpoint — (String)

            For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

            For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

            This endpoint is temporarily unavailable when the file system is undergoing maintenance.

          • PreferredSubnetId — (String)

            For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

            For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

          • PreferredFileServerIp — (String)

            For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

            Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

          • ThroughputCapacity — (Integer)

            The throughput of the Amazon FSx file system, measured in megabytes per second.

          • MaintenanceOperationsInProgress — (Array<String>)

            The list of maintenance operations in progress for this file system.

          • WeeklyMaintenanceStartTime — (String)

            The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

          • DailyAutomaticBackupStartTime — (String)

            The preferred time to take daily automatic backups, in the UTC time zone.

          • AutomaticBackupRetentionDays — (Integer)

            The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

          • CopyTagsToBackups — (Boolean)

            A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

          • Aliases — (Array<map>)

            An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

            • Name — (String)

              The name of the DNS alias. The alias name has to meet the following requirements:

              • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

              • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

              • Cannot start or end with a hyphen.

              • Can start with a numeric.

              For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

            • Lifecycle — (String)

              Describes the state of the DNS alias.

              • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

              • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

              • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

              • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

              • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

              Possible values include:
              • "AVAILABLE"
              • "CREATING"
              • "DELETING"
              • "CREATE_FAILED"
              • "DELETE_FAILED"
          • AuditLogConfiguration — (map)

            The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

            • FileAccessAuditLogLevelrequired — (String)

              Sets which attempt type is logged by Amazon FSx for file and folder accesses.

              • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

              • FAILURE_ONLY - only failed attempts to access files or folders are logged.

              • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

              • DISABLED - access auditing of files and folders is turned off.

              Possible values include:
              • "DISABLED"
              • "SUCCESS_ONLY"
              • "FAILURE_ONLY"
              • "SUCCESS_AND_FAILURE"
            • FileShareAccessAuditLogLevelrequired — (String)

              Sets which attempt type is logged by Amazon FSx for file share accesses.

              • SUCCESS_ONLY - only successful attempts to access file shares are logged.

              • FAILURE_ONLY - only failed attempts to access file shares are logged.

              • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

              • DISABLED - access auditing of file shares is turned off.

              Possible values include:
              • "DISABLED"
              • "SUCCESS_ONLY"
              • "FAILURE_ONLY"
              • "SUCCESS_AND_FAILURE"
            • AuditLogDestination — (String)

              The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

              The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

              The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

          • DiskIopsConfiguration — (map)

            The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

            • Mode — (String)

              Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

              Possible values include:
              • "AUTOMATIC"
              • "USER_PROVISIONED"
            • Iops — (Integer)

              The total number of SSD IOPS provisioned for the file system.

              The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

              Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

        • LustreConfiguration — (map)

          The configuration for the Amazon FSx for Lustre file system.

          • WeeklyMaintenanceStartTime — (String)

            The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

          • DataRepositoryConfiguration — (map)

            The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

            This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

            • Lifecycle — (String)

              Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

              • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

              • AVAILABLE - The data repository is available for use.

              • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

              • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

              • FAILED - The data repository is in a terminal state that cannot be recovered.

              Possible values include:
              • "CREATING"
              • "AVAILABLE"
              • "MISCONFIGURED"
              • "UPDATING"
              • "DELETING"
              • "FAILED"
            • ImportPath — (String)

              The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

            • ExportPath — (String)

              The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

            • ImportedFileChunkSize — (Integer)

              For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

              The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

            • AutoImportPolicy — (String)

              Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

              • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

              • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

              • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

              • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

              Possible values include:
              • "NONE"
              • "NEW"
              • "NEW_CHANGED"
              • "NEW_CHANGED_DELETED"
            • FailureDetails — (map)

              Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

              • Message — (String)

                A detailed error message.

          • DeploymentType — (String)

            The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

            SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

            The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

            The default is SCRATCH_1.

            Possible values include:
            • "SCRATCH_1"
            • "SCRATCH_2"
            • "PERSISTENT_1"
            • "PERSISTENT_2"
          • PerUnitStorageThroughput — (Integer)

            Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

            Valid values:

            • For PERSISTENT_1 SSD storage: 50, 100, 200.

            • For PERSISTENT_1 HDD storage: 12, 40.

            • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

          • MountName — (String)

            You use the MountName value when mounting the file system.

            For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

          • DailyAutomaticBackupStartTime — (String)

            A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

          • AutomaticBackupRetentionDays — (Integer)

            The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

          • CopyTagsToBackups — (Boolean)

            A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

          • DriveCacheType — (String)

            The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

            This parameter is required when StorageType is set to HDD.

            Possible values include:
            • "NONE"
            • "READ"
          • DataCompressionType — (String)

            The data compression configuration for the file system. DataCompressionType can have the following values:

            • NONE - Data compression is turned off for the file system.

            • LZ4 - Data compression is turned on with the LZ4 algorithm.

            For more information, see Lustre data compression.

            Possible values include:
            • "NONE"
            • "LZ4"
          • LogConfiguration — (map)

            The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

            • Levelrequired — (String)

              The data repository events that are logged by Amazon FSx.

              • WARN_ONLY - only warning events are logged.

              • ERROR_ONLY - only error events are logged.

              • WARN_ERROR - both warning events and error events are logged.

              • DISABLED - logging of data repository events is turned off.

              Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

              Possible values include:
              • "DISABLED"
              • "WARN_ONLY"
              • "ERROR_ONLY"
              • "WARN_ERROR"
            • Destination — (String)

              The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

          • RootSquashConfiguration — (map)

            The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

            • RootSquash — (String)

              You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

              • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

              • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

              When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

            • NoSquashNids — (Array<String>)

              When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

              • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

              • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

          • MetadataConfiguration — (map)

            The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

            • Iops — (Integer)

              The number of Metadata IOPS provisioned for the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

            • Moderequired — (String)

              The metadata configuration mode for provisioning Metadata IOPS for the file system.

              • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity.

              • In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system.

              Possible values include:
              • "AUTOMATIC"
              • "USER_PROVISIONED"
        • AdministrativeActions — (Array<map>)

          A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the UpdateFileSystem operation.

          • AdministrativeActionType — (String)

            Describes the type of administrative action, as follows:

            • FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).

            • THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts.

              You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

            • STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

              • For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

              • For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

              You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

            • FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

            • FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

            • IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts.

              You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

            • STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system's throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts.

              You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

            • VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateVolume), or CLI (update-volume).

            • VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API (RestoreVolumeFromSnapshot) or CLI (restore-volume-from-snapshot).

            • SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API (UpdateSnapshot), or CLI (update-snapshot).

            • RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

            • DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

            • VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CreateVolume), or CLI (create-volume) when using the using the FULL_COPY strategy.

            • VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API (CopySnapshotAndUpdateVolume), or CLI (copy-snapshot-and-update-volume).

            Possible values include:
            • "FILE_SYSTEM_UPDATE"
            • "STORAGE_OPTIMIZATION"
            • "FILE_SYSTEM_ALIAS_ASSOCIATION"
            • "FILE_SYSTEM_ALIAS_DISASSOCIATION"
            • "VOLUME_UPDATE"
            • "SNAPSHOT_UPDATE"
            • "RELEASE_NFS_V3_LOCKS"
            • "VOLUME_RESTORE"
            • "THROUGHPUT_OPTIMIZATION"
            • "IOPS_OPTIMIZATION"
            • "STORAGE_TYPE_OPTIMIZATION"
            • "MISCONFIGURED_STATE_RECOVERY"
            • "VOLUME_UPDATE_WITH_SNAPSHOT"
            • "VOLUME_INITIALIZE_WITH_SNAPSHOT"
            • "DOWNLOAD_DATA_FROM_BACKUP"
          • ProgressPercent — (Integer)

            The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

          • RequestTime — (Date)

            The time that the administrative action request was received.

          • Status — (String)

            The status of the administrative action, as follows:

            • FAILED - Amazon FSx failed to process the administrative action successfully.

            • IN_PROGRESS - Amazon FSx is processing the administrative action.

            • PENDING - Amazon FSx is waiting to process the administrative action.

            • COMPLETED - Amazon FSx has finished processing the administrative task.

              For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

            • UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

            • PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume's Lifecycle state is CREATING.

            • IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

            Possible values include:
            • "FAILED"
            • "IN_PROGRESS"
            • "PENDING"
            • "COMPLETED"
            • "UPDATED_OPTIMIZING"
            • "OPTIMIZING"
          • TargetFileSystemValues — (map)

            The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

            • OwnerId — (String)

              The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner.

            • CreationTime — (Date)

              The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

            • FileSystemId — (String)

              The system-generated, unique 17-digit ID of the file system.

            • FileSystemType — (String)

              The type of Amazon FSx file system, which can be LUSTRE, WINDOWS, ONTAP, or OPENZFS.

              Possible values include:
              • "WINDOWS"
              • "LUSTRE"
              • "ONTAP"
              • "OPENZFS"
            • Lifecycle — (String)

              The lifecycle status of the file system. The following are the possible values and what they mean:

              • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

              • CREATING - Amazon FSx is creating the new file system.

              • DELETING - Amazon FSx is deleting an existing file system.

              • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system.

              • MISCONFIGURED - The file system is in a failed but recoverable state.

              • MISCONFIGURED_UNAVAILABLE - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration.

              • UPDATING - The file system is undergoing a customer-initiated update.

              Possible values include:
              • "AVAILABLE"
              • "CREATING"
              • "FAILED"
              • "DELETING"
              • "MISCONFIGURED"
              • "UPDATING"
              • "MISCONFIGURED_UNAVAILABLE"
            • FailureDetails — (map)

              A structure providing details of any failures that occurred.

              • Message — (String)

                A message describing any failures that occurred.

            • StorageCapacity — (Integer)

              The storage capacity of the file system in gibibytes (GiB).

              Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of StorageCapacity is outside of the minimum or maximum values.

            • StorageType — (String)

              The type of storage the file system is using. If set to SSD, the file system uses solid state drive storage. If set to HDD, the file system uses hard disk drive storage.

              Possible values include:
              • "SSD"
              • "HDD"
            • VpcId — (String)

              The ID of the primary virtual private cloud (VPC) for the file system.

            • SubnetIds — (Array<String>)

              Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP MULTI_AZ_1 file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the PreferredSubnetID property. All other file systems have only one subnet ID.

              For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For MULTI_AZ_1 Windows and ONTAP file systems, the file system endpoint is available in the PreferredSubnetID.

            • NetworkInterfaceIds — (Array<String>)

              The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

              For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

            • DNSName — (String)

              The Domain Name System (DNS) name for the file system.

            • KmsKeyId — (String)

              The ID of the Key Management Service (KMS) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types:

              • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

                SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service KMS key for your account.

              • Amazon FSx for NetApp ONTAP

              • Amazon FSx for OpenZFS

              • Amazon FSx for Windows File Server

            • ResourceARN — (String)

              The Amazon Resource Name (ARN) of the file system resource.

            • Tags — (Array<map>)

              The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

              • Keyrequired — (String)

                A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

              • Valuerequired — (String)

                A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

            • WindowsConfiguration — (map)

              The configuration for this Amazon FSx for Windows File Server file system.

              • ActiveDirectoryId — (String)

                The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

              • SelfManagedActiveDirectoryConfiguration — (map)

                The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

                • DomainName — (String)

                  The fully qualified domain name of the self-managed AD directory.

                • OrganizationalUnitDistinguishedName — (String)

                  The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

                • FileSystemAdministratorsGroup — (String)

                  The name of the domain group whose members have administrative privileges for the FSx file system.

                • UserName — (String)

                  The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

                • DnsIps — (Array<String>)

                  A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

              • DeploymentType — (String)

                Specifies the file system deployment type, valid values are the following:

                • MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.

                • SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage.

                • SINGLE_AZ_2 - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.

                For more information, see Single-AZ and Multi-AZ File Systems.

                Possible values include:
                • "MULTI_AZ_1"
                • "SINGLE_AZ_1"
                • "SINGLE_AZ_2"
              • RemoteAdministrationEndpoint — (String)

                For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell.

                For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this is the DNS name of the file system.

                This endpoint is temporarily unavailable when the file system is undergoing maintenance.

              • PreferredSubnetId — (String)

                For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.

                For SINGLE_AZ_1 and SINGLE_AZ_2 deployment types, this value is the same as that for SubnetIDs. For more information, see Availability and durability: Single-AZ and Multi-AZ file systems.

              • PreferredFileServerIp — (String)

                For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.

                Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see Accessing File Shares.

              • ThroughputCapacity — (Integer)

                The throughput of the Amazon FSx file system, measured in megabytes per second.

              • MaintenanceOperationsInProgress — (Array<String>)

                The list of maintenance operations in progress for this file system.

              • WeeklyMaintenanceStartTime — (String)

                The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

              • DailyAutomaticBackupStartTime — (String)

                The preferred time to take daily automatic backups, in the UTC time zone.

              • AutomaticBackupRetentionDays — (Integer)

                The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days.

              • CopyTagsToBackups — (Boolean)

                A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

              • Aliases — (Array<map>)

                An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

                • Name — (String)

                  The name of the DNS alias. The alias name has to meet the following requirements:

                  • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

                  • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

                  • Cannot start or end with a hyphen.

                  • Can start with a numeric.

                  For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

                • Lifecycle — (String)

                  Describes the state of the DNS alias.

                  • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

                  • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

                  • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

                  • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

                  • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

                  Possible values include:
                  • "AVAILABLE"
                  • "CREATING"
                  • "DELETING"
                  • "CREATE_FAILED"
                  • "DELETE_FAILED"
              • AuditLogConfiguration — (map)

                The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

                • FileAccessAuditLogLevelrequired — (String)

                  Sets which attempt type is logged by Amazon FSx for file and folder accesses.

                  • SUCCESS_ONLY - only successful attempts to access files or folders are logged.

                  • FAILURE_ONLY - only failed attempts to access files or folders are logged.

                  • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.

                  • DISABLED - access auditing of files and folders is turned off.

                  Possible values include:
                  • "DISABLED"
                  • "SUCCESS_ONLY"
                  • "FAILURE_ONLY"
                  • "SUCCESS_AND_FAILURE"
                • FileShareAccessAuditLogLevelrequired — (String)

                  Sets which attempt type is logged by Amazon FSx for file share accesses.

                  • SUCCESS_ONLY - only successful attempts to access file shares are logged.

                  • FAILURE_ONLY - only failed attempts to access file shares are logged.

                  • SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.

                  • DISABLED - access auditing of file shares is turned off.

                  Possible values include:
                  • "DISABLED"
                  • "SUCCESS_ONLY"
                  • "FAILURE_ONLY"
                  • "SUCCESS_AND_FAILURE"
                • AuditLogDestination — (String)

                  The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

                  The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

                  The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

              • DiskIopsConfiguration — (map)

                The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

                • Mode — (String)

                  Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                  Possible values include:
                  • "AUTOMATIC"
                  • "USER_PROVISIONED"
                • Iops — (Integer)

                  The total number of SSD IOPS provisioned for the file system.

                  The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

            • LustreConfiguration — (map)

              The configuration for the Amazon FSx for Lustre file system.

              • WeeklyMaintenanceStartTime — (String)

                The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

              • DataRepositoryConfiguration — (map)

                The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

                This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

                • Lifecycle — (String)

                  Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values:

                  • CREATING - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable.

                  • AVAILABLE - The data repository is available for use.

                  • MISCONFIGURED - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see Troubleshooting a Misconfigured linked S3 bucket.

                  • UPDATING - The data repository is undergoing a customer initiated update and availability may be impacted.

                  • FAILED - The data repository is in a terminal state that cannot be recovered.

                  Possible values include:
                  • "CREATING"
                  • "AVAILABLE"
                  • "MISCONFIGURED"
                  • "UPDATING"
                  • "DELETING"
                  • "FAILED"
                • ImportPath — (String)

                  The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

                • ExportPath — (String)

                  The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

                • ImportedFileChunkSize — (Integer)

                  For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

                  The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

                • AutoImportPolicy — (String)

                  Describes the file system's linked S3 data repository's AutoImportPolicy. The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

                  • NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.

                  • NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.

                  • NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.

                  • NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

                  Possible values include:
                  • "NONE"
                  • "NEW"
                  • "NEW_CHANGED"
                  • "NEW_CHANGED_DELETED"
                • FailureDetails — (map)

                  Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

                  • Message — (String)

                    A detailed error message.

              • DeploymentType — (String)

                The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

                SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

                The PERSISTENT_1 and PERSISTENT_2 deployment type is used for longer-term storage and workloads and encryption of data in transit. PERSISTENT_2 offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see FSx for Lustre deployment options.

                The default is SCRATCH_1.

                Possible values include:
                • "SCRATCH_1"
                • "SCRATCH_2"
                • "PERSISTENT_1"
                • "PERSISTENT_2"
              • PerUnitStorageThroughput — (Integer)

                Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for PERSISTENT_1 and PERSISTENT_2 deployment types.

                Valid values:

                • For PERSISTENT_1 SSD storage: 50, 100, 200.

                • For PERSISTENT_1 HDD storage: 12, 40.

                • For PERSISTENT_2 SSD storage: 125, 250, 500, 1000.

              • MountName — (String)

                You use the MountName value when mounting the file system.

                For the SCRATCH_1 deployment type, this value is always "fsx". For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 deployment types, this value is a string that is unique within an Amazon Web Services Region.

              • DailyAutomaticBackupStartTime — (String)

                A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

              • AutomaticBackupRetentionDays — (Integer)

                The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

              • CopyTagsToBackups — (Boolean)

                A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

              • DriveCacheType — (String)

                The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when StorageType is HDD. When set to READ the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity.

                This parameter is required when StorageType is set to HDD.

                Possible values include:
                • "NONE"
                • "READ"
              • DataCompressionType — (String)

                The data compression configuration for the file system. DataCompressionType can have the following values:

                • NONE - Data compression is turned off for the file system.

                • LZ4 - Data compression is turned on with the LZ4 algorithm.

                For more information, see Lustre data compression.

                Possible values include:
                • "NONE"
                • "LZ4"
              • LogConfiguration — (map)

                The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

                • Levelrequired — (String)

                  The data repository events that are logged by Amazon FSx.

                  • WARN_ONLY - only warning events are logged.

                  • ERROR_ONLY - only error events are logged.

                  • WARN_ERROR - both warning events and error events are logged.

                  • DISABLED - logging of data repository events is turned off.

                  Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.

                  Possible values include:
                  • "DISABLED"
                  • "WARN_ONLY"
                  • "ERROR_ONLY"
                  • "WARN_ERROR"
                • Destination — (String)

                  The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

              • RootSquashConfiguration — (map)

                The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user.

                • RootSquash — (String)

                  You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294:

                  • A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value.

                  • A value of 0 (zero) for UID and GID indicates root, and therefore disables root squash.

                  When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide.

                • NoSquashNids — (Array<String>)

                  When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses:

                  • A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp).

                  • An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp).

              • MetadataConfiguration — (map)

                The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a PERSISTENT_2 deployment type.

                • Iops — (Integer)

                  The number of Metadata IOPS provisioned for the file system. Valid values are 1500, 3000, 6000, 12000, and multiples of 12000 up to a maximum of 192000.

                • Moderequired — (String)

                  The metadata configuration mode for provisioning Metadata IOPS for the file system.

                  • In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity.

                  • In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system.

                  Possible values include:
                  • "AUTOMATIC"
                  • "USER_PROVISIONED"
            • OntapConfiguration — (map)

              The configuration for this Amazon FSx for NetApp ONTAP file system.

              • AutomaticBackupRetentionDays — (Integer)

                The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

              • DailyAutomaticBackupStartTime — (String)

                A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

              • DeploymentType — (String)

                Specifies the FSx for ONTAP file system deployment type in use in the file system.

                • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

                • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

                • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

                • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

                For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

                Possible values include:
                • "MULTI_AZ_1"
                • "SINGLE_AZ_1"
                • "SINGLE_AZ_2"
                • "MULTI_AZ_2"
              • EndpointIpAddressRange — (String)

                (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

              • Endpoints — (map)

                The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

                • Intercluster — (map)

                  An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

                  • DNSName — (String)

                    The file system's DNS name. You can mount your file system using its DNS name.

                  • IpAddresses — (Array<String>)

                    IP addresses of the file system endpoint.

                • Management — (map)

                  An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

                  • DNSName — (String)

                    The file system's DNS name. You can mount your file system using its DNS name.

                  • IpAddresses — (Array<String>)

                    IP addresses of the file system endpoint.

              • DiskIopsConfiguration — (map)

                The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

                • Mode — (String)

                  Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                  Possible values include:
                  • "AUTOMATIC"
                  • "USER_PROVISIONED"
                • Iops — (Integer)

                  The total number of SSD IOPS provisioned for the file system.

                  The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

              • PreferredSubnetId — (String)

                The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

              • RouteTableIds — (Array<String>)

                (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

              • ThroughputCapacity — (Integer)

                The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

              • WeeklyMaintenanceStartTime — (String)

                A recurring weekly time, in the format D:HH:MM.

                D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

                HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

                For example, 1:05:00 specifies maintenance at 5 AM Monday.

              • FsxAdminPassword — (String)

                You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.

              • HAPairs — (Integer)

                Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                • The value of HAPairs is less than 1 or greater than 12.

                • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1, MULTI_AZ_1, or MULTI_AZ_2.

              • ThroughputCapacityPerHAPair — (Integer)

                Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

                This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

                This field and ThroughputCapacity are the same for file systems with one HA pair.

                • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

                • For SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps.

                • For MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.

                Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

                • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).

                • The value of ThroughputCapacityPerHAPair is not a valid value.

            • FileSystemTypeVersion — (String)

              The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

            • OpenZFSConfiguration — (map)

              The configuration for this Amazon FSx for OpenZFS file system.

              • AutomaticBackupRetentionDays — (Integer)

                The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30.

              • CopyTagsToBackups — (Boolean)

                A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

              • CopyTagsToVolumes — (Boolean)

                A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

              • DailyAutomaticBackupStartTime — (String)

                A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

              • DeploymentType — (String)

                Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

                Possible values include:
                • "SINGLE_AZ_1"
                • "SINGLE_AZ_2"
                • "SINGLE_AZ_HA_1"
                • "SINGLE_AZ_HA_2"
                • "MULTI_AZ_1"
              • ThroughputCapacity — (Integer)

                The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

              • WeeklyMaintenanceStartTime — (String)

                A recurring weekly time, in the format D:HH:MM.

                D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

                HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

                For example, 1:05:00 specifies maintenance at 5 AM Monday.

              • DiskIopsConfiguration — (map)

                The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

                • Mode — (String)

                  Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

                  Possible values include:
                  • "AUTOMATIC"
                  • "USER_PROVISIONED"
                • Iops — (Integer)

                  The total number of SSD IOPS provisioned for the file system.

                  The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity. The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity). The maximum value is calculated as 200,000 * HAPairs.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

              • RootVolumeId — (String)

                The ID of the root volume of the OpenZFS file system.

              • PreferredSubnetId — (String)

                Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

              • EndpointIpAddressRange — (String)

                (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

              • RouteTableIds — (Array<String>)

                (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

              • EndpointIpAddress — (String)

                The IP address of the endpoint that is used to access data or to manage the file system.

          • FailureDetails — (map)

            Provides information about a failed administrative action.

            • Message — (String)

              Error message providing details about the failed administrative action.

          • TargetVolumeValues — (map)

            Describes an Amazon FSx volume.

            • CreationTime — (Date)

              The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

            • FileSystemId — (String)

              The globally unique ID of the file system, assigned by Amazon FSx.

            • Lifecycle — (String)

              The lifecycle status of the volume.

              • AVAILABLE - The volume is fully available for use.

              • CREATED - The volume has been created.

              • CREATING - Amazon FSx is creating the new volume.

              • DELETING - Amazon FSx is deleting an existing volume.

              • FAILED - Amazon FSx was unable to create the volume.

              • MISCONFIGURED - The volume is in a failed but recoverable state.

              • PENDING - Amazon FSx hasn't started creating the volume.

              Possible values include:
              • "CREATING"
              • "CREATED"
              • "DELETING"
              • "FAILED"
              • "MISCONFIGURED"
              • "PENDING"
              • "AVAILABLE"
            • Name — (String)

              The name of the volume.

            • OntapConfiguration — (map)

              The configuration of an Amazon FSx for NetApp ONTAP volume.

              • FlexCacheEndpointType — (String)

                Specifies the FlexCache endpoint type of the volume. Valid values are the following:

                • NONE specifies that the volume doesn't have a FlexCache configuration. NONE is the default.

                • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.

                • CACHE specifies that the volume is a FlexCache volume.

                Possible values include:
                • "NONE"
                • "ORIGIN"
                • "CACHE"
              • JunctionPath — (String)

                Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.

              • SecurityStyle — (String)

                The security style for the volume, which can be UNIX, NTFS, or MIXED.

                Possible values include:
                • "UNIX"
                • "NTFS"
                • "MIXED"
              • SizeInMegabytes — (Integer)

                The configured size of the volume, in megabytes (MBs).

              • StorageEfficiencyEnabled — (Boolean)

                The volume's storage efficiency setting.

              • StorageVirtualMachineId — (String)

                The ID of the volume's storage virtual machine.

              • StorageVirtualMachineRoot — (Boolean)

                A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.

                This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.

              • TieringPolicy — (map)

                The volume's TieringPolicy setting.

                • CoolingPeriod — (Integer)

                  Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.

                • Name — (String)

                  Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.

                  • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.

                  • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.

                  • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.

                  • NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

                  Possible values include:
                  • "SNAPSHOT_ONLY"
                  • "AUTO"
                  • "ALL"
                  • "NONE"
              • UUID — (String)

                The volume's universally unique identifier (UUID).

              • OntapVolumeType — (String)

                Specifies the type of volume. Valid values are the following:

                • RW specifies a read/write volume. RW is the default.

                • DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.

                • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.

                Possible values include:
                • "RW"
                • "DP"
                • "LS"
              • SnapshotPolicy — (String)

                Specifies the snapshot policy for the volume. There are three built-in snapshot policies:

                • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.

                • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.

                • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.

                You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.

                For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.

              • CopyTagsToBackups — (Boolean)

                A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.

              • SnaplockConfiguration — (map)

                The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

                • AuditLogVolume — (Boolean)

                  Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months.

                  For more information, see SnapLock audit log volumes.

                • AutocommitPeriod — (map)

                  The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

                  • Typerequired — (String)

                    Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.

                    Possible values include:
                    • "MINUTES"
                    • "HOURS"
                    • "DAYS"
                    • "MONTHS"
                    • "YEARS"
                    • "NONE"
                  • Value — (Integer)

                    Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:

                    • Minutes: 5 - 65,535

                    • Hours: 1 - 65,535

                    • Days: 1 - 3,650

                    • Months: 1 - 120

                    • Years: 1 - 10

                • PrivilegedDelete — (String)

                  Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can't re-enable it. The default value is DISABLED.

                  For more information, see Privileged delete.

                  Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                  • "PERMANENTLY_DISABLED"
                • RetentionPeriod — (map)

                  Specifies the retention period of an FSx for ONTAP SnapLock volume.

                  • DefaultRetentionrequired — (map)

                    The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

                    • Typerequired — (String)

                      Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                      Possible values include:
                      • "SECONDS"
                      • "MINUTES"
                      • "HOURS"
                      • "DAYS"
                      • "MONTHS"
                      • "YEARS"
                      • "INFINITE"
                      • "UNSPECIFIED"
                    • Value — (Integer)

                      Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                      • Seconds: 0 - 65,535

                      • Minutes: 0 - 65,535

                      • Hours: 0 - 24

                      • Days: 0 - 365

                      • Months: 0 - 12

                      • Years: 0 - 100

                  • MinimumRetentionrequired — (map)

                    The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                    • Typerequired — (String)

                      Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                      Possible values include:
                      • "SECONDS"
                      • "MINUTES"
                      • "HOURS"
                      • "DAYS"
                      • "MONTHS"
                      • "YEARS"
                      • "INFINITE"
                      • "UNSPECIFIED"
                    • Value — (Integer)

                      Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                      • Seconds: 0 - 65,535

                      • Minutes: 0 - 65,535

                      • Hours: 0 - 24

                      • Days: 0 - 365

                      • Months: 0 - 12

                      • Years: 0 - 100

                  • MaximumRetentionrequired — (map)

                    The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

                    • Typerequired — (String)

                      Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

                      Possible values include:
                      • "SECONDS"
                      • "MINUTES"
                      • "HOURS"
                      • "DAYS"
                      • "MONTHS"
                      • "YEARS"
                      • "INFINITE"
                      • "UNSPECIFIED"
                    • Value — (Integer)

                      Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

                      • Seconds: 0 - 65,535

                      • Minutes: 0 - 65,535

                      • Hours: 0 - 24

                      • Days: 0 - 365

                      • Months: 0 - 12

                      • Years: 0 - 100

                • SnaplockType — (String)

                  Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. You can choose one of the following retention modes:

                  • COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can't be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.

                  • ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization's data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.

                  Possible values include:
                  • "COMPLIANCE"
                  • "ENTERPRISE"
                • VolumeAppendModeEnabled — (Boolean)

                  Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false.

                  For more information, see Volume-append mode.

              • VolumeStyle — (String)

                Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.

                Possible values include:
                • "FLEXVOL"
                • "FLEXGROUP"
              • AggregateConfiguration — (map)

                This structure specifies configuration options for a volume’s storage aggregate or aggregates.

                • Aggregates — (Array<String>)

                  The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry.

                  Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

                  • The strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 12.

                  • The value of Aggregates contains aggregates that are not present.

                  • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.

                • TotalConstituents — (Integer)

                  The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.

              • SizeInBytes — (Integer)

                The configured size of the volume, in bytes.

            • ResourceARN — (String)

              The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

            • Tags — (Array<map>)

              A list of Tag values, with a maximum of 50 elements.

              • Keyrequired — (String)

                A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

              • Valuerequired — (String)

                A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

            • VolumeId — (String)

              The system-generated, unique ID of the volume.

            • VolumeType — (String)

              The type of the volume.

              Possible values include:
              • "ONTAP"
              • "OPENZFS"
            • LifecycleTransitionReason — (map)

              The reason why the volume lifecycle status changed.

              • Message — (String)

                A detailed error message.

            • OpenZFSConfiguration — (map)

              The configuration of an Amazon FSx for OpenZFS volume.

              • ParentVolumeId — (String)

                The ID of the parent volume.

              • VolumePath — (String)

                The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

              • StorageCapacityReservationGiB — (Integer)

                The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

              • StorageCapacityQuotaGiB — (Integer)

                The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

              • RecordSizeKiB — (Integer)

                The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

              • DataCompressionType — (String)

                Specifies the method used to compress the data on the volume. The compression type is NONE by default.

                • NONE - Doesn't compress the data on the volume. NONE is the default.

                • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

                • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

                Possible values include:
                • "NONE"
                • "ZSTD"
                • "LZ4"
              • CopyTagsToSnapshots — (Boolean)

                A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

              • OriginSnapshot — (map)

                The configuration object that specifies the snapshot to use as the origin of the data for the volume.

                • SnapshotARN — (String)

                  The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

                • CopyStrategy — (String)

                  The strategy used when copying data from the snapshot to the new volume.

                  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                  • FULL_COPY - Copies all data from the snapshot to the new volume.

                  Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                  Possible values include:
                  • "CLONE"
                  • "FULL_COPY"
                  • "INCREMENTAL_COPY"
              • ReadOnly — (Boolean)

                A Boolean value indicating whether the volume is read-only.

              • NfsExports — (Array<map>)

                The configuration object for mounting a Network File System (NFS) file system.

                • ClientConfigurationsrequired — (Array<map>)

                  A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

                  • Clientsrequired — (String)

                    A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.

                  • Optionsrequired — (Array<String>)

                    The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:

                    • crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.

                    • sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

              • UserAndGroupQuotas — (Array<map>)

                An object specifying how much storage users or groups can use on the volume.

                • Typerequired — (String)

                  Specifies whether the quota applies to a user or group.

                  Possible values include:
                  • "USER"
                  • "GROUP"
                • Idrequired — (Integer)

                  The ID of the user or group that the quota applies to.

                • StorageCapacityQuotaGiBrequired — (Integer)

                  The user or group's storage quota, in gibibytes (GiB).

              • RestoreToSnapshot — (String)

                Specifies the ID of the snapshot to which the volume was restored.

              • DeleteIntermediateSnaphots — (Boolean)

                A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

              • DeleteClonedVolumes — (Boolean)

                A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

              • DeleteIntermediateData — (Boolean)

                A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

              • SourceSnapshotARN — (String)

                The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

              • DestinationSnapshot — (String)

                The ID of the snapshot that's being copied or was most recently copied to the destination volume.

              • CopyStrategy — (String)

                Specifies the strategy used when copying data from the snapshot to the new volume.

                • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

                • FULL_COPY - Copies all data from the snapshot to the new volume.

                  Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

                Note: The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
                Possible values include:
                • "CLONE"
                • "FULL_COPY"
                • "INCREMENTAL_COPY"
          • TargetSnapshotValues — (map)

            A snapshot of an Amazon FSx for OpenZFS volume.

            • ResourceARN — (String)