CloudHSMV2 class
For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.
Constructors
- CloudHSMV2({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
copyBackupToRegion(
{required String backupId, required String destinationRegion, List< Tag> ? tagList}) → Future<CopyBackupToRegionResponse> - Copy an AWS CloudHSM cluster backup to a different region.
-
createCluster(
{required String hsmType, required List< String> subnetIds, BackupRetentionPolicy? backupRetentionPolicy, String? sourceBackupId, List<Tag> ? tagList}) → Future<CreateClusterResponse> - Creates a new AWS CloudHSM cluster.
-
createHsm(
{required String availabilityZone, required String clusterId, String? ipAddress}) → Future< CreateHsmResponse> - Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
-
deleteBackup(
{required String backupId}) → Future< DeleteBackupResponse> - 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.
-
deleteCluster(
{required String clusterId}) → Future< DeleteClusterResponse> - 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.
-
deleteHsm(
{required String clusterId, String? eniId, String? eniIp, String? hsmId}) → Future< DeleteHsmResponse> - 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.
-
describeBackups(
{Map< String, List< ? filters, int? maxResults, String? nextToken, bool? sortAscending}) → Future<String> >DescribeBackupsResponse> - Gets information about backups of AWS CloudHSM clusters.
-
describeClusters(
{Map< String, List< ? filters, int? maxResults, String? nextToken}) → Future<String> >DescribeClustersResponse> - Gets information about AWS CloudHSM clusters.
-
initializeCluster(
{required String clusterId, required String signedCert, required String trustAnchor}) → Future< InitializeClusterResponse> - 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.
-
listTags(
{required String resourceId, int? maxResults, String? nextToken}) → Future< ListTagsResponse> - Gets a list of tags for the specified AWS CloudHSM cluster.
-
modifyBackupAttributes(
{required String backupId, required bool neverExpires}) → Future< ModifyBackupAttributesResponse> - Modifies attributes for AWS CloudHSM backup.
-
modifyCluster(
{required BackupRetentionPolicy backupRetentionPolicy, required String clusterId}) → Future< ModifyClusterResponse> - Modifies AWS CloudHSM cluster.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
restoreBackup(
{required String backupId}) → Future< RestoreBackupResponse> -
Restores a specified AWS CloudHSM backup that is in the
PENDING_DELETIONstate. For mor information on deleting a backup, see DeleteBackup. -
tagResource(
{required String resourceId, required List< Tag> tagList}) → Future<void> - Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceId, required List< String> tagKeyList}) → Future<void> - Removes the specified tag or tags from the specified AWS CloudHSM cluster.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited