AWS.CloudHSM
AWS CloudHSM Service
Summary↑
create_hapg(client, input, options \\ []) | Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs |
create_hsm(client, input, options \\ []) | Creates an uninitialized HSM instance |
create_luna_client(client, input, options \\ []) | Creates an HSM client |
delete_hapg(client, input, options \\ []) | Deletes a high-availability partition group |
delete_hsm(client, input, options \\ []) | Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered |
delete_luna_client(client, input, options \\ []) | Deletes a client |
describe_hapg(client, input, options \\ []) | Retrieves information about a high-availability partition group |
describe_hsm(client, input, options \\ []) | Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number |
describe_luna_client(client, input, options \\ []) | Retrieves information about an HSM client |
get_config(client, input, options \\ []) | Gets the configuration files necessary to connect to all high availability partition groups the client is associated with |
list_available_zones(client, input, options \\ []) | Lists the Availability Zones that have available AWS CloudHSM capacity |
list_hapgs(client, input, options \\ []) | Lists the high-availability partition groups for the account |
list_hsms(client, input, options \\ []) | Retrieves the identifiers of all of the HSMs provisioned for the current customer |
list_luna_clients(client, input, options \\ []) | Lists all of the clients |
modify_hapg(client, input, options \\ []) | Modifies an existing high-availability partition group |
modify_hsm(client, input, options \\ []) | Modifies an HSM |
modify_luna_client(client, input, options \\ []) | Modifies the certificate used by the client |
Functions
Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
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
.
Creates an HSM client.
Deletes a high-availability partition group.
Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.
Deletes a client.
Retrieves information about a high-availability partition group.
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
Retrieves information about an HSM client.
Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
Lists the Availability Zones that have available AWS CloudHSM capacity.
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.
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.
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.
Modifies an existing high-availability partition group.
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.
Modifies the certificate used by the client.
This action can potentially start a workflow to install the new certificate on the client's HSMs.