AWS SDK Version 2 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.

.NET Framework 4.5
 
Implementation for accessing CloudHSM AWS CloudHSM Service

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CloudHSM.AmazonCloudHSMClient

Namespace: Amazon.CloudHSM
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class AmazonCloudHSMClient : AmazonServiceClient
         IAmazonCloudHSM, IDisposable

The AmazonCloudHSMClient type exposes the following members

Constructors

NameDescription
Public Method AmazonCloudHSMClient() Constructs AmazonCloudHSMClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonCloudHSMClient(RegionEndpoint) Constructs AmazonCloudHSMClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonCloudHSMClient(AmazonCloudHSMConfig) Constructs AmazonCloudHSMClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
Public Method AmazonCloudHSMClient(AWSCredentials) Constructs AmazonCloudHSMClient with AWS Credentials
Public Method AmazonCloudHSMClient(AWSCredentials, RegionEndpoint) Constructs AmazonCloudHSMClient with AWS Credentials
Public Method AmazonCloudHSMClient(AWSCredentials, AmazonCloudHSMConfig) Constructs AmazonCloudHSMClient with AWS Credentials and an AmazonCloudHSMClient Configuration object.
Public Method AmazonCloudHSMClient(string, string) Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCloudHSMClient(string, string, RegionEndpoint) Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCloudHSMClient(string, string, AmazonCloudHSMConfig) Constructs AmazonCloudHSMClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudHSMClient Configuration object.
Public Method AmazonCloudHSMClient(string, string, string) Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCloudHSMClient(string, string, string, RegionEndpoint) Constructs AmazonCloudHSMClient with AWS Access Key ID and AWS Secret Key
Public Method AmazonCloudHSMClient(string, string, string, AmazonCloudHSMConfig) Constructs AmazonCloudHSMClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudHSMClient Configuration object.

Methods

NameDescription
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(CreateHapgRequest, CancellationToken) Initiates the asynchronous execution of the CreateHapg operation.
Public Method CreateHsm(CreateHsmRequest) Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM.
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(DeleteHapgRequest, CancellationToken) Initiates the asynchronous execution of the DeleteHapg operation.
Public Method DeleteHsm(string) Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered.
Public Method DeleteHsm(DeleteHsmRequest) Deletes an HSM. Once complete, 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(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(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(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 Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
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(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(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(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(ListLunaClientsRequest, CancellationToken) Initiates the asynchronous execution of the ListLunaClients 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.
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.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

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