The AWS SDK for JavaScript v2 has reached end-of-support.
We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

Class: AWS.CloudHSMV2

Inherits:
AWS.Service show all
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 CloudHSM, see CloudHSM and the 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 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.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|AWS.Endpoint) —

    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' or an Endpoint object.

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

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

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

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 CloudHSM cluster backup to a different region.

Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

Service Reference:

Examples:

Calling the copyBackupToRegion operation

var params = {
  BackupId: 'STRING_VALUE', /* required */
  DestinationRegion: 'STRING_VALUE', /* required */
  TagList: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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.

    • TagList — (Array<map>)

      Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.

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

          The date and time when both the source backup was created.

        • SourceRegion — (String)

          The AWS region that contains the source backup from which the new backup was copied.

        • SourceBackup — (String)

          The identifier (ID) of the source backup from which the new backup was copied.

        • SourceCluster — (String)

          The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

Returns:

  • (AWS.Request) —

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

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

Creates a new CloudHSM cluster.

Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.

Service Reference:

Examples:

Calling the createCluster operation

var params = {
  HsmType: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  BackupRetentionPolicy: {
    Type: DAYS,
    Value: 'STRING_VALUE'
  },
  Mode: FIPS | NON_FIPS,
  SourceBackupId: 'STRING_VALUE',
  TagList: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
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: {}) —
    • BackupRetentionPolicy — (map)

      A policy that defines how the service retains backups.

      • Type — (String)

        The type of backup retention policy. For the DAYS type, the value is the number of days to retain backups.

        Possible values include:
        • "DAYS"
      • Value — (String)

        Use a value between 7 - 379.

    • HsmType — (String)

      The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

    • SourceBackupId — (String)

      The identifier (ID) or the Amazon Resource Name (ARN) 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 or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

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

    • TagList — (Array<map>)

      Tags to apply to the CloudHSM cluster during creation.

      • Key — required — (String)

        The key of the tag.

      • Value — required — (String)

        The value of the tag.

    • Mode — (String)

      The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

      Possible values include:
      • "FIPS"
      • "NON_FIPS"

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"
        • BackupRetentionPolicy — (map)

          A policy that defines how the service retains backups.

          • Type — (String)

            The type of backup retention policy. For the DAYS type, the value is the number of days to retain backups.

            Possible values include:
            • "DAYS"
          • Value — (String)

            Use a value between 7 - 379.

        • 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 from availability zone to the cluster’s subnet in that availability zone.

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

        • TagList — (Array<map>)

          The list of tags for the cluster.

          • Key — required — (String)

            The key of the tag.

          • Value — required — (String)

            The value of the tag.

        • Mode — (String)

          The mode of the cluster.

          Possible values include:
          • "FIPS"
          • "NON_FIPS"

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 CloudHSM cluster.

Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.

Service Reference:

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: