Class: AWS.CloudHSMV2

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.

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.

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.

      • BackupArn — (String)

        The Amazon Resource Name (ARN) 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)

        The date and time when the backup was copied from a source backup.

      • NeverExpires — (Boolean)

        Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

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

      • DeleteTimestamp — (Date)

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

      • TagList — (Array<map>)

        The list of tags for the backup.

        • Key — required — (String)

          The key of the tag.

        • Value — required — (String)

          The value of the tag.

      • HsmType — (String)

        The HSM type used to create the backup.

      • Mode — (String)

        The mode of the cluster that was backed up.

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

Returns:

• (AWS.Request) —

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

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

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.

var params = {
  ResourceArn: 'STRING_VALUE'
};
cloudhsmv2.deleteResourcePolicy(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)

    Amazon Resource Name (ARN) of the resource from which the policy will be removed.

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:

    • ResourceArn — (String)

      Amazon Resource Name (ARN) of the resource from which the policy was deleted.

    • Policy — (String)

      The policy previously attached to the resource.

Returns:

• (AWS.Request) —

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

var params = {
  Filters: {
    '<Field>': [
      'STRING_VALUE',
      /* more items */
    ],
    /* '<Field>': ... */
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Shared: true || false,
  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.

    Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

  • Shared — (Boolean)

    Describe backups that are shared with you.

    Note: By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.
  • SortAscending — (Boolean)

    Designates whether or not to sort the return backups by ascending chronological order of generation.

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.

      • BackupArn — (String)

        The Amazon Resource Name (ARN) 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)

        The date and time when the backup was copied from a source backup.

      • NeverExpires — (Boolean)

        Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

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

      • DeleteTimestamp — (Date)

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

      • TagList — (Array<map>)

        The list of tags for the backup.

        • Key — required — (String)

          The key of the tag.

        • Value — required — (String)

          The value of the tag.

      • HsmType — (String)

        The HSM type used to create the backup.

      • Mode — (String)

        The mode of the cluster that was backed up.

        Possible values include:
        • "FIPS"
        • "NON_FIPS"
    • 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.

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

var params = {
  ResourceArn: 'STRING_VALUE'
};
cloudhsmv2.getResourcePolicy(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)

    Amazon Resource Name (ARN) of the resource to which a policy is attached.

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:

    • Policy — (String)

      The policy attached to a resource.

Returns:

• (AWS.Request) —

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

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. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate 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.

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.

var params = {
  BackupId: 'STRING_VALUE', /* required */
  NeverExpires: true || false /* required */
};
cloudhsmv2.modifyBackupAttributes(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 identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.

  • NeverExpires — (Boolean)

    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

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)

      Contains information about a backup of an CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.

      • BackupId — required — (String)

        The identifier (ID) of the backup.

      • BackupArn — (String)

        The Amazon Resource Name (ARN) 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)

        The date and time when the backup was copied from a source backup.

      • NeverExpires — (Boolean)

        Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

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

      • DeleteTimestamp — (Date)

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

      • TagList — (Array<map>)

        The list of tags for the backup.

        • Key — required — (String)

          The key of the tag.

        • Value — required — (String)

          The value of the tag.

      • HsmType — (String)

        The HSM type used to create the backup.

      • Mode — (String)

        The mode of the cluster that was backed up.

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

Returns:

• (AWS.Request) —

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

var params = {
  BackupRetentionPolicy: { /* required */
    Type: DAYS,
    Value: 'STRING_VALUE'
  },
  ClusterId: 'STRING_VALUE' /* required */
};
cloudhsmv2.modifyCluster(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.

  • ClusterId — (String)

    The identifier (ID) of the cluster that you want to modify. 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)

      Contains information about an CloudHSM cluster.

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

var params = {
  Policy: 'STRING_VALUE',
  ResourceArn: 'STRING_VALUE'
};
cloudhsmv2.putResourcePolicy(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)

    Amazon Resource Name (ARN) of the resource to which you want to attach a policy.

  • Policy — (String)

    The policy you want to associate with a resource.

    For an example policy, see Working with shared backups in the CloudHSM User Guide

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:

    • ResourceArn — (String)

      Amazon Resource Name (ARN) of the resource to which a policy is attached.

    • Policy — (String)

      The policy attached to a resource.

Returns:

• (AWS.Request) —

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

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.

      • BackupArn — (String)

        The Amazon Resource Name (ARN) 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)

        The date and time when the backup was copied from a source backup.

      • NeverExpires — (Boolean)

        Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

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

      • DeleteTimestamp — (Date)

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

      • TagList — (Array<map>)

        The list of tags for the backup.

        • Key — required — (String)

          The key of the tag.

        • Value — required — (String)

          The value of the tag.

      • HsmType — (String)

        The HSM type used to create the backup.

      • Mode — (String)

        The mode of the cluster that was backed up.

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

Returns:

• (AWS.Request) —

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

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.

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.