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 CloudHSM AWS CloudHSM Service

This is the reference for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs and the AWS CloudHSM Classic User Guide.

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

Inheritance Hierarchy

Amazon.CloudHSM.IAmazonCloudHSM

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

Syntax

C#
public interface IAmazonCloudHSM
         IAmazonService, IDisposable

The IAmazonCloudHSM 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 AddTagsToResource(AddTagsToResourceRequest)

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

Each tag consists of a key and a value. Tag keys must be unique to each resource.

Public Method AddTagsToResourceAsync(AddTagsToResourceRequest, CancellationToken)

Initiates the asynchronous execution of the AddTagsToResource operation.

Public Method CreateHapg(string)

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

Public Method CreateHapg(CreateHapgRequest)

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

Public Method CreateHapgAsync(string, CancellationToken)

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

Public Method CreateHapgAsync(CreateHapgRequest, CancellationToken)

Initiates the asynchronous execution of the CreateHapg operation.

Public Method CreateHsm(CreateHsmRequest)

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.

It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.

Public Method CreateHsmAsync(CreateHsmRequest, CancellationToken)

Initiates the asynchronous execution of the CreateHsm operation.

Public Method CreateLunaClient(CreateLunaClientRequest)

Creates an HSM client.

Public Method CreateLunaClientAsync(CreateLunaClientRequest, CancellationToken)

Initiates the asynchronous execution of the CreateLunaClient operation.

Public Method DeleteHapg(string)

Deletes a high-availability partition group.

Public Method DeleteHapg(DeleteHapgRequest)

Deletes a high-availability partition group.

Public Method DeleteHapgAsync(string, CancellationToken)

Deletes a high-availability partition group.

Public Method DeleteHapgAsync(DeleteHapgRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteHapg operation.

Public Method DeleteHsm(string)

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

Public Method DeleteHsm(DeleteHsmRequest)

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

Public Method DeleteHsmAsync(string, CancellationToken)

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

Public Method DeleteHsmAsync(DeleteHsmRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteHsm operation.

Public Method DeleteLunaClient(string)

Deletes a client.

Public Method DeleteLunaClient(DeleteLunaClientRequest)

Deletes a client.

Public Method DeleteLunaClientAsync(string, CancellationToken)

Deletes a client.

Public Method DeleteLunaClientAsync(DeleteLunaClientRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteLunaClient operation.

Public Method DescribeHapg(string)

Retrieves information about a high-availability partition group.

Public Method DescribeHapg(DescribeHapgRequest)

Retrieves information about a high-availability partition group.

Public Method DescribeHapgAsync(string, CancellationToken)

Retrieves information about a high-availability partition group.

Public Method DescribeHapgAsync(DescribeHapgRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeHapg operation.

Public Method DescribeHsm(string)

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

Public Method DescribeHsm(DescribeHsmRequest)

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

Public Method DescribeHsmAsync(string, CancellationToken)

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

Public Method DescribeHsmAsync(DescribeHsmRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeHsm operation.

Public Method DescribeLunaClient(DescribeLunaClientRequest)

Retrieves information about an HSM client.

Public Method DescribeLunaClientAsync(DescribeLunaClientRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeLunaClient operation.

Public Method GetConfig(GetConfigRequest)

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

Public Method GetConfigAsync(GetConfigRequest, CancellationToken)

Initiates the asynchronous execution of the GetConfig operation.

Public Method ListAvailableZones()

Lists the Availability Zones that have available AWS CloudHSM capacity.

Public Method ListAvailableZones(ListAvailableZonesRequest)

Lists the Availability Zones that have available AWS CloudHSM capacity.

Public Method ListAvailableZonesAsync(CancellationToken)

Lists the Availability Zones that have available AWS CloudHSM capacity.

Public Method ListAvailableZonesAsync(ListAvailableZonesRequest, CancellationToken)

Initiates the asynchronous execution of the ListAvailableZones operation.

Public Method ListHapgs()

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Public Method ListHapgs(ListHapgsRequest)

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Public Method ListHapgsAsync(CancellationToken)

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Public Method ListHapgsAsync(ListHapgsRequest, CancellationToken)

Initiates the asynchronous execution of the ListHapgs operation.

Public Method ListHsms()

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Public Method ListHsms(ListHsmsRequest)

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Public Method ListHsmsAsync(CancellationToken)

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Public Method ListHsmsAsync(ListHsmsRequest, CancellationToken)

Initiates the asynchronous execution of the ListHsms operation.

Public Method ListLunaClients()

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

Public Method ListLunaClients(ListLunaClientsRequest)

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

Public Method ListLunaClientsAsync(CancellationToken)

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

Public Method ListLunaClientsAsync(ListLunaClientsRequest, CancellationToken)

Initiates the asynchronous execution of the ListLunaClients operation.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Returns a list of all tags for the specified AWS CloudHSM resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForResource operation.

Public Method ModifyHapg(ModifyHapgRequest)

Modifies an existing high-availability partition group.

Public Method ModifyHapgAsync(ModifyHapgRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyHapg operation.

Public Method ModifyHsm(ModifyHsmRequest)

Modifies an HSM.

This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

Public Method ModifyHsmAsync(ModifyHsmRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyHsm operation.

Public Method ModifyLunaClient(ModifyLunaClientRequest)

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client's HSMs.

Public Method ModifyLunaClientAsync(ModifyLunaClientRequest, CancellationToken)

Initiates the asynchronous execution of the ModifyLunaClient operation.

Public Method RemoveTagsFromResource(RemoveTagsFromResourceRequest)

Removes one or more tags from the specified AWS CloudHSM resource.

To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

Public Method RemoveTagsFromResourceAsync(RemoveTagsFromResourceRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveTagsFromResource 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