CloudHSMClient Class

(QtAws::CloudHSM::CloudHSMClient)

The CloudHSMClient class provides access to the Amazon CloudHSM service. More...

Header:	#include <CloudHSMClient>
Inherits:	QtAws::Core::AwsAbstractClient

List of all members, including inherited members

Public Functions

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

12 public functions inherited from QtAws::Core::AwsAbstractClient

Public Slots

AddTagsToResourceResponse *	addTagsToResource(const AddTagsToResourceRequest &request)
CreateHapgResponse *	createHapg(const CreateHapgRequest &request)
CreateHsmResponse *	createHsm(const CreateHsmRequest &request)
CreateLunaClientResponse *	createLunaClient(const CreateLunaClientRequest &request)
DeleteHapgResponse *	deleteHapg(const DeleteHapgRequest &request)
DeleteHsmResponse *	deleteHsm(const DeleteHsmRequest &request)
DeleteLunaClientResponse *	deleteLunaClient(const DeleteLunaClientRequest &request)
DescribeHapgResponse *	describeHapg(const DescribeHapgRequest &request)
DescribeHsmResponse *	describeHsm(const DescribeHsmRequest &request)
DescribeLunaClientResponse *	describeLunaClient(const DescribeLunaClientRequest &request)
GetConfigResponse *	getConfig(const GetConfigRequest &request)
ListAvailableZonesResponse *	listAvailableZones(const ListAvailableZonesRequest &request)
ListHapgsResponse *	listHapgs(const ListHapgsRequest &request)
ListHsmsResponse *	listHsms(const ListHsmsRequest &request)
ListLunaClientsResponse *	listLunaClients(const ListLunaClientsRequest &request)
ListTagsForResourceResponse *	listTagsForResource(const ListTagsForResourceRequest &request)
ModifyHapgResponse *	modifyHapg(const ModifyHapgRequest &request)
ModifyHsmResponse *	modifyHsm(const ModifyHsmRequest &request)
ModifyLunaClientResponse *	modifyLunaClient(const ModifyLunaClientRequest &request)
RemoveTagsFromResourceResponse *	removeTagsFromResource(const RemoveTagsFromResourceRequest &request)

Additional Inherited Members

2 protected functions inherited from QtAws::Core::AwsAbstractClient

Detailed Description

The CloudHSMClient class provides access to the Amazon CloudHSM service.

<fullname>AWS CloudHSM Service</fullname>

This is documentation for AWS CloudHSM Classic. For more information, see <a href="http://aws.amazon.com/cloudhsm/faqs-classic/">AWS CloudHSM Classic FAQs</a>, the <a href="http://docs.aws.amazon.com/cloudhsm/classic/userguide/">AWS CloudHSM Classic User Guide</a>, and the <a href="http://docs.aws.amazon.com/cloudhsm/classic/APIReference/">AWS CloudHSM Classic API

Reference</a>>

For information about the current version of AWS CloudHSM, see <a href="http://aws.amazon.com/cloudhsm/">AWS CloudHSM</a>, the <a href="http://docs.aws.amazon.com/cloudhsm/latest/userguide/">AWS CloudHSM User Guide</a>, and the <a href="http://docs.aws.amazon.com/cloudhsm/latest/APIReference/">AWS CloudHSM API

Member Function Documentation

CloudHSMClient::CloudHSMClient(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 CloudHSMClient object.

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

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

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

This function overloads CloudHSMClient().

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

`[slot]` AddTagsToResourceResponse CloudHSMClient::addTagsToResource(const AddTagsToResourceRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an AddTagsToResourceResponse object to track the result.

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

Reference</a>>

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

`[slot]` CreateHapgResponse CloudHSMClient::createHapg(const CreateHapgRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an CreateHapgResponse object to track the result.

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

Reference</a>>

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

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

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

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

Reference</a>>

Creates an uninitialized HSM

instance>

There is an upfront fee charged for each HSM instance that you create with the <code>CreateHsm</code> operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the <a>DeleteHsm</a> operation, go to the <a href="https://console.aws.amazon.com/support/home">AWS Support Center</a>, 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 <a>DescribeHsm</a> operation. The HSM is ready to be initialized when the status changes to

`[slot]` CreateLunaClientResponse CloudHSMClient::createLunaClient(const CreateLunaClientRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an CreateLunaClientResponse object to track the result.

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

Reference</a>>

Creates an HSM

`[slot]` DeleteHapgResponse CloudHSMClient::deleteHapg(const DeleteHapgRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an DeleteHapgResponse object to track the result.

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

Reference</a>>

Deletes a high-availability partition

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

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

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

Reference</a>>

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

`[slot]` DeleteLunaClientResponse CloudHSMClient::deleteLunaClient(const DeleteLunaClientRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an DeleteLunaClientResponse object to track the result.

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

Reference</a>>

Deletes a

`[slot]` DescribeHapgResponse CloudHSMClient::describeHapg(const DescribeHapgRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an DescribeHapgResponse object to track the result.

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

Reference</a>>

Retrieves information about a high-availability partition

`[slot]` DescribeHsmResponse CloudHSMClient::describeHsm(const DescribeHsmRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an DescribeHsmResponse object to track the result.

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

Reference</a>>

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

`[slot]` DescribeLunaClientResponse CloudHSMClient::describeLunaClient(const DescribeLunaClientRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an DescribeLunaClientResponse object to track the result.

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

Reference</a>>

Retrieves information about an HSM

`[slot]` GetConfigResponse CloudHSMClient::getConfig(const GetConfigRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an GetConfigResponse object to track the result.

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

Reference</a>>

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

`[slot]` ListAvailableZonesResponse CloudHSMClient::listAvailableZones(const ListAvailableZonesRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an ListAvailableZonesResponse object to track the result.

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

Reference</a>>

Lists the Availability Zones that have available AWS CloudHSM

`[slot]` ListHapgsResponse CloudHSMClient::listHapgs(const ListHapgsRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an ListHapgsResponse object to track the result.

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

Reference</a>>

Lists the high-availability partition groups for the

account>

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

`[slot]` ListHsmsResponse CloudHSMClient::listHsms(const ListHsmsRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an ListHsmsResponse object to track the result.

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

Reference</a>>

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

customer>

`[slot]` ListLunaClientsResponse CloudHSMClient::listLunaClients(const ListLunaClientsRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an ListLunaClientsResponse object to track the result.

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

Reference</a>>

Lists all of the

clients>

`[slot]` ListTagsForResourceResponse CloudHSMClient::listTagsForResource(const ListTagsForResourceRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an ListTagsForResourceResponse object to track the result.

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

Reference</a>>

Returns a list of all tags for the specified AWS CloudHSM

`[slot]` ModifyHapgResponse CloudHSMClient::modifyHapg(const ModifyHapgRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an ModifyHapgResponse object to track the result.

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

Reference</a>>

Modifies an existing high-availability partition

`[slot]` ModifyHsmResponse CloudHSMClient::modifyHsm(const ModifyHsmRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an ModifyHsmResponse object to track the result.

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

Reference</a>>

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

`[slot]` ModifyLunaClientResponse CloudHSMClient::modifyLunaClient(const ModifyLunaClientRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an ModifyLunaClientResponse object to track the result.

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

Reference</a>>

Modifies the certificate used by the

client>

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

`[slot]` RemoveTagsFromResourceResponse CloudHSMClient::removeTagsFromResource(const RemoveTagsFromResourceRequest &request*)

Sends request to the CloudHSMClient service, and returns a pointer to an RemoveTagsFromResourceResponse object to track the result.

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

Reference</a>>

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

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.

Contents

CloudHSMClient Class

Public Functions

Public Slots

Additional Inherited Members

Detailed Description

Member Function Documentation

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

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

[slot] AddTagsToResourceResponse *CloudHSMClient::addTagsToResource(const AddTagsToResourceRequest &request)

[slot] CreateHapgResponse *CloudHSMClient::createHapg(const CreateHapgRequest &request)

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

[slot] CreateLunaClientResponse *CloudHSMClient::createLunaClient(const CreateLunaClientRequest &request)

[slot] DeleteHapgResponse *CloudHSMClient::deleteHapg(const DeleteHapgRequest &request)

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

[slot] DeleteLunaClientResponse *CloudHSMClient::deleteLunaClient(const DeleteLunaClientRequest &request)

[slot] DescribeHapgResponse *CloudHSMClient::describeHapg(const DescribeHapgRequest &request)

[slot] DescribeHsmResponse *CloudHSMClient::describeHsm(const DescribeHsmRequest &request)

[slot] DescribeLunaClientResponse *CloudHSMClient::describeLunaClient(const DescribeLunaClientRequest &request)

[slot] GetConfigResponse *CloudHSMClient::getConfig(const GetConfigRequest &request)

[slot] ListAvailableZonesResponse *CloudHSMClient::listAvailableZones(const ListAvailableZonesRequest &request)

[slot] ListHapgsResponse *CloudHSMClient::listHapgs(const ListHapgsRequest &request)

[slot] ListHsmsResponse *CloudHSMClient::listHsms(const ListHsmsRequest &request)

[slot] ListLunaClientsResponse *CloudHSMClient::listLunaClients(const ListLunaClientsRequest &request)

[slot] ListTagsForResourceResponse *CloudHSMClient::listTagsForResource(const ListTagsForResourceRequest &request)

[slot] ModifyHapgResponse *CloudHSMClient::modifyHapg(const ModifyHapgRequest &request)

[slot] ModifyHsmResponse *CloudHSMClient::modifyHsm(const ModifyHsmRequest &request)

[slot] ModifyLunaClientResponse *CloudHSMClient::modifyLunaClient(const ModifyLunaClientRequest &request)

[slot] RemoveTagsFromResourceResponse *CloudHSMClient::removeTagsFromResource(const RemoveTagsFromResourceRequest &request)

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

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

`[slot]` AddTagsToResourceResponse CloudHSMClient::addTagsToResource(const AddTagsToResourceRequest &request*)

`[slot]` CreateHapgResponse CloudHSMClient::createHapg(const CreateHapgRequest &request*)

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

`[slot]` CreateLunaClientResponse CloudHSMClient::createLunaClient(const CreateLunaClientRequest &request*)

`[slot]` DeleteHapgResponse CloudHSMClient::deleteHapg(const DeleteHapgRequest &request*)

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

`[slot]` DeleteLunaClientResponse CloudHSMClient::deleteLunaClient(const DeleteLunaClientRequest &request*)

`[slot]` DescribeHapgResponse CloudHSMClient::describeHapg(const DescribeHapgRequest &request*)

`[slot]` DescribeHsmResponse CloudHSMClient::describeHsm(const DescribeHsmRequest &request*)

`[slot]` DescribeLunaClientResponse CloudHSMClient::describeLunaClient(const DescribeLunaClientRequest &request*)

`[slot]` GetConfigResponse CloudHSMClient::getConfig(const GetConfigRequest &request*)

`[slot]` ListAvailableZonesResponse CloudHSMClient::listAvailableZones(const ListAvailableZonesRequest &request*)

`[slot]` ListHapgsResponse CloudHSMClient::listHapgs(const ListHapgsRequest &request*)

`[slot]` ListHsmsResponse CloudHSMClient::listHsms(const ListHsmsRequest &request*)

`[slot]` ListLunaClientsResponse CloudHSMClient::listLunaClients(const ListLunaClientsRequest &request*)

`[slot]` ListTagsForResourceResponse CloudHSMClient::listTagsForResource(const ListTagsForResourceRequest &request*)

`[slot]` ModifyHapgResponse CloudHSMClient::modifyHapg(const ModifyHapgRequest &request*)

`[slot]` ModifyHsmResponse CloudHSMClient::modifyHsm(const ModifyHsmRequest &request*)

`[slot]` ModifyLunaClientResponse CloudHSMClient::modifyLunaClient(const ModifyLunaClientRequest &request*)

`[slot]` RemoveTagsFromResourceResponse CloudHSMClient::removeTagsFromResource(const RemoveTagsFromResourceRequest &request*)