AWS CloudHSM (v2) (version v1.*.*)

copy_backup_to_region#

Copy an AWS CloudHSM cluster backup to a different region.

{
  "DestinationRegion" : "The AWS region that will contain your copied CloudHSM cluster backup.",
  "BackupId" : "The ID of the backup that will be copied to the destination region. "
}

create_cluster#

Creates a new AWS CloudHSM cluster.

{
  "SourceBackupId" : "The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.",
  "HsmType" : "The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.",
  "SubnetIds" : [ "string" ]
}

create_hsm#

Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

{
  "ClusterId" : "The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.",
  "AvailabilityZone" : "The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.",
  "IpAddress" : "The HSM's IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify an IP address, one is chosen for you from that subnet."
}

delete_backup#

Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request. For more information on restoring a backup, see RestoreBackup

{
  "BackupId" : "The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation."
}

delete_cluster#

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.

{
  "ClusterId" : "The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters."
}

delete_hsm#

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

{
  "HsmId" : "The identifier (ID) of the HSM that you are deleting.",
  "EniId" : "The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.",
  "ClusterId" : "The identifier (ID) of the cluster that contains the HSM that you are deleting.",
  "EniIp" : "The IP address of the elastic network interface (ENI) of the HSM that you are deleting."
}

describe_backups#

Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

{
  "Filters" : "One or more filters to limit the items returned in the response. \nUse the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID). \nUse the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation. \nUse the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID). \nUse the states filter to return only backups that match the specified state.",
  "SortAscending" : "boolean"
}

describe_clusters#

Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

{
  "Filters" : "One or more filters to limit the items returned in the response. \nUse the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID). \nUse the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID). \nUse the states filter to return only clusters that match the specified state."
}

initialize_cluster#

Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

{
  "SignedCert" : "The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.",
  "ClusterId" : "The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.",
  "TrustAnchor" : "The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format and can contain a maximum of 5000 characters."
}

list_tags#

Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

{
  "ResourceId" : "The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters."
}

restore_backup#

Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup.

{
  "BackupId" : "The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation."
}

tag_resource#

Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

{
  "ResourceId" : "The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.",
  "TagList" : [ {
    "Value" : "The value of the tag.",
    "Key" : "The key of the tag."
  } ]
}

untag_resource#

Removes the specified tag or tags from the specified AWS CloudHSM cluster.

{
  "ResourceId" : "The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.",
  "TagKeyList" : [ "string" ]
}