import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateFileSystemFromBackupRequest, CreateFileSystemFromBackupResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateFileSystemFromBackupCommand}. */ export interface CreateFileSystemFromBackupCommandInput extends CreateFileSystemFromBackupRequest { } /** * @public * * The output of {@link CreateFileSystemFromBackupCommand}. */ export interface CreateFileSystemFromBackupCommandOutput extends CreateFileSystemFromBackupResponse, __MetadataBearer { } declare const CreateFileSystemFromBackupCommand_base: { new (input: CreateFileSystemFromBackupCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateFileSystemFromBackupCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File * Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.

*

If a file system with the specified client request token exists and the parameters * match, this operation returns the description of the file system. If a file system * with the specified client request token exists but the parameters don't match, this * call returns IncompatibleParameterError. If a file system with the * specified client request token doesn't exist, this operation does the following:

* *

Parameters like the Active Directory, default share name, automatic backup, and backup * settings default to the parameters of the file system that was backed up, unless * overridden. You can explicitly supply other settings.

*

By using the idempotent operation, you can retry a * CreateFileSystemFromBackup call without the risk of creating an extra * file system. This approach can be useful when an initial call fails in a way that makes * it unclear whether a file system was created. Examples are if a transport level timeout * occurred, or your connection was reset. If you use the same client request token and the * initial call created a file system, the client receives a success message as long as the * parameters are the same.

* *

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.

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { FSxClient, CreateFileSystemFromBackupCommand } from "@aws-sdk/client-fsx"; // ES Modules import * // const { FSxClient, CreateFileSystemFromBackupCommand } = require("@aws-sdk/client-fsx"); // CommonJS import * // import type { FSxClientConfig } from "@aws-sdk/client-fsx"; * const config = {}; // type is FSxClientConfig * const client = new FSxClient(config); * const input = { // CreateFileSystemFromBackupRequest * BackupId: "STRING_VALUE", // required * ClientRequestToken: "STRING_VALUE", * SubnetIds: [ // SubnetIds // required * "STRING_VALUE", * ], * SecurityGroupIds: [ // SecurityGroupIds * "STRING_VALUE", * ], * Tags: [ // Tags * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * WindowsConfiguration: { // CreateFileSystemWindowsConfiguration * ActiveDirectoryId: "STRING_VALUE", * SelfManagedActiveDirectoryConfiguration: { // SelfManagedActiveDirectoryConfiguration * DomainName: "STRING_VALUE", // required * OrganizationalUnitDistinguishedName: "STRING_VALUE", * FileSystemAdministratorsGroup: "STRING_VALUE", * UserName: "STRING_VALUE", * Password: "STRING_VALUE", * DnsIps: [ // DnsIps // required * "STRING_VALUE", * ], * DomainJoinServiceAccountSecret: "STRING_VALUE", * }, * DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2", * PreferredSubnetId: "STRING_VALUE", * ThroughputCapacity: Number("int"), // required * WeeklyMaintenanceStartTime: "STRING_VALUE", * DailyAutomaticBackupStartTime: "STRING_VALUE", * AutomaticBackupRetentionDays: Number("int"), * CopyTagsToBackups: true || false, * Aliases: [ // AlternateDNSNames * "STRING_VALUE", * ], * AuditLogConfiguration: { // WindowsAuditLogCreateConfiguration * FileAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * AuditLogDestination: "STRING_VALUE", * }, * DiskIopsConfiguration: { // DiskIopsConfiguration * Mode: "AUTOMATIC" || "USER_PROVISIONED", * Iops: Number("long"), * }, * FsrmConfiguration: { // WindowsFsrmConfiguration * FsrmServiceEnabled: true || false, // required * EventLogDestination: "STRING_VALUE", * }, * }, * LustreConfiguration: { // CreateFileSystemLustreConfiguration * WeeklyMaintenanceStartTime: "STRING_VALUE", * ImportPath: "STRING_VALUE", * ExportPath: "STRING_VALUE", * ImportedFileChunkSize: Number("int"), * DeploymentType: "SCRATCH_1" || "SCRATCH_2" || "PERSISTENT_1" || "PERSISTENT_2", * AutoImportPolicy: "NONE" || "NEW" || "NEW_CHANGED" || "NEW_CHANGED_DELETED", * PerUnitStorageThroughput: Number("int"), * DailyAutomaticBackupStartTime: "STRING_VALUE", * AutomaticBackupRetentionDays: Number("int"), * CopyTagsToBackups: true || false, * DriveCacheType: "NONE" || "READ", * DataCompressionType: "NONE" || "LZ4", * EfaEnabled: true || false, * LogConfiguration: { // LustreLogCreateConfiguration * Level: "DISABLED" || "WARN_ONLY" || "ERROR_ONLY" || "WARN_ERROR", // required * Destination: "STRING_VALUE", * }, * RootSquashConfiguration: { // LustreRootSquashConfiguration * RootSquash: "STRING_VALUE", * NoSquashNids: [ // LustreNoSquashNids * "STRING_VALUE", * ], * }, * MetadataConfiguration: { // CreateFileSystemLustreMetadataConfiguration * Iops: Number("int"), * Mode: "AUTOMATIC" || "USER_PROVISIONED", // required * }, * ThroughputCapacity: Number("int"), * DataReadCacheConfiguration: { // LustreReadCacheConfiguration * SizingMode: "NO_CACHE" || "USER_PROVISIONED" || "PROPORTIONAL_TO_THROUGHPUT_CAPACITY", * SizeGiB: Number("int"), * }, * }, * StorageType: "SSD" || "HDD" || "INTELLIGENT_TIERING", * KmsKeyId: "STRING_VALUE", * FileSystemTypeVersion: "STRING_VALUE", * OpenZFSConfiguration: { // CreateFileSystemOpenZFSConfiguration * AutomaticBackupRetentionDays: Number("int"), * CopyTagsToBackups: true || false, * CopyTagsToVolumes: true || false, * DailyAutomaticBackupStartTime: "STRING_VALUE", * DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "SINGLE_AZ_HA_1" || "SINGLE_AZ_HA_2" || "MULTI_AZ_1", // required * ThroughputCapacity: Number("int"), // required * WeeklyMaintenanceStartTime: "STRING_VALUE", * DiskIopsConfiguration: { * Mode: "AUTOMATIC" || "USER_PROVISIONED", * Iops: Number("long"), * }, * RootVolumeConfiguration: { // OpenZFSCreateRootVolumeConfiguration * RecordSizeKiB: Number("int"), * DataCompressionType: "NONE" || "ZSTD" || "LZ4", * NfsExports: [ // OpenZFSNfsExports * { // OpenZFSNfsExport * ClientConfigurations: [ // OpenZFSClientConfigurations // required * { // OpenZFSClientConfiguration * Clients: "STRING_VALUE", // required * Options: [ // OpenZFSNfsExportOptions // required * "STRING_VALUE", * ], * }, * ], * }, * ], * UserAndGroupQuotas: [ // OpenZFSUserAndGroupQuotas * { // OpenZFSUserOrGroupQuota * Type: "USER" || "GROUP", // required * Id: Number("int"), // required * StorageCapacityQuotaGiB: Number("int"), // required * }, * ], * CopyTagsToSnapshots: true || false, * ReadOnly: true || false, * }, * PreferredSubnetId: "STRING_VALUE", * EndpointIpAddressRange: "STRING_VALUE", * EndpointIpv6AddressRange: "STRING_VALUE", * RouteTableIds: [ // RouteTableIds * "STRING_VALUE", * ], * ReadCacheConfiguration: { // OpenZFSReadCacheConfiguration * SizingMode: "NO_CACHE" || "USER_PROVISIONED" || "PROPORTIONAL_TO_THROUGHPUT_CAPACITY", * SizeGiB: Number("int"), * }, * }, * StorageCapacity: Number("int"), * NetworkType: "IPV4" || "DUAL", * }; * const command = new CreateFileSystemFromBackupCommand(input); * const response = await client.send(command); * // { // CreateFileSystemFromBackupResponse * // FileSystem: { // FileSystem * // OwnerId: "STRING_VALUE", * // CreationTime: new Date("TIMESTAMP"), * // FileSystemId: "STRING_VALUE", * // FileSystemType: "WINDOWS" || "LUSTRE" || "ONTAP" || "OPENZFS", * // Lifecycle: "AVAILABLE" || "CREATING" || "FAILED" || "DELETING" || "MISCONFIGURED" || "UPDATING" || "MISCONFIGURED_UNAVAILABLE", * // FailureDetails: { // FileSystemFailureDetails * // Message: "STRING_VALUE", * // }, * // StorageCapacity: Number("int"), * // StorageType: "SSD" || "HDD" || "INTELLIGENT_TIERING", * // VpcId: "STRING_VALUE", * // SubnetIds: [ // SubnetIds * // "STRING_VALUE", * // ], * // NetworkInterfaceIds: [ // NetworkInterfaceIds * // "STRING_VALUE", * // ], * // DNSName: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // ResourceARN: "STRING_VALUE", * // Tags: [ // Tags * // { // Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // WindowsConfiguration: { // WindowsFileSystemConfiguration * // ActiveDirectoryId: "STRING_VALUE", * // SelfManagedActiveDirectoryConfiguration: { // SelfManagedActiveDirectoryAttributes * // DomainName: "STRING_VALUE", * // OrganizationalUnitDistinguishedName: "STRING_VALUE", * // FileSystemAdministratorsGroup: "STRING_VALUE", * // UserName: "STRING_VALUE", * // DnsIps: [ // DnsIps * // "STRING_VALUE", * // ], * // DomainJoinServiceAccountSecret: "STRING_VALUE", * // }, * // DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2", * // RemoteAdministrationEndpoint: "STRING_VALUE", * // PreferredSubnetId: "STRING_VALUE", * // PreferredFileServerIp: "STRING_VALUE", * // ThroughputCapacity: Number("int"), * // MaintenanceOperationsInProgress: [ // FileSystemMaintenanceOperations * // "PATCHING" || "BACKING_UP", * // ], * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // DailyAutomaticBackupStartTime: "STRING_VALUE", * // AutomaticBackupRetentionDays: Number("int"), * // CopyTagsToBackups: true || false, * // Aliases: [ // Aliases * // { // Alias * // Name: "STRING_VALUE", * // Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED", * // }, * // ], * // AuditLogConfiguration: { // WindowsAuditLogConfiguration * // FileAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * // FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * // AuditLogDestination: "STRING_VALUE", * // }, * // DiskIopsConfiguration: { // DiskIopsConfiguration * // Mode: "AUTOMATIC" || "USER_PROVISIONED", * // Iops: Number("long"), * // }, * // PreferredFileServerIpv6: "STRING_VALUE", * // FsrmConfiguration: { // WindowsFsrmConfiguration * // FsrmServiceEnabled: true || false, // required * // EventLogDestination: "STRING_VALUE", * // }, * // }, * // LustreConfiguration: { // LustreFileSystemConfiguration * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // DataRepositoryConfiguration: { // DataRepositoryConfiguration * // Lifecycle: "CREATING" || "AVAILABLE" || "MISCONFIGURED" || "UPDATING" || "DELETING" || "FAILED", * // ImportPath: "STRING_VALUE", * // ExportPath: "STRING_VALUE", * // ImportedFileChunkSize: Number("int"), * // AutoImportPolicy: "NONE" || "NEW" || "NEW_CHANGED" || "NEW_CHANGED_DELETED", * // FailureDetails: { // DataRepositoryFailureDetails * // Message: "STRING_VALUE", * // }, * // }, * // DeploymentType: "SCRATCH_1" || "SCRATCH_2" || "PERSISTENT_1" || "PERSISTENT_2", * // PerUnitStorageThroughput: Number("int"), * // MountName: "STRING_VALUE", * // DailyAutomaticBackupStartTime: "STRING_VALUE", * // AutomaticBackupRetentionDays: Number("int"), * // CopyTagsToBackups: true || false, * // DriveCacheType: "NONE" || "READ", * // DataCompressionType: "NONE" || "LZ4", * // LogConfiguration: { // LustreLogConfiguration * // Level: "DISABLED" || "WARN_ONLY" || "ERROR_ONLY" || "WARN_ERROR", // required * // Destination: "STRING_VALUE", * // }, * // RootSquashConfiguration: { // LustreRootSquashConfiguration * // RootSquash: "STRING_VALUE", * // NoSquashNids: [ // LustreNoSquashNids * // "STRING_VALUE", * // ], * // }, * // MetadataConfiguration: { // FileSystemLustreMetadataConfiguration * // Iops: Number("int"), * // Mode: "AUTOMATIC" || "USER_PROVISIONED", // required * // }, * // EfaEnabled: true || false, * // ThroughputCapacity: Number("int"), * // DataReadCacheConfiguration: { // LustreReadCacheConfiguration * // SizingMode: "NO_CACHE" || "USER_PROVISIONED" || "PROPORTIONAL_TO_THROUGHPUT_CAPACITY", * // SizeGiB: Number("int"), * // }, * // }, * // AdministrativeActions: [ // AdministrativeActions * // { // AdministrativeAction * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION" || "MISCONFIGURED_STATE_RECOVERY" || "VOLUME_UPDATE_WITH_SNAPSHOT" || "VOLUME_INITIALIZE_WITH_SNAPSHOT" || "DOWNLOAD_DATA_FROM_BACKUP", * // ProgressPercent: Number("int"), * // RequestTime: new Date("TIMESTAMP"), * // Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING" || "OPTIMIZING" || "PAUSED" || "CANCELLED", * // TargetFileSystemValues: { * // OwnerId: "STRING_VALUE", * // CreationTime: new Date("TIMESTAMP"), * // FileSystemId: "STRING_VALUE", * // FileSystemType: "WINDOWS" || "LUSTRE" || "ONTAP" || "OPENZFS", * // Lifecycle: "AVAILABLE" || "CREATING" || "FAILED" || "DELETING" || "MISCONFIGURED" || "UPDATING" || "MISCONFIGURED_UNAVAILABLE", * // FailureDetails: { * // Message: "STRING_VALUE", * // }, * // StorageCapacity: Number("int"), * // StorageType: "SSD" || "HDD" || "INTELLIGENT_TIERING", * // VpcId: "STRING_VALUE", * // SubnetIds: [ * // "STRING_VALUE", * // ], * // NetworkInterfaceIds: [ * // "STRING_VALUE", * // ], * // DNSName: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // ResourceARN: "STRING_VALUE", * // Tags: [ * // { * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // WindowsConfiguration: { * // ActiveDirectoryId: "STRING_VALUE", * // SelfManagedActiveDirectoryConfiguration: { * // DomainName: "STRING_VALUE", * // OrganizationalUnitDistinguishedName: "STRING_VALUE", * // FileSystemAdministratorsGroup: "STRING_VALUE", * // UserName: "STRING_VALUE", * // DnsIps: [ * // "STRING_VALUE", * // ], * // DomainJoinServiceAccountSecret: "STRING_VALUE", * // }, * // DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2", * // RemoteAdministrationEndpoint: "STRING_VALUE", * // PreferredSubnetId: "STRING_VALUE", * // PreferredFileServerIp: "STRING_VALUE", * // ThroughputCapacity: Number("int"), * // MaintenanceOperationsInProgress: [ * // "PATCHING" || "BACKING_UP", * // ], * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // DailyAutomaticBackupStartTime: "STRING_VALUE", * // AutomaticBackupRetentionDays: Number("int"), * // CopyTagsToBackups: true || false, * // Aliases: [ * // { * // Name: "STRING_VALUE", * // Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "CREATE_FAILED" || "DELETE_FAILED", * // }, * // ], * // AuditLogConfiguration: { * // FileAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * // FileShareAccessAuditLogLevel: "DISABLED" || "SUCCESS_ONLY" || "FAILURE_ONLY" || "SUCCESS_AND_FAILURE", // required * // AuditLogDestination: "STRING_VALUE", * // }, * // DiskIopsConfiguration: { * // Mode: "AUTOMATIC" || "USER_PROVISIONED", * // Iops: Number("long"), * // }, * // PreferredFileServerIpv6: "STRING_VALUE", * // FsrmConfiguration: { * // FsrmServiceEnabled: true || false, // required * // EventLogDestination: "STRING_VALUE", * // }, * // }, * // LustreConfiguration: { * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // DataRepositoryConfiguration: { * // Lifecycle: "CREATING" || "AVAILABLE" || "MISCONFIGURED" || "UPDATING" || "DELETING" || "FAILED", * // ImportPath: "STRING_VALUE", * // ExportPath: "STRING_VALUE", * // ImportedFileChunkSize: Number("int"), * // AutoImportPolicy: "NONE" || "NEW" || "NEW_CHANGED" || "NEW_CHANGED_DELETED", * // FailureDetails: { * // Message: "STRING_VALUE", * // }, * // }, * // DeploymentType: "SCRATCH_1" || "SCRATCH_2" || "PERSISTENT_1" || "PERSISTENT_2", * // PerUnitStorageThroughput: Number("int"), * // MountName: "STRING_VALUE", * // DailyAutomaticBackupStartTime: "STRING_VALUE", * // AutomaticBackupRetentionDays: Number("int"), * // CopyTagsToBackups: true || false, * // DriveCacheType: "NONE" || "READ", * // DataCompressionType: "NONE" || "LZ4", * // LogConfiguration: { * // Level: "DISABLED" || "WARN_ONLY" || "ERROR_ONLY" || "WARN_ERROR", // required * // Destination: "STRING_VALUE", * // }, * // RootSquashConfiguration: { * // RootSquash: "STRING_VALUE", * // NoSquashNids: [ * // "STRING_VALUE", * // ], * // }, * // MetadataConfiguration: { * // Iops: Number("int"), * // Mode: "AUTOMATIC" || "USER_PROVISIONED", // required * // }, * // EfaEnabled: true || false, * // ThroughputCapacity: Number("int"), * // DataReadCacheConfiguration: { * // SizingMode: "NO_CACHE" || "USER_PROVISIONED" || "PROPORTIONAL_TO_THROUGHPUT_CAPACITY", * // SizeGiB: Number("int"), * // }, * // }, * // AdministrativeActions: [ * // { * // AdministrativeActionType: "FILE_SYSTEM_UPDATE" || "STORAGE_OPTIMIZATION" || "FILE_SYSTEM_ALIAS_ASSOCIATION" || "FILE_SYSTEM_ALIAS_DISASSOCIATION" || "VOLUME_UPDATE" || "SNAPSHOT_UPDATE" || "RELEASE_NFS_V3_LOCKS" || "VOLUME_RESTORE" || "THROUGHPUT_OPTIMIZATION" || "IOPS_OPTIMIZATION" || "STORAGE_TYPE_OPTIMIZATION" || "MISCONFIGURED_STATE_RECOVERY" || "VOLUME_UPDATE_WITH_SNAPSHOT" || "VOLUME_INITIALIZE_WITH_SNAPSHOT" || "DOWNLOAD_DATA_FROM_BACKUP", * // ProgressPercent: Number("int"), * // RequestTime: new Date("TIMESTAMP"), * // Status: "FAILED" || "IN_PROGRESS" || "PENDING" || "COMPLETED" || "UPDATED_OPTIMIZING" || "OPTIMIZING" || "PAUSED" || "CANCELLED", * // TargetFileSystemValues: "", * // FailureDetails: { // AdministrativeActionFailureDetails * // Message: "STRING_VALUE", * // }, * // TargetVolumeValues: { // Volume * // CreationTime: new Date("TIMESTAMP"), * // FileSystemId: "STRING_VALUE", * // Lifecycle: "CREATING" || "CREATED" || "DELETING" || "FAILED" || "MISCONFIGURED" || "PENDING" || "AVAILABLE", * // Name: "STRING_VALUE", * // OntapConfiguration: { // OntapVolumeConfiguration * // FlexCacheEndpointType: "NONE" || "ORIGIN" || "CACHE", * // JunctionPath: "STRING_VALUE", * // SecurityStyle: "UNIX" || "NTFS" || "MIXED", * // SizeInMegabytes: Number("int"), * // StorageEfficiencyEnabled: true || false, * // StorageVirtualMachineId: "STRING_VALUE", * // StorageVirtualMachineRoot: true || false, * // TieringPolicy: { // TieringPolicy * // CoolingPeriod: Number("int"), * // Name: "SNAPSHOT_ONLY" || "AUTO" || "ALL" || "NONE", * // }, * // UUID: "STRING_VALUE", * // OntapVolumeType: "RW" || "DP" || "LS", * // SnapshotPolicy: "STRING_VALUE", * // CopyTagsToBackups: true || false, * // SnaplockConfiguration: { // SnaplockConfiguration * // AuditLogVolume: true || false, * // AutocommitPeriod: { // AutocommitPeriod * // Type: "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "NONE", // required * // Value: Number("int"), * // }, * // PrivilegedDelete: "DISABLED" || "ENABLED" || "PERMANENTLY_DISABLED", * // RetentionPeriod: { // SnaplockRetentionPeriod * // DefaultRetention: { // RetentionPeriod * // Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required * // Value: Number("int"), * // }, * // MinimumRetention: { * // Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required * // Value: Number("int"), * // }, * // MaximumRetention: { * // Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required * // Value: Number("int"), * // }, * // }, * // SnaplockType: "COMPLIANCE" || "ENTERPRISE", * // VolumeAppendModeEnabled: true || false, * // }, * // VolumeStyle: "FLEXVOL" || "FLEXGROUP", * // AggregateConfiguration: { // AggregateConfiguration * // Aggregates: [ // Aggregates * // "STRING_VALUE", * // ], * // TotalConstituents: Number("int"), * // }, * // SizeInBytes: Number("long"), * // }, * // ResourceARN: "STRING_VALUE", * // Tags: "", * // VolumeId: "STRING_VALUE", * // VolumeType: "ONTAP" || "OPENZFS", * // LifecycleTransitionReason: { // LifecycleTransitionReason * // Message: "STRING_VALUE", * // }, * // AdministrativeActions: "", * // OpenZFSConfiguration: { // OpenZFSVolumeConfiguration * // ParentVolumeId: "STRING_VALUE", * // VolumePath: "STRING_VALUE", * // StorageCapacityReservationGiB: Number("int"), * // StorageCapacityQuotaGiB: Number("int"), * // RecordSizeKiB: Number("int"), * // DataCompressionType: "NONE" || "ZSTD" || "LZ4", * // CopyTagsToSnapshots: true || false, * // OriginSnapshot: { // OpenZFSOriginSnapshotConfiguration * // SnapshotARN: "STRING_VALUE", * // CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY", * // }, * // ReadOnly: true || false, * // NfsExports: [ // OpenZFSNfsExports * // { // OpenZFSNfsExport * // ClientConfigurations: [ // OpenZFSClientConfigurations // required * // { // OpenZFSClientConfiguration * // Clients: "STRING_VALUE", // required * // Options: [ // OpenZFSNfsExportOptions // required * // "STRING_VALUE", * // ], * // }, * // ], * // }, * // ], * // UserAndGroupQuotas: [ // OpenZFSUserAndGroupQuotas * // { // OpenZFSUserOrGroupQuota * // Type: "USER" || "GROUP", // required * // Id: Number("int"), // required * // StorageCapacityQuotaGiB: Number("int"), // required * // }, * // ], * // RestoreToSnapshot: "STRING_VALUE", * // DeleteIntermediateSnaphots: true || false, * // DeleteClonedVolumes: true || false, * // DeleteIntermediateData: true || false, * // SourceSnapshotARN: "STRING_VALUE", * // DestinationSnapshot: "STRING_VALUE", * // CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY", * // }, * // }, * // TargetSnapshotValues: { // Snapshot * // ResourceARN: "STRING_VALUE", * // SnapshotId: "STRING_VALUE", * // Name: "STRING_VALUE", * // VolumeId: "STRING_VALUE", * // CreationTime: new Date("TIMESTAMP"), * // Lifecycle: "PENDING" || "CREATING" || "DELETING" || "AVAILABLE", * // LifecycleTransitionReason: { * // Message: "STRING_VALUE", * // }, * // Tags: "", * // AdministrativeActions: "", * // }, * // TotalTransferBytes: Number("long"), * // RemainingTransferBytes: Number("long"), * // Message: "STRING_VALUE", * // }, * // ], * // OntapConfiguration: { // OntapFileSystemConfiguration * // AutomaticBackupRetentionDays: Number("int"), * // DailyAutomaticBackupStartTime: "STRING_VALUE", * // DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_2", * // EndpointIpAddressRange: "STRING_VALUE", * // Endpoints: { // FileSystemEndpoints * // Intercluster: { // FileSystemEndpoint * // DNSName: "STRING_VALUE", * // IpAddresses: [ // OntapEndpointIpAddresses * // "STRING_VALUE", * // ], * // Ipv6Addresses: [ * // "STRING_VALUE", * // ], * // }, * // Management: { * // DNSName: "STRING_VALUE", * // IpAddresses: [ * // "STRING_VALUE", * // ], * // Ipv6Addresses: [ * // "STRING_VALUE", * // ], * // }, * // }, * // DiskIopsConfiguration: { * // Mode: "AUTOMATIC" || "USER_PROVISIONED", * // Iops: Number("long"), * // }, * // PreferredSubnetId: "STRING_VALUE", * // RouteTableIds: [ // RouteTableIds * // "STRING_VALUE", * // ], * // ThroughputCapacity: Number("int"), * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // FsxAdminPassword: "STRING_VALUE", * // HAPairs: Number("int"), * // ThroughputCapacityPerHAPair: Number("int"), * // EndpointIpv6AddressRange: "STRING_VALUE", * // }, * // FileSystemTypeVersion: "STRING_VALUE", * // OpenZFSConfiguration: { // OpenZFSFileSystemConfiguration * // AutomaticBackupRetentionDays: Number("int"), * // CopyTagsToBackups: true || false, * // CopyTagsToVolumes: true || false, * // DailyAutomaticBackupStartTime: "STRING_VALUE", * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "SINGLE_AZ_HA_1" || "SINGLE_AZ_HA_2" || "MULTI_AZ_1", * // ThroughputCapacity: Number("int"), * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // DiskIopsConfiguration: { * // Mode: "AUTOMATIC" || "USER_PROVISIONED", * // Iops: Number("long"), * // }, * // RootVolumeId: "STRING_VALUE", * // PreferredSubnetId: "STRING_VALUE", * // EndpointIpAddressRange: "STRING_VALUE", * // EndpointIpv6AddressRange: "STRING_VALUE", * // RouteTableIds: [ * // "STRING_VALUE", * // ], * // EndpointIpAddress: "STRING_VALUE", * // EndpointIpv6Address: "STRING_VALUE", * // ReadCacheConfiguration: { // OpenZFSReadCacheConfiguration * // SizingMode: "NO_CACHE" || "USER_PROVISIONED" || "PROPORTIONAL_TO_THROUGHPUT_CAPACITY", * // SizeGiB: Number("int"), * // }, * // }, * // NetworkType: "IPV4" || "DUAL", * // }, * // FailureDetails: { * // Message: "STRING_VALUE", * // }, * // TargetVolumeValues: { * // CreationTime: new Date("TIMESTAMP"), * // FileSystemId: "STRING_VALUE", * // Lifecycle: "CREATING" || "CREATED" || "DELETING" || "FAILED" || "MISCONFIGURED" || "PENDING" || "AVAILABLE", * // Name: "STRING_VALUE", * // OntapConfiguration: { * // FlexCacheEndpointType: "NONE" || "ORIGIN" || "CACHE", * // JunctionPath: "STRING_VALUE", * // SecurityStyle: "UNIX" || "NTFS" || "MIXED", * // SizeInMegabytes: Number("int"), * // StorageEfficiencyEnabled: true || false, * // StorageVirtualMachineId: "STRING_VALUE", * // StorageVirtualMachineRoot: true || false, * // TieringPolicy: { * // CoolingPeriod: Number("int"), * // Name: "SNAPSHOT_ONLY" || "AUTO" || "ALL" || "NONE", * // }, * // UUID: "STRING_VALUE", * // OntapVolumeType: "RW" || "DP" || "LS", * // SnapshotPolicy: "STRING_VALUE", * // CopyTagsToBackups: true || false, * // SnaplockConfiguration: { * // AuditLogVolume: true || false, * // AutocommitPeriod: { * // Type: "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "NONE", // required * // Value: Number("int"), * // }, * // PrivilegedDelete: "DISABLED" || "ENABLED" || "PERMANENTLY_DISABLED", * // RetentionPeriod: { * // DefaultRetention: { * // Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required * // Value: Number("int"), * // }, * // MinimumRetention: { * // Type: "SECONDS" || "MINUTES" || "HOURS" || "DAYS" || "MONTHS" || "YEARS" || "INFINITE" || "UNSPECIFIED", // required * // Value: Number("int"), * // }, * // MaximumRetention: "", // required * // }, * // SnaplockType: "COMPLIANCE" || "ENTERPRISE", * // VolumeAppendModeEnabled: true || false, * // }, * // VolumeStyle: "FLEXVOL" || "FLEXGROUP", * // AggregateConfiguration: { * // Aggregates: [ * // "STRING_VALUE", * // ], * // TotalConstituents: Number("int"), * // }, * // SizeInBytes: Number("long"), * // }, * // ResourceARN: "STRING_VALUE", * // Tags: "", * // VolumeId: "STRING_VALUE", * // VolumeType: "ONTAP" || "OPENZFS", * // LifecycleTransitionReason: { * // Message: "STRING_VALUE", * // }, * // AdministrativeActions: "", * // OpenZFSConfiguration: { * // ParentVolumeId: "STRING_VALUE", * // VolumePath: "STRING_VALUE", * // StorageCapacityReservationGiB: Number("int"), * // StorageCapacityQuotaGiB: Number("int"), * // RecordSizeKiB: Number("int"), * // DataCompressionType: "NONE" || "ZSTD" || "LZ4", * // CopyTagsToSnapshots: true || false, * // OriginSnapshot: { * // SnapshotARN: "STRING_VALUE", * // CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY", * // }, * // ReadOnly: true || false, * // NfsExports: [ * // { * // ClientConfigurations: [ // required * // { * // Clients: "STRING_VALUE", // required * // Options: [ // required * // "STRING_VALUE", * // ], * // }, * // ], * // }, * // ], * // UserAndGroupQuotas: [ * // { * // Type: "USER" || "GROUP", // required * // Id: Number("int"), // required * // StorageCapacityQuotaGiB: Number("int"), // required * // }, * // ], * // RestoreToSnapshot: "STRING_VALUE", * // DeleteIntermediateSnaphots: true || false, * // DeleteClonedVolumes: true || false, * // DeleteIntermediateData: true || false, * // SourceSnapshotARN: "STRING_VALUE", * // DestinationSnapshot: "STRING_VALUE", * // CopyStrategy: "CLONE" || "FULL_COPY" || "INCREMENTAL_COPY", * // }, * // }, * // TargetSnapshotValues: { * // ResourceARN: "STRING_VALUE", * // SnapshotId: "STRING_VALUE", * // Name: "STRING_VALUE", * // VolumeId: "STRING_VALUE", * // CreationTime: new Date("TIMESTAMP"), * // Lifecycle: "PENDING" || "CREATING" || "DELETING" || "AVAILABLE", * // LifecycleTransitionReason: { * // Message: "STRING_VALUE", * // }, * // Tags: "", * // AdministrativeActions: "", * // }, * // TotalTransferBytes: Number("long"), * // RemainingTransferBytes: Number("long"), * // Message: "STRING_VALUE", * // }, * // ], * // OntapConfiguration: { * // AutomaticBackupRetentionDays: Number("int"), * // DailyAutomaticBackupStartTime: "STRING_VALUE", * // DeploymentType: "MULTI_AZ_1" || "SINGLE_AZ_1" || "SINGLE_AZ_2" || "MULTI_AZ_2", * // EndpointIpAddressRange: "STRING_VALUE", * // Endpoints: { * // Intercluster: { * // DNSName: "STRING_VALUE", * // IpAddresses: [ * // "STRING_VALUE", * // ], * // Ipv6Addresses: "", * // }, * // Management: { * // DNSName: "STRING_VALUE", * // IpAddresses: "", * // Ipv6Addresses: "", * // }, * // }, * // DiskIopsConfiguration: { * // Mode: "AUTOMATIC" || "USER_PROVISIONED", * // Iops: Number("long"), * // }, * // PreferredSubnetId: "STRING_VALUE", * // RouteTableIds: [ * // "STRING_VALUE", * // ], * // ThroughputCapacity: Number("int"), * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // FsxAdminPassword: "STRING_VALUE", * // HAPairs: Number("int"), * // ThroughputCapacityPerHAPair: Number("int"), * // EndpointIpv6AddressRange: "STRING_VALUE", * // }, * // FileSystemTypeVersion: "STRING_VALUE", * // OpenZFSConfiguration: { * // AutomaticBackupRetentionDays: Number("int"), * // CopyTagsToBackups: true || false, * // CopyTagsToVolumes: true || false, * // DailyAutomaticBackupStartTime: "STRING_VALUE", * // DeploymentType: "SINGLE_AZ_1" || "SINGLE_AZ_2" || "SINGLE_AZ_HA_1" || "SINGLE_AZ_HA_2" || "MULTI_AZ_1", * // ThroughputCapacity: Number("int"), * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // DiskIopsConfiguration: "", * // RootVolumeId: "STRING_VALUE", * // PreferredSubnetId: "STRING_VALUE", * // EndpointIpAddressRange: "STRING_VALUE", * // EndpointIpv6AddressRange: "STRING_VALUE", * // RouteTableIds: [ * // "STRING_VALUE", * // ], * // EndpointIpAddress: "STRING_VALUE", * // EndpointIpv6Address: "STRING_VALUE", * // ReadCacheConfiguration: { * // SizingMode: "NO_CACHE" || "USER_PROVISIONED" || "PROPORTIONAL_TO_THROUGHPUT_CAPACITY", * // SizeGiB: Number("int"), * // }, * // }, * // NetworkType: "IPV4" || "DUAL", * // }, * // }; * * ``` * * @param CreateFileSystemFromBackupCommandInput - {@link CreateFileSystemFromBackupCommandInput} * @returns {@link CreateFileSystemFromBackupCommandOutput} * @see {@link CreateFileSystemFromBackupCommandInput} for command's `input` shape. * @see {@link CreateFileSystemFromBackupCommandOutput} for command's `response` shape. * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape. * * @throws {@link ActiveDirectoryError} (client fault) *

An Active Directory error.

* * @throws {@link BackupNotFound} (client fault) *

No Amazon FSx backups were found based upon the supplied parameters.

* * @throws {@link BadRequest} (client fault) *

A generic error indicating a failure with a client request.

* * @throws {@link IncompatibleParameterError} (client fault) *

The error returned when a second request is received with the same client request * token but different parameters settings. A client request token should always uniquely * identify a single request.

* * @throws {@link InternalServerError} (server fault) *

A generic error indicating a server-side failure.

* * @throws {@link InvalidNetworkSettings} (client fault) *

One or more network settings specified in the request are invalid.

* * @throws {@link InvalidPerUnitStorageThroughput} (client fault) *

An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

* * @throws {@link MissingFileSystemConfiguration} (client fault) *

A file system configuration is required for this operation.

* * @throws {@link ServiceLimitExceeded} (client fault) *

An error indicating that a particular service limit was exceeded. You can increase * some service limits by contacting Amazon Web Services Support.

* * @throws {@link FSxServiceException} *

Base exception class for all service exceptions from FSx service.

* * * @public */ export declare class CreateFileSystemFromBackupCommand extends CreateFileSystemFromBackupCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateFileSystemFromBackupRequest; output: CreateFileSystemFromBackupResponse; }; sdk: { input: CreateFileSystemFromBackupCommandInput; output: CreateFileSystemFromBackupCommandOutput; }; }; }