ExAws.CloudHSM.Core

Amazon CloudHSM

AWS CloudHSM Service

Source

Summary

create_hapg!(client, input)

Same as create_hapg/2 but raise on error

create_hapg(client, input)

CreateHapg

create_hsm!(client, input)

Same as create_hsm/2 but raise on error

create_hsm(client, input)

CreateHsm

create_luna_client!(client, input)

Same as create_luna_client/2 but raise on error

create_luna_client(client, input)

CreateLunaClient

delete_hapg!(client, input)

Same as delete_hapg/2 but raise on error

delete_hapg(client, input)

DeleteHapg

delete_hsm!(client, input)

Same as delete_hsm/2 but raise on error

delete_hsm(client, input)

DeleteHsm

delete_luna_client!(client, input)

Same as delete_luna_client/2 but raise on error

delete_luna_client(client, input)

DeleteLunaClient

describe_hapg!(client, input)

Same as describe_hapg/2 but raise on error

describe_hapg(client, input)

DescribeHapg

describe_hsm!(client, input)

Same as describe_hsm/2 but raise on error

describe_hsm(client, input)

DescribeHsm

describe_luna_client!(client, input)

Same as describe_luna_client/2 but raise on error

describe_luna_client(client, input)

DescribeLunaClient

get_config!(client, input)

Same as get_config/2 but raise on error

get_config(client, input)

GetConfig

list_available_zones!(client, input)

Same as list_available_zones/2 but raise on error

list_available_zones(client, input)

ListAvailableZones

list_hapgs!(client, input)

Same as list_hapgs/2 but raise on error

list_hapgs(client, input)

ListHapgs

list_hsms!(client, input)

Same as list_hsms/2 but raise on error

list_hsms(client, input)

ListHsms

list_luna_clients!(client, input)

Same as list_luna_clients/2 but raise on error

list_luna_clients(client, input)

ListLunaClients

modify_hapg!(client, input)

Same as modify_hapg/2 but raise on error

modify_hapg(client, input)

ModifyHapg

modify_hsm!(client, input)

Same as modify_hsm/2 but raise on error

modify_hsm(client, input)

ModifyHsm

modify_luna_client!(client, input)

Same as modify_luna_client/2 but raise on error

modify_luna_client(client, input)

ModifyLunaClient

Types

eni_id :: binary

describe_hsm_response :: [availability_zone: az, eni_id: eni_id, eni_ip: ip_address, hsm_arn: hsm_arn, hsm_type: binary, iam_role_arn: iam_role_arn, partitions: partition_list, serial_number: hsm_serial_number, server_cert_last_updated: timestamp, server_cert_uri: binary, software_version: binary, ssh_key_last_updated: timestamp, ssh_public_key: ssh_key, status: hsm_status, status_details: binary, subnet_id: subnet_id, subscription_end_date: timestamp, subscription_start_date: timestamp, subscription_type: subscription_type, vendor_name: binary, vpc_id: vpc_id]

describe_luna_client_request :: [certificate_fingerprint: certificate_fingerprint, client_arn: client_arn]

az_list :: [az]

list_hsms_request :: [{:next_token, pagination_token}]

az :: binary

describe_hsm_request :: [hsm_arn: hsm_arn, hsm_serial_number: hsm_serial_number]

cloud_hsm_service_exception :: [message: binary, retryable: boolean]

modify_hapg_request :: [hapg_arn: hapg_arn, label: label, partition_serial_list: partition_serial_list]

modify_hsm_request :: [eni_ip: ip_address, external_id: external_id, hsm_arn: hsm_arn, iam_role_arn: iam_role_arn, subnet_id: subnet_id, syslog_ip: ip_address]

client_token :: binary

modify_hapg_response :: [{:hapg_arn, hapg_arn}]

subscription_type :: binary

delete_hapg_response :: [{:status, binary}]

delete_hsm_response :: [{:status, binary}]

ssh_key :: binary

list_hapgs_response :: [hapg_list: hapg_list, next_token: pagination_token]

hsm_status :: binary

list_hapgs_request :: [{:next_token, pagination_token}]

iam_role_arn :: binary

vpc_id :: binary

describe_hapg_request :: [{:hapg_arn, hapg_arn}]

modify_hsm_response :: [{:hsm_arn, hsm_arn}]

hsm_serial_number :: binary

partition_arn :: binary

delete_hsm_request :: [{:hsm_arn, hsm_arn}]

timestamp :: binary

delete_luna_client_response :: [{:status, binary}]

get_config_request :: [client_arn: client_arn, client_version: client_version, hapg_list: hapg_list]

external_id :: binary

list_hsms_response :: [hsm_list: hsm_list, next_token: pagination_token]

subnet_id :: binary

describe_hapg_response :: [hapg_arn: hapg_arn, hapg_serial: binary, hsms_last_action_failed: hsm_list, hsms_pending_deletion: hsm_list, hsms_pending_registration: hsm_list, label: label, last_modified_timestamp: timestamp, partition_serial_list: partition_serial_list, state: cloud_hsm_object_state]

describe_luna_client_response :: [certificate: certificate, certificate_fingerprint: certificate_fingerprint, client_arn: client_arn, label: label, last_modified_timestamp: timestamp]

delete_hapg_request :: [{:hapg_arn, hapg_arn}]

ip_address :: binary

create_hsm_response :: [{:hsm_arn, hsm_arn}]

client_label :: binary

hsm_arn :: binary

pagination_token :: binary

get_config_response :: [config_cred: binary, config_file: binary, config_type: binary]

create_hsm_request :: [client_token: client_token, eni_ip: ip_address, external_id: external_id, iam_role_arn: iam_role_arn, ssh_key: ssh_key, subnet_id: subnet_id, subscription_type: subscription_type, syslog_ip: ip_address]

modify_luna_client_request :: [certificate: certificate, client_arn: client_arn]

partition_serial :: binary

create_hapg_request :: [{:label, label}]

label :: binary

client_arn :: binary

create_hapg_response :: [{:hapg_arn, hapg_arn}]

client_version :: binary

certificate :: binary

hapg_arn :: binary

Functions

create_hapg(client, input)

Specs:

  • create_hapg(client :: ExAws.CloudHSM.t, input :: create_hapg_request) :: ExAws.Request.JSON.response_t

CreateHapg

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

Source
create_hapg!(client, input)

Specs:

  • create_hapg!(client :: ExAws.CloudHSM.t, input :: create_hapg_request) :: ExAws.Request.JSON.success_t | no_return

Same as create_hapg/2 but raise on error.

Source
create_hsm(client, input)

Specs:

  • create_hsm(client :: ExAws.CloudHSM.t, input :: create_hsm_request) :: ExAws.Request.JSON.response_t

CreateHsm

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.

**

Source
create_hsm!(client, input)

Specs:

  • create_hsm!(client :: ExAws.CloudHSM.t, input :: create_hsm_request) :: ExAws.Request.JSON.success_t | no_return

Same as create_hsm/2 but raise on error.

Source
create_luna_client(client, input)

Specs:

CreateLunaClient

Creates an HSM client.

Source
create_luna_client!(client, input)

Specs:

  • create_luna_client!(client :: ExAws.CloudHSM.t, input :: create_luna_client_request) :: ExAws.Request.JSON.success_t | no_return

Same as create_luna_client/2 but raise on error.

Source
delete_hapg(client, input)

Specs:

  • delete_hapg(client :: ExAws.CloudHSM.t, input :: delete_hapg_request) :: ExAws.Request.JSON.response_t

DeleteHapg

Deletes a high-availability partition group.

Source
delete_hapg!(client, input)

Specs:

  • delete_hapg!(client :: ExAws.CloudHSM.t, input :: delete_hapg_request) :: ExAws.Request.JSON.success_t | no_return

Same as delete_hapg/2 but raise on error.

Source
delete_hsm(client, input)

Specs:

  • delete_hsm(client :: ExAws.CloudHSM.t, input :: delete_hsm_request) :: ExAws.Request.JSON.response_t

DeleteHsm

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

Source
delete_hsm!(client, input)

Specs:

  • delete_hsm!(client :: ExAws.CloudHSM.t, input :: delete_hsm_request) :: ExAws.Request.JSON.success_t | no_return

Same as delete_hsm/2 but raise on error.

Source
delete_luna_client(client, input)

Specs:

DeleteLunaClient

Deletes a client.

Source
delete_luna_client!(client, input)

Specs:

  • delete_luna_client!(client :: ExAws.CloudHSM.t, input :: delete_luna_client_request) :: ExAws.Request.JSON.success_t | no_return

Same as delete_luna_client/2 but raise on error.

Source
describe_hapg(client, input)

Specs:

  • describe_hapg(client :: ExAws.CloudHSM.t, input :: describe_hapg_request) :: ExAws.Request.JSON.response_t

DescribeHapg

Retrieves information about a high-availability partition group.

Source
describe_hapg!(client, input)

Specs:

  • describe_hapg!(client :: ExAws.CloudHSM.t, input :: describe_hapg_request) :: ExAws.Request.JSON.success_t | no_return

Same as describe_hapg/2 but raise on error.

Source
describe_hsm(client, input)

Specs:

  • describe_hsm(client :: ExAws.CloudHSM.t, input :: describe_hsm_request) :: ExAws.Request.JSON.response_t

DescribeHsm

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

Source
describe_hsm!(client, input)

Specs:

  • describe_hsm!(client :: ExAws.CloudHSM.t, input :: describe_hsm_request) :: ExAws.Request.JSON.success_t | no_return

Same as describe_hsm/2 but raise on error.

Source
describe_luna_client(client, input)

Specs:

DescribeLunaClient

Retrieves information about an HSM client.

Source
describe_luna_client!(client, input)

Specs:

Same as describe_luna_client/2 but raise on error.

Source
get_config(client, input)

Specs:

  • get_config(client :: ExAws.CloudHSM.t, input :: get_config_request) :: ExAws.Request.JSON.response_t

GetConfig

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

Source
get_config!(client, input)

Specs:

  • get_config!(client :: ExAws.CloudHSM.t, input :: get_config_request) :: ExAws.Request.JSON.success_t | no_return

Same as get_config/2 but raise on error.

Source
list_available_zones(client, input)

Specs:

ListAvailableZones

Lists the Availability Zones that have available AWS CloudHSM capacity.

Source
list_available_zones!(client, input)

Specs:

Same as list_available_zones/2 but raise on error.

Source
list_hapgs(client, input)

Specs:

  • list_hapgs(client :: ExAws.CloudHSM.t, input :: list_hapgs_request) :: ExAws.Request.JSON.response_t

ListHapgs

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.

Source
list_hapgs!(client, input)

Specs:

  • list_hapgs!(client :: ExAws.CloudHSM.t, input :: list_hapgs_request) :: ExAws.Request.JSON.success_t | no_return

Same as list_hapgs/2 but raise on error.

Source
list_hsms(client, input)

Specs:

  • list_hsms(client :: ExAws.CloudHSM.t, input :: list_hsms_request) :: ExAws.Request.JSON.response_t

ListHsms

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.

Source
list_hsms!(client, input)

Specs:

  • list_hsms!(client :: ExAws.CloudHSM.t, input :: list_hsms_request) :: ExAws.Request.JSON.success_t | no_return

Same as list_hsms/2 but raise on error.

Source
list_luna_clients(client, input)

Specs:

ListLunaClients

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.

Source
list_luna_clients!(client, input)

Specs:

  • list_luna_clients!(client :: ExAws.CloudHSM.t, input :: list_luna_clients_request) :: ExAws.Request.JSON.success_t | no_return

Same as list_luna_clients/2 but raise on error.

Source
modify_hapg(client, input)

Specs:

  • modify_hapg(client :: ExAws.CloudHSM.t, input :: modify_hapg_request) :: ExAws.Request.JSON.response_t

ModifyHapg

Modifies an existing high-availability partition group.

Source
modify_hapg!(client, input)

Specs:

  • modify_hapg!(client :: ExAws.CloudHSM.t, input :: modify_hapg_request) :: ExAws.Request.JSON.success_t | no_return

Same as modify_hapg/2 but raise on error.

Source
modify_hsm(client, input)

Specs:

  • modify_hsm(client :: ExAws.CloudHSM.t, input :: modify_hsm_request) :: ExAws.Request.JSON.response_t

ModifyHsm

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.

**

Source
modify_hsm!(client, input)

Specs:

  • modify_hsm!(client :: ExAws.CloudHSM.t, input :: modify_hsm_request) :: ExAws.Request.JSON.success_t | no_return

Same as modify_hsm/2 but raise on error.

Source
modify_luna_client(client, input)

Specs:

ModifyLunaClient

Modifies the certificate used by the client.

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

Source
modify_luna_client!(client, input)

Specs:

  • modify_luna_client!(client :: ExAws.CloudHSM.t, input :: modify_luna_client_request) :: ExAws.Request.JSON.success_t | no_return

Same as modify_luna_client/2 but raise on error.

Source