@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCloudHSMV2AsyncClient extends AWSCloudHSMV2Client implements AWSCloudHSMV2Async
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
For more information about CloudHSM, see CloudHSM and the CloudHSM User Guide.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, copyBackupToRegion, createCluster, createHsm, deleteBackup, deleteCluster, deleteHsm, deleteResourcePolicy, describeBackups, describeClusters, getCachedResponseMetadata, getResourcePolicy, initializeCluster, listTags, modifyBackupAttributes, modifyCluster, putResourcePolicy, restoreBackup, tagResource, untagResourceaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcopyBackupToRegion, createCluster, createHsm, deleteBackup, deleteCluster, deleteHsm, deleteResourcePolicy, describeBackups, describeClusters, getCachedResponseMetadata, getResourcePolicy, initializeCluster, listTags, modifyBackupAttributes, modifyCluster, putResourcePolicy, restoreBackup, tagResource, untagResourcepublic static AWSCloudHSMV2AsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CopyBackupToRegionResult> copyBackupToRegionAsync(CopyBackupToRegionRequest request)
AWSCloudHSMV2AsyncCopy 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.
copyBackupToRegionAsync in interface AWSCloudHSMV2Asyncpublic Future<CopyBackupToRegionResult> copyBackupToRegionAsync(CopyBackupToRegionRequest request, AsyncHandler<CopyBackupToRegionRequest,CopyBackupToRegionResult> asyncHandler)
AWSCloudHSMV2AsyncCopy 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.
copyBackupToRegionAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request)
AWSCloudHSMV2AsyncCreates 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.
createClusterAsync in interface AWSCloudHSMV2Asyncpublic Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request, AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)
AWSCloudHSMV2AsyncCreates 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.
createClusterAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateHsmResult> createHsmAsync(CreateHsmRequest request)
AWSCloudHSMV2AsyncCreates 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.
createHsmAsync in interface AWSCloudHSMV2Asyncpublic Future<CreateHsmResult> createHsmAsync(CreateHsmRequest request, AsyncHandler<CreateHsmRequest,CreateHsmResult> asyncHandler)
AWSCloudHSMV2AsyncCreates 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.
createHsmAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteBackupResult> deleteBackupAsync(DeleteBackupRequest request)
AWSCloudHSMV2AsyncDeletes 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.
deleteBackupAsync in interface AWSCloudHSMV2Asyncpublic Future<DeleteBackupResult> deleteBackupAsync(DeleteBackupRequest request, AsyncHandler<DeleteBackupRequest,DeleteBackupResult> asyncHandler)
AWSCloudHSMV2AsyncDeletes 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.
deleteBackupAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request)
AWSCloudHSMV2AsyncDeletes 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.
deleteClusterAsync in interface AWSCloudHSMV2Asyncpublic Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request, AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler)
AWSCloudHSMV2AsyncDeletes 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.
deleteClusterAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteHsmResult> deleteHsmAsync(DeleteHsmRequest request)
AWSCloudHSMV2AsyncDeletes 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.
deleteHsmAsync in interface AWSCloudHSMV2Asyncpublic Future<DeleteHsmResult> deleteHsmAsync(DeleteHsmRequest request, AsyncHandler<DeleteHsmRequest,DeleteHsmResult> asyncHandler)
AWSCloudHSMV2AsyncDeletes 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.
deleteHsmAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest request)
AWSCloudHSMV2AsyncDeletes 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.
deleteResourcePolicyAsync in interface AWSCloudHSMV2Asyncpublic Future<DeleteResourcePolicyResult> deleteResourcePolicyAsync(DeleteResourcePolicyRequest request, AsyncHandler<DeleteResourcePolicyRequest,DeleteResourcePolicyResult> asyncHandler)
AWSCloudHSMV2AsyncDeletes 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.
deleteResourcePolicyAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeBackupsResult> describeBackupsAsync(DescribeBackupsRequest request)
AWSCloudHSMV2AsyncGets 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.
describeBackupsAsync in interface AWSCloudHSMV2Asyncpublic Future<DescribeBackupsResult> describeBackupsAsync(DescribeBackupsRequest request, AsyncHandler<DescribeBackupsRequest,DescribeBackupsResult> asyncHandler)
AWSCloudHSMV2AsyncGets 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.
describeBackupsAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeClustersResult> describeClustersAsync(DescribeClustersRequest request)
AWSCloudHSMV2AsyncGets 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.
describeClustersAsync in interface AWSCloudHSMV2Asyncpublic Future<DescribeClustersResult> describeClustersAsync(DescribeClustersRequest request, AsyncHandler<DescribeClustersRequest,DescribeClustersResult> asyncHandler)
AWSCloudHSMV2AsyncGets 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.
describeClustersAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetResourcePolicyResult> getResourcePolicyAsync(GetResourcePolicyRequest request)
AWSCloudHSMV2AsyncRetrieves 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.
getResourcePolicyAsync in interface AWSCloudHSMV2Asyncpublic Future<GetResourcePolicyResult> getResourcePolicyAsync(GetResourcePolicyRequest request, AsyncHandler<GetResourcePolicyRequest,GetResourcePolicyResult> asyncHandler)
AWSCloudHSMV2AsyncRetrieves 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.
getResourcePolicyAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<InitializeClusterResult> initializeClusterAsync(InitializeClusterRequest request)
AWSCloudHSMV2AsyncClaims 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.
initializeClusterAsync in interface AWSCloudHSMV2Asyncpublic Future<InitializeClusterResult> initializeClusterAsync(InitializeClusterRequest request, AsyncHandler<InitializeClusterRequest,InitializeClusterResult> asyncHandler)
AWSCloudHSMV2AsyncClaims 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.
initializeClusterAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsResult> listTagsAsync(ListTagsRequest request)
AWSCloudHSMV2AsyncGets 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.
listTagsAsync in interface AWSCloudHSMV2Asyncpublic Future<ListTagsResult> listTagsAsync(ListTagsRequest request, AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
AWSCloudHSMV2AsyncGets 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.
listTagsAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ModifyBackupAttributesResult> modifyBackupAttributesAsync(ModifyBackupAttributesRequest request)
AWSCloudHSMV2AsyncModifies attributes for CloudHSM backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
modifyBackupAttributesAsync in interface AWSCloudHSMV2Asyncpublic Future<ModifyBackupAttributesResult> modifyBackupAttributesAsync(ModifyBackupAttributesRequest request, AsyncHandler<ModifyBackupAttributesRequest,ModifyBackupAttributesResult> asyncHandler)
AWSCloudHSMV2AsyncModifies attributes for CloudHSM backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
modifyBackupAttributesAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ModifyClusterResult> modifyClusterAsync(ModifyClusterRequest request)
AWSCloudHSMV2AsyncModifies CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
modifyClusterAsync in interface AWSCloudHSMV2Asyncpublic Future<ModifyClusterResult> modifyClusterAsync(ModifyClusterRequest request, AsyncHandler<ModifyClusterRequest,ModifyClusterResult> asyncHandler)
AWSCloudHSMV2AsyncModifies CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
modifyClusterAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest request)
AWSCloudHSMV2AsyncCreates 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.
putResourcePolicyAsync in interface AWSCloudHSMV2Asyncpublic Future<PutResourcePolicyResult> putResourcePolicyAsync(PutResourcePolicyRequest request, AsyncHandler<PutResourcePolicyRequest,PutResourcePolicyResult> asyncHandler)
AWSCloudHSMV2AsyncCreates 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.
putResourcePolicyAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RestoreBackupResult> restoreBackupAsync(RestoreBackupRequest request)
AWSCloudHSMV2Async
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.
restoreBackupAsync in interface AWSCloudHSMV2Asyncpublic Future<RestoreBackupResult> restoreBackupAsync(RestoreBackupRequest request, AsyncHandler<RestoreBackupRequest,RestoreBackupResult> asyncHandler)
AWSCloudHSMV2Async
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.
restoreBackupAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSCloudHSMV2AsyncAdds 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.
tagResourceAsync in interface AWSCloudHSMV2Asyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSCloudHSMV2AsyncAdds 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.
tagResourceAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSCloudHSMV2AsyncRemoves 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.
untagResourceAsync in interface AWSCloudHSMV2Asyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSCloudHSMV2AsyncRemoves 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.
untagResourceAsync in interface AWSCloudHSMV2AsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSCloudHSMV2shutdown in class AWSCloudHSMV2Client