Amazon Web Services, Inc.

AWS CloudHSM V2

For more information about CloudHSM, see CloudHSM and the CloudHSM User Guide .

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

For more information about CloudHSM, see CloudHSM and the
CloudHSM User Guide .

Endpoints 18

  • POSTCopy backup to region/#X-Amz-Target=BaldrApiService.CopyBackupToRegionCopy an CloudHSM cluster backup to a different region. Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon…
  • POSTCreate cluster/#X-Amz-Target=BaldrApiService.CreateClusterCreates a new CloudHSM cluster. Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup…
  • POSTCreate hsm/#X-Amz-Target=BaldrApiService.CreateHsmCreates a new hardware security module (HSM) in the specified CloudHSM cluster. Cross-account use: No. You cannot perform this operation on an CloudHSM…
  • POSTDelete backup/#X-Amz-Target=BaldrApiService.DeleteBackupDeletes a specified CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup,…
  • POSTDelete cluster/#X-Amz-Target=BaldrApiService.DeleteClusterDeletes the specified 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…
  • POSTDelete hsm/#X-Amz-Target=BaldrApiService.DeleteHsmDeletes 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…
  • POSTDelete resource policy/#X-Amz-Target=BaldrApiService.DeleteResourcePolicyDeletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting…
  • POSTDescribe backups/#X-Amz-Target=BaldrApiService.DescribeBackupsGets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true. This…
  • POSTDescribe clusters/#X-Amz-Target=BaldrApiService.DescribeClustersGets information about CloudHSM clusters. This is a paginated operation, which means that each response might contain only a subset of all the clusters. When…
  • POSTGet resource policy/#X-Amz-Target=BaldrApiService.GetResourcePolicyRetrieves the resource policy document attached to a given resource. Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a…
  • POSTInitialize cluster/#X-Amz-Target=BaldrApiService.InitializeClusterClaims an CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you…
  • POSTList tags/#X-Amz-Target=BaldrApiService.ListTagsGets a list of tags for the specified CloudHSM cluster. This is a paginated operation, which means that each response might contain only a subset of all the…
  • POSTModify backup attributes/#X-Amz-Target=BaldrApiService.ModifyBackupAttributesModifies attributes for CloudHSM backup. Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services…
  • POSTModify cluster/#X-Amz-Target=BaldrApiService.ModifyClusterModifies CloudHSM cluster. Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
  • POSTPut resource policy/#X-Amz-Target=BaldrApiService.PutResourcePolicyCreates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can…
  • POSTRestore backup/#X-Amz-Target=BaldrApiService.RestoreBackupRestores a specified CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup . Cross-account use:…
  • POSTTag resource/#X-Amz-Target=BaldrApiService.TagResourceAdds or overwrites one or more tags for the specified CloudHSM cluster. Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a…
  • POSTUntag resource/#X-Amz-Target=BaldrApiService.UntagResourceRemoves the specified tag or tags from the specified CloudHSM cluster. Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a…

API details

Base URL
https://cloudhsmv2.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
18 operations on 18 pathsPOST 18
Description format
AWS Smithy model, API version 2017-04-28

How to test the AWS CloudHSM V2 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS CloudHSM V2 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Copy backup to region” (POST /#X-Amz-Target=BaldrApiService.CopyBackupToRegion), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS CloudHSM V2?

For more information about CloudHSM, see CloudHSM and the CloudHSM User Guide . It is listed under Developer tools and has 18 endpoints.

Who publishes the AWS CloudHSM V2?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS CloudHSM V2?

Requests go to https://cloudhsmv2.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS CloudHSM V2?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS CloudHSM V2 have?

18 operations on 18 paths (18 POST).

Is forking the AWS CloudHSM V2 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.