Class: AWS.CloudHSMV2

Inherits:

AWS.Service

• Object
• AWS.Service
• AWS.CloudHSMV2

Identifier:

cloudhsmv2

API Version:

2017-04-28

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using CloudHSMV2

var cloudhsmv2 = new AWS.CloudHSMV2();
cloudhsmv2.copyBackupToRegion(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 CloudHSMV2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var cloudhsmv2 = new AWS.CloudHSMV2({apiVersion: '2017-04-28'});

You can also set the API version globally in AWS.config.apiVersions using the cloudhsmv2 service identifier:

AWS.config.apiVersions = {
  cloudhsmv2: '2017-04-28',
  // other service API versions
};

var cloudhsmv2 = new AWS.CloudHSMV2();

Version:

• 2017-04-28

Constructor Summary

• new AWS.CloudHSMV2(options = {}) ⇒ Object constructor

  Constructs a service object.

Property Summary

• endpoint ⇒ AWS.Endpoint readwrite

  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary

• copyBackupToRegion(params = {}, callback) ⇒ AWS.Request

  Copy an AWS CloudHSM cluster backup to a different region.

• createCluster(params = {}, callback) ⇒ AWS.Request

  Creates a new AWS CloudHSM cluster.

• createHsm(params = {}, callback) ⇒ AWS.Request

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

• deleteBackup(params = {}, callback) ⇒ AWS.Request

  Deletes a specified AWS CloudHSM backup.

• deleteCluster(params = {}, callback) ⇒ AWS.Request

  Deletes the specified AWS CloudHSM cluster.

• deleteHsm(params = {}, callback) ⇒ AWS.Request

  Deletes the specified HSM.

• describeBackups(params = {}, callback) ⇒ AWS.Request

  Gets information about backups of AWS CloudHSM clusters.

• describeClusters(params = {}, callback) ⇒ AWS.Request

  Gets information about AWS CloudHSM clusters.

• initializeCluster(params = {}, callback) ⇒ AWS.Request

  Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate.

• listTags(params = {}, callback) ⇒ AWS.Request

  Gets a list of tags for the specified AWS CloudHSM cluster.

• restoreBackup(params = {}, callback) ⇒ AWS.Request

  Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state.

• tagResource(params = {}, callback) ⇒ AWS.Request

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

• untagResource(params = {}, callback) ⇒ AWS.Request

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

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CloudHSMV2(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CloudHSMV2 object

var cloudhsmv2 = new AWS.CloudHSMV2({apiVersion: '2017-04-28'});

Options Hash (options):

• params (map) —

  An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

• endpoint (String) —

  The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

• accessKeyId (String) —

  your AWS access key ID.

• secretAccessKey (String) —

  your AWS secret access key.

• sessionToken (AWS.Credentials) —

  the optional AWS session token to sign requests with.

• credentials (AWS.Credentials) —

  the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

• credentialProvider (AWS.CredentialProviderChain) —

  the provider chain used to resolve credentials if no static credentials property is set.

• region (String) —

  the region to send service requests to. See AWS.CloudHSMV2.region for more information.

• maxRetries (Integer) —

  the maximum amount of retries to attempt with a request. See AWS.CloudHSMV2.maxRetries for more information.

• maxRedirects (Integer) —

  the maximum amount of redirects to follow with a request. See AWS.CloudHSMV2.maxRedirects for more information.

• sslEnabled (Boolean) —

  whether to enable SSL for requests.

• paramValidation (Boolean|map) —

  whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

  • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
  • max [Boolean] — Validates that a value meets the max constraint.
  • pattern [Boolean] — Validates that a string value matches a regular expression.
  • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
• computeChecksums (Boolean) —

  whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

• convertResponseTypes (Boolean) —

  whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

• correctClockSkew (Boolean) —

  whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

• s3ForcePathStyle (Boolean) —

  whether to force path style URLs for S3 objects.

• s3BucketEndpoint (Boolean) —

  whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

• s3DisableBodySigning (Boolean) —

  whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

• retryDelayOptions (map) —

  A set of options to configure the retry delay on retryable errors. Currently supported options are:

  • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
  • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
• httpOptions (map) —

  A set of options to pass to the low-level HTTP request. Currently supported options are:

  • proxy [String] — the URL to proxy requests through
  • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
  • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
  • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
  • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
  • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
• apiVersion (String, Date) —

  a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

• apiVersions (map<String, String|Date>) —

  a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

• logger (#write, #log) —

  an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

• systemClockOffset (Number) —

  an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

• signatureVersion (String) —

  the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

• signatureCache (Boolean) —

  whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

• dynamoDbCrc32 (Boolean) —

  whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

• useAccelerateEndpoint (Boolean) —

  Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

• clientSideMonitoring (Boolean) —

  whether to collect and publish this client's performance metrics of all its API requests.

• endpointDiscoveryEnabled (Boolean) —

  whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

• endpointCacheSize (Number) —

  the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

• hostPrefixEnabled (Boolean) —

  whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

• (AWS.Endpoint) —

  an Endpoint object representing the endpoint URL for service requests.

Method Details

copyBackupToRegion(params = {}, callback) ⇒ AWS.Request

Copy an AWS CloudHSM cluster backup to a different region.

Service Reference:

• CopyBackupToRegion

Examples:

Calling the copyBackupToRegion operation

var params = {
  BackupId: 'STRING_VALUE', /* required */
  DestinationRegion: 'STRING_VALUE' /* required */
};
cloudhsmv2.copyBackupToRegion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DestinationRegion — (String)

    The AWS region that will contain your copied CloudHSM cluster backup.

  • BackupId — (String)

    The ID of the backup that will be copied to the destination region.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DestinationBackup — (map)

      Information on the backup that will be copied to the destination region, including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the destination backup will be the same as that of the source backup.

      You will need to use the sourceBackupID returned in this operation to use the DescribeBackups operation on the backup that will be copied to the destination region.

      • CreateTimestamp — (Date)
      • SourceRegion — (String)
      • SourceBackup — (String)
      • SourceCluster — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

createCluster(params = {}, callback) ⇒ AWS.Request

Creates a new AWS CloudHSM cluster.

Service Reference:

• CreateCluster

Examples:

Calling the createCluster operation

var params = {
  HsmType: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  SourceBackupId: 'STRING_VALUE'
};
cloudhsmv2.createCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SubnetIds — (Array<String>)

    The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

    • All subnets must be in the same virtual private cloud (VPC).

    • You can specify only one subnet per Availability Zone.

  • HsmType — (String)

    The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.

  • SourceBackupId — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Cluster — (map)

      Information about the cluster that was created.

      • BackupPolicy — (String)

        The cluster's backup policy.

        Possible values include:
        • "DEFAULT"
      • ClusterId — (String)

        The cluster's identifier (ID).

      • CreateTimestamp — (Date)

        The date and time when the cluster was created.

      • Hsms — (Array<map>)

        Contains information about the HSMs in the cluster.

        • AvailabilityZone — (String)

          The Availability Zone that contains the HSM.

        • ClusterId — (String)

          The identifier (ID) of the cluster that contains the HSM.

        • SubnetId — (String)

          The subnet that contains the HSM's elastic network interface (ENI).

        • EniId — (String)

          The identifier (ID) of the HSM's elastic network interface (ENI).

        • EniIp — (String)

          The IP address of the HSM's elastic network interface (ENI).

        • HsmId — required — (String)

          The HSM's identifier (ID).

        • State — (String)

          The HSM's state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "ACTIVE"
          • "DEGRADED"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
        • StateMessage — (String)

          A description of the HSM's state.

      • HsmType — (String)

        The type of HSM that the cluster contains.

      • PreCoPassword — (String)

        The default password for the cluster's Pre-Crypto Officer (PRECO) user.

      • SecurityGroup — (String)

        The identifier (ID) of the cluster's security group.

      • SourceBackupId — (String)

        The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

      • State — (String)

        The cluster's state.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "UNINITIALIZED"
        • "INITIALIZE_IN_PROGRESS"
        • "INITIALIZED"
        • "ACTIVE"
        • "UPDATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "DELETED"
        • "DEGRADED"
      • StateMessage — (String)

        A description of the cluster's state.

      • SubnetMapping — (map<String>)

        A map of the cluster's subnets and their corresponding Availability Zones.

      • VpcId — (String)

        The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

      • Certificates — (map)

        Contains one or more certificates or a certificate signing request (CSR).

        • ClusterCsr — (String)

          The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED.

        • HsmCertificate — (String)

          The HSM certificate issued (signed) by the HSM hardware.

        • AwsHardwareCertificate — (String)

          The HSM hardware certificate issued (signed) by AWS CloudHSM.

        • ManufacturerHardwareCertificate — (String)

          The HSM hardware certificate issued (signed) by the hardware manufacturer.

        • ClusterCertificate — (String)

          The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

createHsm(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

• CreateHsm

Examples:

Calling the createHsm operation

var params = {
  AvailabilityZone: 'STRING_VALUE', /* required */
  ClusterId: 'STRING_VALUE', /* required */
  IpAddress: 'STRING_VALUE'
};
cloudhsmv2.createHsm(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClusterId — (String)

    The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.

  • AvailabilityZone — (String)

    The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.

  • IpAddress — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Hsm — (map)

      Information about the HSM that was created.

      • AvailabilityZone — (String)

        The Availability Zone that contains the HSM.

      • ClusterId — (String)

        The identifier (ID) of the cluster that contains the HSM.

      • SubnetId — (String)

        The subnet that contains the HSM's elastic network interface (ENI).

      • EniId — (String)

        The identifier (ID) of the HSM's elastic network interface (ENI).

      • EniIp — (String)

        The IP address of the HSM's elastic network interface (ENI).

      • HsmId — required — (String)

        The HSM's identifier (ID).

      • State — (String)

        The HSM's state.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "DEGRADED"
        • "DELETE_IN_PROGRESS"
        • "DELETED"
      • StateMessage — (String)

        A description of the HSM's state.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

deleteBackup(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

• DeleteBackup

Examples:

Calling the deleteBackup operation

var params = {
  BackupId: 'STRING_VALUE' /* required */
};
cloudhsmv2.deleteBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • BackupId — (String)

    The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Backup — (map)

      Information on the Backup object deleted.

      • BackupId — required — (String)

        The identifier (ID) of the backup.

      • BackupState — (String)

        The state of the backup.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "READY"
        • "DELETED"
        • "PENDING_DELETION"
      • ClusterId — (String)

        The identifier (ID) of the cluster that was backed up.

      • CreateTimestamp — (Date)

        The date and time when the backup was created.

      • CopyTimestamp — (Date)
      • SourceRegion — (String)
      • SourceBackup — (String)
      • SourceCluster — (String)
      • DeleteTimestamp — (Date)

        The date and time when the backup will be permanently deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

deleteCluster(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

• DeleteCluster

Examples:

Calling the deleteCluster operation

var params = {
  ClusterId: 'STRING_VALUE' /* required */
};
cloudhsmv2.deleteCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClusterId — (String)

    The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Cluster — (map)

      Information about the cluster that was deleted.

      • BackupPolicy — (String)

        The cluster's backup policy.

        Possible values include:
        • "DEFAULT"
      • ClusterId — (String)

        The cluster's identifier (ID).

      • CreateTimestamp — (Date)

        The date and time when the cluster was created.

      • Hsms — (Array<map>)

        Contains information about the HSMs in the cluster.

        • AvailabilityZone — (String)

          The Availability Zone that contains the HSM.

        • ClusterId — (String)

          The identifier (ID) of the cluster that contains the HSM.

        • SubnetId — (String)

          The subnet that contains the HSM's elastic network interface (ENI).

        • EniId — (String)

          The identifier (ID) of the HSM's elastic network interface (ENI).

        • EniIp — (String)

          The IP address of the HSM's elastic network interface (ENI).

        • HsmId — required — (String)

          The HSM's identifier (ID).

        • State — (String)

          The HSM's state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "ACTIVE"
          • "DEGRADED"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
        • StateMessage — (String)

          A description of the HSM's state.

      • HsmType — (String)

        The type of HSM that the cluster contains.

      • PreCoPassword — (String)

        The default password for the cluster's Pre-Crypto Officer (PRECO) user.

      • SecurityGroup — (String)

        The identifier (ID) of the cluster's security group.

      • SourceBackupId — (String)

        The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

      • State — (String)

        The cluster's state.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "UNINITIALIZED"
        • "INITIALIZE_IN_PROGRESS"
        • "INITIALIZED"
        • "ACTIVE"
        • "UPDATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "DELETED"
        • "DEGRADED"
      • StateMessage — (String)

        A description of the cluster's state.

      • SubnetMapping — (map<String>)

        A map of the cluster's subnets and their corresponding Availability Zones.

      • VpcId — (String)

        The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

      • Certificates — (map)

        Contains one or more certificates or a certificate signing request (CSR).

        • ClusterCsr — (String)

          The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED.

        • HsmCertificate — (String)

          The HSM certificate issued (signed) by the HSM hardware.

        • AwsHardwareCertificate — (String)

          The HSM hardware certificate issued (signed) by AWS CloudHSM.

        • ManufacturerHardwareCertificate — (String)

          The HSM hardware certificate issued (signed) by the hardware manufacturer.

        • ClusterCertificate — (String)

          The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

deleteHsm(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

• DeleteHsm

Examples:

Calling the deleteHsm operation

var params = {
  ClusterId: 'STRING_VALUE', /* required */
  EniId: 'STRING_VALUE',
  EniIp: 'STRING_VALUE',
  HsmId: 'STRING_VALUE'
};
cloudhsmv2.deleteHsm(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClusterId — (String)

    The identifier (ID) of the cluster that contains the HSM that you are deleting.

  • HsmId — (String)

    The identifier (ID) of the HSM that you are deleting.

  • EniId — (String)

    The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.

  • EniIp — (String)

    The IP address of the elastic network interface (ENI) of the HSM that you are deleting.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • HsmId — (String)

      The identifier (ID) of the HSM that was deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

describeBackups(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

• DescribeBackups

Examples:

Calling the describeBackups operation

var params = {
  Filters: {
    '<Field>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<Field>': ... */
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  SortAscending: true || false
};
cloudhsmv2.describeBackups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    The NextToken value that you received in the previous response. Use this value to get more backups.

  • MaxResults — (Integer)

    The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

  • Filters — (map<Array<String>>)

    One or more filters to limit the items returned in the response.

    Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

    Use 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.

    Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

    Use the states filter to return only backups that match the specified state.

  • SortAscending — (Boolean)

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Backups — (Array<map>)

      A list of backups.

      • BackupId — required — (String)

        The identifier (ID) of the backup.

      • BackupState — (String)

        The state of the backup.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "READY"
        • "DELETED"
        • "PENDING_DELETION"
      • ClusterId — (String)

        The identifier (ID) of the cluster that was backed up.

      • CreateTimestamp — (Date)

        The date and time when the backup was created.

      • CopyTimestamp — (Date)
      • SourceRegion — (String)
      • SourceBackup — (String)
      • SourceCluster — (String)
      • DeleteTimestamp — (Date)

        The date and time when the backup will be permanently deleted.

    • NextToken — (String)

      An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

describeClusters(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

• DescribeClusters

Examples:

Calling the describeClusters operation

var params = {
  Filters: {
    '<Field>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<Field>': ... */
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
cloudhsmv2.describeClusters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filters — (map<Array<String>>)

    One or more filters to limit the items returned in the response.

    Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

    Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

    Use the states filter to return only clusters that match the specified state.

  • NextToken — (String)

    The NextToken value that you received in the previous response. Use this value to get more clusters.

  • MaxResults — (Integer)

    The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Clusters — (Array<map>)

      A list of clusters.

      • BackupPolicy — (String)

        The cluster's backup policy.

        Possible values include:
        • "DEFAULT"
      • ClusterId — (String)

        The cluster's identifier (ID).

      • CreateTimestamp — (Date)

        The date and time when the cluster was created.

      • Hsms — (Array<map>)

        Contains information about the HSMs in the cluster.

        • AvailabilityZone — (String)

          The Availability Zone that contains the HSM.

        • ClusterId — (String)

          The identifier (ID) of the cluster that contains the HSM.

        • SubnetId — (String)

          The subnet that contains the HSM's elastic network interface (ENI).

        • EniId — (String)

          The identifier (ID) of the HSM's elastic network interface (ENI).

        • EniIp — (String)

          The IP address of the HSM's elastic network interface (ENI).

        • HsmId — required — (String)

          The HSM's identifier (ID).

        • State — (String)

          The HSM's state.

          Possible values include:
          • "CREATE_IN_PROGRESS"
          • "ACTIVE"
          • "DEGRADED"
          • "DELETE_IN_PROGRESS"
          • "DELETED"
        • StateMessage — (String)

          A description of the HSM's state.

      • HsmType — (String)

        The type of HSM that the cluster contains.

      • PreCoPassword — (String)

        The default password for the cluster's Pre-Crypto Officer (PRECO) user.

      • SecurityGroup — (String)

        The identifier (ID) of the cluster's security group.

      • SourceBackupId — (String)

        The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

      • State — (String)

        The cluster's state.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "UNINITIALIZED"
        • "INITIALIZE_IN_PROGRESS"
        • "INITIALIZED"
        • "ACTIVE"
        • "UPDATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "DELETED"
        • "DEGRADED"
      • StateMessage — (String)

        A description of the cluster's state.

      • SubnetMapping — (map<String>)

        A map of the cluster's subnets and their corresponding Availability Zones.

      • VpcId — (String)

        The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

      • Certificates — (map)

        Contains one or more certificates or a certificate signing request (CSR).

        • ClusterCsr — (String)

          The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED.

        • HsmCertificate — (String)

          The HSM certificate issued (signed) by the HSM hardware.

        • AwsHardwareCertificate — (String)

          The HSM hardware certificate issued (signed) by AWS CloudHSM.

        • ManufacturerHardwareCertificate — (String)

          The HSM hardware certificate issued (signed) by the hardware manufacturer.

        • ClusterCertificate — (String)

          The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.

    • NextToken — (String)

      An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters request to get more clusters.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

initializeCluster(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

• InitializeCluster

Examples:

Calling the initializeCluster operation

var params = {
  ClusterId: 'STRING_VALUE', /* required */
  SignedCert: 'STRING_VALUE', /* required */
  TrustAnchor: 'STRING_VALUE' /* required */
};
cloudhsmv2.initializeCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClusterId — (String)

    The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.

  • SignedCert — (String)

    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.

  • TrustAnchor — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • State — (String)

      The cluster's state.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "UNINITIALIZED"
      • "INITIALIZE_IN_PROGRESS"
      • "INITIALIZED"
      • "ACTIVE"
      • "UPDATE_IN_PROGRESS"
      • "DELETE_IN_PROGRESS"
      • "DELETED"
      • "DEGRADED"
    • StateMessage — (String)

      A description of the cluster's state.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

listTags(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

• ListTags

Examples:

Calling the listTags operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
cloudhsmv2.listTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceId — (String)

    The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.

  • NextToken — (String)

    The NextToken value that you received in the previous response. Use this value to get more tags.

  • MaxResults — (Integer)

    The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a NextToken value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TagList — (Array<map>)

      A list of tags.

      • Key — required — (String)

        The key of the tag.

      • Value — required — (String)

        The value of the tag.

    • NextToken — (String)

      An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent ListTags request to get more tags.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

restoreBackup(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

• RestoreBackup

Examples:

Calling the restoreBackup operation

var params = {
  BackupId: 'STRING_VALUE' /* required */
};
cloudhsmv2.restoreBackup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • BackupId — (String)

    The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Backup — (map)

      Information on the Backup object created.

      • BackupId — required — (String)

        The identifier (ID) of the backup.

      • BackupState — (String)

        The state of the backup.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "READY"
        • "DELETED"
        • "PENDING_DELETION"
      • ClusterId — (String)

        The identifier (ID) of the cluster that was backed up.

      • CreateTimestamp — (Date)

        The date and time when the backup was created.

      • CopyTimestamp — (Date)
      • SourceRegion — (String)
      • SourceBackup — (String)
      • SourceCluster — (String)
      • DeleteTimestamp — (Date)

        The date and time when the backup will be permanently deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

• TagResource

Examples:

Calling the tagResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  TagList: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
cloudhsmv2.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceId — (String)

    The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.

  • TagList — (Array<map>)

    A list of one or more tags.

    • Key — required — (String)

      The key of the tag.

    • Value — required — (String)

      The value of the tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

• UntagResource

Examples:

Calling the untagResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  TagKeyList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudhsmv2.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceId — (String)

    The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.

  • TagKeyList — (Array<String>)

    A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.