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.
334 335 336 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 334 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.
382 383 384 385 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 382 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.
473 474 475 476 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 473 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.
522 523 524 525 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 522 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.
565 566 567 568 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 565 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.
627 628 629 630 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 627 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.
673 674 675 676 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 673 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.
761 762 763 764 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 761 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.
854 855 856 857 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 854 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.
903 904 905 906 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 903 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.
956 957 958 959 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 956 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#modify_backup_attributes(params = {}) ⇒ Types::ModifyBackupAttributesResponse
Modifies attributes for AWS CloudHSM backup.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1004 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.
1070 1071 1072 1073 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1070 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.
1113 1114 1115 1116 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1113 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.
1146 1147 1148 1149 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1146 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.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/client.rb', line 1175 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |