Package software.amazon.awssdk.services.cloudhsmv2

Interface CloudHsmV2AsyncClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CloudHsmV2AsyncClient
extends AwsClient
    Service client for accessing CloudHSM V2 asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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

    • Method Detail

      • copyBackupToRegion

        default CompletableFuture<CopyBackupToRegionResponse> copyBackupToRegion​(CopyBackupToRegionRequest copyBackupToRegionRequest)

        Copy an CloudHSM cluster backup to a different region.

        Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

        Parameters:
        copyBackupToRegionRequest -
        Returns:
        A Java Future containing the result of the CopyBackupToRegion operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • copyBackupToRegion

        default CompletableFuture<CopyBackupToRegionResponse> copyBackupToRegion​(Consumer<CopyBackupToRegionRequest.Builder> copyBackupToRegionRequest)

        Copy an CloudHSM cluster backup to a different region.

        Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.


        This is a convenience which creates an instance of the CopyBackupToRegionRequest.Builder avoiding the need to create one manually via CopyBackupToRegionRequest.builder()

        Parameters:
        copyBackupToRegionRequest - A Consumer that will call methods on CopyBackupToRegionRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the CopyBackupToRegion operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createCluster

        default CompletableFuture<CreateClusterResponse> createCluster​(CreateClusterRequest createClusterRequest)

        Creates a new CloudHSM cluster.

        Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.

        Parameters:
        createClusterRequest -
        Returns:
        A Java Future containing the result of the CreateCluster operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createCluster

        default CompletableFuture<CreateClusterResponse> createCluster​(Consumer<CreateClusterRequest.Builder> createClusterRequest)

        Creates a new CloudHSM cluster.

        Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.


        This is a convenience which creates an instance of the CreateClusterRequest.Builder avoiding the need to create one manually via CreateClusterRequest.builder()

        Parameters:
        createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the CreateCluster operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createHsm

        default CompletableFuture<CreateHsmResponse> createHsm​(CreateHsmRequest createHsmRequest)

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

        Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.

        Parameters:
        createHsmRequest -
        Returns:
        A Java Future containing the result of the CreateHsm operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createHsm

        default CompletableFuture<CreateHsmResponse> createHsm​(Consumer<CreateHsmRequest.Builder> createHsmRequest)

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

        Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.


        This is a convenience which creates an instance of the CreateHsmRequest.Builder avoiding the need to create one manually via CreateHsmRequest.builder()

        Parameters:
        createHsmRequest - A Consumer that will call methods on CreateHsmRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the CreateHsm operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBackup

        default CompletableFuture<DeleteBackupResponse> deleteBackup​(DeleteBackupRequest deleteBackupRequest)

        Deletes a specified 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.

        Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

        Parameters:
        deleteBackupRequest -
        Returns:
        A Java Future containing the result of the DeleteBackup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBackup

        default CompletableFuture<DeleteBackupResponse> deleteBackup​(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)

        Deletes a specified 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.

        Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.


        This is a convenience which creates an instance of the DeleteBackupRequest.Builder avoiding the need to create one manually via DeleteBackupRequest.builder()

        Parameters:
        deleteBackupRequest - A Consumer that will call methods on DeleteBackupRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteBackup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteCluster

        default CompletableFuture<DeleteClusterResponse> deleteCluster​(DeleteClusterRequest deleteClusterRequest)

        Deletes the specified 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.

        Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

        Parameters:
        deleteClusterRequest -
        Returns:
        A Java Future containing the result of the DeleteCluster operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteCluster

        default CompletableFuture<DeleteClusterResponse> deleteCluster​(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)

        Deletes the specified 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.

        Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.


        This is a convenience which creates an instance of the DeleteClusterRequest.Builder avoiding the need to create one manually via DeleteClusterRequest.builder()

        Parameters:
        deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteCluster operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteHsm

        default CompletableFuture<DeleteHsmResponse> deleteHsm​(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.

        Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.

        Parameters:
        deleteHsmRequest -
        Returns:
        A Java Future containing the result of the DeleteHsm operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteHsm

        default CompletableFuture<DeleteHsmResponse> deleteHsm​(Consumer<DeleteHsmRequest.Builder> 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.

        Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.


        This is a convenience which creates an instance of the DeleteHsmRequest.Builder avoiding the need to create one manually via DeleteHsmRequest.builder()

        Parameters:
        deleteHsmRequest - A Consumer that will call methods on DeleteHsmRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteHsm operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteResourcePolicy

        default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy​(DeleteResourcePolicyRequest deleteResourcePolicyRequest)

        Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that backup.

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

        Parameters:
        deleteResourcePolicyRequest -
        Returns:
        A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteResourcePolicy

        default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy​(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)

        Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that backup.

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.


        This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the need to create one manually via DeleteResourcePolicyRequest.builder()

        Parameters:
        deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBackups

        default CompletableFuture<DescribeBackupsResponse> describeBackups​(DescribeBackupsRequest describeBackupsRequest)

        Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.

        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.

        Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.

        Parameters:
        describeBackupsRequest -
        Returns:
        A Java Future containing the result of the DescribeBackups operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBackups

        default CompletableFuture<DescribeBackupsResponse> describeBackups​(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)

        Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.

        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.

        Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.


        This is a convenience which creates an instance of the DescribeBackupsRequest.Builder avoiding the need to create one manually via DescribeBackupsRequest.builder()

        Parameters:
        describeBackupsRequest - A Consumer that will call methods on DescribeBackupsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DescribeBackups operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBackups

        default CompletableFuture<DescribeBackupsResponse> describeBackups()

        Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.

        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.

        Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.

        Returns:
        A Java Future containing the result of the DescribeBackups operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBackupsPaginator

        default DescribeBackupsPublisher describeBackupsPaginator()

        This is a variant of describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest) operation.

        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBackupsPaginator

        default DescribeBackupsPublisher describeBackupsPaginator​(DescribeBackupsRequest describeBackupsRequest)

        This is a variant of describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest) operation.

        Parameters:
        describeBackupsRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBackupsPaginator

        default DescribeBackupsPublisher describeBackupsPaginator​(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)

        This is a variant of describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest) operation.


        This is a convenience which creates an instance of the DescribeBackupsRequest.Builder avoiding the need to create one manually via DescribeBackupsRequest.builder()

        Parameters:
        describeBackupsRequest - A Consumer that will call methods on DescribeBackupsRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeClusters

        default CompletableFuture<DescribeClustersResponse> describeClusters​(DescribeClustersRequest describeClustersRequest)

        Gets information about 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.

        Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.

        Parameters:
        describeClustersRequest -
        Returns:
        A Java Future containing the result of the DescribeClusters operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeClusters

        default CompletableFuture<DescribeClustersResponse> describeClusters​(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)

        Gets information about 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.

        Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.


        This is a convenience which creates an instance of the DescribeClustersRequest.Builder avoiding the need to create one manually via DescribeClustersRequest.builder()

        Parameters:
        describeClustersRequest - A Consumer that will call methods on DescribeClustersRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DescribeClusters operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeClusters

        default CompletableFuture<DescribeClustersResponse> describeClusters()

        Gets information about 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.

        Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.

        Returns:
        A Java Future containing the result of the DescribeClusters operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeClustersPaginator

        default DescribeClustersPublisher describeClustersPaginator()

        This is a variant of describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation.

        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeClustersPaginator

        default DescribeClustersPublisher describeClustersPaginator​(DescribeClustersRequest describeClustersRequest)

        This is a variant of describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation.

        Parameters:
        describeClustersRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeClustersPaginator

        default DescribeClustersPublisher describeClustersPaginator​(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)

        This is a variant of describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation.


        This is a convenience which creates an instance of the DescribeClustersRequest.Builder avoiding the need to create one manually via DescribeClustersRequest.builder()

        Parameters:
        describeClustersRequest - A Consumer that will call methods on DescribeClustersRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getResourcePolicy

        default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy​(GetResourcePolicyRequest getResourcePolicyRequest)

        Retrieves the resource policy document attached to a given resource.

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

        Parameters:
        getResourcePolicyRequest -
        Returns:
        A Java Future containing the result of the GetResourcePolicy operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • getResourcePolicy

        default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy​(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)

        Retrieves the resource policy document attached to a given resource.

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.


        This is a convenience which creates an instance of the GetResourcePolicyRequest.Builder avoiding the need to create one manually via GetResourcePolicyRequest.builder()

        Parameters:
        getResourcePolicyRequest - A Consumer that will call methods on GetResourcePolicyRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the GetResourcePolicy operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • initializeCluster

        default CompletableFuture<InitializeClusterResponse> initializeCluster​(InitializeClusterRequest initializeClusterRequest)

        Claims an 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.

        Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

        Parameters:
        initializeClusterRequest -
        Returns:
        A Java Future containing the result of the InitializeCluster operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • initializeCluster

        default CompletableFuture<InitializeClusterResponse> initializeCluster​(Consumer<InitializeClusterRequest.Builder> initializeClusterRequest)

        Claims an 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.

        Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.


        This is a convenience which creates an instance of the InitializeClusterRequest.Builder avoiding the need to create one manually via InitializeClusterRequest.builder()

        Parameters:
        initializeClusterRequest - A Consumer that will call methods on InitializeClusterRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the InitializeCluster operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTags

        default CompletableFuture<ListTagsResponse> listTags​(ListTagsRequest listTagsRequest)

        Gets a list of tags for the specified 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.

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

        Parameters:
        listTagsRequest -
        Returns:
        A Java Future containing the result of the ListTags operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTags

        default CompletableFuture<ListTagsResponse> listTags​(Consumer<ListTagsRequest.Builder> listTagsRequest)

        Gets a list of tags for the specified 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.

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.


        This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to create one manually via ListTagsRequest.builder()

        Parameters:
        listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListTags operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTagsPaginator

        default ListTagsPublisher listTagsPaginator​(ListTagsRequest listTagsRequest)

        This is a variant of listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest) operation.

        Parameters:
        listTagsRequest -
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTagsPaginator

        default ListTagsPublisher listTagsPaginator​(Consumer<ListTagsRequest.Builder> listTagsRequest)

        This is a variant of listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

        Note: If you prefer to have control on service calls, use the listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest) operation.


        This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to create one manually via ListTagsRequest.builder()

        Parameters:
        listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.
        Returns:
        A custom publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • modifyBackupAttributes

        default CompletableFuture<ModifyBackupAttributesResponse> modifyBackupAttributes​(ModifyBackupAttributesRequest modifyBackupAttributesRequest)

        Modifies attributes for CloudHSM backup.

        Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

        Parameters:
        modifyBackupAttributesRequest -
        Returns:
        A Java Future containing the result of the ModifyBackupAttributes operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • modifyBackupAttributes

        default CompletableFuture<ModifyBackupAttributesResponse> modifyBackupAttributes​(Consumer<ModifyBackupAttributesRequest.Builder> modifyBackupAttributesRequest)

        Modifies attributes for CloudHSM backup.

        Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.


        This is a convenience which creates an instance of the ModifyBackupAttributesRequest.Builder avoiding the need to create one manually via ModifyBackupAttributesRequest.builder()

        Parameters:
        modifyBackupAttributesRequest - A Consumer that will call methods on ModifyBackupAttributesRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ModifyBackupAttributes operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • modifyCluster

        default CompletableFuture<ModifyClusterResponse> modifyCluster​(ModifyClusterRequest modifyClusterRequest)

        Modifies CloudHSM cluster.

        Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.

        Parameters:
        modifyClusterRequest -
        Returns:
        A Java Future containing the result of the ModifyCluster operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • modifyCluster

        default CompletableFuture<ModifyClusterResponse> modifyCluster​(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest)

        Modifies CloudHSM cluster.

        Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.


        This is a convenience which creates an instance of the ModifyClusterRequest.Builder avoiding the need to create one manually via ModifyClusterRequest.builder()

        Parameters:
        modifyClusterRequest - A Consumer that will call methods on ModifyClusterRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ModifyCluster operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • putResourcePolicy

        default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy​(PutResourcePolicyRequest putResourcePolicyRequest)

        Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support CloudHSM resource policies:

        • Backup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account.

        In order to share a backup, it must be in a 'READY' state and you must own it.

        While you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple resources to be shared at one time, and increases the discoverability of shared resources. If you use PutResourcePolicy and want consumers to be able to describe the backups you share with them, you must promote the backup to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information, see Working with shared backups in the CloudHSM User Guide

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

        Parameters:
        putResourcePolicyRequest -
        Returns:
        A Java Future containing the result of the PutResourcePolicy operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • putResourcePolicy

        default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy​(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)

        Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support CloudHSM resource policies:

        • Backup - The resource policy allows you to describe the backup and restore a cluster from the backup in another Amazon Web Services account.

        In order to share a backup, it must be in a 'READY' state and you must own it.

        While you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple resources to be shared at one time, and increases the discoverability of shared resources. If you use PutResourcePolicy and want consumers to be able to describe the backups you share with them, you must promote the backup to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information, see Working with shared backups in the CloudHSM User Guide

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.


        This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need to create one manually via PutResourcePolicyRequest.builder()

        Parameters:
        putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the PutResourcePolicy operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • restoreBackup

        default CompletableFuture<RestoreBackupResponse> restoreBackup​(RestoreBackupRequest restoreBackupRequest)

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

        Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.

        Parameters:
        restoreBackupRequest -
        Returns:
        A Java Future containing the result of the RestoreBackup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • restoreBackup

        default CompletableFuture<RestoreBackupResponse> restoreBackup​(Consumer<RestoreBackupRequest.Builder> restoreBackupRequest)

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

        Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.


        This is a convenience which creates an instance of the RestoreBackupRequest.Builder avoiding the need to create one manually via RestoreBackupRequest.builder()

        Parameters:
        restoreBackupRequest - A Consumer that will call methods on RestoreBackupRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the RestoreBackup operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • tagResource

        default CompletableFuture<TagResourceResponse> tagResource​(TagResourceRequest tagResourceRequest)

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

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

        Parameters:
        tagResourceRequest -
        Returns:
        A Java Future containing the result of the TagResource operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • tagResource

        default CompletableFuture<TagResourceResponse> tagResource​(Consumer<TagResourceRequest.Builder> tagResourceRequest)

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

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.


        This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

        Parameters:
        tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the TagResource operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • untagResource

        default CompletableFuture<UntagResourceResponse> untagResource​(UntagResourceRequest untagResourceRequest)

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

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.

        Parameters:
        untagResourceRequest -
        Returns:
        A Java Future containing the result of the UntagResource operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • untagResource

        default CompletableFuture<UntagResourceResponse> untagResource​(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

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

        Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.


        This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

        Parameters:
        untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the UntagResource operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
        • CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
        • CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
        • CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
        • CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
        • CloudHsmServiceException The request was rejected because an error occurred.
        • CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation