Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class DeleteClusterCommandProtected

Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

Example

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

import { CloudHSMV2Client, DeleteClusterCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import
// const { CloudHSMV2Client, DeleteClusterCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import
const client = new CloudHSMV2Client(config);
const input = { // DeleteClusterRequest
ClusterId: "STRING_VALUE", // required
};
const command = new DeleteClusterCommand(input);
const response = await client.send(command);
// { // DeleteClusterResponse
// Cluster: { // Cluster
// BackupPolicy: "DEFAULT",
// BackupRetentionPolicy: { // BackupRetentionPolicy
// Type: "DAYS",
// Value: "STRING_VALUE",
// },
// ClusterId: "STRING_VALUE",
// CreateTimestamp: new Date("TIMESTAMP"),
// Hsms: [ // Hsms
// { // Hsm
// AvailabilityZone: "STRING_VALUE",
// ClusterId: "STRING_VALUE",
// SubnetId: "STRING_VALUE",
// EniId: "STRING_VALUE",
// EniIp: "STRING_VALUE",
// HsmId: "STRING_VALUE", // required
// State: "CREATE_IN_PROGRESS" || "ACTIVE" || "DEGRADED" || "DELETE_IN_PROGRESS" || "DELETED",
// StateMessage: "STRING_VALUE",
// },
// ],
// HsmType: "STRING_VALUE",
// PreCoPassword: "STRING_VALUE",
// SecurityGroup: "STRING_VALUE",
// SourceBackupId: "STRING_VALUE",
// State: "CREATE_IN_PROGRESS" || "UNINITIALIZED" || "INITIALIZE_IN_PROGRESS" || "INITIALIZED" || "ACTIVE" || "UPDATE_IN_PROGRESS" || "DELETE_IN_PROGRESS" || "DELETED" || "DEGRADED",
// StateMessage: "STRING_VALUE",
// SubnetMapping: { // ExternalSubnetMapping
// "<keys>": "STRING_VALUE",
// },
// VpcId: "STRING_VALUE",
// Certificates: { // Certificates
// ClusterCsr: "STRING_VALUE",
// HsmCertificate: "STRING_VALUE",
// AwsHardwareCertificate: "STRING_VALUE",
// ManufacturerHardwareCertificate: "STRING_VALUE",
// ClusterCertificate: "STRING_VALUE",
// },
// TagList: [ // TagList
// { // Tag
// Key: "STRING_VALUE", // required
// Value: "STRING_VALUE", // required
// },
// ],
// },
// };

Param

DeleteClusterCommandInput

Returns

DeleteClusterCommandOutput

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

Constructors

Properties

Methods