Class: Aws::CloudHSM::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudHSM::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb
Overview
An API client for CloudHSM. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CloudHSM::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_tags_to_resource(params = {}) ⇒ Types::AddTagsToResourceResponse
This is documentation for AWS CloudHSM Classic.
-
#create_hapg(params = {}) ⇒ Types::CreateHapgResponse
This is documentation for AWS CloudHSM Classic.
-
#create_hsm(params = {}) ⇒ Types::CreateHsmResponse
This is documentation for AWS CloudHSM Classic.
-
#create_luna_client(params = {}) ⇒ Types::CreateLunaClientResponse
This is documentation for AWS CloudHSM Classic.
-
#delete_hapg(params = {}) ⇒ Types::DeleteHapgResponse
This is documentation for AWS CloudHSM Classic.
-
#delete_hsm(params = {}) ⇒ Types::DeleteHsmResponse
This is documentation for AWS CloudHSM Classic.
-
#delete_luna_client(params = {}) ⇒ Types::DeleteLunaClientResponse
This is documentation for AWS CloudHSM Classic.
-
#describe_hapg(params = {}) ⇒ Types::DescribeHapgResponse
This is documentation for AWS CloudHSM Classic.
-
#describe_hsm(params = {}) ⇒ Types::DescribeHsmResponse
This is documentation for AWS CloudHSM Classic.
-
#describe_luna_client(params = {}) ⇒ Types::DescribeLunaClientResponse
This is documentation for AWS CloudHSM Classic.
-
#get_config(params = {}) ⇒ Types::GetConfigResponse
This is documentation for AWS CloudHSM Classic.
-
#list_available_zones(params = {}) ⇒ Types::ListAvailableZonesResponse
This is documentation for AWS CloudHSM Classic.
-
#list_hapgs(params = {}) ⇒ Types::ListHapgsResponse
This is documentation for AWS CloudHSM Classic.
-
#list_hsms(params = {}) ⇒ Types::ListHsmsResponse
This is documentation for AWS CloudHSM Classic.
-
#list_luna_clients(params = {}) ⇒ Types::ListLunaClientsResponse
This is documentation for AWS CloudHSM Classic.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
This is documentation for AWS CloudHSM Classic.
-
#modify_hapg(params = {}) ⇒ Types::ModifyHapgResponse
This is documentation for AWS CloudHSM Classic.
-
#modify_hsm(params = {}) ⇒ Types::ModifyHsmResponse
This is documentation for AWS CloudHSM Classic.
-
#modify_luna_client(params = {}) ⇒ Types::ModifyLunaClientResponse
This is documentation for AWS CloudHSM Classic.
-
#remove_tags_from_resource(params = {}) ⇒ Types::RemoveTagsFromResourceResponse
This is documentation for AWS CloudHSM Classic.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
447 448 449 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 447 def initialize(*args) super end |
Instance Method Details
#add_tags_to_resource(params = {}) ⇒ Types::AddTagsToResourceResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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 resource.
507 508 509 510 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 507 def (params = {}, = {}) req = build_request(:add_tags_to_resource, params) req.send_request() end |
#create_hapg(params = {}) ⇒ Types::CreateHapgResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
555 556 557 558 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 555 def create_hapg(params = {}, = {}) req = build_request(:create_hapg, params) req.send_request() end |
#create_hsm(params = {}) ⇒ Types::CreateHsmResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates an uninitialized HSM instance.
There is an upfront fee charged for each HSM instance that you create
with the CreateHsm
operation. If you accidentally provision an HSM
and want to request a refund, delete the instance using the DeleteHsm
operation, go to the AWS Support Center, 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 DescribeHsm operation. The HSM
is ready to be initialized when the status changes to RUNNING
.
650 651 652 653 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 650 def create_hsm(params = {}, = {}) req = build_request(:create_hsm, params) req.send_request() end |
#create_luna_client(params = {}) ⇒ Types::CreateLunaClientResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates an HSM client.
701 702 703 704 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 701 def create_luna_client(params = {}, = {}) req = build_request(:create_luna_client, params) req.send_request() end |
#delete_hapg(params = {}) ⇒ Types::DeleteHapgResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes a high-availability partition group.
747 748 749 750 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 747 def delete_hapg(params = {}, = {}) req = build_request(:delete_hapg, params) req.send_request() end |
#delete_hsm(params = {}) ⇒ Types::DeleteHsmResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.
794 795 796 797 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 794 def delete_hsm(params = {}, = {}) req = build_request(:delete_hsm, params) req.send_request() end |
#delete_luna_client(params = {}) ⇒ Types::DeleteLunaClientResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes a client.
840 841 842 843 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 840 def delete_luna_client(params = {}, = {}) req = build_request(:delete_luna_client, params) req.send_request() end |
#describe_hapg(params = {}) ⇒ Types::DescribeHapgResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about a high-availability partition group.
906 907 908 909 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 906 def describe_hapg(params = {}, = {}) req = build_request(:describe_hapg, params) req.send_request() end |
#describe_hsm(params = {}) ⇒ Types::DescribeHsmResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
1000 1001 1002 1003 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1000 def describe_hsm(params = {}, = {}) req = build_request(:describe_hsm, params) req.send_request() end |
#describe_luna_client(params = {}) ⇒ Types::DescribeLunaClientResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about an HSM client.
1058 1059 1060 1061 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1058 def describe_luna_client(params = {}, = {}) req = build_request(:describe_luna_client, params) req.send_request() end |
#get_config(params = {}) ⇒ Types::GetConfigResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
1118 1119 1120 1121 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1118 def get_config(params = {}, = {}) req = build_request(:get_config, params) req.send_request() end |
#list_available_zones(params = {}) ⇒ Types::ListAvailableZonesResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Lists the Availability Zones that have available AWS CloudHSM capacity.
1157 1158 1159 1160 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1157 def list_available_zones(params = {}, = {}) req = build_request(:list_available_zones, params) req.send_request() end |
#list_hapgs(params = {}) ⇒ Types::ListHapgsResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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.
1212 1213 1214 1215 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1212 def list_hapgs(params = {}, = {}) req = build_request(:list_hapgs, params) req.send_request() end |
#list_hsms(params = {}) ⇒ Types::ListHsmsResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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.
1268 1269 1270 1271 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1268 def list_hsms(params = {}, = {}) req = build_request(:list_hsms, params) req.send_request() end |
#list_luna_clients(params = {}) ⇒ Types::ListLunaClientsResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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.
1323 1324 1325 1326 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1323 def list_luna_clients(params = {}, = {}) req = build_request(:list_luna_clients, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Returns a list of all tags for the specified AWS CloudHSM resource.
1371 1372 1373 1374 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1371 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#modify_hapg(params = {}) ⇒ Types::ModifyHapgResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Modifies an existing high-availability partition group.
1426 1427 1428 1429 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1426 def modify_hapg(params = {}, = {}) req = build_request(:modify_hapg, params) req.send_request() end |
#modify_hsm(params = {}) ⇒ Types::ModifyHsmResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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 window.
1505 1506 1507 1508 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1505 def modify_hsm(params = {}, = {}) req = build_request(:modify_hsm, params) req.send_request() end |
#modify_luna_client(params = {}) ⇒ Types::ModifyLunaClientResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Modifies the certificate used by the client.
This action can potentially start a workflow to install the new certificate on the client's HSMs.
1558 1559 1560 1561 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1558 def modify_luna_client(params = {}, = {}) req = build_request(:modify_luna_client, params) req.send_request() end |
#remove_tags_from_resource(params = {}) ⇒ Types::RemoveTagsFromResourceResponse
This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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 AddTagsToResource.
1614 1615 1616 1617 |
# File 'gems/aws-sdk-cloudhsm/lib/aws-sdk-cloudhsm/client.rb', line 1614 def (params = {}, = {}) req = build_request(:remove_tags_from_resource, params) req.send_request() end |