Smaws_Client_CloudHSMV2 (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_untag_resource_response : unit -> unit

val make_untag_resource_request : 
  tag_key_list:Types.tag_key_list ->
  resource_id:Types.resource_id ->
  unit ->
  Types.untag_resource_request

val make_tag_resource_response : unit -> unit

val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag

val make_tag_resource_request : 
  tag_list:Types.tag_list ->
  resource_id:Types.resource_id ->
  unit ->
  Types.tag_resource_request

val make_backup : 
  ?mode:Types.cluster_mode ->
  ?hsm_type:Types.hsm_type ->
  ?tag_list:Types.tag_list ->
  ?delete_timestamp:Types.timestamp ->
  ?source_cluster:Types.cluster_id ->
  ?source_backup:Types.backup_id ->
  ?source_region:Types.region ->
  ?never_expires:Types.boolean_ ->
  ?copy_timestamp:Types.timestamp ->
  ?create_timestamp:Types.timestamp ->
  ?cluster_id:Types.cluster_id ->
  ?backup_state:Types.backup_state ->
  ?backup_arn:Types.backup_arn ->
  backup_id:Types.backup_id ->
  unit ->
  Types.backup

val make_restore_backup_response : 
  ?backup:Types.backup ->
  unit ->
  Types.restore_backup_response

val make_restore_backup_request : 
  backup_id:Types.backup_id ->
  unit ->
  Types.restore_backup_request

val make_put_resource_policy_response : 
  ?policy:Types.resource_policy ->
  ?resource_arn:Types.cloud_hsm_arn ->
  unit ->
  Types.put_resource_policy_response

val make_put_resource_policy_request : 
  ?policy:Types.resource_policy ->
  ?resource_arn:Types.cloud_hsm_arn ->
  unit ->
  Types.put_resource_policy_request

val make_backup_retention_policy : 
  ?value:Types.backup_retention_value ->
  ?type_:Types.backup_retention_type ->
  unit ->
  Types.backup_retention_policy

val make_hsm : 
  ?state_message:Types.string_ ->
  ?state:Types.hsm_state ->
  ?hsm_type:Types.hsm_type ->
  ?eni_ip_v6:Types.ip_v6_address ->
  ?eni_ip:Types.ip_address ->
  ?eni_id:Types.eni_id ->
  ?subnet_id:Types.subnet_id ->
  ?cluster_id:Types.cluster_id ->
  ?availability_zone:Types.external_az ->
  hsm_id:Types.hsm_id ->
  unit ->
  Types.hsm

val make_certificates : 
  ?cluster_certificate:Types.cert ->
  ?manufacturer_hardware_certificate:Types.cert ->
  ?aws_hardware_certificate:Types.cert ->
  ?hsm_certificate:Types.cert ->
  ?cluster_csr:Types.cert ->
  unit ->
  Types.certificates

val make_cluster : 
  ?mode:Types.cluster_mode ->
  ?tag_list:Types.tag_list ->
  ?certificates:Types.certificates ->
  ?network_type:Types.network_type ->
  ?vpc_id:Types.vpc_id ->
  ?subnet_mapping:Types.external_subnet_mapping ->
  ?state_message:Types.state_message ->
  ?state:Types.cluster_state ->
  ?source_backup_id:Types.backup_id ->
  ?security_group:Types.security_group ->
  ?pre_co_password:Types.pre_co_password ->
  ?hsm_type_rollback_expiration:Types.timestamp ->
  ?hsm_type:Types.hsm_type ->
  ?hsms:Types.hsms ->
  ?create_timestamp:Types.timestamp ->
  ?cluster_id:Types.cluster_id ->
  ?backup_retention_policy:Types.backup_retention_policy ->
  ?backup_policy:Types.backup_policy ->
  unit ->
  Types.cluster

val make_modify_cluster_response : 
  ?cluster:Types.cluster ->
  unit ->
  Types.modify_cluster_response

val make_modify_cluster_request : 
  ?backup_retention_policy:Types.backup_retention_policy ->
  ?hsm_type:Types.hsm_type ->
  cluster_id:Types.cluster_id ->
  unit ->
  Types.modify_cluster_request

val make_modify_backup_attributes_response : 
  ?backup:Types.backup ->
  unit ->
  Types.modify_backup_attributes_response

val make_modify_backup_attributes_request : 
  never_expires:Types.boolean_ ->
  backup_id:Types.backup_id ->
  unit ->
  Types.modify_backup_attributes_request

val make_list_tags_response : 
  ?next_token:Types.next_token ->
  tag_list:Types.tag_list ->
  unit ->
  Types.list_tags_response

val make_list_tags_request : 
  ?max_results:Types.max_size ->
  ?next_token:Types.next_token ->
  resource_id:Types.resource_id ->
  unit ->
  Types.list_tags_request

val make_initialize_cluster_response : 
  ?state_message:Types.state_message ->
  ?state:Types.cluster_state ->
  unit ->
  Types.initialize_cluster_response

val make_initialize_cluster_request : 
  trust_anchor:Types.cert ->
  signed_cert:Types.cert ->
  cluster_id:Types.cluster_id ->
  unit ->
  Types.initialize_cluster_request

val make_get_resource_policy_response : 
  ?policy:Types.resource_policy ->
  unit ->
  Types.get_resource_policy_response

val make_get_resource_policy_request : 
  ?resource_arn:Types.cloud_hsm_arn ->
  unit ->
  Types.get_resource_policy_request

val make_destination_backup : 
  ?source_cluster:Types.cluster_id ->
  ?source_backup:Types.backup_id ->
  ?source_region:Types.region ->
  ?create_timestamp:Types.timestamp ->
  unit ->
  Types.destination_backup

val make_describe_clusters_response : 
  ?next_token:Types.next_token ->
  ?clusters:Types.clusters ->
  unit ->
  Types.describe_clusters_response

val make_describe_clusters_request : 
  ?max_results:Types.clusters_max_size ->
  ?next_token:Types.next_token ->
  ?filters:Types.filters ->
  unit ->
  Types.describe_clusters_request

val make_describe_backups_response : 
  ?next_token:Types.next_token ->
  ?backups:Types.backups ->
  unit ->
  Types.describe_backups_response

val make_describe_backups_request : 
  ?sort_ascending:Types.boolean_ ->
  ?shared:Types.boolean_ ->
  ?filters:Types.filters ->
  ?max_results:Types.backups_max_size ->
  ?next_token:Types.next_token ->
  unit ->
  Types.describe_backups_request

val make_delete_resource_policy_response : 
  ?policy:Types.resource_policy ->
  ?resource_arn:Types.cloud_hsm_arn ->
  unit ->
  Types.delete_resource_policy_response

val make_delete_resource_policy_request : 
  ?resource_arn:Types.cloud_hsm_arn ->
  unit ->
  Types.delete_resource_policy_request

val make_delete_hsm_response : 
  ?hsm_id:Types.hsm_id ->
  unit ->
  Types.delete_hsm_response

val make_delete_hsm_request : 
  ?eni_ip:Types.ip_address ->
  ?eni_id:Types.eni_id ->
  ?hsm_id:Types.hsm_id ->
  cluster_id:Types.cluster_id ->
  unit ->
  Types.delete_hsm_request

val make_delete_cluster_response : 
  ?cluster:Types.cluster ->
  unit ->
  Types.delete_cluster_response

val make_delete_cluster_request : 
  cluster_id:Types.cluster_id ->
  unit ->
  Types.delete_cluster_request

val make_delete_backup_response : 
  ?backup:Types.backup ->
  unit ->
  Types.delete_backup_response

val make_delete_backup_request : 
  backup_id:Types.backup_id ->
  unit ->
  Types.delete_backup_request

val make_create_hsm_response : 
  ?hsm:Types.hsm ->
  unit ->
  Types.create_hsm_response

val make_create_hsm_request : 
  ?ip_address:Types.ip_address ->
  availability_zone:Types.external_az ->
  cluster_id:Types.cluster_id ->
  unit ->
  Types.create_hsm_request

val make_create_cluster_response : 
  ?cluster:Types.cluster ->
  unit ->
  Types.create_cluster_response

val make_create_cluster_request : 
  ?mode:Types.cluster_mode ->
  ?tag_list:Types.tag_list ->
  ?network_type:Types.network_type ->
  ?source_backup_id:Types.backup_arn ->
  ?backup_retention_policy:Types.backup_retention_policy ->
  subnet_ids:Types.subnet_ids ->
  hsm_type:Types.hsm_type ->
  unit ->
  Types.create_cluster_request

val make_copy_backup_to_region_response : 
  ?destination_backup:Types.destination_backup ->
  unit ->
  Types.copy_backup_to_region_response

val make_copy_backup_to_region_request : 
  ?tag_list:Types.tag_list ->
  backup_id:Types.backup_id ->
  destination_region:Types.region ->
  unit ->
  Types.copy_backup_to_region_request

Operations

module CopyBackupToRegion : sig ... end

Copy an CloudHSM cluster backup to a different region.

module CreateCluster : sig ... end

Creates a new CloudHSM cluster.

module CreateHsm : sig ... end

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

module DeleteBackup : sig ... end

Deletes a specified 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.

module DeleteCluster : sig ... end

Deletes the specified 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.

module DeleteHsm : sig ... end

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.

module DeleteResourcePolicy : sig ... end

Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that backup.

module DescribeBackups : sig ... end

Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.

module DescribeClusters : sig ... end

Gets information about CloudHSM clusters.

module GetResourcePolicy : sig ... end

Retrieves the resource policy document attached to a given resource.

module InitializeCluster : sig ... end

Claims an 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.

module ListTags : sig ... end

Gets a list of tags for the specified CloudHSM cluster.

module ModifyBackupAttributes : sig ... end

Modifies attributes for CloudHSM backup.

module ModifyCluster : sig ... end

Modifies CloudHSM cluster.

module PutResourcePolicy : sig ... end

Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support CloudHSM resource policies:

module RestoreBackup : sig ... end

Restores a specified CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup.

module TagResource : sig ... end

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

module UntagResource : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end