import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CopyBackupRequest, CopyBackupResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CopyBackupCommand}. */ export interface CopyBackupCommandInput extends CopyBackupRequest { } /** * @public * * The output of {@link CopyBackupCommand}. */ export interface CopyBackupCommandOutput extends CopyBackupResponse, __MetadataBearer { } declare const CopyBackupCommand_base: { new (input: CopyBackupCommandInput): import("@smithy/core/client").CommandImpl; new (input: CopyBackupCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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

*

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

*

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

*

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

*

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { FSxClient, CopyBackupCommand } from "@aws-sdk/client-fsx"; // ES Modules import * // const { FSxClient, CopyBackupCommand } = 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 = { // CopyBackupRequest * ClientRequestToken: "STRING_VALUE", * SourceBackupId: "STRING_VALUE", // required * SourceRegion: "STRING_VALUE", * KmsKeyId: "STRING_VALUE", * CopyTags: true || false, * Tags: [ // Tags * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }; * const command = new CopyBackupCommand(input); * const response = await client.send(command); * // { // CopyBackupResponse * // Backup: { // Backup * // BackupId: "STRING_VALUE", // required * // Lifecycle: "AVAILABLE" || "CREATING" || "TRANSFERRING" || "DELETED" || "FAILED" || "PENDING" || "COPYING", // required * // FailureDetails: { // BackupFailureDetails * // Message: "STRING_VALUE", * // }, * // Type: "AUTOMATIC" || "USER_INITIATED" || "AWS_BACKUP", // required * // ProgressPercent: Number("int"), * // CreationTime: new Date("TIMESTAMP"), // required * // KmsKeyId: "STRING_VALUE", * // ResourceARN: "STRING_VALUE", * // Tags: [ // Tags * // { // Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // 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: [ * // { * // 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: "", * // 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", * // }, * // DirectoryInformation: { // ActiveDirectoryBackupAttributes * // DomainName: "STRING_VALUE", * // ActiveDirectoryId: "STRING_VALUE", * // ResourceARN: "STRING_VALUE", * // }, * // OwnerId: "STRING_VALUE", * // SourceBackupId: "STRING_VALUE", * // SourceBackupRegion: "STRING_VALUE", * // ResourceType: "FILE_SYSTEM" || "VOLUME", * // Volume: "", * // SizeInBytes: Number("long"), * // }, * // }; * * ``` * * @param CopyBackupCommandInput - {@link CopyBackupCommandInput} * @returns {@link CopyBackupCommandOutput} * @see {@link CopyBackupCommandInput} for command's `input` shape. * @see {@link CopyBackupCommandOutput} for command's `response` shape. * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape. * * @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 IncompatibleRegionForMultiAZ} (client fault) *

Amazon FSx doesn't support Multi-AZ Windows File Server copy backup in the * destination Region, so the copied backup can't be restored.

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

A generic error indicating a server-side failure.

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

The Key Management Service (KMS) key of the destination backup is not * valid.

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

The Region provided for SourceRegion is not valid or is in a different * Amazon Web Services partition.

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

The Key Management Service (KMS) key of the source backup is not * valid.

* * @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 SourceBackupUnavailable} (client fault) *

The request was rejected because the lifecycle status of the source backup isn't * AVAILABLE.

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

The requested operation is not supported for this resource or API.

* * @throws {@link FSxServiceException} *

Base exception class for all service exceptions from FSx service.

* * * @example To copy a backup * ```javascript * // This operation copies an Amazon FSx backup. * const input = { * SourceBackupId: "backup-03e3c82e0183b7b6b", * SourceRegion: "us-east-2" * }; * const command = new CopyBackupCommand(input); * const response = await client.send(command); * /* response is * { * Backup: { * BackupId: "backup-0a3364eded1014b28", * CreationTime: 1.617954808068E9, * FileSystem: { * FileSystemId: "fs-0498eed5fe91001ec", * FileSystemType: "LUSTRE", * LustreConfiguration: { * AutomaticBackupRetentionDays: 0, * DeploymentType: "PERSISTENT_1", * PerUnitStorageThroughput: 50, * WeeklyMaintenanceStartTime: "1:05:00" * }, * ResourceARN: "arn:aws:fsx:us-east-1:012345678912:file-system/fs-0f5179e395f597e66", * StorageCapacity: 2400, * StorageType: "SSD" * }, * KmsKeyId: "arn:aws:fsx:us-east-1:012345678912:key/d1234e22-543a-12b7-a98f-e12c2b54001a", * Lifecycle: "COPYING", * OwnerId: "123456789012", * ResourceARN: "arn:aws:fsx:us-east-1:012345678912:backup/backup-0a3364eded1014b28", * Tags: [ * { * Key: "Name", * Value: "MyBackup" * } * ], * Type: "USER_INITIATED" * } * } * *\/ * ``` * * @public */ export declare class CopyBackupCommand extends CopyBackupCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CopyBackupRequest; output: CopyBackupResponse; }; sdk: { input: CopyBackupCommandInput; output: CopyBackupCommandOutput; }; }; }