Cloudhsm V2
This page documents function available when using the Cloudhsm_V2 module, created with @service Cloudhsm_V2.
Index
Main.Cloudhsm_V2.copy_backup_to_regionMain.Cloudhsm_V2.create_clusterMain.Cloudhsm_V2.create_hsmMain.Cloudhsm_V2.delete_backupMain.Cloudhsm_V2.delete_clusterMain.Cloudhsm_V2.delete_hsmMain.Cloudhsm_V2.describe_backupsMain.Cloudhsm_V2.describe_clustersMain.Cloudhsm_V2.initialize_clusterMain.Cloudhsm_V2.list_tagsMain.Cloudhsm_V2.modify_backup_attributesMain.Cloudhsm_V2.modify_clusterMain.Cloudhsm_V2.restore_backupMain.Cloudhsm_V2.tag_resourceMain.Cloudhsm_V2.untag_resource
Documentation
Main.Cloudhsm_V2.copy_backup_to_region — Methodcopy_backup_to_region(backup_id, destination_region)
copy_backup_to_region(backup_id, destination_region, params::Dict{String,<:Any})Copy an AWS CloudHSM cluster backup to a different region.
Arguments
backup_id: The ID of the backup that will be copied to the destination region.destination_region: The AWS region that will contain your copied CloudHSM cluster backup.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"TagList": 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.
Main.Cloudhsm_V2.create_cluster — Methodcreate_cluster(hsm_type, subnet_ids)
create_cluster(hsm_type, subnet_ids, params::Dict{String,<:Any})Creates a new AWS CloudHSM cluster.
Arguments
hsm_type: The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"BackupRetentionPolicy": A policy that defines how the service retains backups."SourceBackupId": The identifier (ID) 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, use DescribeBackups."TagList": Tags to apply to the CloudHSM cluster during creation.
Main.Cloudhsm_V2.create_hsm — Methodcreate_hsm(availability_zone, cluster_id)
create_hsm(availability_zone, cluster_id, params::Dict{String,<:Any})Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
Arguments
availability_zone: The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.cluster_id: The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"IpAddress": 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.
Main.Cloudhsm_V2.delete_backup — Methoddelete_backup(backup_id)
delete_backup(backup_id, params::Dict{String,<:Any})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.
Arguments
backup_id: The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.
Main.Cloudhsm_V2.delete_cluster — Methoddelete_cluster(cluster_id)
delete_cluster(cluster_id, params::Dict{String,<:Any})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.
Arguments
cluster_id: The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.
Main.Cloudhsm_V2.delete_hsm — Methoddelete_hsm(cluster_id)
delete_hsm(cluster_id, params::Dict{String,<:Any})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.
Arguments
cluster_id: The identifier (ID) of the cluster that contains the HSM that you are deleting.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"EniId": The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting."EniIp": The IP address of the elastic network interface (ENI) of the HSM that you are deleting."HsmId": The identifier (ID) of the HSM that you are deleting.
Main.Cloudhsm_V2.describe_backups — Methoddescribe_backups()
describe_backups(params::Dict{String,<:Any})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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Filters": 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."MaxResults": 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."NextToken": The NextToken value that you received in the previous response. Use this value to get more backups."SortAscending": Designates whether or not to sort the return backups by ascending chronological order of generation.
Main.Cloudhsm_V2.describe_clusters — Methoddescribe_clusters()
describe_clusters(params::Dict{String,<:Any})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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Filters": 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."MaxResults": 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."NextToken": The NextToken value that you received in the previous response. Use this value to get more clusters.
Main.Cloudhsm_V2.initialize_cluster — Methodinitialize_cluster(cluster_id, signed_cert, trust_anchor)
initialize_cluster(cluster_id, signed_cert, trust_anchor, params::Dict{String,<:Any})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.
Arguments
cluster_id: The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.signed_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.trust_anchor: 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.
Main.Cloudhsm_V2.list_tags — Methodlist_tags(resource_id)
list_tags(resource_id, params::Dict{String,<:Any})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.
Arguments
resource_id: The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": 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."NextToken": The NextToken value that you received in the previous response. Use this value to get more tags.
Main.Cloudhsm_V2.modify_backup_attributes — Methodmodify_backup_attributes(backup_id, never_expires)
modify_backup_attributes(backup_id, never_expires, params::Dict{String,<:Any})Modifies attributes for AWS CloudHSM backup.
Arguments
backup_id: The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.never_expires: 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.
Main.Cloudhsm_V2.modify_cluster — Methodmodify_cluster(backup_retention_policy, cluster_id)
modify_cluster(backup_retention_policy, cluster_id, params::Dict{String,<:Any})Modifies AWS CloudHSM cluster.
Arguments
backup_retention_policy: A policy that defines how the service retains backups.cluster_id: The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use DescribeClusters.
Main.Cloudhsm_V2.restore_backup — Methodrestore_backup(backup_id)
restore_backup(backup_id, params::Dict{String,<:Any})Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.
Arguments
backup_id: The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.
Main.Cloudhsm_V2.tag_resource — Methodtag_resource(resource_id, tag_list)
tag_resource(resource_id, tag_list, params::Dict{String,<:Any})Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
Arguments
resource_id: The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.tag_list: A list of one or more tags.
Main.Cloudhsm_V2.untag_resource — Methoduntag_resource(resource_id, tag_key_list)
untag_resource(resource_id, tag_key_list, params::Dict{String,<:Any})Removes the specified tag or tags from the specified AWS CloudHSM cluster.
Arguments
resource_id: The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.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.