Class: AWS.CloudHSM

Inherits:
AWS.Service show all
Identifier:
cloudhsm
API Version:
2014-05-30
Defined in:
(unknown)

Overview

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

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();

Version:

  • 2014-05-30

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a CloudHSM object

var cloudhsm = new AWS.CloudHSM({apiVersion: '2014-05-30'});

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.CloudHSM.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.CloudHSM.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 accept 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.

Property Details

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

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

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

Each tag consists of a key and a value. Tag keys must be unique to each resource.

Service Reference:

Examples:

Calling the addTagsToResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagList: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
cloudhsm.addTagsToResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.

    • TagList — (Array<map>)

      One or more tags.

      • Keyrequired — (String)

        The key of the tag.

      • Valuerequired — (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. The data object has the following properties:

      • Status — (String)

        The status of the operation.

Returns:

  • (AWS.Request)

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

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

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

Service Reference:

Examples:

Calling the createHapg operation

var params = {
  Label: 'STRING_VALUE' /* required */
};
cloudhsm.createHapg(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: {})
    • Label — (String)

      The label of the new high-availability partition group.

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:

      • HapgArn — (String)

        The ARN of the high-availability partition group.

Returns:

  • (AWS.Request)

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

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

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.

Service Reference:

Examples:

Calling the createHsm operation

var params = {
  IamRoleArn: 'STRING_VALUE', /* required */
  SshKey: 'STRING_VALUE', /* required */
  SubnetId: 'STRING_VALUE', /* required */
  SubscriptionType: PRODUCTION, /* required */
  ClientToken: 'STRING_VALUE',
  EniIp: 'STRING_VALUE',
  ExternalId: 'STRING_VALUE',
  SyslogIp: 'STRING_VALUE'
};
cloudhsm.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: {})
    • SubnetId — (String)

      The identifier of the subnet in your VPC in which to place the HSM.

    • SshKey — (String)

      The SSH public key to install on the HSM.

    • EniIp — (String)

      The IP address to assign to the HSM's ENI.

      If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

    • IamRoleArn — (String)

      The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

    • ExternalId — (String)

      The external ID from IamRoleArn, if present.

    • SubscriptionType — (String)

      Specifies the type of subscription for the HSM.

      • PRODUCTION - The HSM is being used in a production environment.
      • TRIAL - The HSM is being used in a product trial.
      Possible values include:
      • "PRODUCTION"
    • ClientToken — (String)

      A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

    • SyslogIp — (String)

      The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

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:

      • HsmArn — (String)

        The ARN of the HSM.

Returns:

  • (AWS.Request)

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

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

Creates an HSM client.

Service Reference:

Examples:

Calling the createLunaClient operation

var params = {
  Certificate: 'STRING_VALUE', /* required */
  Label: 'STRING_VALUE'
};
cloudhsm.createLunaClient(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: {})
    • Label — (String)

      The label for the client.

    • Certificate — (String)

      The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.

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:

      • ClientArn — (String)

        The ARN of the client.

Returns:

  • (AWS.Request)

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

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

Deletes a high-availability partition group.

Service Reference:

Examples:

Calling the deleteHapg operation

var params = {
  HapgArn: 'STRING_VALUE' /* required */
};
cloudhsm.deleteHapg(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: {})
    • HapgArn — (String)

      The ARN of the high-availability partition group to delete.

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:

      • Status — (String)

        The status of the action.

Returns:

  • (AWS.Request)

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

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

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

Service Reference:

Examples:

Calling the deleteHsm operation

var params = {
  HsmArn: 'STRING_VALUE' /* required */
};
cloudhsm.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: {})
    • HsmArn — (String)

      The ARN of the HSM to delete.

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:

      • Status — (String)

        The status of the operation.

Returns:

  • (AWS.Request)

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

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

Deletes a client.

Service Reference:

Examples:

Calling the deleteLunaClient operation

var params = {
  ClientArn: 'STRING_VALUE' /* required */
};
cloudhsm.deleteLunaClient(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: {})
    • ClientArn — (String)

      The ARN of the client to delete.

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:

      • Status — (String)

        The status of the action.

Returns:

  • (AWS.Request)

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

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

Retrieves information about a high-availability partition group.

Service Reference:

Examples:

Calling the describeHapg operation

var params = {
  HapgArn: 'STRING_VALUE' /* required */
};
cloudhsm.describeHapg(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: {})
    • HapgArn — (String)

      The ARN of the high-availability partition group to describe.

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:

      • HapgArn — (String)

        The ARN of the high-availability partition group.

      • HapgSerial — (String)

        The serial number of the high-availability partition group.

      • HsmsLastActionFailed — (Array<String>)

        Contains a list of ARNs that identify the HSMs.

      • HsmsPendingDeletion — (Array<String>)

        Contains a list of ARNs that identify the HSMs.

      • HsmsPendingRegistration — (Array<String>)

        Contains a list of ARNs that identify the HSMs.

      • Label — (String)

        The label for the high-availability partition group.

      • LastModifiedTimestamp — (String)

        The date and time the high-availability partition group was last modified.

      • PartitionSerialList — (Array<String>)

        The list of partition serial numbers that belong to the high-availability partition group.

      • State — (String)

        The state of the high-availability partition group.

        Possible values include:
        • "READY"
        • "UPDATING"
        • "DEGRADED"

Returns:

  • (AWS.Request)

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

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

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

Service Reference:

Examples:

Calling the describeHsm operation

var params = {
  HsmArn: 'STRING_VALUE',
  HsmSerialNumber: 'STRING_VALUE'
};
cloudhsm.describeHsm(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: {})
    • HsmArn — (String)

      The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

    • HsmSerialNumber — (String)

      The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

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:

      • HsmArn — (String)

        The ARN of the HSM.

      • Status — (String)

        The status of the HSM.

        Possible values include:
        • "PENDING"
        • "RUNNING"
        • "UPDATING"
        • "SUSPENDED"
        • "TERMINATING"
        • "TERMINATED"
        • "DEGRADED"
      • StatusDetails — (String)

        Contains additional information about the status of the HSM.

      • AvailabilityZone — (String)

        The Availability Zone that the HSM is in.

      • EniId — (String)

        The identifier of the elastic network interface (ENI) attached to the HSM.

      • EniIp — (String)

        The IP address assigned to the HSM's ENI.

      • SubscriptionType — (String)

        Specifies the type of subscription for the HSM.

        • PRODUCTION - The HSM is being used in a production environment.
        • TRIAL - The HSM is being used in a product trial.
        Possible values include:
        • "PRODUCTION"
      • SubscriptionStartDate — (String)

        The subscription start date.

      • SubscriptionEndDate — (String)

        The subscription end date.

      • VpcId — (String)

        The identifier of the VPC that the HSM is in.

      • SubnetId — (String)

        The identifier of the subnet that the HSM is in.

      • IamRoleArn — (String)

        The ARN of the IAM role assigned to the HSM.

      • SerialNumber — (String)

        The serial number of the HSM.

      • VendorName — (String)

        The name of the HSM vendor.

      • HsmType — (String)

        The HSM model type.

      • SoftwareVersion — (String)

        The HSM software version.

      • SshPublicKey — (String)

        The public SSH key.

      • SshKeyLastUpdated — (String)

        The date and time that the SSH key was last updated.

      • ServerCertUri — (String)

        The URI of the certificate server.

      • ServerCertLastUpdated — (String)

        The date and time that the server certificate was last updated.

      • Partitions — (Array<String>)

        The list of partitions on the HSM.

Returns:

  • (AWS.Request)

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

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

Retrieves information about an HSM client.

Service Reference:

Examples:

Calling the describeLunaClient operation

var params = {
  CertificateFingerprint: 'STRING_VALUE',
  ClientArn: 'STRING_VALUE'
};
cloudhsm.describeLunaClient(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: {})
    • ClientArn — (String)

      The ARN of the client.

    • CertificateFingerprint — (String)

      The certificate fingerprint.

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:

      • ClientArn — (String)

        The ARN of the client.

      • Certificate — (String)

        The certificate installed on the HSMs used by this client.

      • CertificateFingerprint — (String)

        The certificate fingerprint.

      • LastModifiedTimestamp — (String)

        The date and time the client was last modified.

      • Label — (String)

        The label of the client.

Returns:

  • (AWS.Request)

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

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

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

Service Reference:

Examples:

Calling the getConfig operation

var params = {
  ClientArn: 'STRING_VALUE', /* required */
  ClientVersion: 5.1 | 5.3, /* required */
  HapgList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudhsm.getConfig(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: {})
    • ClientArn — (String)

      The ARN of the client.

    • ClientVersion — (String)

      The client version.

      Possible values include:
      • "5.1"
      • "5.3"
    • HapgList — (Array<String>)

      A list of ARNs that identify the high-availability partition groups that are associated with the client.

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:

      • ConfigType — (String)

        The type of credentials.

      • ConfigFile — (String)

        The chrystoki.conf configuration file.

      • ConfigCred — (String)

        The certificate file containing the server.pem files of the HSMs.

Returns:

  • (AWS.Request)

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

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

Lists the Availability Zones that have available AWS CloudHSM capacity.

Service Reference:

Examples:

Calling the listAvailableZones operation

var params = {
};
cloudhsm.listAvailableZones(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: {})

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:

      • AZList — (Array<String>)

        The list of Availability Zones that have available AWS CloudHSM capacity.

Returns:

  • (AWS.Request)

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

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

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Service Reference:

Examples:

Calling the listHapgs operation

var params = {
  NextToken: 'STRING_VALUE'
};
cloudhsm.listHapgs(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 from a previous call to ListHapgs. Pass null if this is the first call.

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:

      • HapgList — (Array<String>)

        The list of high-availability partition groups.

      • NextToken — (String)

        If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.

Returns:

  • (AWS.Request)

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

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

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Service Reference:

Examples:

Calling the listHsms operation

var params = {
  NextToken: 'STRING_VALUE'
};
cloudhsm.listHsms(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 from a previous call to ListHsms. Pass null if this is the first call.

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:

      • HsmList — (Array<String>)

        The list of ARNs that identify the HSMs.

      • NextToken — (String)

        If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.

Returns:

  • (AWS.Request)

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

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

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

Service Reference:

Examples:

Calling the listLunaClients operation

var params = {
  NextToken: 'STRING_VALUE'
};
cloudhsm.listLunaClients(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 from a previous call to ListLunaClients. Pass null if this is the first call.

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:

      • ClientList — (Array<String>)

        The list of clients.

      • NextToken — (String)

        If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.

Returns:

  • (AWS.Request)

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

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

Returns a list of all tags for the specified AWS CloudHSM resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
cloudhsm.listTagsForResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

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>)

        One or more tags.

        • Keyrequired — (String)

          The key of the tag.

        • Valuerequired — (String)

          The value of the tag.

Returns:

  • (AWS.Request)

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

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

Modifies an existing high-availability partition group.

Service Reference:

Examples:

Calling the modifyHapg operation

var params = {
  HapgArn: 'STRING_VALUE', /* required */
  Label: 'STRING_VALUE',
  PartitionSerialList: [
    'STRING_VALUE',
    /* more items */
  ]
};
cloudhsm.modifyHapg(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: {})
    • HapgArn — (String)

      The ARN of the high-availability partition group to modify.

    • Label — (String)

      The new label for the high-availability partition group.

    • PartitionSerialList — (Array<String>)

      The list of partition serial numbers to make members of the high-availability partition group.

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:

      • HapgArn — (String)

        The ARN of the high-availability partition group.

Returns:

  • (AWS.Request)

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

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

Modifies an HSM.

This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

Service Reference:

Examples:

Calling the modifyHsm operation

var params = {
  HsmArn: 'STRING_VALUE', /* required */
  EniIp: 'STRING_VALUE',
  ExternalId: 'STRING_VALUE',
  IamRoleArn: 'STRING_VALUE',
  SubnetId: 'STRING_VALUE',
  SyslogIp: 'STRING_VALUE'
};
cloudhsm.modifyHsm(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: {})
    • HsmArn — (String)

      The ARN of the HSM to modify.

    • SubnetId — (String)

      The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

    • EniIp — (String)

      The new IP address for the elastic network interface (ENI) attached to the HSM.

      If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

    • IamRoleArn — (String)

      The new IAM role ARN.

    • ExternalId — (String)

      The new external ID.

    • SyslogIp — (String)

      The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

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:

      • HsmArn — (String)

        The ARN of the HSM.

Returns:

  • (AWS.Request)

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

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

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client's HSMs.

Service Reference:

Examples:

Calling the modifyLunaClient operation

var params = {
  Certificate: 'STRING_VALUE', /* required */
  ClientArn: 'STRING_VALUE' /* required */
};
cloudhsm.modifyLunaClient(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: {})
    • ClientArn — (String)

      The ARN of the client.

    • Certificate — (String)

      The new certificate for the client.

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:

      • ClientArn — (String)

        The ARN of the client.

Returns:

  • (AWS.Request)

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

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

Removes one or more tags from the specified AWS CloudHSM resource.

To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

Service Reference:

Examples:

Calling the removeTagsFromResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeyList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
cloudhsm.removeTagsFromResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

    • TagKeyList — (Array<String>)

      The tag key or keys to remove.

      Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

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:

      • Status — (String)

        The status of the operation.

Returns:

  • (AWS.Request)

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