Class ModifyClusterCommandProtected

Modifies AWS CloudHSM cluster.

Example

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

import { CloudHSMV2Client, ModifyClusterCommand } from "@aws-sdk/client-cloudhsm-v2"; // ES Modules import
// const { CloudHSMV2Client, ModifyClusterCommand } = require("@aws-sdk/client-cloudhsm-v2"); // CommonJS import
const client = new CloudHSMV2Client(config);
const input = { // ModifyClusterRequest
  BackupRetentionPolicy: { // BackupRetentionPolicy
    Type: "DAYS",
    Value: "STRING_VALUE",
  },
  ClusterId: "STRING_VALUE", // required
};
const command = new ModifyClusterCommand(input);
const response = await client.send(command);
// { // ModifyClusterResponse
//   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

ModifyClusterCommandInput

Returns

ModifyClusterCommandOutput

See

• ModifyClusterCommandInput for command's input shape.
• ModifyClusterCommandOutput for command's response shape.
• config for CloudHSMV2Client's config shape.

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

CloudHSMV2ServiceException

Base exception class for all service exceptions from CloudHSMV2 service.