AWS.CloudHSMV2 (aws-elixir v0.8.0) View Source

For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.

Link to this section Summary

Functions

Copy an AWS CloudHSM cluster backup to a different region.

Creates a new AWS CloudHSM cluster.

Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Deletes a specified AWS CloudHSM backup.

Deletes the specified AWS CloudHSM cluster.

Deletes the specified HSM.

Gets information about backups of AWS CloudHSM clusters.

Gets information about AWS CloudHSM clusters.

Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate.

Gets a list of tags for the specified AWS CloudHSM cluster.

Modifies attributes for AWS CloudHSM backup.

Modifies AWS CloudHSM cluster.

Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state.

Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Link to this section Functions

Link to this function

copy_backup_to_region(client, input, options \\ [])

View Source

Copy an AWS CloudHSM cluster backup to a different region.

Link to this function

create_cluster(client, input, options \\ [])

View Source

Creates a new AWS CloudHSM cluster.

Link to this function

create_hsm(client, input, options \\ [])

View Source

Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

Link to this function

delete_backup(client, input, options \\ [])

View Source

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.

Link to this function

delete_cluster(client, input, options \\ [])

View Source

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.

Link to this function

delete_hsm(client, input, options \\ [])

View Source

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.

Link to this function

describe_backups(client, input, options \\ [])

View Source

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.

Link to this function

describe_clusters(client, input, options \\ [])

View Source

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.

Link to this function

initialize_cluster(client, input, options \\ [])

View Source

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.

Link to this function

list_tags(client, input, options \\ [])

View Source

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.

Link to this function

modify_backup_attributes(client, input, options \\ [])

View Source

Modifies attributes for AWS CloudHSM backup.

Link to this function

modify_cluster(client, input, options \\ [])

View Source

Modifies AWS CloudHSM cluster.

Link to this function

restore_backup(client, input, options \\ [])

View Source

Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state.

For mor information on deleting a backup, see DeleteBackup.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes the specified tag or tags from the specified AWS CloudHSM cluster.