Class: Aws::CloudHSMV2::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudHSMV2::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb
Overview
An API client for CloudHSMV2. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CloudHSMV2::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
-
#copy_backup_to_region(params = {}) ⇒ Types::CopyBackupToRegionResponse
Copy an AWS CloudHSM cluster backup to a different region.
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a new AWS CloudHSM cluster.
-
#create_hsm(params = {}) ⇒ Types::CreateHsmResponse
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
-
#delete_backup(params = {}) ⇒ Types::DeleteBackupResponse
Deletes a specified AWS CloudHSM backup.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the specified AWS CloudHSM cluster.
-
#delete_hsm(params = {}) ⇒ Types::DeleteHsmResponse
Deletes the specified HSM.
-
#describe_backups(params = {}) ⇒ Types::DescribeBackupsResponse
Gets information about backups of AWS CloudHSM clusters.
-
#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse
Gets information about AWS CloudHSM clusters.
-
#initialize_cluster(params = {}) ⇒ Types::InitializeClusterResponse
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate.
-
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Gets a list of tags for the specified AWS CloudHSM cluster.
-
#modify_backup_attributes(params = {}) ⇒ Types::ModifyBackupAttributesResponse
Modifies attributes for AWS CloudHSM backup.
-
#modify_cluster(params = {}) ⇒ Types::ModifyClusterResponse
Modifies AWS CloudHSM cluster.
-
#restore_backup(params = {}) ⇒ Types::RestoreBackupResponse
Restores a specified AWS CloudHSM backup that is in the
PENDING_DELETION
state. -
#tag_resource(params = {}) ⇒ Struct
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tag or tags from the specified AWS CloudHSM cluster.
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.
395 396 397 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 395 def initialize(*args) super end |
Instance Method Details
#copy_backup_to_region(params = {}) ⇒ Types::CopyBackupToRegionResponse
Copy an AWS CloudHSM cluster backup to a different region.
443 444 445 446 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 443 def copy_backup_to_region(params = {}, = {}) req = build_request(:copy_backup_to_region, params) req.send_request() end |
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a new AWS CloudHSM cluster.
534 535 536 537 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 534 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_hsm(params = {}) ⇒ Types::CreateHsmResponse
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
583 584 585 586 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 583 def create_hsm(params = {}, = {}) req = build_request(:create_hsm, params) req.send_request() end |
#delete_backup(params = {}) ⇒ Types::DeleteBackupResponse
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.
626 627 628 629 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 626 def delete_backup(params = {}, = {}) req = build_request(:delete_backup, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
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.
688 689 690 691 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 688 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_hsm(params = {}) ⇒ Types::DeleteHsmResponse
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.
734 735 736 737 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 734 def delete_hsm(params = {}, = {}) req = build_request(:delete_hsm, params) req.send_request() end |
#describe_backups(params = {}) ⇒ Types::DescribeBackupsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
822 823 824 825 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 822 def describe_backups(params = {}, = {}) req = build_request(:describe_backups, params) req.send_request() end |
#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
915 916 917 918 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 915 def describe_clusters(params = {}, = {}) req = build_request(:describe_clusters, params) req.send_request() end |
#initialize_cluster(params = {}) ⇒ Types::InitializeClusterResponse
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.
964 965 966 967 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 964 def initialize_cluster(params = {}, = {}) req = build_request(:initialize_cluster, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1017 1018 1019 1020 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1017 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#modify_backup_attributes(params = {}) ⇒ Types::ModifyBackupAttributesResponse
Modifies attributes for AWS CloudHSM backup.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1065 def modify_backup_attributes(params = {}, = {}) req = build_request(:modify_backup_attributes, params) req.send_request() end |
#modify_cluster(params = {}) ⇒ Types::ModifyClusterResponse
Modifies AWS CloudHSM cluster.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1131 def modify_cluster(params = {}, = {}) req = build_request(:modify_cluster, params) req.send_request() end |
#restore_backup(params = {}) ⇒ Types::RestoreBackupResponse
Restores a specified AWS CloudHSM backup that is in the
PENDING_DELETION
state. For mor information on deleting a backup,
see DeleteBackup.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1174 def restore_backup(params = {}, = {}) req = build_request(:restore_backup, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
1207 1208 1209 1210 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1207 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tag or tags from the specified AWS CloudHSM cluster.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1236 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |