AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing CloudHSMV2 For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.

Inheritance Hierarchy

Amazon.CloudHSMV2.IAmazonCloudHSMV2

Namespace: Amazon.CloudHSMV2
Assembly: AWSSDK.CloudHSMV2.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonCloudHSMV2
         IAmazonService, IDisposable

The IAmazonCloudHSMV2 type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateCluster(CreateClusterRequest)

Creates a new AWS CloudHSM cluster.

Public Method CreateClusterAsync(CreateClusterRequest, CancellationToken)

Initiates the asynchronous execution of the CreateCluster operation.

Public Method CreateHsm(CreateHsmRequest)

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

Public Method CreateHsmAsync(CreateHsmRequest, CancellationToken)

Initiates the asynchronous execution of the CreateHsm operation.

Public Method DeleteCluster(DeleteClusterRequest)

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.

Public Method DeleteClusterAsync(DeleteClusterRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteCluster operation.

Public Method DeleteHsm(DeleteHsmRequest)

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.

Public Method DeleteHsmAsync(DeleteHsmRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteHsm operation.

Public Method DescribeBackups(DescribeBackupsRequest)

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.

Public Method DescribeBackupsAsync(DescribeBackupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeBackups operation.

Public Method DescribeClusters(DescribeClustersRequest)

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.

Public Method DescribeClustersAsync(DescribeClustersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeClusters operation.

Public Method InitializeCluster(InitializeClusterRequest)

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.

Public Method InitializeClusterAsync(InitializeClusterRequest, CancellationToken)

Initiates the asynchronous execution of the InitializeCluster operation.

Public Method ListTags(ListTagsRequest)

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.

Public Method ListTagsAsync(ListTagsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTags operation.

Public Method TagResource(TagResourceRequest)

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

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the TagResource operation.

Public Method UntagResource(UntagResourceRequest)

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

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Initiates the asynchronous execution of the UntagResource operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms