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.createBackup(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

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

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) —

    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'.

  • 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.

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • 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.

Property Details

endpoint ⇒ AWS.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

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

Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.

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 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 CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

Note:

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 = {
  FileSystemId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
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 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      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.

      • Key — (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.

      • Value — (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 description of the backup.

        • BackupId — required — (String)

          The ID of the backup.

        • Lifecycle — required — (String)

          The lifecycle status of the backup.

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

          Details explaining any failures that occur when creating a backup.

          • Message — (String)

            A message describing the backup creation failure.

        • Type — required — (String)

          The type of the backup.

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

          The current percent of progress of an asynchronous task.

        • CreationTime — required — (Date)

          The time when a particular backup was created.

        • KmsKeyId — (String)

          The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data.

        • ResourceARN — (String)

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

        • Tags — (Array<map>)

          Tags associated with a particular file system.

          • Key — (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.

          • Value — (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.

        • FileSystem — required — (map)

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

          • OwnerId — (String)

            The AWS account that created the file system. If the file system was created by an IAM user, the AWS 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 eight-digit ID of the file system that was automatically assigned by Amazon FSx.

          • FileSystemType — (String)

            Type of file system. Currently the only supported type is WINDOWS.

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

            The lifecycle status of the file system.

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

            Structure providing details of any failures that occur when creating the file system has failed.

            • Message — (String)

              Message describing the failures that occurred during file system creation.

          • StorageCapacity — (Integer)

            The storage capacity of the file system in gigabytes.

          • VpcId — (String)

            The ID of the primary VPC for the file system.

          • SubnetIds — (Array<String>)

            The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

          • NetworkInterfaceIds — (Array<String>)

            The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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 DNS name for the file system.

          • KmsKeyId — (String)

            The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

          • ResourceARN — (String)

            The resource ARN of the file system.

          • Tags — (Array<map>)

            The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

            • Key — (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.

            • Value — (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 Microsoft Active Directory instance that the file system should join when it's created.

            • ThroughputCapacity — (Integer)

              The throughput of an 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 time to perform weekly maintenance, in the UTC time zone.

            • 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 35 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.

          • LustreConfiguration — (map)

            The configuration for the Amazon FSx for Lustre file system.

            • WeeklyMaintenanceStartTime — (String)

              The UTC time that you want to begin your weekly maintenance window.

            • DataRepositoryConfiguration — (map)

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

              • 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.

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.

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 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.

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.

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 file system. */

 var params = {
  ClientRequestToken: "a8ca07e4-61ec-4399-99f4-19853801bcd5", 
  FileSystemType: "WINDOWS", 
  KmsKeyId: "arn:aws:kms:us-east-1:012345678912:key/0ff3ea8d-130e-4133-877f-93908b6fdbd6", 
  SecurityGroupIds: [
     "sg-edcd9784"
  ], 
  StorageCapacity: 300, 
  SubnetIds: [
     "subnet-1234abcd"
  ], 
  Tags: [
     {
    Key: "Name", 
    Value: "MyFileSystem"
   }
  ], 
  WindowsConfiguration: {
   ActiveDirectoryId: "d-1234abcd12", 
   AutomaticBackupRetentionDays: 30, 
   DailyAutomaticBackupStartTime: "05:00", 
   ThroughputCapacity: 8, 
   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-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 createFileSystem operation

var params = {
  FileSystemType: WINDOWS | LUSTRE, /* required */
  StorageCapacity: 'NUMBER_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  LustreConfiguration: {
    ExportPath: 'STRING_VALUE',
    ImportPath: 'STRING_VALUE',
    ImportedFileChunkSize: 'NUMBER_VALUE',
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  },
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  WindowsConfiguration: {
    ThroughputCapacity: 'NUMBER_VALUE', /* required */
    ActiveDirectoryId: 'STRING_VALUE',
    AutomaticBackupRetentionDays: 'NUMBER_VALUE',
    CopyTagsToBackups: true || false,
    DailyAutomaticBackupStartTime: '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)

      (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

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

      The type of file system.

      Possible values include:
      • "WINDOWS"
      • "LUSTRE"
    • StorageCapacity — (Integer)

      The storage capacity of the file system.

      For Windows file systems, the storage capacity has a minimum of 300 GiB, and a maximum of 65,536 GiB.

      For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storage capacity is provisioned in increments of 3,600 GiB.

    • SubnetIds — (Array<String>)

      A list of IDs for the subnets that the file system will be accessible from. File systems support only one subnet. The file server is also 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 will apply to all network interfaces. This list isn't returned in later describe 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.

      • Key — (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.

      • Value — (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)

      The ID of your AWS Key Management Service (AWS KMS) key. This ID is used to encrypt the data in your file system at rest. For more information, see Encrypt in the AWS Key Management Service API Reference.

    • WindowsConfiguration — (map)

      The configuration for this Microsoft Windows file system.

      • ActiveDirectoryId — (String)

        The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.

      • ThroughputCapacity — required — (Integer)

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

      • WeeklyMaintenanceStartTime — (String)

        The preferred start time to perform weekly maintenance, in the UTC time zone.

      • 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. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 35 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.

    • LustreConfiguration — (map)

      The configuration object for Lustre file systems used in the CreateFileSystem operation.

      • WeeklyMaintenanceStartTime — (String)

        The preferred time to perform weekly maintenance, in the UTC time zone.

      • 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.

      • ExportPath — (String)

        (Optional) The path in Amazon S3 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 only specify 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.

      • 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 chunk size default 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.

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 AWS account that created the file system. If the file system was created by an IAM user, the AWS 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 eight-digit ID of the file system that was automatically assigned by Amazon FSx.

        • FileSystemType — (String)

          Type of file system. Currently the only supported type is WINDOWS.

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

          The lifecycle status of the file system.

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

          Structure providing details of any failures that occur when creating the file system has failed.

          • Message — (String)

            Message describing the failures that occurred during file system creation.

        • StorageCapacity — (Integer)

          The storage capacity of the file system in gigabytes.

        • VpcId — (String)

          The ID of the primary VPC for the file system.

        • SubnetIds — (Array<String>)

          The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

        • NetworkInterfaceIds — (Array<String>)

          The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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 DNS name for the file system.

        • KmsKeyId — (String)

          The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

        • ResourceARN — (String)

          The resource ARN of the file system.

        • Tags — (Array<map>)

          The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

          • Key — (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.

          • Value — (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 Microsoft Active Directory instance that the file system should join when it's created.

          • ThroughputCapacity — (Integer)

            The throughput of an 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 time to perform weekly maintenance, in the UTC time zone.

          • 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 35 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.

        • LustreConfiguration — (map)

          The configuration for the Amazon FSx for Lustre file system.

          • WeeklyMaintenanceStartTime — (String)

            The UTC time that you want to begin your weekly maintenance window.

          • DataRepositoryConfiguration — (map)

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

            • 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.

Returns:

  • (AWS.Request) —

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

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

Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.

If a file system with the specified client request token exists and the parameters match, this call returns the description of the existing file system. If a client request token specified by the file system exists and 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 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 success 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',
  SecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  WindowsConfiguration: {
    ThroughputCapacity: 'NUMBER_VALUE', /* required */
    ActiveDirectoryId: 'STRING_VALUE',
    AutomaticBackupRetentionDays: 'NUMBER_VALUE',
    CopyTagsToBackups: true || false,
    DailyAutomaticBackupStartTime: '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 backup.

    • ClientRequestToken — (String)

      (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

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

      A list of IDs for the subnets that the file system will be accessible from. Currently, you can specify only one subnet. The file server is also 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 describe 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.

      • Key — (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.

      • Value — (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 Microsoft Active Directory instance that the file system should join when it's created.

      • ThroughputCapacity — required — (Integer)

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

      • WeeklyMaintenanceStartTime — (String)

        The preferred start time to perform weekly maintenance, in the UTC time zone.

      • 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. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 35 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.

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 AWS account that created the file system. If the file system was created by an IAM user, the AWS 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 eight-digit ID of the file system that was automatically assigned by Amazon FSx.

        • FileSystemType — (String)

          Type of file system. Currently the only supported type is WINDOWS.

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

          The lifecycle status of the file system.

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

          Structure providing details of any failures that occur when creating the file system has failed.

          • Message — (String)

            Message describing the failures that occurred during file system creation.

        • StorageCapacity — (Integer)

          The storage capacity of the file system in gigabytes.

        • VpcId — (String)

          The ID of the primary VPC for the file system.

        • SubnetIds — (Array<String>)

          The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

        • NetworkInterfaceIds — (Array<String>)

          The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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 DNS name for the file system.

        • KmsKeyId — (String)

          The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

        • ResourceARN — (String)

          The resource ARN of the file system.

        • Tags — (Array<map>)

          The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

          • Key — (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.

          • Value — (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 Microsoft Active Directory instance that the file system should join when it's created.

          • ThroughputCapacity — (Integer)

            The throughput of an 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 time to perform weekly maintenance, in the UTC time zone.

          • 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 35 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.

        • LustreConfiguration — (map)

          The configuration for the Amazon FSx for Lustre file system.

          • WeeklyMaintenanceStartTime — (String)

            The UTC time that you want to begin your weekly maintenance window.

          • DataRepositoryConfiguration — (map)

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

            • 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.

Returns:

  • (AWS.Request) —

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

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

Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.

The data in a deleted backup is also deleted and can't be recovered by any means.

Service Reference:

Examples:

To delete a backup


/* This operation deletes an Amazon FSx file system backup. */

 var params = {
  BackupId: "backup-03e3c82e0183b7b6b"
 };
 fsx.deleteBackup(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    BackupId: "backup-03e3c82e0183b7b6b", 
    Lifecycle: "DELETED"
   }
   */
 });

Calling the deleteBackup operation

var params = {
  BackupId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE'
};
fsx.deleteBackup(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 backup you want to delete.

    • ClientRequestToken — (String)

      (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • BackupId — (String)

        The ID of the backup deleted.

      • Lifecycle — (String)

        The lifecycle of the backup. Should be DELETED.

        Possible values include:
        • "AVAILABLE"
        • "CREATING"
        • "DELETED"
        • "FAILED"

Returns:

  • (AWS.Request) —

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

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

Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.

By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.

The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.

The data in a deleted file system is also deleted and can't be recovered by any means.

Service Reference:

Examples:

To delete a file system


/* This operation deletes an Amazon FSx file system. */

 var params = {
  FileSystemId: "fs-0498eed5fe91001ec"
 };
 fsx.deleteFileSystem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FileSystemId: "fs-0498eed5fe91001ec", 
    Lifecycle: "DELETING"
   }
   */
 });

Calling the deleteFileSystem operation

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  WindowsConfiguration: {
    FinalBackupTags: [
      {
        Key: 'STRING_VALUE',
        Value: 'STRING_VALUE'
      },
      /* more items */
    ],
    SkipFinalBackup: true || false
  }
};
fsx.deleteFileSystem(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 you want to delete.

    • ClientRequestToken — (String)

      (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

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

      The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.

      • SkipFinalBackup — (Boolean)

        By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so.

      • FinalBackupTags — (Array<map>)

        A set of tags for your final backup.

        • Key — (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.

        • Value — (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:

      • FileSystemId — (String)

        The ID of the file system being deleted.

      • Lifecycle — (String)

        The file system lifecycle for the deletion request. Should be DELETING.

        Possible values include:
        • "AVAILABLE"
        • "CREATING"
        • "FAILED"
        • "DELETING"
      • WindowsResponse — (map)

        The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.

        • FinalBackupId — (String)

          The ID of the final backup for this file system.

        • FinalBackupTags — (Array<map>)

          The set of tags applied to the final backup.

          • Key — (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.

          • Value — (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.

Returns:

  • (AWS.Request) —

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

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

Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.

Service Reference:

Examples:

To describe Amazon FSx backups


/* This operation describes all of the Amazon FSx backups in an account. */

 var params = {
 };
 fsx.describeBackups(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Backups: [
       {
      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: "AVAILABLE", 
      ResourceARN: "arn:aws:fsx:us-east-1:012345678912:backup/backup-03e3c82e0183b7b6b", 
      Tags: [
         {
        Key: "Name", 
        Value: "MyBackup"
       }
      ], 
      Type: "USER_INITIATED"
     }
    ]
   }
   */
 });

Calling the describeBackups operation

var params = {
  BackupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Filters: [
    {
      Name: file-system-id | backup-type,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
fsx.describeBackups(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: {}) —
    • BackupIds — (Array<String>)

      (Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

    • Filters — (Array<map>)

      (Optional) Filters structure. Supported names are file-system-id and backup-type.

      • Name — (String)

        The name for this filter.

        Possible values include:
        • "file-system-id"
        • "backup-type"
      • Values — (Array<String>)

        The values of the filter. These are all the values for any of the applied filters.

    • MaxResults — (Integer)

      (Optional) Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

    • NextToken — (String)

      (Optional) Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

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:

      • Backups — (Array<map>)

        Any array of backups.

        • BackupId — required — (String)

          The ID of the backup.

        • Lifecycle — required — (String)

          The lifecycle status of the backup.

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

          Details explaining any failures that occur when creating a backup.

          • Message — (String)

            A message describing the backup creation failure.

        • Type — required — (String)

          The type of the backup.

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

          The current percent of progress of an asynchronous task.

        • CreationTime — required — (Date)

          The time when a particular backup was created.

        • KmsKeyId — (String)

          The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data.

        • ResourceARN — (String)

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

        • Tags — (Array<map>)

          Tags associated with a particular file system.

          • Key — (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.

          • Value — (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.

        • FileSystem — required — (map)

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

          • OwnerId — (String)

            The AWS account that created the file system. If the file system was created by an IAM user, the AWS 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 eight-digit ID of the file system that was automatically assigned by Amazon FSx.

          • FileSystemType — (String)

            Type of file system. Currently the only supported type is WINDOWS.

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

            The lifecycle status of the file system.

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

            Structure providing details of any failures that occur when creating the file system has failed.

            • Message — (String)

              Message describing the failures that occurred during file system creation.

          • StorageCapacity — (Integer)

            The storage capacity of the file system in gigabytes.

          • VpcId — (String)

            The ID of the primary VPC for the file system.

          • SubnetIds — (Array<String>)

            The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

          • NetworkInterfaceIds — (Array<String>)

            The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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 DNS name for the file system.

          • KmsKeyId — (String)

            The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

          • ResourceARN — (String)

            The resource ARN of the file system.

          • Tags — (Array<map>)

            The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

            • Key — (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.

            • Value — (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 Microsoft Active Directory instance that the file system should join when it's created.

            • ThroughputCapacity — (Integer)

              The throughput of an 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 time to perform weekly maintenance, in the UTC time zone.

            • 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 35 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.

          • LustreConfiguration — (map)

            The configuration for the Amazon FSx for Lustre file system.

            • WeeklyMaintenanceStartTime — (String)

              The UTC time that you want to begin your weekly maintenance window.

            • DataRepositoryConfiguration — (map)

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

              • 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.

      • NextToken — (String)

        This is present if there are more backups than returned in the response (String). You can use the NextToken value in the later request to fetch the backups.

Returns:

  • (AWS.Request) —

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

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

Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

Service Reference:

Examples:

To describe an Amazon FSx file system


/* This operation describes all of the Amazon FSx file systems in an account. */

 var params = {
 };
 fsx.describeFileSystems(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FileSystems: [
       {
      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: "AVAILABLE", 
      NetworkInterfaceIds: [
         "eni-abcd1234"
      ], 
      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 describeFileSystems operation

var params = {
  FileSystemIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
fsx.describeFileSystems(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: {}) —
    • FileSystemIds — (Array<String>)

      (Optional) IDs of the file systems whose descriptions you want to retrieve (String).

    • MaxResults — (Integer)

      (Optional) Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

    • NextToken — (String)

      (Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the action continues the list from where the returning call left off.

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:

      • FileSystems — (Array<map>)

        An array of file system descriptions.

        • OwnerId — (String)

          The AWS account that created the file system. If the file system was created by an IAM user, the AWS 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 eight-digit ID of the file system that was automatically assigned by Amazon FSx.

        • FileSystemType — (String)

          Type of file system. Currently the only supported type is WINDOWS.

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

          The lifecycle status of the file system.

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

          Structure providing details of any failures that occur when creating the file system has failed.

          • Message — (String)

            Message describing the failures that occurred during file system creation.

        • StorageCapacity — (Integer)

          The storage capacity of the file system in gigabytes.

        • VpcId — (String)

          The ID of the primary VPC for the file system.

        • SubnetIds — (Array<String>)

          The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

        • NetworkInterfaceIds — (Array<String>)

          The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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 DNS name for the file system.

        • KmsKeyId — (String)

          The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

        • ResourceARN — (String)

          The resource ARN of the file system.

        • Tags — (Array<map>)

          The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

          • Key — (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.

          • Value — (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 Microsoft Active Directory instance that the file system should join when it's created.

          • ThroughputCapacity — (Integer)

            The throughput of an 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 time to perform weekly maintenance, in the UTC time zone.

          • 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 35 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.

        • LustreConfiguration — (map)

          The configuration for the Amazon FSx for Lustre file system.

          • WeeklyMaintenanceStartTime — (String)

            The UTC time that you want to begin your weekly maintenance window.

          • DataRepositoryConfiguration — (map)

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

            • 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.

      • NextToken — (String)

        Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions.

Returns:

  • (AWS.Request) —

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

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

Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.

When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.

Service Reference:

Examples:

To list tags for a resource


/* This operation lists tags for an Amazon FSx resource. */

 var params = {
  ResourceARN: "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec"
 };
 fsx.listTagsForResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Tags: [
       {
      Key: "Name", 
      Value: "MyFileSystem"
     }
    ]
   }
   */
 });

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
fsx.listTagsForResource(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: {}) —
    • ResourceARN — (String)

      The ARN of the Amazon FSx resource that will have its tags listed.

    • MaxResults — (Integer)

      (Optional) Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

    • NextToken — (String)

      (Optional) Opaque pagination token returned from a previous ListTagsForResource operation (String). If a token present, the action continues the list from where the returning call left off.

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:

      • Tags — (Array<map>)

        A list of tags on the resource.

        • Key — (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.

        • Value — (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.

      • NextToken — (String)

        This is present if there are more tags than returned in the response (String). You can use the NextToken value in the later request to fetch the tags.

Returns:

  • (AWS.Request) —

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

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

Tags an Amazon FSx resource.

Service Reference:

Examples:

To tag a resource


/* This operation tags an Amazon FSx resource. */

 var params = {
  ResourceARN: "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", 
  Tags: [
     {
    Key: "Name", 
    Value: "MyFileSystem"
   }
  ]
 };
 fsx.tagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
fsx.tagResource(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: {}) —
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.

    • Tags — (Array<map>)

      A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one specified in this parameter.

      • Key — (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.

      • Value — (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.

Returns:

  • (AWS.Request) —

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

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

This action removes a tag from an Amazon FSx resource.

Service Reference:

Examples:

To untag a resource


/* This operation untags an Amazon FSx resource. */

 var params = {
  ResourceARN: "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0498eed5fe91001ec", 
  TagKeys: [
     "Name"
  ]
 };
 fsx.untagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
fsx.untagResource(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: {}) —
    • ResourceARN — (String)

      The ARN of the Amazon FSx resource to untag.

    • TagKeys — (Array<String>)

      A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent.

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.

Returns:

  • (AWS.Request) —

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

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

Updates a file system configuration.

Service Reference:

Examples:

To update an existing file system


/* This operation updates an existing file system. */

 var params = {
  FileSystemId: "fs-0498eed5fe91001ec", 
  WindowsConfiguration: {
   AutomaticBackupRetentionDays: 10, 
   DailyAutomaticBackupStartTime: "06:00", 
   WeeklyMaintenanceStartTime: "3:06:00"
  }
 };
 fsx.updateFileSystem(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: "AVAILABLE", 
     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: {
      AutomaticBackupRetentionDays: 10, 
      DailyAutomaticBackupStartTime: "06:00", 
      ThroughputCapacity: 8, 
      WeeklyMaintenanceStartTime: "3:06:00"
     }
    }
   }
   */
 });

Calling the updateFileSystem operation

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  LustreConfiguration: {
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  },
  WindowsConfiguration: {
    AutomaticBackupRetentionDays: 'NUMBER_VALUE',
    DailyAutomaticBackupStartTime: 'STRING_VALUE',
    WeeklyMaintenanceStartTime: 'STRING_VALUE'
  }
};
fsx.updateFileSystem(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.

    • ClientRequestToken — (String)

      (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

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

      The configuration for this Microsoft Windows file system. The only supported options are for backup and maintenance.

      • WeeklyMaintenanceStartTime — (String)

        The preferred time to perform weekly maintenance, in the UTC time zone.

      • 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 35 days.

    • LustreConfiguration — (map)

      The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

      • WeeklyMaintenanceStartTime — (String)

        The preferred time to perform weekly maintenance, in the UTC time zone.

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 AWS account that created the file system. If the file system was created by an IAM user, the AWS 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 eight-digit ID of the file system that was automatically assigned by Amazon FSx.

        • FileSystemType — (String)

          Type of file system. Currently the only supported type is WINDOWS.

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

          The lifecycle status of the file system.

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

          Structure providing details of any failures that occur when creating the file system has failed.

          • Message — (String)

            Message describing the failures that occurred during file system creation.

        • StorageCapacity — (Integer)

          The storage capacity of the file system in gigabytes.

        • VpcId — (String)

          The ID of the primary VPC for the file system.

        • SubnetIds — (Array<String>)

          The IDs of the subnets to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

        • NetworkInterfaceIds — (Array<String>)

          The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same 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 DNS name for the file system.

        • KmsKeyId — (String)

          The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

        • ResourceARN — (String)

          The resource ARN of the file system.

        • Tags — (Array<map>)

          The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

          • Key — (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.

          • Value — (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 Microsoft Active Directory instance that the file system should join when it's created.

          • ThroughputCapacity — (Integer)

            The throughput of an 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 time to perform weekly maintenance, in the UTC time zone.

          • 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 35 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.

        • LustreConfiguration — (map)

          The configuration for the Amazon FSx for Lustre file system.

          • WeeklyMaintenanceStartTime — (String)

            The UTC time that you want to begin your weekly maintenance window.

          • DataRepositoryConfiguration — (map)

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

            • 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.

Returns:

  • (AWS.Request) —

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