Module Smaws_Client_CloudHSMV2.Types

type nonrec error_message = string
type nonrec vpc_id = string
type nonrec untag_resource_response = unit
type nonrec resource_id = string
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_request = {
  1. tag_key_list : tag_key_list;
    (*

    A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.

    *)
  2. resource_id : resource_id;
    (*

    The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.

    *)
}
type nonrec cloud_hsm_tag_exception = {
  1. message : error_message option;
}

The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

type nonrec cloud_hsm_service_exception = {
  1. message : error_message option;
}

The request was rejected because an error occurred.

type nonrec cloud_hsm_resource_not_found_exception = {
  1. message : error_message option;
}

The request was rejected because it refers to a resource that cannot be found.

type nonrec cloud_hsm_invalid_request_exception = {
  1. message : error_message option;
}

The request was rejected because it is not a valid request.

type nonrec cloud_hsm_internal_failure_exception = {
  1. message : error_message option;
}

The request was rejected because of an CloudHSM internal failure. The request can be retried.

type nonrec cloud_hsm_access_denied_exception = {
  1. message : error_message option;
}

The request was rejected because the requester does not have permission to perform the requested operation.

type nonrec timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec tag_value = string
type nonrec tag_resource_response = unit
type nonrec tag = {
  1. value : tag_value;
    (*

    The value of the tag.

    *)
  2. key : tag_key;
    (*

    The key of the tag.

    *)
}

Contains a tag. A tag is a key-value pair.

type nonrec tag_list = tag list
type nonrec tag_resource_request = {
  1. tag_list : tag_list;
    (*

    A list of one or more tags.

    *)
  2. resource_id : resource_id;
    (*

    The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.

    *)
}
type nonrec cloud_hsm_resource_limit_exceeded_exception = {
  1. message : error_message option;
}

The request was rejected because it exceeds an CloudHSM limit.

type nonrec subnet_id = string
type nonrec subnet_ids = subnet_id list
type nonrec string_ = string
type nonrec strings = string_ list
type nonrec state_message = string
type nonrec security_group = string
type nonrec backup_id = string
type nonrec backup_arn = string
type nonrec backup_state =
  1. | PENDING_DELETION
  2. | DELETED
  3. | READY
  4. | CREATE_IN_PROGRESS
type nonrec cluster_id = string
type nonrec boolean_ = bool
type nonrec region = string
type nonrec hsm_type = string
type nonrec cluster_mode =
  1. | NON_FIPS
  2. | FIPS
type nonrec backup = {
  1. mode : cluster_mode option;
    (*

    The mode of the cluster that was backed up.

    *)
  2. hsm_type : hsm_type option;
    (*

    The HSM type used to create the backup.

    *)
  3. tag_list : tag_list option;
    (*

    The list of tags for the backup.

    *)
  4. delete_timestamp : timestamp option;
    (*

    The date and time when the backup will be permanently deleted.

    *)
  5. source_cluster : cluster_id option;
    (*

    The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

    *)
  6. source_backup : backup_id option;
    (*

    The identifier (ID) of the source backup from which the new backup was copied.

    *)
  7. source_region : region option;
    (*

    The AWS Region that contains the source backup from which the new backup was copied.

    *)
  8. never_expires : boolean_ option;
    (*

    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

    *)
  9. copy_timestamp : timestamp option;
    (*

    The date and time when the backup was copied from a source backup.

    *)
  10. create_timestamp : timestamp option;
    (*

    The date and time when the backup was created.

    *)
  11. cluster_id : cluster_id option;
    (*

    The identifier (ID) of the cluster that was backed up.

    *)
  12. backup_state : backup_state option;
    (*

    The state of the backup.

    *)
  13. backup_arn : backup_arn option;
    (*

    The Amazon Resource Name (ARN) of the backup.

    *)
  14. backup_id : backup_id;
    (*

    The identifier (ID) of the backup.

    *)
}

Contains information about a backup of an CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.

type nonrec restore_backup_response = {
  1. backup : backup option;
    (*

    Information on the Backup object created.

    *)
}
type nonrec restore_backup_request = {
  1. backup_id : backup_id;
    (*

    The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.

    *)
}
type nonrec resource_policy = string
type nonrec cloud_hsm_arn = string
type nonrec put_resource_policy_response = {
  1. policy : resource_policy option;
    (*

    The policy attached to a resource.

    *)
  2. resource_arn : cloud_hsm_arn option;
    (*

    Amazon Resource Name (ARN) of the resource to which a policy is attached.

    *)
}
type nonrec put_resource_policy_request = {
  1. policy : resource_policy option;
    (*

    The policy you want to associate with a resource.

    For an example policy, see Working with shared backups in the CloudHSM User Guide

    *)
  2. resource_arn : cloud_hsm_arn option;
    (*

    Amazon Resource Name (ARN) of the resource to which you want to attach a policy.

    *)
}
type nonrec pre_co_password = string
type nonrec next_token = string
type nonrec network_type =
  1. | DUALSTACK
  2. | IPV4
type nonrec backup_policy =
  1. | DEFAULT
type nonrec backup_retention_type =
  1. | DAYS
type nonrec backup_retention_value = string
type nonrec backup_retention_policy = {
  1. value : backup_retention_value option;
    (*

    Use a value between 7 - 379.

    *)
  2. type_ : backup_retention_type option;
    (*

    The type of backup retention policy. For the DAYS type, the value is the number of days to retain backups.

    *)
}

A policy that defines the number of days to retain backups.

type nonrec external_az = string
type nonrec eni_id = string
type nonrec ip_address = string
type nonrec ip_v6_address = string
type nonrec hsm_id = string
type nonrec hsm_state =
  1. | DELETED
  2. | DELETE_IN_PROGRESS
  3. | DEGRADED
  4. | ACTIVE
  5. | CREATE_IN_PROGRESS
type nonrec hsm = {
  1. state_message : string_ option;
    (*

    A description of the HSM's state.

    *)
  2. state : hsm_state option;
    (*

    The HSM's state.

    *)
  3. hsm_type : hsm_type option;
    (*

    The type of HSM.

    *)
  4. hsm_id : hsm_id;
    (*

    The HSM's identifier (ID).

    *)
  5. eni_ip_v6 : ip_v6_address option;
    (*

    The IPv6 address (if any) of the HSM's elastic network interface (ENI).

    *)
  6. eni_ip : ip_address option;
    (*

    The IP address of the HSM's elastic network interface (ENI).

    *)
  7. eni_id : eni_id option;
    (*

    The identifier (ID) of the HSM's elastic network interface (ENI).

    *)
  8. subnet_id : subnet_id option;
    (*

    The subnet that contains the HSM's elastic network interface (ENI).

    *)
  9. cluster_id : cluster_id option;
    (*

    The identifier (ID) of the cluster that contains the HSM.

    *)
  10. availability_zone : external_az option;
    (*

    The Availability Zone that contains the HSM.

    *)
}

Contains information about a hardware security module (HSM) in an CloudHSM cluster.

type nonrec hsms = hsm list
type nonrec cluster_state =
  1. | DEGRADED
  2. | DELETED
  3. | DELETE_IN_PROGRESS
  4. | ROLLBACK_IN_PROGRESS
  5. | MODIFY_IN_PROGRESS
  6. | UPDATE_IN_PROGRESS
  7. | ACTIVE
  8. | INITIALIZED
  9. | INITIALIZE_IN_PROGRESS
  10. | UNINITIALIZED
  11. | CREATE_IN_PROGRESS
type nonrec external_subnet_mapping = (external_az * subnet_id) list
type nonrec cert = string
type nonrec certificates = {
  1. cluster_certificate : cert option;
    (*

    The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.

    *)
  2. manufacturer_hardware_certificate : cert option;
    (*

    The HSM hardware certificate issued (signed) by the hardware manufacturer.

    *)
  3. aws_hardware_certificate : cert option;
    (*

    The HSM hardware certificate issued (signed) by CloudHSM.

    *)
  4. hsm_certificate : cert option;
    (*

    The HSM certificate issued (signed) by the HSM hardware.

    *)
  5. cluster_csr : cert option;
    (*

    The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED.

    *)
}

Contains one or more certificates or a certificate signing request (CSR).

type nonrec cluster = {
  1. mode : cluster_mode option;
    (*

    The mode of the cluster.

    *)
  2. tag_list : tag_list option;
    (*

    The list of tags for the cluster.

    *)
  3. certificates : certificates option;
    (*

    Contains one or more certificates or a certificate signing request (CSR).

    *)
  4. network_type : network_type option;
    (*

    The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.

    *)
  5. vpc_id : vpc_id option;
    (*

    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

    *)
  6. subnet_mapping : external_subnet_mapping option;
    (*

    A map from availability zone to the cluster’s subnet in that availability zone.

    *)
  7. state_message : state_message option;
    (*

    A description of the cluster's state.

    *)
  8. state : cluster_state option;
    (*

    The cluster's state.

    *)
  9. source_backup_id : backup_id option;
    (*

    The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

    *)
  10. security_group : security_group option;
    (*

    The identifier (ID) of the cluster's security group.

    *)
  11. pre_co_password : pre_co_password option;
    (*

    The default password for the cluster's Pre-Crypto Officer (PRECO) user.

    *)
  12. hsm_type_rollback_expiration : timestamp option;
    (*

    The timestamp until when the cluster can be rolled back to its original HSM type.

    *)
  13. hsm_type : hsm_type option;
    (*

    The type of HSM that the cluster contains.

    *)
  14. hsms : hsms option;
    (*

    Contains information about the HSMs in the cluster.

    *)
  15. create_timestamp : timestamp option;
    (*

    The date and time when the cluster was created.

    *)
  16. cluster_id : cluster_id option;
    (*

    The cluster's identifier (ID).

    *)
  17. backup_retention_policy : backup_retention_policy option;
    (*

    A policy that defines how the service retains backups.

    *)
  18. backup_policy : backup_policy option;
    (*

    The cluster's backup policy.

    *)
}

Contains information about an CloudHSM cluster.

type nonrec modify_cluster_response = {
  1. cluster : cluster option;
}
type nonrec modify_cluster_request = {
  1. cluster_id : cluster_id;
    (*

    The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use DescribeClusters.

    *)
  2. backup_retention_policy : backup_retention_policy option;
    (*

    A policy that defines how the service retains backups.

    *)
  3. hsm_type : hsm_type option;
    (*

    The desired HSM type of the cluster.

    *)
}
type nonrec modify_backup_attributes_response = {
  1. backup : backup option;
}
type nonrec modify_backup_attributes_request = {
  1. never_expires : boolean_;
    (*

    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.

    *)
  2. backup_id : backup_id;
    (*

    The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.

    *)
}
type nonrec max_size = int
type nonrec list_tags_response = {
  1. next_token : next_token option;
    (*

    An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent ListTags request to get more tags.

    *)
  2. tag_list : tag_list;
    (*

    A list of tags.

    *)
}
type nonrec list_tags_request = {
  1. max_results : max_size option;
    (*

    The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a NextToken value.

    *)
  2. next_token : next_token option;
    (*

    The NextToken value that you received in the previous response. Use this value to get more tags.

    *)
  3. resource_id : resource_id;
    (*

    The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.

    *)
}
type nonrec initialize_cluster_response = {
  1. state_message : state_message option;
    (*

    A description of the cluster's state.

    *)
  2. state : cluster_state option;
    (*

    The cluster's state.

    *)
}
type nonrec initialize_cluster_request = {
  1. trust_anchor : cert;
    (*

    The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000 characters.

    *)
  2. signed_cert : cert;
    (*

    The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.

    *)
  3. cluster_id : cluster_id;
    (*

    The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.

    *)
}
type nonrec get_resource_policy_response = {
  1. policy : resource_policy option;
    (*

    The policy attached to a resource.

    *)
}
type nonrec get_resource_policy_request = {
  1. resource_arn : cloud_hsm_arn option;
    (*

    Amazon Resource Name (ARN) of the resource to which a policy is attached.

    *)
}
type nonrec field = string
type nonrec filters = (field * strings) list
type nonrec destination_backup = {
  1. source_cluster : cluster_id option;
    (*

    The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

    *)
  2. source_backup : backup_id option;
    (*

    The identifier (ID) of the source backup from which the new backup was copied.

    *)
  3. source_region : region option;
    (*

    The AWS region that contains the source backup from which the new backup was copied.

    *)
  4. create_timestamp : timestamp option;
    (*

    The date and time when both the source backup was created.

    *)
}

Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.

type nonrec clusters = cluster list
type nonrec describe_clusters_response = {
  1. next_token : next_token option;
    (*

    An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters request to get more clusters.

    *)
  2. clusters : clusters option;
    (*

    A list of clusters.

    *)
}
type nonrec clusters_max_size = int
type nonrec describe_clusters_request = {
  1. max_results : clusters_max_size option;
    (*

    The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

    *)
  2. next_token : next_token option;
    (*

    The NextToken value that you received in the previous response. Use this value to get more clusters.

    *)
  3. filters : filters option;
    (*

    One or more filters to limit the items returned in the response.

    Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

    Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

    Use the states filter to return only clusters that match the specified state.

    *)
}
type nonrec backups = backup list
type nonrec describe_backups_response = {
  1. next_token : next_token option;
    (*

    An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.

    *)
  2. backups : backups option;
    (*

    A list of backups.

    *)
}
type nonrec backups_max_size = int
type nonrec describe_backups_request = {
  1. sort_ascending : boolean_ option;
    (*

    Designates whether or not to sort the return backups by ascending chronological order of generation.

    *)
  2. shared : boolean_ option;
    (*

    Describe backups that are shared with you.

    By default when using this option, the command returns backups that have been shared using a standard Resource Access Manager resource share. In order for a backup that was shared using the PutResourcePolicy command to be returned, the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information about sharing backups, see Working with shared backups in the CloudHSM User Guide.

    *)
  3. filters : filters option;
    (*

    One or more filters to limit the items returned in the response.

    Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

    Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

    Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

    Use the states filter to return only backups that match the specified state.

    Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

    *)
  4. max_results : backups_max_size option;
    (*

    The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

    *)
  5. next_token : next_token option;
    (*

    The NextToken value that you received in the previous response. Use this value to get more backups.

    *)
}
type nonrec delete_resource_policy_response = {
  1. policy : resource_policy option;
    (*

    The policy previously attached to the resource.

    *)
  2. resource_arn : cloud_hsm_arn option;
    (*

    Amazon Resource Name (ARN) of the resource from which the policy was deleted.

    *)
}
type nonrec delete_resource_policy_request = {
  1. resource_arn : cloud_hsm_arn option;
    (*

    Amazon Resource Name (ARN) of the resource from which the policy will be removed.

    *)
}
type nonrec delete_hsm_response = {
  1. hsm_id : hsm_id option;
    (*

    The identifier (ID) of the HSM that was deleted.

    *)
}
type nonrec delete_hsm_request = {
  1. eni_ip : ip_address option;
    (*

    The IP address of the elastic network interface (ENI) of the HSM that you are deleting.

    *)
  2. eni_id : eni_id option;
    (*

    The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.

    *)
  3. hsm_id : hsm_id option;
    (*

    The identifier (ID) of the HSM that you are deleting.

    *)
  4. cluster_id : cluster_id;
    (*

    The identifier (ID) of the cluster that contains the HSM that you are deleting.

    *)
}
type nonrec delete_cluster_response = {
  1. cluster : cluster option;
    (*

    Information about the cluster that was deleted.

    *)
}
type nonrec delete_cluster_request = {
  1. cluster_id : cluster_id;
    (*

    The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.

    *)
}
type nonrec delete_backup_response = {
  1. backup : backup option;
    (*

    Information on the Backup object deleted.

    *)
}
type nonrec delete_backup_request = {
  1. backup_id : backup_id;
    (*

    The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.

    *)
}
type nonrec create_hsm_response = {
  1. hsm : hsm option;
    (*

    Information about the HSM that was created.

    *)
}
type nonrec create_hsm_request = {
  1. ip_address : ip_address option;
    (*

    The HSM's IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify an IP address, one is chosen for you from that subnet.

    *)
  2. availability_zone : external_az;
    (*

    The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.

    *)
  3. cluster_id : cluster_id;
    (*

    The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.

    *)
}
type nonrec create_cluster_response = {
  1. cluster : cluster option;
    (*

    Information about the cluster that was created.

    *)
}
type nonrec create_cluster_request = {
  1. mode : cluster_mode option;
    (*

    The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

    *)
  2. tag_list : tag_list option;
    (*

    Tags to apply to the CloudHSM cluster during creation.

    *)
  3. network_type : network_type option;
    (*

    The NetworkType to create a cluster with. The allowed values are IPV4 and DUALSTACK.

    *)
  4. subnet_ids : subnet_ids;
    (*

    The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

    • All subnets must be in the same virtual private cloud (VPC).
    • You can specify only one subnet per Availability Zone.
    *)
  5. source_backup_id : backup_arn option;
    (*

    The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

    *)
  6. hsm_type : hsm_type;
    (*

    The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

    *)
  7. backup_retention_policy : backup_retention_policy option;
    (*

    A policy that defines how the service retains backups.

    *)
}
type nonrec copy_backup_to_region_response = {
  1. destination_backup : destination_backup option;
    (*

    Information on the backup that will be copied to the destination region, including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the destination backup will be the same as that of the source backup.

    You will need to use the sourceBackupID returned in this operation to use the DescribeBackups operation on the backup that will be copied to the destination region.

    *)
}
type nonrec copy_backup_to_region_request = {
  1. tag_list : tag_list option;
    (*

    Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.

    *)
  2. backup_id : backup_id;
    (*

    The ID of the backup that will be copied to the destination region.

    *)
  3. destination_region : region;
    (*

    The AWS region that will contain your copied CloudHSM cluster backup.

    *)
}