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.

Implementation for accessing CloudHSMV2

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CloudHSMV2.AmazonCloudHSMV2Client

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

Syntax

C# 
public class AmazonCloudHSMV2Client : AmazonServiceClient
         IAmazonCloudHSMV2, IAmazonService, IDisposable

The AmazonCloudHSMV2Client type exposes the following members

Constructors

NameDescription
Public Method AmazonCloudHSMV2Client()

Constructs AmazonCloudHSMV2Client 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 AmazonCloudHSMV2Client(RegionEndpoint)

Constructs AmazonCloudHSMV2Client 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 AmazonCloudHSMV2Client(AmazonCloudHSMV2Config)

Constructs AmazonCloudHSMV2Client 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 AmazonCloudHSMV2Client(AWSCredentials)

Constructs AmazonCloudHSMV2Client with AWS Credentials

Public Method AmazonCloudHSMV2Client(AWSCredentials, RegionEndpoint)

Constructs AmazonCloudHSMV2Client with AWS Credentials

Public Method AmazonCloudHSMV2Client(AWSCredentials, AmazonCloudHSMV2Config)

Constructs AmazonCloudHSMV2Client with AWS Credentials and an AmazonCloudHSMV2Client Configuration object.

Public Method AmazonCloudHSMV2Client(string, string)

Constructs AmazonCloudHSMV2Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudHSMV2Client(string, string, RegionEndpoint)

Constructs AmazonCloudHSMV2Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudHSMV2Client(string, string, AmazonCloudHSMV2Config)

Constructs AmazonCloudHSMV2Client with AWS Access Key ID, AWS Secret Key and an AmazonCloudHSMV2Client Configuration object.

Public Method AmazonCloudHSMV2Client(string, string, string)

Constructs AmazonCloudHSMV2Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudHSMV2Client(string, string, string, RegionEndpoint)

Constructs AmazonCloudHSMV2Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudHSMV2Client(string, string, string, AmazonCloudHSMV2Config)

Constructs AmazonCloudHSMV2Client with AWS Access Key ID, AWS Secret Key and an AmazonCloudHSMV2Client Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.CloudHSMV2.Model.ICloudHSMV2PaginatorFactory

Paginators for the service

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 CopyBackupToRegion(CopyBackupToRegionRequest)

Copy an AWS CloudHSM cluster backup to a different region.

Public Method CopyBackupToRegionAsync(CopyBackupToRegionRequest, CancellationToken)

Copy an AWS CloudHSM cluster backup to a different region.

Public Method CreateCluster(CreateClusterRequest)

Creates a new AWS CloudHSM cluster.

Public Method CreateClusterAsync(CreateClusterRequest, CancellationToken)

Creates a new AWS CloudHSM cluster.

Public Method CreateHsm(CreateHsmRequest)

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

Public Method CreateHsmAsync(CreateHsmRequest, CancellationToken)

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

Public Method DeleteBackup(DeleteBackupRequest)

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.

Public Method DeleteBackupAsync(DeleteBackupRequest, CancellationToken)

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.

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)

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 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)

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 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)

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 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)

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 DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
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)

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 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)

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 ModifyBackupAttributes(ModifyBackupAttributesRequest)

Modifies attributes for AWS CloudHSM backup.

Public Method ModifyBackupAttributesAsync(ModifyBackupAttributesRequest, CancellationToken)

Modifies attributes for AWS CloudHSM backup.

Public Method ModifyCluster(ModifyClusterRequest)

Modifies AWS CloudHSM cluster.

Public Method ModifyClusterAsync(ModifyClusterRequest, CancellationToken)

Modifies AWS CloudHSM cluster.

Public Method RestoreBackup(RestoreBackupRequest)

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

Public Method RestoreBackupAsync(RestoreBackupRequest, CancellationToken)

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

Public Method TagResource(TagResourceRequest)

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

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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

Public Method UntagResource(UntagResourceRequest)

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

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

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

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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