/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cloudhsmv2; import javax.annotation.Generated; import com.amazonaws.services.cloudhsmv2.model.*; /** * Interface for accessing CloudHSM V2 asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.cloudhsmv2.AbstractAWSCloudHSMV2Async} instead. *

*

*

* For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSCloudHSMV2Async extends AWSCloudHSMV2 { /** *

* Copy an AWS CloudHSM cluster backup to a different region. *

* * @param copyBackupToRegionRequest * @return A Java Future containing the result of the CopyBackupToRegion operation returned by the service. * @sample AWSCloudHSMV2Async.CopyBackupToRegion * @see AWS * API Documentation */ java.util.concurrent.Future copyBackupToRegionAsync(CopyBackupToRegionRequest copyBackupToRegionRequest); /** *

* Copy an AWS CloudHSM cluster backup to a different region. *

* * @param copyBackupToRegionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CopyBackupToRegion operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.CopyBackupToRegion * @see AWS * API Documentation */ java.util.concurrent.Future copyBackupToRegionAsync(CopyBackupToRegionRequest copyBackupToRegionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates a new AWS CloudHSM cluster. *

* * @param createClusterRequest * @return A Java Future containing the result of the CreateCluster operation returned by the service. * @sample AWSCloudHSMV2Async.CreateCluster * @see AWS API * Documentation */ java.util.concurrent.Future createClusterAsync(CreateClusterRequest createClusterRequest); /** *

* Creates a new AWS CloudHSM cluster. *

* * @param createClusterRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateCluster operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.CreateCluster * @see AWS API * Documentation */ java.util.concurrent.Future createClusterAsync(CreateClusterRequest createClusterRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param createHsmRequest * @return A Java Future containing the result of the CreateHsm operation returned by the service. * @sample AWSCloudHSMV2Async.CreateHsm * @see AWS API * Documentation */ java.util.concurrent.Future createHsmAsync(CreateHsmRequest createHsmRequest); /** *

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

* * @param createHsmRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateHsm operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.CreateHsm * @see AWS API * Documentation */ java.util.concurrent.Future createHsmAsync(CreateHsmRequest createHsmRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param deleteBackupRequest * @return A Java Future containing the result of the DeleteBackup operation returned by the service. * @sample AWSCloudHSMV2Async.DeleteBackup * @see AWS API * Documentation */ java.util.concurrent.Future deleteBackupAsync(DeleteBackupRequest deleteBackupRequest); /** *

* 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. *

* * @param deleteBackupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteBackup operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.DeleteBackup * @see AWS API * Documentation */ java.util.concurrent.Future deleteBackupAsync(DeleteBackupRequest deleteBackupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param deleteClusterRequest * @return A Java Future containing the result of the DeleteCluster operation returned by the service. * @sample AWSCloudHSMV2Async.DeleteCluster * @see AWS API * Documentation */ java.util.concurrent.Future deleteClusterAsync(DeleteClusterRequest deleteClusterRequest); /** *

* 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. *

* * @param deleteClusterRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteCluster operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.DeleteCluster * @see AWS API * Documentation */ java.util.concurrent.Future deleteClusterAsync(DeleteClusterRequest deleteClusterRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param deleteHsmRequest * @return A Java Future containing the result of the DeleteHsm operation returned by the service. * @sample AWSCloudHSMV2Async.DeleteHsm * @see AWS API * Documentation */ java.util.concurrent.Future deleteHsmAsync(DeleteHsmRequest deleteHsmRequest); /** *

* 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. *

* * @param deleteHsmRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteHsm operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.DeleteHsm * @see AWS API * Documentation */ java.util.concurrent.Future deleteHsmAsync(DeleteHsmRequest deleteHsmRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeBackupsRequest * @return A Java Future containing the result of the DescribeBackups operation returned by the service. * @sample AWSCloudHSMV2Async.DescribeBackups * @see AWS API * Documentation */ java.util.concurrent.Future describeBackupsAsync(DescribeBackupsRequest describeBackupsRequest); /** *

* 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. *

* * @param describeBackupsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeBackups operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.DescribeBackups * @see AWS API * Documentation */ java.util.concurrent.Future describeBackupsAsync(DescribeBackupsRequest describeBackupsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param describeClustersRequest * @return A Java Future containing the result of the DescribeClusters operation returned by the service. * @sample AWSCloudHSMV2Async.DescribeClusters * @see AWS * API Documentation */ java.util.concurrent.Future describeClustersAsync(DescribeClustersRequest describeClustersRequest); /** *

* 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. *

* * @param describeClustersRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeClusters operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.DescribeClusters * @see AWS * API Documentation */ java.util.concurrent.Future describeClustersAsync(DescribeClustersRequest describeClustersRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param initializeClusterRequest * @return A Java Future containing the result of the InitializeCluster operation returned by the service. * @sample AWSCloudHSMV2Async.InitializeCluster * @see AWS * API Documentation */ java.util.concurrent.Future initializeClusterAsync(InitializeClusterRequest initializeClusterRequest); /** *

* 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. *

* * @param initializeClusterRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the InitializeCluster operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.InitializeCluster * @see AWS * API Documentation */ java.util.concurrent.Future initializeClusterAsync(InitializeClusterRequest initializeClusterRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param listTagsRequest * @return A Java Future containing the result of the ListTags operation returned by the service. * @sample AWSCloudHSMV2Async.ListTags * @see AWS API * Documentation */ java.util.concurrent.Future listTagsAsync(ListTagsRequest listTagsRequest); /** *

* 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. *

* * @param listTagsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTags operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.ListTags * @see AWS API * Documentation */ java.util.concurrent.Future listTagsAsync(ListTagsRequest listTagsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Modifies attributes for AWS CloudHSM backup. *

* * @param modifyBackupAttributesRequest * @return A Java Future containing the result of the ModifyBackupAttributes operation returned by the service. * @sample AWSCloudHSMV2Async.ModifyBackupAttributes * @see AWS API Documentation */ java.util.concurrent.Future modifyBackupAttributesAsync(ModifyBackupAttributesRequest modifyBackupAttributesRequest); /** *

* Modifies attributes for AWS CloudHSM backup. *

* * @param modifyBackupAttributesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ModifyBackupAttributes operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.ModifyBackupAttributes * @see AWS API Documentation */ java.util.concurrent.Future modifyBackupAttributesAsync(ModifyBackupAttributesRequest modifyBackupAttributesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Modifies AWS CloudHSM cluster. *

* * @param modifyClusterRequest * @return A Java Future containing the result of the ModifyCluster operation returned by the service. * @sample AWSCloudHSMV2Async.ModifyCluster * @see AWS API * Documentation */ java.util.concurrent.Future modifyClusterAsync(ModifyClusterRequest modifyClusterRequest); /** *

* Modifies AWS CloudHSM cluster. *

* * @param modifyClusterRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ModifyCluster operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.ModifyCluster * @see AWS API * Documentation */ java.util.concurrent.Future modifyClusterAsync(ModifyClusterRequest modifyClusterRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param restoreBackupRequest * @return A Java Future containing the result of the RestoreBackup operation returned by the service. * @sample AWSCloudHSMV2Async.RestoreBackup * @see AWS API * Documentation */ java.util.concurrent.Future restoreBackupAsync(RestoreBackupRequest restoreBackupRequest); /** *

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

* * @param restoreBackupRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the RestoreBackup operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.RestoreBackup * @see AWS API * Documentation */ java.util.concurrent.Future restoreBackupAsync(RestoreBackupRequest restoreBackupRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSCloudHSMV2Async.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest); /** *

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

* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Removes the specified tag or tags from the specified AWS CloudHSM cluster. *

* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSCloudHSMV2Async.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest); /** *

* Removes the specified tag or tags from the specified AWS CloudHSM cluster. *

* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSCloudHSMV2AsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }