ModifyCluster - AWS CloudHSM


Modifies AWS CloudHSM cluster.

Cross-account use: No. You cannot perform this operation on an AWS CloudHSM cluster in a different AWS account.

Request Syntax

{ "BackupRetentionPolicy": { "Type": "string", "Value": "string" }, "ClusterId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


A policy that defines how the service retains backups.

Type: BackupRetentionPolicy object

Required: Yes


The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use DescribeClusters.

Type: String

Pattern: cluster-[2-7a-zA-Z]{11,16}

Required: Yes

Response Syntax

{ "Cluster": { "BackupPolicy": "string", "BackupRetentionPolicy": { "Type": "string", "Value": "string" }, "Certificates": { "AwsHardwareCertificate": "string", "ClusterCertificate": "string", "ClusterCsr": "string", "HsmCertificate": "string", "ManufacturerHardwareCertificate": "string" }, "ClusterId": "string", "CreateTimestamp": number, "Hsms": [ { "AvailabilityZone": "string", "ClusterId": "string", "EniId": "string", "EniIp": "string", "HsmId": "string", "State": "string", "StateMessage": "string", "SubnetId": "string" } ], "HsmType": "string", "Mode": "string", "PreCoPassword": "string", "SecurityGroup": "string", "SourceBackupId": "string", "State": "string", "StateMessage": "string", "SubnetMapping": { "string" : "string" }, "TagList": [ { "Key": "string", "Value": "string" } ], "VpcId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Contains information about an AWS CloudHSM cluster.

Type: Cluster object


For information about the errors that are common to all actions, see Common Errors.


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

HTTP Status Code: 400


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

HTTP Status Code: 500


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

HTTP Status Code: 400


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

HTTP Status Code: 400


The request was rejected because an error occurred.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: