Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class CopyBackupToRegionCommandProtected

Copy an AWS CloudHSM cluster backup to a different region.

Example

Use a bare-bones client and the command you need to make an API call.

import { CloudHSMV2Client, CopyBackupToRegionCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import
// const { CloudHSMV2Client, CopyBackupToRegionCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import
const client = new CloudHSMV2Client(config);
const input = { // CopyBackupToRegionRequest
DestinationRegion: "STRING_VALUE", // required
BackupId: "STRING_VALUE", // required
TagList: [ // TagList
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
};
const command = new CopyBackupToRegionCommand(input);
const response = await client.send(command);
// { // CopyBackupToRegionResponse
// DestinationBackup: { // DestinationBackup
// CreateTimestamp: new Date("TIMESTAMP"),
// SourceRegion: "STRING_VALUE",
// SourceBackup: "STRING_VALUE",
// SourceCluster: "STRING_VALUE",
// },
// };

Param

CopyBackupToRegionCommandInput

Returns

CopyBackupToRegionCommandOutput

See

Throws

CloudHsmAccessDeniedException (client fault)

The request was rejected because the requester does not have permission to perform the requested operation.

Throws

CloudHsmInternalFailureException (server fault)

The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

Throws

CloudHsmInvalidRequestException (client fault)

The request was rejected because it is not a valid request.

Throws

CloudHsmResourceNotFoundException (client fault)

The request was rejected because it refers to a resource that cannot be found.

Throws

CloudHsmServiceException (client fault)

The request was rejected because an error occurred.

Throws

CloudHsmTagException (client fault)

The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

Throws

CloudHSMV2ServiceException

Base exception class for all service exceptions from CloudHSMV2 service.

Hierarchy

Constructors

Properties

Methods