CloudHSMV2Client Class

Member Function Documentation

CloudHSMV2Client::CloudHSMV2Client(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CloudHSMV2Client object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CloudHSMV2Client::CloudHSMV2Client(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CloudHSMV2Client().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CreateClusterResponse *CloudHSMV2Client::createCluster(const CreateClusterRequest &request)

Sends request to the CloudHSMV2Client service, and returns a pointer to an CreateClusterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new AWS CloudHSM

[slot] CreateHsmResponse *CloudHSMV2Client::createHsm(const CreateHsmRequest &request)

Sends request to the CloudHSMV2Client service, and returns a pointer to an CreateHsmResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteClusterResponse *CloudHSMV2Client::deleteCluster(const DeleteClusterRequest &request)

Sends request to the CloudHSMV2Client service, and returns a pointer to an DeleteClusterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>DescribeClusters</a>. To delete an HSM, use

[slot] DeleteHsmResponse *CloudHSMV2Client::deleteHsm(const DeleteHsmRequest &request)

Sends request to the CloudHSMV2Client service, and returns a pointer to an DeleteHsmResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeBackupsResponse *CloudHSMV2Client::describeBackups(const DescribeBackupsRequest &request)

Sends request to the CloudHSMV2Client service, and returns a pointer to an DescribeBackupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>NextToken</code> value. Use this value in a subsequent <code>DescribeBackups</code> request to get more backups. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more backups to

[slot] DescribeClustersResponse *CloudHSMV2Client::describeClusters(const DescribeClustersRequest &request)

Sends request to the CloudHSMV2Client service, and returns a pointer to an DescribeClustersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>NextToken</code> value. Use this value in a subsequent <code>DescribeClusters</code> request to get more clusters. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more clusters to

[slot] InitializeClusterResponse *CloudHSMV2Client::initializeCluster(const InitializeClusterRequest &request)

Sends request to the CloudHSMV2Client service, and returns a pointer to an InitializeClusterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListTagsResponse *CloudHSMV2Client::listTags(const ListTagsRequest &request)

Sends request to the CloudHSMV2Client service, and returns a pointer to an ListTagsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>NextToken</code> value. Use this value in a subsequent <code>ListTags</code> request to get more tags. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more tags to

[slot] TagResourceResponse *CloudHSMV2Client::tagResource(const TagResourceRequest &request)

Sends request to the CloudHSMV2Client service, and returns a pointer to an TagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UntagResourceResponse *CloudHSMV2Client::untagResource(const UntagResourceRequest &request)

Sends request to the CloudHSMV2Client service, and returns a pointer to an UntagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes the specified tag or tags from the specified AWS CloudHSM