baiji v0.6.5 Baiji.CloudHSM

AWS CloudHSM Service

Link to this section Summary

Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Adds or overwrites one or more tags for the specified AWS CloudHSM resource

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

Deletes a high-availability partition group

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

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

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

Returns a list of all tags for the specified AWS CloudHSM resource

Modifies an existing high-availability partition group

Modifies the certificate used by the client

Removes one or more tags from the specified AWS CloudHSM resource

Link to this section Functions

Returns a map containing the input/output shapes for this endpoint

Outputs values common to all actions

Link to this function add_tags_to_resource(input \\ %{}, options \\ [])

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.

Link to this function create_hapg(input \\ %{}, options \\ [])

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

Link to this function create_hsm(input \\ %{}, options \\ [])

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`.
Link to this function create_luna_client(input \\ %{}, options \\ [])

Creates an HSM client.

Link to this function delete_hapg(input \\ %{}, options \\ [])

Deletes a high-availability partition group.

Link to this function delete_hsm(input \\ %{}, options \\ [])

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

Link to this function delete_luna_client(input \\ %{}, options \\ [])

Deletes a client.

Link to this function describe_hapg(input \\ %{}, options \\ [])

Retrieves information about a high-availability partition group.

Link to this function describe_hsm(input \\ %{}, options \\ [])

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

Link to this function describe_luna_client(input \\ %{}, options \\ [])

Retrieves information about an HSM client.

Link to this function get_config(input \\ %{}, options \\ [])

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

Link to this function list_available_zones(input \\ %{}, options \\ [])

Lists the Availability Zones that have available AWS CloudHSM capacity.

Link to this function list_hapgs(input \\ %{}, options \\ [])

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.

Link to this function list_hsms(input \\ %{}, options \\ [])

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.

Link to this function list_luna_clients(input \\ %{}, options \\ [])

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.

Link to this function list_tags_for_resource(input \\ %{}, options \\ [])

Returns a list of all tags for the specified AWS CloudHSM resource.

Link to this function modify_hapg(input \\ %{}, options \\ [])

Modifies an existing high-availability partition group.

Link to this function modify_hsm(input \\ %{}, options \\ [])

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.
Link to this function modify_luna_client(input \\ %{}, options \\ [])

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client’s HSMs.

Link to this function remove_tags_from_resource(input \\ %{}, options \\ [])

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.