Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/fsx.ts?docs=full";

§Classes

FSx

§Interfaces

ActiveDirectoryBackupAttributes

The Microsoft Active Directory attributes of the Amazon FSx for Windows File Server file system.

AdministrativeAction

Describes a specific Amazon FSx administrative action for the current Windows, Lustre, or OpenZFS file system.

AdministrativeActionFailureDetails

Provides information about a failed administrative action.

Alias

A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide.

AssociateFileSystemAliasesRequest

The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.

AssociateFileSystemAliasesResponse

The system generated response showing the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system. It can take up to 2.5 minutes for the alias status to change from CREATING to AVAILABLE.

AutoExportPolicy

Describes a data repository association's automatic export policy. The AutoExportPolicy defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.

AutoImportPolicy

Describes the data repository association's automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.

Backup

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

BackupFailureDetails

If backup creation fails, this structure contains the details of that failure.

CancelDataRepositoryTaskRequest

Cancels a data repository task.

CancelDataRepositoryTaskResponse
CompletionReport

Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report Scope parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the report Path parameter. You can specify whether or not a report gets generated for a task using the Enabled parameter.

CopyBackupRequest
CopyBackupResponse
CreateBackupRequest

The request object for the CreateBackup operation.

CreateBackupResponse

The response object for the CreateBackup operation.

CreateDataRepositoryAssociationRequest
CreateDataRepositoryAssociationResponse
CreateDataRepositoryTaskRequest
CreateDataRepositoryTaskResponse
CreateFileCacheLustreConfiguration

The Amazon File Cache configuration for the cache that you are creating.

CreateFileCacheRequest
CreateFileCacheResponse
CreateFileSystemFromBackupRequest

The request object for the CreateFileSystemFromBackup operation.

CreateFileSystemFromBackupResponse

The response object for the CreateFileSystemFromBackup operation.

CreateFileSystemLustreConfiguration

The Lustre configuration for the file system being created.

CreateFileSystemOntapConfiguration

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

CreateFileSystemOpenZFSConfiguration

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

CreateFileSystemRequest

The request object used to create a new Amazon FSx file system.

CreateFileSystemResponse

The response object returned after the file system is created.

CreateFileSystemWindowsConfiguration

The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.

CreateOntapVolumeConfiguration

Specifies the configuration of the ONTAP volume that you are creating.

CreateOpenZFSOriginSnapshotConfiguration

The snapshot configuration to use when creating an OpenZFS volume from a snapshot.

CreateOpenZFSVolumeConfiguration

Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

CreateSnapshotRequest
CreateSnapshotResponse
CreateStorageVirtualMachineRequest
CreateStorageVirtualMachineResponse
CreateSvmActiveDirectoryConfiguration

The configuration that Amazon FSx uses to join the ONTAP storage virtual machine (SVM) to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.

CreateVolumeFromBackupRequest
CreateVolumeFromBackupResponse
CreateVolumeRequest
CreateVolumeResponse
DataRepositoryAssociation

The configuration of a data repository association that links an Amazon FSx for Lustre file system to an Amazon S3 bucket or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system. The data repository association configuration object is returned in the response of the following operations:

DataRepositoryConfiguration

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

DataRepositoryFailureDetails

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

DataRepositoryTask

A description of the data repository task. You use data repository tasks to perform bulk transfer operations between an Amazon FSx for Lustre file system and a linked data repository. An Amazon File Cache resource uses a task to automatically release files from the cache.

DataRepositoryTaskFailureDetails

Provides information about why a data repository task failed. Only populated when the task Lifecycle is set to FAILED.

DataRepositoryTaskFilter

(Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter Name, and one or more Values for the filter.

DataRepositoryTaskStatus

Provides the task status showing a running total of the total number of files to be processed, the number successfully processed, and the number of files the task failed to process.

DeleteBackupRequest

The request object for the DeleteBackup operation.

DeleteBackupResponse

The response object for the DeleteBackup operation.

DeleteDataRepositoryAssociationRequest
DeleteDataRepositoryAssociationResponse
DeleteFileCacheRequest
DeleteFileCacheResponse
DeleteFileSystemLustreConfiguration

The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

DeleteFileSystemLustreResponse

The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

DeleteFileSystemOpenZFSConfiguration

The configuration object for the Amazon FSx for OpenZFS file system used in the DeleteFileSystem operation.

DeleteFileSystemOpenZFSResponse

The response object for the Amazon FSx for OpenZFS file system that's being deleted in the DeleteFileSystem operation.

DeleteFileSystemRequest

The request object for DeleteFileSystem operation.

DeleteFileSystemResponse

The response object for the DeleteFileSystem operation.

DeleteFileSystemWindowsConfiguration

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

DeleteFileSystemWindowsResponse

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

DeleteSnapshotRequest
DeleteSnapshotResponse
DeleteStorageVirtualMachineRequest
DeleteStorageVirtualMachineResponse
DeleteVolumeOntapConfiguration

Use to specify skipping a final backup, or to add tags to a final backup.

DeleteVolumeOntapResponse

The response object for the Amazon FSx for NetApp ONTAP volume being deleted in the DeleteVolume operation.

DeleteVolumeOpenZFSConfiguration

A value that specifies whether to delete all child volumes and snapshots.

DeleteVolumeRequest
DeleteVolumeResponse
DescribeBackupsRequest

The request object for the DescribeBackups operation.

DescribeBackupsResponse

Response object for the DescribeBackups operation.

DescribeDataRepositoryAssociationsRequest
DescribeDataRepositoryAssociationsResponse
DescribeDataRepositoryTasksRequest
DescribeDataRepositoryTasksResponse
DescribeFileCachesRequest
DescribeFileCachesResponse
DescribeFileSystemAliasesRequest

The request object for DescribeFileSystemAliases operation.

DescribeFileSystemAliasesResponse

The response object for DescribeFileSystemAliases operation.

DescribeFileSystemsRequest

The request object for DescribeFileSystems operation.

DescribeFileSystemsResponse

The response object for DescribeFileSystems operation.

DescribeSnapshotsRequest
DescribeSnapshotsResponse
DescribeStorageVirtualMachinesRequest
DescribeStorageVirtualMachinesResponse
DescribeVolumesRequest
DescribeVolumesResponse
DisassociateFileSystemAliasesRequest

The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.

DisassociateFileSystemAliasesResponse

The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.

DiskIopsConfiguration

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).

FileCache

A description of a specific Amazon File Cache resource, which is a response object from the DescribeFileCaches operation.

FileCacheCreating

The response object for the Amazon File Cache resource being created in the CreateFileCache operation.

FileCacheDataRepositoryAssociation

The configuration for a data repository association (DRA) to be created during the Amazon File Cache resource creation. The DRA links the cache to either an Amazon S3 bucket or prefix, or a Network File System (NFS) data repository that supports the NFSv3 protocol.

FileCacheFailureDetails

A structure providing details of any failures that occurred.

FileCacheLustreConfiguration

The configuration for the Amazon File Cache resource.

FileCacheLustreMetadataConfiguration

The configuration for a Lustre MDT (Metadata Target) storage volume. The metadata on Amazon File Cache is managed by a Lustre Metadata Server (MDS) while the actual metadata is persisted on an MDT.

FileCacheNFSConfiguration

The configuration for an NFS data repository association (DRA) created during the creation of the Amazon File Cache resource.

FileSystem

A description of a specific Amazon FSx file system.

FileSystemEndpoint

An Amazon FSx for NetApp ONTAP file system has two endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. They are the Management and Intercluster endpoints.

FileSystemEndpoints

An Amazon FSx for NetApp ONTAP file system has the following endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

FileSystemFailureDetails

A structure providing details of any failures that occurred.

Filter

A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.

LifecycleTransitionReason

Describes why a resource lifecycle state changed.

ListTagsForResourceRequest

The request object for ListTagsForResource operation.

ListTagsForResourceResponse

The response object for ListTagsForResource operation.

LustreFileSystemConfiguration

The configuration for the Amazon FSx for Lustre file system.

LustreLogConfiguration

The configuration for Lustre logging used to write the enabled logging events for your Amazon FSx for Lustre file system or Amazon File Cache resource to Amazon CloudWatch Logs.

LustreLogCreateConfiguration

The Lustre logging configuration used when creating or updating an Amazon FSx for Lustre file system. An Amazon File Cache is created with Lustre logging enabled by default, with a setting of WARN_ERROR for the logging events. which can't be changed.

LustreRootSquashConfiguration

The configuration for Lustre root squash used to restrict root-level access from clients that try to access your FSx for Lustre file system as root. Use the RootSquash parameter to enable root squash. To learn more about Lustre root squash, see Lustre root squash.

NFSDataRepositoryConfiguration

The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

OntapFileSystemConfiguration

Configuration for the FSx for NetApp ONTAP file system.

OntapVolumeConfiguration

The configuration of an Amazon FSx for NetApp ONTAP volume.

OpenZFSClientConfiguration

Specifies who can mount an OpenZFS file system and the options available while mounting the file system.

OpenZFSCreateRootVolumeConfiguration

The configuration of an Amazon FSx for OpenZFS root volume.

OpenZFSFileSystemConfiguration

The configuration for the Amazon FSx for OpenZFS file system.

OpenZFSNfsExport

The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system.

OpenZFSOriginSnapshotConfiguration

The snapshot configuration to use when creating an OpenZFS volume from a snapshot.

OpenZFSUserOrGroupQuota

The configuration for how much storage a user or group can use on the volume.

OpenZFSVolumeConfiguration

The configuration of an Amazon FSx for OpenZFS volume.

ReleaseFileSystemNfsV3LocksRequest
ReleaseFileSystemNfsV3LocksResponse
RestoreVolumeFromSnapshotRequest
RestoreVolumeFromSnapshotResponse
S3DataRepositoryConfiguration

The configuration for an Amazon S3 data repository linked to an Amazon FSx for Lustre file system with a data repository association. The configuration consists of an AutoImportPolicy that defines which file events on the data repository are automatically imported to the file system and an AutoExportPolicy that defines which file events on the file system are automatically exported to the data repository. File events are when files or directories are added, changed, or deleted on the file system or the data repository.

SelfManagedActiveDirectoryAttributes

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

SelfManagedActiveDirectoryConfiguration

The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx with your self-managed Microsoft Active Directory or Managing SVMs.

SelfManagedActiveDirectoryConfigurationUpdates

The configuration that Amazon FSx uses to join the Windows File Server instance to a self-managed Microsoft Active Directory (AD) directory.

Snapshot

A snapshot of an Amazon FSx for OpenZFS volume.

SnapshotFilter

A filter used to restrict the results of DescribeSnapshots calls. You can use multiple filters to return results that meet all applied filter requirements.

StorageVirtualMachine

Describes the Amazon FSx for NetApp ONTAP storage virtual machine (SVM) configuration.

StorageVirtualMachineFilter

A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP storage virtual machines (SVMs). You can use multiple filters to return results that meet all applied filter requirements.

SvmActiveDirectoryConfiguration

Describes the configuration of the Microsoft Active Directory (AD) directory to which the Amazon FSx for ONTAP storage virtual machine (SVM) is joined. Pleae note, account credentials are not returned in the response payload.

SvmEndpoint

An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the Iscsi, Management, Nfs, and Smb endpoints.

SvmEndpoints

An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has the following endpoints that are used to access data or to manage the SVM using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.

Tag

Specifies a key-value pair for a resource tag.

TagResourceRequest

The request object for the TagResource operation.

TieringPolicy

Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

UntagResourceRequest

The request object for UntagResource action.

UpdateDataRepositoryAssociationRequest
UpdateDataRepositoryAssociationResponse
UpdateFileCacheLustreConfiguration

The configuration update for an Amazon File Cache resource.

UpdateFileCacheRequest
UpdateFileCacheResponse
UpdateFileSystemLustreConfiguration

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

UpdateFileSystemOntapConfiguration

The configuration updates for an Amazon FSx for NetApp ONTAP file system.

UpdateFileSystemOpenZFSConfiguration

The configuration updates for an Amazon FSx for OpenZFS file system.

UpdateFileSystemRequest

The request object for the UpdateFileSystem operation.

UpdateFileSystemResponse

The response object for the UpdateFileSystem operation.

UpdateFileSystemWindowsConfiguration

Updates the configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx only overwrites existing properties with non-null values provided in the request.

UpdateOntapVolumeConfiguration

Used to specify changes to the ONTAP configuration for the volume you are updating.

UpdateOpenZFSVolumeConfiguration

Used to specify changes to the OpenZFS configuration for the volume that you are updating.

UpdateSnapshotRequest
UpdateSnapshotResponse
UpdateStorageVirtualMachineRequest
UpdateStorageVirtualMachineResponse
UpdateSvmActiveDirectoryConfiguration

Updates the Microsoft Active Directory (AD) configuration of an SVM joined to an AD. Please note, account credentials are not returned in the response payload.

UpdateVolumeRequest
UpdateVolumeResponse
Volume

Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.

VolumeFilter

A filter used to restrict the results of describe calls for Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes. You can use multiple filters to return results that meet all applied filter requirements.

WindowsAuditLogConfiguration

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

WindowsAuditLogCreateConfiguration

The Windows file access auditing configuration used when creating or updating an Amazon FSx for Windows File Server file system.

WindowsFileSystemConfiguration

The configuration for this Microsoft Windows file system.

§Type Aliases

AdministrativeActionType

Describes the type of administrative action, as follows:

AliasLifecycle
AutoImportPolicyType
BackupLifecycle

The lifecycle status of the backup.

BackupType

The type of the backup.

DataCompressionType
DataRepositoryLifecycle
DataRepositoryTaskFilterName
DataRepositoryTaskLifecycle
DataRepositoryTaskType
DeleteFileSystemOpenZFSOption
DeleteOpenZFSVolumeOption
DiskIopsConfigurationMode
DriveCacheType
EventType
FileCacheLifecycle
FileCacheLustreDeploymentType
FileCacheType
FileSystemLifecycle

The lifecycle status of the file system.

FileSystemMaintenanceOperation

An enumeration specifying the currently ongoing maintenance operation.

FileSystemType

The type of file system.

FilterName

The name for a filter.

FlexCacheEndpointType
InputOntapVolumeType
LustreAccessAuditLogLevel
LustreDeploymentType
NfsVersion
OntapDeploymentType
OntapVolumeType
OpenZFSCopyStrategy
OpenZFSDataCompressionType
OpenZFSDeploymentType
OpenZFSQuotaType
ReportFormat
ReportScope
ResourceType
RestoreOpenZFSVolumeOption
SecurityStyle
SnapshotFilterName
SnapshotLifecycle
Status
StorageType

The storage type for your Amazon FSx file system.

StorageVirtualMachineFilterName
StorageVirtualMachineLifecycle
StorageVirtualMachineRootVolumeSecurityStyle
StorageVirtualMachineSubtype
TieringPolicyName
VolumeFilterName
VolumeLifecycle
VolumeType
WindowsAccessAuditLogLevel
WindowsDeploymentType