AWS.CloudHSM — AWS SDK for JavaScript (original) (raw)
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
Class: AWS.CloudHSM
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Sending a Request Using CloudHSM
var cloudhsm = new AWS.CloudHSM();
cloudhsm.addTagsToResource(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the CloudHSM object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:
var cloudhsm = new AWS.CloudHSM({apiVersion: '2014-05-30'});
You can also set the API version globally in AWS.config.apiVersions using the cloudhsm service identifier:
AWS.config.apiVersions = {
cloudhsm: '2014-05-30',
// other service API versions
};
var cloudhsm = new AWS.CloudHSM();
Constructor Summarycollapse
- new AWS.CloudHSM(options = {}) ⇒ Object constructor
Constructs a service object.
Property Summarycollapse
- endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summarycollapse
- addTagsToResource(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - createHapg(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - createHsm(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - createLunaClient(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - deleteHapg(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - deleteHsm(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - deleteLunaClient(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - describeHapg(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - describeHsm(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - describeLunaClient(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - getConfig(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - listAvailableZones(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - listHapgs(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - listHsms(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - listLunaClients(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - listTagsForResource(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - modifyHapg(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - modifyHsm(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - modifyLunaClient(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. - removeTagsFromResource(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.CloudHSM(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
endpoint ⇒ AWS.Endpoint
Returns an Endpoint object representing the endpoint URL for service requests.
Method Details
addTagsToResource(params = {}, callback) ⇒ AWS.Request
createHsm(params = {}, callback) ⇒ AWS.Request
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates an uninitialized HSM instance.
There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.
It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.