CloudHSMV2 | CloudHSM V2 Client - AWS SDK for JavaScript v3

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

Hierarchy

CloudHSMV2Client
CloudHSMV2Client
- CloudHSMV2

Implements

Client<ServiceInputTypes, ServiceOutputTypes, CloudHSMV2ClientResolvedConfig>
Client<ServiceInputTypes, ServiceOutputTypes, CloudHSMV2ClientResolvedConfig>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CloudHSMV2(configuration: CloudHSMV2ClientConfig): CloudHSMV2

Inherited from CloudHSMV2Client.constructor

Overrides Client.constructor
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2Client.d.ts:151
Parameters
- configuration: CloudHSMV2ClientConfig
Returns CloudHSMV2

Properties

Readonly config

config: CloudHSMV2ClientResolvedConfig

The resolved configuration of CloudHSMV2Client class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

middlewareStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>

Methods

copyBackupToRegion

copyBackupToRegion(args: CopyBackupToRegionCommandInput, options?: __HttpHandlerOptions): Promise<CopyBackupToRegionCommandOutput>
copyBackupToRegion(args: CopyBackupToRegionCommandInput, cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void): void
copyBackupToRegion(args: CopyBackupToRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void): void
copyBackupToRegion(args: CopyBackupToRegionCommandInput, options?: __HttpHandlerOptions): Promise<CopyBackupToRegionCommandOutput>
copyBackupToRegion(args: CopyBackupToRegionCommandInput, cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void): void
copyBackupToRegion(args: CopyBackupToRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:26
Copy an AWS CloudHSM cluster backup to a different region.

Parameters
- args: CopyBackupToRegionCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CopyBackupToRegionCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:27
Copy an AWS CloudHSM cluster backup to a different region.

Parameters
- args: CopyBackupToRegionCommandInput
- cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void
  - - (err: any, data?: CopyBackupToRegionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CopyBackupToRegionCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:28
Copy an AWS CloudHSM cluster backup to a different region.

Parameters
- args: CopyBackupToRegionCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void
  - - (err: any, data?: CopyBackupToRegionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CopyBackupToRegionCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:73
Copy an AWS CloudHSM cluster backup to a different region.

Parameters
- args: CopyBackupToRegionCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CopyBackupToRegionCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:77
Copy an AWS CloudHSM cluster backup to a different region.

Parameters
- args: CopyBackupToRegionCommandInput
- cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void
  - - (err: any, data?: CopyBackupToRegionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CopyBackupToRegionCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:81
Copy an AWS CloudHSM cluster backup to a different region.

Parameters
- args: CopyBackupToRegionCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void
  - - (err: any, data?: CopyBackupToRegionCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CopyBackupToRegionCommandOutput
      Returns void
Returns void

createCluster

createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateClusterCommandOutput>
createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void
createCluster(args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void): void
createCluster(args: CreateClusterCommandInput, options?: __HttpHandlerOptions): Promise<CreateClusterCommandOutput>
createCluster(args: CreateClusterCommandInput, cb: (err: any, data?: CreateClusterCommandOutput) => void): void
createCluster(args: CreateClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateClusterCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:32
Creates a new AWS CloudHSM cluster.

Parameters
- args: CreateClusterCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreateClusterCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:33
Creates a new AWS CloudHSM cluster.

Parameters
- args: CreateClusterCommandInput
- cb: (err: any, data?: CreateClusterCommandOutput) => void
  - - (err: any, data?: CreateClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:34
Creates a new AWS CloudHSM cluster.

Parameters
- args: CreateClusterCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreateClusterCommandOutput) => void
  - - (err: any, data?: CreateClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:105
Creates a new AWS CloudHSM cluster.

Parameters
- args: CreateClusterCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreateClusterCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:109
Creates a new AWS CloudHSM cluster.

Parameters
- args: CreateClusterCommandInput
- cb: (err: any, data?: CreateClusterCommandOutput) => void
  - - (err: any, data?: CreateClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:113
Creates a new AWS CloudHSM cluster.

Parameters
- args: CreateClusterCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreateClusterCommandOutput) => void
  - - (err: any, data?: CreateClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateClusterCommandOutput
      Returns void
Returns void

createHsm

createHsm(args: CreateHsmCommandInput, options?: __HttpHandlerOptions): Promise<CreateHsmCommandOutput>
createHsm(args: CreateHsmCommandInput, cb: (err: any, data?: CreateHsmCommandOutput) => void): void
createHsm(args: CreateHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHsmCommandOutput) => void): void
createHsm(args: CreateHsmCommandInput, options?: __HttpHandlerOptions): Promise<CreateHsmCommandOutput>
createHsm(args: CreateHsmCommandInput, cb: (err: any, data?: CreateHsmCommandOutput) => void): void
createHsm(args: CreateHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateHsmCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:39
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Parameters
- args: CreateHsmCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreateHsmCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:40
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Parameters
- args: CreateHsmCommandInput
- cb: (err: any, data?: CreateHsmCommandOutput) => void
  - - (err: any, data?: CreateHsmCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateHsmCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:41
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Parameters
- args: CreateHsmCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreateHsmCommandOutput) => void
  - - (err: any, data?: CreateHsmCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateHsmCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:138
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Parameters
- args: CreateHsmCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<CreateHsmCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:139
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Parameters
- args: CreateHsmCommandInput
- cb: (err: any, data?: CreateHsmCommandOutput) => void
  - - (err: any, data?: CreateHsmCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateHsmCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:140
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Parameters
- args: CreateHsmCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: CreateHsmCommandOutput) => void
  - - (err: any, data?: CreateHsmCommandOutput): void
    - Parameters
      - err: any
      - Optional data: CreateHsmCommandOutput
      Returns void
Returns void

deleteBackup

deleteBackup(args: DeleteBackupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBackupCommandOutput>
deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void
deleteBackup(args: DeleteBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void
deleteBackup(args: DeleteBackupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBackupCommandOutput>
deleteBackup(args: DeleteBackupCommandInput, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void
deleteBackup(args: DeleteBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBackupCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:47
Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.

Parameters
- args: DeleteBackupCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DeleteBackupCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:48
Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.

Parameters
- args: DeleteBackupCommandInput
- cb: (err: any, data?: DeleteBackupCommandOutput) => void
  - - (err: any, data?: DeleteBackupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteBackupCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:49
Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.

Parameters
- args: DeleteBackupCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DeleteBackupCommandOutput) => void
  - - (err: any, data?: DeleteBackupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteBackupCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:166
Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.

Parameters
- args: DeleteBackupCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DeleteBackupCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:170
Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.

Parameters
- args: DeleteBackupCommandInput
- cb: (err: any, data?: DeleteBackupCommandOutput) => void
  - - (err: any, data?: DeleteBackupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteBackupCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:171
Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.

Parameters
- args: DeleteBackupCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DeleteBackupCommandOutput) => void
  - - (err: any, data?: DeleteBackupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteBackupCommandOutput
      Returns void
Returns void

deleteCluster

deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteClusterCommandOutput>
deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void
deleteCluster(args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void
deleteCluster(args: DeleteClusterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteClusterCommandOutput>
deleteCluster(args: DeleteClusterCommandInput, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void
deleteCluster(args: DeleteClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteClusterCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:54
Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

Parameters
- args: DeleteClusterCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DeleteClusterCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:55
Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

Parameters
- args: DeleteClusterCommandInput
- cb: (err: any, data?: DeleteClusterCommandOutput) => void
  - - (err: any, data?: DeleteClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:56
Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

Parameters
- args: DeleteClusterCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DeleteClusterCommandOutput) => void
  - - (err: any, data?: DeleteClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:196
Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

Parameters
- args: DeleteClusterCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DeleteClusterCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:200
Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

Parameters
- args: DeleteClusterCommandInput
- cb: (err: any, data?: DeleteClusterCommandOutput) => void
  - - (err: any, data?: DeleteClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:204
Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

Parameters
- args: DeleteClusterCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DeleteClusterCommandOutput) => void
  - - (err: any, data?: DeleteClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteClusterCommandOutput
      Returns void
Returns void

deleteHsm

deleteHsm(args: DeleteHsmCommandInput, options?: __HttpHandlerOptions): Promise<DeleteHsmCommandOutput>
deleteHsm(args: DeleteHsmCommandInput, cb: (err: any, data?: DeleteHsmCommandOutput) => void): void
deleteHsm(args: DeleteHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHsmCommandOutput) => void): void
deleteHsm(args: DeleteHsmCommandInput, options?: __HttpHandlerOptions): Promise<DeleteHsmCommandOutput>
deleteHsm(args: DeleteHsmCommandInput, cb: (err: any, data?: DeleteHsmCommandOutput) => void): void
deleteHsm(args: DeleteHsmCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteHsmCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:62
Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Parameters
- args: DeleteHsmCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DeleteHsmCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:63
Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Parameters
- args: DeleteHsmCommandInput
- cb: (err: any, data?: DeleteHsmCommandOutput) => void
  - - (err: any, data?: DeleteHsmCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteHsmCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:64
Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Parameters
- args: DeleteHsmCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DeleteHsmCommandOutput) => void
  - - (err: any, data?: DeleteHsmCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteHsmCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:230
Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Parameters
- args: DeleteHsmCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DeleteHsmCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:231
Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Parameters
- args: DeleteHsmCommandInput
- cb: (err: any, data?: DeleteHsmCommandOutput) => void
  - - (err: any, data?: DeleteHsmCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteHsmCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:232
Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Parameters
- args: DeleteHsmCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DeleteHsmCommandOutput) => void
  - - (err: any, data?: DeleteHsmCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DeleteHsmCommandOutput
      Returns void
Returns void

describeBackups

describeBackups(args: DescribeBackupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBackupsCommandOutput>
describeBackups(args: DescribeBackupsCommandInput, cb: (err: any, data?: DescribeBackupsCommandOutput) => void): void
describeBackups(args: DescribeBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupsCommandOutput) => void): void
describeBackups(args: DescribeBackupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBackupsCommandOutput>
describeBackups(args: DescribeBackupsCommandInput, cb: (err: any, data?: DescribeBackupsCommandOutput) => void): void
describeBackups(args: DescribeBackupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBackupsCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:73
Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

Parameters
- args: DescribeBackupsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DescribeBackupsCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:74
Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

Parameters
- args: DescribeBackupsCommandInput
- cb: (err: any, data?: DescribeBackupsCommandOutput) => void
  - - (err: any, data?: DescribeBackupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DescribeBackupsCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:75
Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

Parameters
- args: DescribeBackupsCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DescribeBackupsCommandOutput) => void
  - - (err: any, data?: DescribeBackupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DescribeBackupsCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:261
Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

Parameters
- args: DescribeBackupsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DescribeBackupsCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:265
Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

Parameters
- args: DescribeBackupsCommandInput
- cb: (err: any, data?: DescribeBackupsCommandOutput) => void
  - - (err: any, data?: DescribeBackupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DescribeBackupsCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:269
Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

Parameters
- args: DescribeBackupsCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DescribeBackupsCommandOutput) => void
  - - (err: any, data?: DescribeBackupsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DescribeBackupsCommandOutput
      Returns void
Returns void

describeClusters

describeClusters(args: DescribeClustersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeClustersCommandOutput>
describeClusters(args: DescribeClustersCommandInput, cb: (err: any, data?: DescribeClustersCommandOutput) => void): void
describeClusters(args: DescribeClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClustersCommandOutput) => void): void
describeClusters(args: DescribeClustersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeClustersCommandOutput>
describeClusters(args: DescribeClustersCommandInput, cb: (err: any, data?: DescribeClustersCommandOutput) => void): void
describeClusters(args: DescribeClustersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeClustersCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:84
Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

Parameters
- args: DescribeClustersCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DescribeClustersCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:85
Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

Parameters
- args: DescribeClustersCommandInput
- cb: (err: any, data?: DescribeClustersCommandOutput) => void
  - - (err: any, data?: DescribeClustersCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DescribeClustersCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:86
Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

Parameters
- args: DescribeClustersCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DescribeClustersCommandOutput) => void
  - - (err: any, data?: DescribeClustersCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DescribeClustersCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:298
Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

Parameters
- args: DescribeClustersCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<DescribeClustersCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:302
Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

Parameters
- args: DescribeClustersCommandInput
- cb: (err: any, data?: DescribeClustersCommandOutput) => void
  - - (err: any, data?: DescribeClustersCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DescribeClustersCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:306
Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

Parameters
- args: DescribeClustersCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: DescribeClustersCommandOutput) => void
  - - (err: any, data?: DescribeClustersCommandOutput): void
    - Parameters
      - err: any
      - Optional data: DescribeClustersCommandOutput
      Returns void
Returns void

destroy

destroy(): void

Inherited from CloudHSMV2Client.destroy

Overrides Client.destroy
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2Client.d.ts:158
Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

Returns void

initializeCluster

initializeCluster(args: InitializeClusterCommandInput, options?: __HttpHandlerOptions): Promise<InitializeClusterCommandOutput>
initializeCluster(args: InitializeClusterCommandInput, cb: (err: any, data?: InitializeClusterCommandOutput) => void): void
initializeCluster(args: InitializeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitializeClusterCommandOutput) => void): void
initializeCluster(args: InitializeClusterCommandInput, options?: __HttpHandlerOptions): Promise<InitializeClusterCommandOutput>
initializeCluster(args: InitializeClusterCommandInput, cb: (err: any, data?: InitializeClusterCommandOutput) => void): void
initializeCluster(args: InitializeClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InitializeClusterCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:93
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

Parameters
- args: InitializeClusterCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<InitializeClusterCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:94
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

Parameters
- args: InitializeClusterCommandInput
- cb: (err: any, data?: InitializeClusterCommandOutput) => void
  - - (err: any, data?: InitializeClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: InitializeClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:95
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

Parameters
- args: InitializeClusterCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: InitializeClusterCommandOutput) => void
  - - (err: any, data?: InitializeClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: InitializeClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:333
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

Parameters
- args: InitializeClusterCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<InitializeClusterCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:337
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

Parameters
- args: InitializeClusterCommandInput
- cb: (err: any, data?: InitializeClusterCommandOutput) => void
  - - (err: any, data?: InitializeClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: InitializeClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:341
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

Parameters
- args: InitializeClusterCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: InitializeClusterCommandOutput) => void
  - - (err: any, data?: InitializeClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: InitializeClusterCommandOutput
      Returns void
Returns void

listTags

listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsCommandOutput>
listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void
listTags(args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void): void
listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsCommandOutput>
listTags(args: ListTagsCommandInput, cb: (err: any, data?: ListTagsCommandOutput) => void): void
listTags(args: ListTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:104
Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

Parameters
- args: ListTagsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ListTagsCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:105
Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

Parameters
- args: ListTagsCommandInput
- cb: (err: any, data?: ListTagsCommandOutput) => void
  - - (err: any, data?: ListTagsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListTagsCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:106
Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

Parameters
- args: ListTagsCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ListTagsCommandOutput) => void
  - - (err: any, data?: ListTagsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListTagsCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:370
Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

Parameters
- args: ListTagsCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ListTagsCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:371
Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

Parameters
- args: ListTagsCommandInput
- cb: (err: any, data?: ListTagsCommandOutput) => void
  - - (err: any, data?: ListTagsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListTagsCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:372
Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

Parameters
- args: ListTagsCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ListTagsCommandOutput) => void
  - - (err: any, data?: ListTagsCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ListTagsCommandOutput
      Returns void
Returns void

modifyBackupAttributes

modifyBackupAttributes(args: ModifyBackupAttributesCommandInput, options?: __HttpHandlerOptions): Promise<ModifyBackupAttributesCommandOutput>
modifyBackupAttributes(args: ModifyBackupAttributesCommandInput, cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void): void
modifyBackupAttributes(args: ModifyBackupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void): void
modifyBackupAttributes(args: ModifyBackupAttributesCommandInput, options?: __HttpHandlerOptions): Promise<ModifyBackupAttributesCommandOutput>
modifyBackupAttributes(args: ModifyBackupAttributesCommandInput, cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void): void
modifyBackupAttributes(args: ModifyBackupAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:110
Modifies attributes for AWS CloudHSM backup.

Parameters
- args: ModifyBackupAttributesCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ModifyBackupAttributesCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:111
Modifies attributes for AWS CloudHSM backup.

Parameters
- args: ModifyBackupAttributesCommandInput
- cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void
  - - (err: any, data?: ModifyBackupAttributesCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ModifyBackupAttributesCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:112
Modifies attributes for AWS CloudHSM backup.

Parameters
- args: ModifyBackupAttributesCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void
  - - (err: any, data?: ModifyBackupAttributesCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ModifyBackupAttributesCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:396
Modifies attributes for AWS CloudHSM backup.

Parameters
- args: ModifyBackupAttributesCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ModifyBackupAttributesCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:400
Modifies attributes for AWS CloudHSM backup.

Parameters
- args: ModifyBackupAttributesCommandInput
- cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void
  - - (err: any, data?: ModifyBackupAttributesCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ModifyBackupAttributesCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:404
Modifies attributes for AWS CloudHSM backup.

Parameters
- args: ModifyBackupAttributesCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ModifyBackupAttributesCommandOutput) => void
  - - (err: any, data?: ModifyBackupAttributesCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ModifyBackupAttributesCommandOutput
      Returns void
Returns void

modifyCluster

modifyCluster(args: ModifyClusterCommandInput, options?: __HttpHandlerOptions): Promise<ModifyClusterCommandOutput>
modifyCluster(args: ModifyClusterCommandInput, cb: (err: any, data?: ModifyClusterCommandOutput) => void): void
modifyCluster(args: ModifyClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterCommandOutput) => void): void
modifyCluster(args: ModifyClusterCommandInput, options?: __HttpHandlerOptions): Promise<ModifyClusterCommandOutput>
modifyCluster(args: ModifyClusterCommandInput, cb: (err: any, data?: ModifyClusterCommandOutput) => void): void
modifyCluster(args: ModifyClusterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ModifyClusterCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:116
Modifies AWS CloudHSM cluster.

Parameters
- args: ModifyClusterCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ModifyClusterCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:117
Modifies AWS CloudHSM cluster.

Parameters
- args: ModifyClusterCommandInput
- cb: (err: any, data?: ModifyClusterCommandOutput) => void
  - - (err: any, data?: ModifyClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ModifyClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:118
Modifies AWS CloudHSM cluster.

Parameters
- args: ModifyClusterCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ModifyClusterCommandOutput) => void
  - - (err: any, data?: ModifyClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ModifyClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:428
Modifies AWS CloudHSM cluster.

Parameters
- args: ModifyClusterCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<ModifyClusterCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:432
Modifies AWS CloudHSM cluster.

Parameters
- args: ModifyClusterCommandInput
- cb: (err: any, data?: ModifyClusterCommandOutput) => void
  - - (err: any, data?: ModifyClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ModifyClusterCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:436
Modifies AWS CloudHSM cluster.

Parameters
- args: ModifyClusterCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: ModifyClusterCommandOutput) => void
  - - (err: any, data?: ModifyClusterCommandOutput): void
    - Parameters
      - err: any
      - Optional data: ModifyClusterCommandOutput
      Returns void
Returns void

restoreBackup

restoreBackup(args: RestoreBackupCommandInput, options?: __HttpHandlerOptions): Promise<RestoreBackupCommandOutput>
restoreBackup(args: RestoreBackupCommandInput, cb: (err: any, data?: RestoreBackupCommandOutput) => void): void
restoreBackup(args: RestoreBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreBackupCommandOutput) => void): void
restoreBackup(args: RestoreBackupCommandInput, options?: __HttpHandlerOptions): Promise<RestoreBackupCommandOutput>
restoreBackup(args: RestoreBackupCommandInput, cb: (err: any, data?: RestoreBackupCommandOutput) => void): void
restoreBackup(args: RestoreBackupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RestoreBackupCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:124
Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.

Parameters
- args: RestoreBackupCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<RestoreBackupCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:125
Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.

Parameters
- args: RestoreBackupCommandInput
- cb: (err: any, data?: RestoreBackupCommandOutput) => void
  - - (err: any, data?: RestoreBackupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RestoreBackupCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:126
Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.

Parameters
- args: RestoreBackupCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: RestoreBackupCommandOutput) => void
  - - (err: any, data?: RestoreBackupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RestoreBackupCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:462
Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.

Parameters
- args: RestoreBackupCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<RestoreBackupCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:466
Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.

Parameters
- args: RestoreBackupCommandInput
- cb: (err: any, data?: RestoreBackupCommandOutput) => void
  - - (err: any, data?: RestoreBackupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RestoreBackupCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:470
Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.

Parameters
- args: RestoreBackupCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: RestoreBackupCommandOutput) => void
  - - (err: any, data?: RestoreBackupCommandOutput): void
    - Parameters
      - err: any
      - Optional data: RestoreBackupCommandOutput
      Returns void
Returns void

send

send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options?: HandlerOptions): Promise<OutputType>
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, cb: (err: any, data?: OutputType) => void): void
send<InputType, OutputType>(command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>, options: __HttpHandlerOptions, cb: (err: any, data?: OutputType) => void): void

Inherited from CloudHSMV2Client.send

Overrides CloudHSMV2Client.send
- Defined in packages/smithy-client/dist-types/client.d.ts:16
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- Optional options: HandlerOptions
Returns Promise<OutputType>
Inherited from CloudHSMV2Client.send

Overrides CloudHSMV2Client.send
- Defined in packages/smithy-client/dist-types/client.d.ts:17
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void
Inherited from CloudHSMV2Client.send

Overrides CloudHSMV2Client.send
- Defined in packages/smithy-client/dist-types/client.d.ts:18
Type parameters
- InputType: ServiceInputTypes
- OutputType: ServiceOutputTypes
Parameters
- command: Command<ServiceInputTypes, InputType, ServiceOutputTypes, OutputType, SmithyResolvedConfiguration<__HttpHandlerOptions>>
- options: __HttpHandlerOptions
- cb: (err: any, data?: OutputType) => void
  - - (err: any, data?: OutputType): void
    - Parameters
      - err: any
      - Optional data: OutputType
      Returns void
Returns void

tagResource

tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:130
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Parameters
- args: TagResourceCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<TagResourceCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:131
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Parameters
- args: TagResourceCommandInput
- cb: (err: any, data?: TagResourceCommandOutput) => void
  - - (err: any, data?: TagResourceCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TagResourceCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:132
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Parameters
- args: TagResourceCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: TagResourceCommandOutput) => void
  - - (err: any, data?: TagResourceCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TagResourceCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:494
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Parameters
- args: TagResourceCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<TagResourceCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:495
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Parameters
- args: TagResourceCommandInput
- cb: (err: any, data?: TagResourceCommandOutput) => void
  - - (err: any, data?: TagResourceCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TagResourceCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:496
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Parameters
- args: TagResourceCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: TagResourceCommandOutput) => void
  - - (err: any, data?: TagResourceCommandOutput): void
    - Parameters
      - err: any
      - Optional data: TagResourceCommandOutput
      Returns void
Returns void

untagResource

untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void

- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:136
Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Parameters
- args: UntagResourceCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<UntagResourceCommandOutput>
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:137
Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Parameters
- args: UntagResourceCommandInput
- cb: (err: any, data?: UntagResourceCommandOutput) => void
  - - (err: any, data?: UntagResourceCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UntagResourceCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/dist-types/CloudHSMV2.d.ts:138
Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Parameters
- args: UntagResourceCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: UntagResourceCommandOutput) => void
  - - (err: any, data?: UntagResourceCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UntagResourceCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:520
Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Parameters
- args: UntagResourceCommandInput
- Optional options: __HttpHandlerOptions
Returns Promise<UntagResourceCommandOutput>
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:524
Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Parameters
- args: UntagResourceCommandInput
- cb: (err: any, data?: UntagResourceCommandOutput) => void
  - - (err: any, data?: UntagResourceCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UntagResourceCommandOutput
      Returns void
Returns void
- Defined in clients/client-cloudhsm-v2/src/CloudHSMV2.ts:528
Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Parameters
- args: UntagResourceCommandInput
- options: __HttpHandlerOptions
- cb: (err: any, data?: UntagResourceCommandOutput) => void
  - - (err: any, data?: UntagResourceCommandOutput): void
    - Parameters
      - err: any
      - Optional data: UntagResourceCommandOutput
      Returns void
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: CloudHSMV2ClientConfig

Returns CloudHSMV2

Properties

Readonly config

middlewareStack

Methods

copyBackupToRegion

Parameters

args: CopyBackupToRegionCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CopyBackupToRegionCommandOutput>

Parameters

args: CopyBackupToRegionCommandInput

cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void

Parameters

err: any

Optional data: CopyBackupToRegionCommandOutput

Returns void

Returns void

Parameters

args: CopyBackupToRegionCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void

Parameters

err: any

Optional data: CopyBackupToRegionCommandOutput

Returns void

Returns void

Parameters

args: CopyBackupToRegionCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CopyBackupToRegionCommandOutput>

Parameters

args: CopyBackupToRegionCommandInput

cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void

Parameters

err: any

Optional data: CopyBackupToRegionCommandOutput

Returns void

Returns void

Parameters

args: CopyBackupToRegionCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: CopyBackupToRegionCommandOutput) => void

Parameters

err: any

Optional data: CopyBackupToRegionCommandOutput

Returns void

Returns void

createCluster

Parameters

args: CreateClusterCommandInput

Optional options: __HttpHandlerOptions

Returns Promise<CreateClusterCommandOutput>

Parameters

args: CreateClusterCommandInput

cb: (err: any, data?: CreateClusterCommandOutput) => void

Parameters

err: any

Optional data: CreateClusterCommandOutput

Returns void

Returns void

Parameters

args: CreateClusterCommandInput

options: __HttpHandlerOptions

cb: (err: any, data?: CreateClusterCommandOutput) => void

Parameters

err: any

Optional data: CreateClusterCommandOutput

Returns void

Returns void