ExAws.CloudHSM.Core
Amazon CloudHSM
AWS CloudHSM Service
Summary↑
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]
list_hsms_request :: [{:next_token, pagination_token}]
az :: binary
modify_luna_client_response :: [{:client_arn, client_arn}]
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}]
create_luna_client_request :: [certificate: certificate, label: client_label]
delete_hsm_response :: [{:status, binary}]
ssh_key :: binary
certificate_fingerprint :: binary
list_hapgs_response :: [hapg_list: hapg_list, next_token: pagination_token]
list_luna_clients_request :: [{:next_token, pagination_token}]
hsm_status :: binary
list_hapgs_request :: [{:next_token, pagination_token}]
iam_role_arn :: binary
cloud_hsm_object_state :: binary
delete_luna_client_request :: [{:client_arn, client_arn}]
vpc_id :: binary
describe_hapg_request :: [{:hapg_arn, hapg_arn}]
create_luna_client_response :: [{:client_arn, client_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
client_list :: [client_arn]
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
list_luna_clients_response :: [client_list: client_list, next_token: pagination_token]
create_hapg_request :: [{:label, label}]
label :: binary
client_arn :: binary
create_hapg_response :: [{:hapg_arn, hapg_arn}]
client_version :: binary
list_available_zones_response :: [{:az_list, az_list}]
certificate :: binary
hapg_arn :: binary
Functions
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.
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.
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
.
**
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.
Specs:
- create_luna_client(client :: ExAws.CloudHSM.t, input :: create_luna_client_request) :: ExAws.Request.JSON.response_t
CreateLunaClient
Creates an HSM client.
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.
Specs:
- delete_hapg(client :: ExAws.CloudHSM.t, input :: delete_hapg_request) :: ExAws.Request.JSON.response_t
DeleteHapg
Deletes a high-availability partition group.
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.
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.
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.
Specs:
- delete_luna_client(client :: ExAws.CloudHSM.t, input :: delete_luna_client_request) :: ExAws.Request.JSON.response_t
DeleteLunaClient
Deletes a client.
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.
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.
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.
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.
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.
Specs:
- describe_luna_client(client :: ExAws.CloudHSM.t, input :: describe_luna_client_request) :: ExAws.Request.JSON.response_t
DescribeLunaClient
Retrieves information about an HSM client.
Specs:
- describe_luna_client!(client :: ExAws.CloudHSM.t, input :: describe_luna_client_request) :: ExAws.Request.JSON.success_t | no_return
Same as describe_luna_client/2
but raise on error.
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.
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.
Specs:
- list_available_zones(client :: ExAws.CloudHSM.t, input :: list_available_zones_request) :: ExAws.Request.JSON.response_t
ListAvailableZones
Lists the Availability Zones that have available AWS CloudHSM capacity.
Specs:
- list_available_zones!(client :: ExAws.CloudHSM.t, input :: list_available_zones_request) :: ExAws.Request.JSON.success_t | no_return
Same as list_available_zones/2
but raise on error.
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.
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.
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.
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.
Specs:
- list_luna_clients(client :: ExAws.CloudHSM.t, input :: list_luna_clients_request) :: ExAws.Request.JSON.response_t
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.
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.
Specs:
- modify_hapg(client :: ExAws.CloudHSM.t, input :: modify_hapg_request) :: ExAws.Request.JSON.response_t
ModifyHapg
Modifies an existing high-availability partition group.
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.
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.
**
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.
Specs:
- modify_luna_client(client :: ExAws.CloudHSM.t, input :: modify_luna_client_request) :: ExAws.Request.JSON.response_t
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.
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.