String backupId
The identifier (ID) of the backup.
String backupArn
The Amazon Resource Name (ARN) of the backup.
String backupState
The state of the backup.
String clusterId
The identifier (ID) of the cluster that was backed up.
Date createTimestamp
The date and time when the backup was created.
Date copyTimestamp
The date and time when the backup was copied from a source backup.
Boolean neverExpires
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.
String sourceRegion
The AWS Region that contains the source backup from which the new backup was copied.
String sourceBackup
The identifier (ID) of the source backup from which the new backup was copied.
String sourceCluster
The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
Date deleteTimestamp
The date and time when the backup will be permanently deleted.
List<E> tagList
The list of tags for the backup.
String hsmType
The HSM type used to create the backup.
String mode
The mode of the cluster that was backed up.
String clusterCsr
The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is
UNINITIALIZED.
String hsmCertificate
The HSM certificate issued (signed) by the HSM hardware.
String awsHardwareCertificate
The HSM hardware certificate issued (signed) by CloudHSM.
String manufacturerHardwareCertificate
The HSM hardware certificate issued (signed) by the hardware manufacturer.
String clusterCertificate
The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
String backupPolicy
The cluster's backup policy.
BackupRetentionPolicy backupRetentionPolicy
A policy that defines how the service retains backups.
String clusterId
The cluster's identifier (ID).
Date createTimestamp
The date and time when the cluster was created.
List<E> hsms
Contains information about the HSMs in the cluster.
String hsmType
The type of HSM that the cluster contains.
String preCoPassword
The default password for the cluster's Pre-Crypto Officer (PRECO) user.
String securityGroup
The identifier (ID) of the cluster's security group.
String sourceBackupId
The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
String state
The cluster's state.
String stateMessage
A description of the cluster's state.
Map<K,V> subnetMapping
A map from availability zone to the cluster’s subnet in that availability zone.
String vpcId
The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
Certificates certificates
Contains one or more certificates or a certificate signing request (CSR).
List<E> tagList
The list of tags for the cluster.
String mode
The mode of the cluster.
String destinationRegion
The AWS region that will contain your copied CloudHSM cluster backup.
String backupId
The ID of the backup that will be copied to the destination region.
List<E> 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.
DestinationBackup destinationBackup
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.
BackupRetentionPolicy backupRetentionPolicy
A policy that defines how the service retains backups.
String hsmType
The type of HSM to use in the cluster. The allowed values are hsm1.medium and
hsm2m.medium.
String sourceBackupId
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.
List<E> subnetIds
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.
List<E> tagList
Tags to apply to the CloudHSM cluster during creation.
String mode
The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
Cluster cluster
Information about the cluster that was created.
String clusterId
The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.
String availabilityZone
The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.
String 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.
Hsm hsm
Information about the HSM that was created.
String backupId
The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.
Backup backup
Information on the Backup object deleted.
String clusterId
The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.
Cluster cluster
Information about the cluster that was deleted.
String clusterId
The identifier (ID) of the cluster that contains the HSM that you are deleting.
String hsmId
The identifier (ID) of the HSM that you are deleting.
String eniId
The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.
String eniIp
The IP address of the elastic network interface (ENI) of the HSM that you are deleting.
String hsmId
The identifier (ID) of the HSM that was deleted.
String resourceArn
Amazon Resource Name (ARN) of the resource from which the policy will be removed.
String nextToken
The NextToken value that you received in the previous response. Use this value to get more backups.
Integer 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.
Map<K,V> 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.
Boolean shared
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.
Boolean sortAscending
Designates whether or not to sort the return backups by ascending chronological order of generation.
Map<K,V> 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.
String nextToken
The NextToken value that you received in the previous response. Use this value to get more clusters.
Integer 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.
Date createTimestamp
The date and time when both the source backup was created.
String sourceRegion
The AWS region that contains the source backup from which the new backup was copied.
String sourceBackup
The identifier (ID) of the source backup from which the new backup was copied.
String sourceCluster
The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
String resourceArn
Amazon Resource Name (ARN) of the resource to which a policy is attached.
String policy
The policy attached to a resource.
String availabilityZone
The Availability Zone that contains the HSM.
String clusterId
The identifier (ID) of the cluster that contains the HSM.
String subnetId
The subnet that contains the HSM's elastic network interface (ENI).
String eniId
The identifier (ID) of the HSM's elastic network interface (ENI).
String eniIp
The IP address of the HSM's elastic network interface (ENI).
String hsmId
The HSM's identifier (ID).
String state
The HSM's state.
String stateMessage
A description of the HSM's state.
String clusterId
The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.
String signedCert
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.
String trustAnchor
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.
String resourceId
The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.
String nextToken
The NextToken value that you received in the previous response. Use this value to get more tags.
Integer 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.
String backupId
The identifier (ID) of the backup to modify. To find the ID of a backup, use the DescribeBackups operation.
Boolean neverExpires
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.
Backup backup
BackupRetentionPolicy backupRetentionPolicy
A policy that defines how the service retains backups.
String clusterId
The identifier (ID) of the cluster that you want to modify. To find the cluster ID, use DescribeClusters.
Cluster cluster
String resourceArn
Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
String policy
The policy you want to associate with a resource.
For an example policy, see Working with shared backups in the CloudHSM User Guide
String backupId
The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.
Backup backup
Information on the Backup object created.
String resourceId
The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.
List<E> tagList
A list of one or more tags.
String resourceId
The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.
List<E> tagKeyList
A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.
Copyright © 2025. All rights reserved.