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.

Classes

NameDescription
Class Backup

Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.

Class BackupRetentionPolicy

A policy that defines the number of days to retain backups.

Class Certificates

Contains one or more certificates or a certificate signing request (CSR).

Class CloudHsmAccessDeniedException

The request was rejected because the requester does not have permission to perform the requested operation.

Class CloudHsmInternalFailureException

The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

Class CloudHsmInvalidRequestException

The request was rejected because it is not a valid request.

Class CloudHsmResourceNotFoundException

The request was rejected because it refers to a resource that cannot be found.

Class CloudHsmServiceException

The request was rejected because an error occurred.

Class CloudHsmTagException

The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

Class CloudHSMV2PaginatorFactory

Paginators for the CloudHSMV2 service

Class Cluster

Contains information about an AWS CloudHSM cluster.

Class CopyBackupToRegionRequest

Container for the parameters to the CopyBackupToRegion operation. Copy an AWS CloudHSM cluster backup to a different region.

Class CopyBackupToRegionResponse

This is the response object from the CopyBackupToRegion operation.

Class CreateClusterRequest

Container for the parameters to the CreateCluster operation. Creates a new AWS CloudHSM cluster.

Class CreateClusterResponse

This is the response object from the CreateCluster operation.

Class CreateHsmRequest

Container for the parameters to the CreateHsm operation. Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Class CreateHsmResponse

This is the response object from the CreateHsm operation.

Class DeleteBackupRequest

Container for the parameters to the DeleteBackup operation. 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.

Class DeleteBackupResponse

This is the response object from the DeleteBackup operation.

Class DeleteClusterRequest

Container for the parameters to the DeleteCluster operation. 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.

Class DeleteClusterResponse

This is the response object from the DeleteCluster operation.

Class DeleteHsmRequest

Container for the parameters to the DeleteHsm operation. 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.

Class DeleteHsmResponse

This is the response object from the DeleteHsm operation.

Class DescribeBackupsRequest

Container for the parameters to the DescribeBackups operation. 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.

Class DescribeBackupsResponse

This is the response object from the DescribeBackups operation.

Class DescribeClustersRequest

Container for the parameters to the DescribeClusters operation. 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.

Class DescribeClustersResponse

This is the response object from the DescribeClusters operation.

Class DestinationBackup

Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.

Class Hsm

Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.

Class InitializeClusterRequest

Container for the parameters to the InitializeCluster operation. 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.

Class InitializeClusterResponse

This is the response object from the InitializeCluster operation.

Class ListTagsRequest

Container for the parameters to the ListTags operation. 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.

Class ListTagsResponse

This is the response object from the ListTags operation.

Class ModifyBackupAttributesRequest

Container for the parameters to the ModifyBackupAttributes operation. Modifies attributes for AWS CloudHSM backup.

Class ModifyBackupAttributesResponse

This is the response object from the ModifyBackupAttributes operation.

Class ModifyClusterRequest

Container for the parameters to the ModifyCluster operation. Modifies AWS CloudHSM cluster.

Class ModifyClusterResponse

This is the response object from the ModifyCluster operation.

Class RestoreBackupRequest

Container for the parameters to the RestoreBackup operation. Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.

Class RestoreBackupResponse

This is the response object from the RestoreBackup operation.

Class Tag

Contains a tag. A tag is a key-value pair.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Interfaces

NameDescription
Interface ICloudHSMV2PaginatorFactory

Paginators for the CloudHSMV2 service

Interface IDescribeBackupsPaginator

Paginator for the DescribeBackups operation

Interface IDescribeClustersPaginator

Paginator for the DescribeClusters operation

Interface IListTagsPaginator

Paginator for the ListTags operation