Interface AWSCloudHSMAsync

  • All Superinterfaces:
    AWSCloudHSM
    All Known Implementing Classes:
    AbstractAWSCloudHSMAsync, AWSCloudHSMAsyncClient

    public interface AWSCloudHSMAsync
    extends AWSCloudHSM
    Interface for accessing CloudHSM asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

    AWS CloudHSM Service

    • Method Detail

      • addTagsToResourceAsync

        Future<AddTagsToResourceResult> addTagsToResourceAsync​(AddTagsToResourceRequest addTagsToResourceRequest)

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

        Each tag consists of a key and a value. Tag keys must be unique to each resource.

        Parameters:
        addTagsToResourceRequest -
        Returns:
        A Java Future containing the result of the AddTagsToResource operation returned by the service.
      • addTagsToResourceAsync

        Future<AddTagsToResourceResult> addTagsToResourceAsync​(AddTagsToResourceRequest addTagsToResourceRequest,
                                                               AsyncHandler<AddTagsToResourceRequest,​AddTagsToResourceResult> asyncHandler)

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

        Each tag consists of a key and a value. Tag keys must be unique to each resource.

        Parameters:
        addTagsToResourceRequest -
        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.
        Returns:
        A Java Future containing the result of the AddTagsToResource operation returned by the service.
      • createHapgAsync

        Future<CreateHapgResult> createHapgAsync​(CreateHapgRequest createHapgRequest)

        Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

        Parameters:
        createHapgRequest - Contains the inputs for the CreateHapgRequest action.
        Returns:
        A Java Future containing the result of the CreateHapg operation returned by the service.
      • createHapgAsync

        Future<CreateHapgResult> createHapgAsync​(CreateHapgRequest createHapgRequest,
                                                 AsyncHandler<CreateHapgRequest,​CreateHapgResult> asyncHandler)

        Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

        Parameters:
        createHapgRequest - Contains the inputs for the CreateHapgRequest action.
        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.
        Returns:
        A Java Future containing the result of the CreateHapg operation returned by the service.
      • createHsmAsync

        Future<CreateHsmResult> createHsmAsync​(CreateHsmRequest createHsmRequest)

        Creates an uninitialized HSM instance.

        There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.

        It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.

        Parameters:
        createHsmRequest - Contains the inputs for the CreateHsm operation.
        Returns:
        A Java Future containing the result of the CreateHsm operation returned by the service.
      • createHsmAsync

        Future<CreateHsmResult> createHsmAsync​(CreateHsmRequest createHsmRequest,
                                               AsyncHandler<CreateHsmRequest,​CreateHsmResult> asyncHandler)

        Creates an uninitialized HSM instance.

        There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.

        It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.

        Parameters:
        createHsmRequest - Contains the inputs for the CreateHsm operation.
        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.
        Returns:
        A Java Future containing the result of the CreateHsm operation returned by the service.
      • createLunaClientAsync

        Future<CreateLunaClientResult> createLunaClientAsync​(CreateLunaClientRequest createLunaClientRequest)

        Creates an HSM client.

        Parameters:
        createLunaClientRequest - Contains the inputs for the CreateLunaClient action.
        Returns:
        A Java Future containing the result of the CreateLunaClient operation returned by the service.
      • createLunaClientAsync

        Future<CreateLunaClientResult> createLunaClientAsync​(CreateLunaClientRequest createLunaClientRequest,
                                                             AsyncHandler<CreateLunaClientRequest,​CreateLunaClientResult> asyncHandler)

        Creates an HSM client.

        Parameters:
        createLunaClientRequest - Contains the inputs for the CreateLunaClient action.
        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.
        Returns:
        A Java Future containing the result of the CreateLunaClient operation returned by the service.
      • deleteHapgAsync

        Future<DeleteHapgResult> deleteHapgAsync​(DeleteHapgRequest deleteHapgRequest)

        Deletes a high-availability partition group.

        Parameters:
        deleteHapgRequest - Contains the inputs for the DeleteHapg action.
        Returns:
        A Java Future containing the result of the DeleteHapg operation returned by the service.
      • deleteHapgAsync

        Future<DeleteHapgResult> deleteHapgAsync​(DeleteHapgRequest deleteHapgRequest,
                                                 AsyncHandler<DeleteHapgRequest,​DeleteHapgResult> asyncHandler)

        Deletes a high-availability partition group.

        Parameters:
        deleteHapgRequest - Contains the inputs for the DeleteHapg action.
        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.
        Returns:
        A Java Future containing the result of the DeleteHapg operation returned by the service.
      • deleteHsmAsync

        Future<DeleteHsmResult> deleteHsmAsync​(DeleteHsmRequest deleteHsmRequest)

        Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

        Parameters:
        deleteHsmRequest - Contains the inputs for the DeleteHsm operation.
        Returns:
        A Java Future containing the result of the DeleteHsm operation returned by the service.
      • deleteHsmAsync

        Future<DeleteHsmResult> deleteHsmAsync​(DeleteHsmRequest deleteHsmRequest,
                                               AsyncHandler<DeleteHsmRequest,​DeleteHsmResult> asyncHandler)

        Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

        Parameters:
        deleteHsmRequest - Contains the inputs for the DeleteHsm operation.
        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.
        Returns:
        A Java Future containing the result of the DeleteHsm operation returned by the service.
      • deleteLunaClientAsync

        Future<DeleteLunaClientResult> deleteLunaClientAsync​(DeleteLunaClientRequest deleteLunaClientRequest)

        Deletes a client.

        Parameters:
        deleteLunaClientRequest -
        Returns:
        A Java Future containing the result of the DeleteLunaClient operation returned by the service.
      • deleteLunaClientAsync

        Future<DeleteLunaClientResult> deleteLunaClientAsync​(DeleteLunaClientRequest deleteLunaClientRequest,
                                                             AsyncHandler<DeleteLunaClientRequest,​DeleteLunaClientResult> asyncHandler)

        Deletes a client.

        Parameters:
        deleteLunaClientRequest -
        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.
        Returns:
        A Java Future containing the result of the DeleteLunaClient operation returned by the service.
      • describeHapgAsync

        Future<DescribeHapgResult> describeHapgAsync​(DescribeHapgRequest describeHapgRequest)

        Retrieves information about a high-availability partition group.

        Parameters:
        describeHapgRequest - Contains the inputs for the DescribeHapg action.
        Returns:
        A Java Future containing the result of the DescribeHapg operation returned by the service.
      • describeHapgAsync

        Future<DescribeHapgResult> describeHapgAsync​(DescribeHapgRequest describeHapgRequest,
                                                     AsyncHandler<DescribeHapgRequest,​DescribeHapgResult> asyncHandler)

        Retrieves information about a high-availability partition group.

        Parameters:
        describeHapgRequest - Contains the inputs for the DescribeHapg action.
        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.
        Returns:
        A Java Future containing the result of the DescribeHapg operation returned by the service.
      • describeHsmAsync

        Future<DescribeHsmResult> describeHsmAsync​(DescribeHsmRequest describeHsmRequest)

        Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

        Parameters:
        describeHsmRequest - Contains the inputs for the DescribeHsm operation.
        Returns:
        A Java Future containing the result of the DescribeHsm operation returned by the service.
      • describeHsmAsync

        Future<DescribeHsmResult> describeHsmAsync​(DescribeHsmRequest describeHsmRequest,
                                                   AsyncHandler<DescribeHsmRequest,​DescribeHsmResult> asyncHandler)

        Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

        Parameters:
        describeHsmRequest - Contains the inputs for the DescribeHsm operation.
        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.
        Returns:
        A Java Future containing the result of the DescribeHsm operation returned by the service.
      • describeLunaClientAsync

        Future<DescribeLunaClientResult> describeLunaClientAsync​(DescribeLunaClientRequest describeLunaClientRequest)

        Retrieves information about an HSM client.

        Parameters:
        describeLunaClientRequest -
        Returns:
        A Java Future containing the result of the DescribeLunaClient operation returned by the service.
      • describeLunaClientAsync

        Future<DescribeLunaClientResult> describeLunaClientAsync​(DescribeLunaClientRequest describeLunaClientRequest,
                                                                 AsyncHandler<DescribeLunaClientRequest,​DescribeLunaClientResult> asyncHandler)

        Retrieves information about an HSM client.

        Parameters:
        describeLunaClientRequest -
        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.
        Returns:
        A Java Future containing the result of the DescribeLunaClient operation returned by the service.
      • getConfigAsync

        Future<GetConfigResult> getConfigAsync​(GetConfigRequest getConfigRequest)

        Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

        Parameters:
        getConfigRequest -
        Returns:
        A Java Future containing the result of the GetConfig operation returned by the service.
      • getConfigAsync

        Future<GetConfigResult> getConfigAsync​(GetConfigRequest getConfigRequest,
                                               AsyncHandler<GetConfigRequest,​GetConfigResult> asyncHandler)

        Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

        Parameters:
        getConfigRequest -
        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.
        Returns:
        A Java Future containing the result of the GetConfig operation returned by the service.
      • listAvailableZonesAsync

        Future<ListAvailableZonesResult> listAvailableZonesAsync​(ListAvailableZonesRequest listAvailableZonesRequest)

        Lists the Availability Zones that have available AWS CloudHSM capacity.

        Parameters:
        listAvailableZonesRequest - Contains the inputs for the ListAvailableZones action.
        Returns:
        A Java Future containing the result of the ListAvailableZones operation returned by the service.
      • listAvailableZonesAsync

        Future<ListAvailableZonesResult> listAvailableZonesAsync​(ListAvailableZonesRequest listAvailableZonesRequest,
                                                                 AsyncHandler<ListAvailableZonesRequest,​ListAvailableZonesResult> asyncHandler)

        Lists the Availability Zones that have available AWS CloudHSM capacity.

        Parameters:
        listAvailableZonesRequest - Contains the inputs for the ListAvailableZones action.
        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.
        Returns:
        A Java Future containing the result of the ListAvailableZones operation returned by the service.
      • listHapgsAsync

        Future<ListHapgsResult> listHapgsAsync​(ListHapgsRequest listHapgsRequest)

        Lists the high-availability partition groups for the account.

        This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

        Parameters:
        listHapgsRequest -
        Returns:
        A Java Future containing the result of the ListHapgs operation returned by the service.
      • listHapgsAsync

        Future<ListHapgsResult> listHapgsAsync​(ListHapgsRequest listHapgsRequest,
                                               AsyncHandler<ListHapgsRequest,​ListHapgsResult> asyncHandler)

        Lists the high-availability partition groups for the account.

        This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

        Parameters:
        listHapgsRequest -
        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.
        Returns:
        A Java Future containing the result of the ListHapgs operation returned by the service.
      • listHsmsAsync

        Future<ListHsmsResult> listHsmsAsync​(ListHsmsRequest listHsmsRequest)

        Retrieves the identifiers of all of the HSMs provisioned for the current customer.

        This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

        Parameters:
        listHsmsRequest -
        Returns:
        A Java Future containing the result of the ListHsms operation returned by the service.
      • listHsmsAsync

        Future<ListHsmsResult> listHsmsAsync​(ListHsmsRequest listHsmsRequest,
                                             AsyncHandler<ListHsmsRequest,​ListHsmsResult> asyncHandler)

        Retrieves the identifiers of all of the HSMs provisioned for the current customer.

        This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

        Parameters:
        listHsmsRequest -
        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.
        Returns:
        A Java Future containing the result of the ListHsms operation returned by the service.
      • listLunaClientsAsync

        Future<ListLunaClientsResult> listLunaClientsAsync​(ListLunaClientsRequest listLunaClientsRequest)

        Lists all of the clients.

        This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

        Parameters:
        listLunaClientsRequest -
        Returns:
        A Java Future containing the result of the ListLunaClients operation returned by the service.
      • listLunaClientsAsync

        Future<ListLunaClientsResult> listLunaClientsAsync​(ListLunaClientsRequest listLunaClientsRequest,
                                                           AsyncHandler<ListLunaClientsRequest,​ListLunaClientsResult> asyncHandler)

        Lists all of the clients.

        This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

        Parameters:
        listLunaClientsRequest -
        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.
        Returns:
        A Java Future containing the result of the ListLunaClients operation returned by the service.
      • listTagsForResourceAsync

        Future<ListTagsForResourceResult> listTagsForResourceAsync​(ListTagsForResourceRequest listTagsForResourceRequest)

        Returns a list of all tags for the specified AWS CloudHSM resource.

        Parameters:
        listTagsForResourceRequest -
        Returns:
        A Java Future containing the result of the ListTagsForResource operation returned by the service.
      • listTagsForResourceAsync

        Future<ListTagsForResourceResult> listTagsForResourceAsync​(ListTagsForResourceRequest listTagsForResourceRequest,
                                                                   AsyncHandler<ListTagsForResourceRequest,​ListTagsForResourceResult> asyncHandler)

        Returns a list of all tags for the specified AWS CloudHSM resource.

        Parameters:
        listTagsForResourceRequest -
        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.
        Returns:
        A Java Future containing the result of the ListTagsForResource operation returned by the service.
      • modifyHapgAsync

        Future<ModifyHapgResult> modifyHapgAsync​(ModifyHapgRequest modifyHapgRequest)

        Modifies an existing high-availability partition group.

        Parameters:
        modifyHapgRequest -
        Returns:
        A Java Future containing the result of the ModifyHapg operation returned by the service.
      • modifyHapgAsync

        Future<ModifyHapgResult> modifyHapgAsync​(ModifyHapgRequest modifyHapgRequest,
                                                 AsyncHandler<ModifyHapgRequest,​ModifyHapgResult> asyncHandler)

        Modifies an existing high-availability partition group.

        Parameters:
        modifyHapgRequest -
        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.
        Returns:
        A Java Future containing the result of the ModifyHapg operation returned by the service.
      • modifyHsmAsync

        Future<ModifyHsmResult> modifyHsmAsync​(ModifyHsmRequest modifyHsmRequest)

        Modifies an HSM.

        This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

        Parameters:
        modifyHsmRequest - Contains the inputs for the ModifyHsm operation.
        Returns:
        A Java Future containing the result of the ModifyHsm operation returned by the service.
      • modifyHsmAsync

        Future<ModifyHsmResult> modifyHsmAsync​(ModifyHsmRequest modifyHsmRequest,
                                               AsyncHandler<ModifyHsmRequest,​ModifyHsmResult> asyncHandler)

        Modifies an HSM.

        This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

        Parameters:
        modifyHsmRequest - Contains the inputs for the ModifyHsm operation.
        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.
        Returns:
        A Java Future containing the result of the ModifyHsm operation returned by the service.
      • modifyLunaClientAsync

        Future<ModifyLunaClientResult> modifyLunaClientAsync​(ModifyLunaClientRequest modifyLunaClientRequest)

        Modifies the certificate used by the client.

        This action can potentially start a workflow to install the new certificate on the client's HSMs.

        Parameters:
        modifyLunaClientRequest -
        Returns:
        A Java Future containing the result of the ModifyLunaClient operation returned by the service.
      • modifyLunaClientAsync

        Future<ModifyLunaClientResult> modifyLunaClientAsync​(ModifyLunaClientRequest modifyLunaClientRequest,
                                                             AsyncHandler<ModifyLunaClientRequest,​ModifyLunaClientResult> asyncHandler)

        Modifies the certificate used by the client.

        This action can potentially start a workflow to install the new certificate on the client's HSMs.

        Parameters:
        modifyLunaClientRequest -
        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.
        Returns:
        A Java Future containing the result of the ModifyLunaClient operation returned by the service.
      • removeTagsFromResourceAsync

        Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync​(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

        Removes one or more tags from the specified AWS CloudHSM resource.

        To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

        Parameters:
        removeTagsFromResourceRequest -
        Returns:
        A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
      • removeTagsFromResourceAsync

        Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync​(RemoveTagsFromResourceRequest removeTagsFromResourceRequest,
                                                                         AsyncHandler<RemoveTagsFromResourceRequest,​RemoveTagsFromResourceResult> asyncHandler)

        Removes one or more tags from the specified AWS CloudHSM resource.

        To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

        Parameters:
        removeTagsFromResourceRequest -
        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.
        Returns:
        A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.