Skip to main content

clusters

Contains information about an AWS CloudHSM cluster.

Overview

Nameclusters
TypeResource
DescriptionContains information about an AWS CloudHSM cluster.
Idaws.cloudhsm.clusters

Fields

NameDatatypeDescription
backup_policystringThe cluster's backup policy.
backup_retention_policyobjectA policy that defines how the service retains backups.
cluster_idstringThe cluster's identifier (ID).
create_timestampstringThe date and time when the cluster was created.
hsmsarrayContains information about the HSMs in the cluster.
hsm_typestringThe type of HSM that the cluster contains.
pre_co_passwordstringThe default password for the cluster's Pre-Crypto Officer (PRECO) user.
security_groupstringThe identifier (ID) of the cluster's security group.
source_backup_idstringThe identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
statestringThe cluster's state.
state_messagestringA description of the cluster's state.
subnet_mappingobjectA map from availability zone to the cluster’s subnet in that availability zone.
vpc_idstringThe identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
certificatesobjectContains one or more certificates or a certificate signing request (CSR).
tag_listarrayThe list of tags for the cluster.
regionstringAWS region.

Methods

NameAccessible byRequired Params
describe_clustersSELECTregion
create_clusterINSERTX-Amz-Target, data__HsmType, data__SubnetIds, region
delete_clusterDELETEX-Amz-Target, data__ClusterId, region
initialize_clusterEXECX-Amz-Target, data__ClusterId, data__SignedCert, data__TrustAnchor, region
modify_clusterEXECX-Amz-Target, data__BackupRetentionPolicy, data__ClusterId, region