CloudHSMV2

import { CloudHSMV2 } from "https://aws-api.deno.dev/v0.4/services/cloudhsmv2.ts?docs=full";

class CloudHSMV2 {

constructor(apiFactory: client.ApiFactory);

async copyBackupToRegion(params: CopyBackupToRegionRequest, opts?: client.RequestOptions): Promise<CopyBackupToRegionResponse>;

async createCluster(params: CreateClusterRequest, opts?: client.RequestOptions): Promise<CreateClusterResponse>;

async createHsm(params: CreateHsmRequest, opts?: client.RequestOptions): Promise<CreateHsmResponse>;

async deleteBackup(params: DeleteBackupRequest, opts?: client.RequestOptions): Promise<DeleteBackupResponse>;

async deleteCluster(params: DeleteClusterRequest, opts?: client.RequestOptions): Promise<DeleteClusterResponse>;

async deleteHsm(params: DeleteHsmRequest, opts?: client.RequestOptions): Promise<DeleteHsmResponse>;

async describeBackups(params?: DescribeBackupsRequest, opts?: client.RequestOptions): Promise<DescribeBackupsResponse>;

async describeClusters(params?: DescribeClustersRequest, opts?: client.RequestOptions): Promise<DescribeClustersResponse>;

async initializeCluster(params: InitializeClusterRequest, opts?: client.RequestOptions): Promise<InitializeClusterResponse>;

async listTags(params: ListTagsRequest, opts?: client.RequestOptions): Promise<ListTagsResponse>;

async modifyBackupAttributes(params: ModifyBackupAttributesRequest, opts?: client.RequestOptions): Promise<ModifyBackupAttributesResponse>;

async modifyCluster(params: ModifyClusterRequest, opts?: client.RequestOptions): Promise<ModifyClusterResponse>;

async restoreBackup(params: RestoreBackupRequest, opts?: client.RequestOptions): Promise<RestoreBackupResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new CloudHSMV2(apiFactory: client.ApiFactory)

[src]

§Methods

copyBackupToRegion(params: CopyBackupToRegionRequest, opts?: client.RequestOptions): Promise<CopyBackupToRegionResponse>

[src]

Copy an AWS CloudHSM cluster backup to a different region.

createCluster(params: CreateClusterRequest, opts?: client.RequestOptions): Promise<CreateClusterResponse>

[src]

Creates a new AWS CloudHSM cluster.

createHsm(params: CreateHsmRequest, opts?: client.RequestOptions): Promise<CreateHsmResponse>

[src]

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

deleteBackup(params: DeleteBackupRequest, opts?: client.RequestOptions): Promise<DeleteBackupResponse>

[src]

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

deleteCluster(params: DeleteClusterRequest, opts?: client.RequestOptions): Promise<DeleteClusterResponse>

[src]

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

deleteHsm(params: DeleteHsmRequest, opts?: client.RequestOptions): Promise<DeleteHsmResponse>

[src]

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

describeBackups(params?: DescribeBackupsRequest, opts?: client.RequestOptions): Promise<DescribeBackupsResponse>

[src]

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.

describeClusters(params?: DescribeClustersRequest, opts?: client.RequestOptions): Promise<DescribeClustersResponse>

[src]

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.

initializeCluster(params: InitializeClusterRequest, opts?: client.RequestOptions): Promise<InitializeClusterResponse>

[src]

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

modifyBackupAttributes(params: ModifyBackupAttributesRequest, opts?: client.RequestOptions): Promise<ModifyBackupAttributesResponse>

[src]

Modifies attributes for AWS CloudHSM backup.

modifyCluster(params: ModifyClusterRequest, opts?: client.RequestOptions): Promise<ModifyClusterResponse>

[src]

Modifies AWS CloudHSM cluster.

restoreBackup(params: RestoreBackupRequest, opts?: client.RequestOptions): Promise<RestoreBackupResponse>

[src]

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

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]