Interface CloudHsmV2Client
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic CloudHsmV2ClientBuilder
builder()
Create a builder that can be used to configure and create aCloudHsmV2Client
.default CopyBackupToRegionResponse
copyBackupToRegion
(Consumer<CopyBackupToRegionRequest.Builder> copyBackupToRegionRequest) Copy an AWS CloudHSM cluster backup to a different region.default CopyBackupToRegionResponse
copyBackupToRegion
(CopyBackupToRegionRequest copyBackupToRegionRequest) Copy an AWS CloudHSM cluster backup to a different region.static CloudHsmV2Client
create()
Create aCloudHsmV2Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateClusterResponse
createCluster
(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates a new AWS CloudHSM cluster.default CreateClusterResponse
createCluster
(CreateClusterRequest createClusterRequest) Creates a new AWS CloudHSM cluster.default CreateHsmResponse
createHsm
(Consumer<CreateHsmRequest.Builder> createHsmRequest) Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.default CreateHsmResponse
createHsm
(CreateHsmRequest createHsmRequest) Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.default DeleteBackupResponse
deleteBackup
(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest) Deletes a specified AWS CloudHSM backup.default DeleteBackupResponse
deleteBackup
(DeleteBackupRequest deleteBackupRequest) Deletes a specified AWS CloudHSM backup.default DeleteClusterResponse
deleteCluster
(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes the specified AWS CloudHSM cluster.default DeleteClusterResponse
deleteCluster
(DeleteClusterRequest deleteClusterRequest) Deletes the specified AWS CloudHSM cluster.default DeleteHsmResponse
deleteHsm
(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest) Deletes the specified HSM.default DeleteHsmResponse
deleteHsm
(DeleteHsmRequest deleteHsmRequest) Deletes the specified HSM.default DescribeBackupsResponse
Gets information about backups of AWS CloudHSM clusters.default DescribeBackupsResponse
describeBackups
(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) Gets information about backups of AWS CloudHSM clusters.default DescribeBackupsResponse
describeBackups
(DescribeBackupsRequest describeBackupsRequest) Gets information about backups of AWS CloudHSM clusters.default DescribeBackupsIterable
This is a variant ofdescribeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation.default DescribeBackupsIterable
describeBackupsPaginator
(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) This is a variant ofdescribeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation.default DescribeBackupsIterable
describeBackupsPaginator
(DescribeBackupsRequest describeBackupsRequest) This is a variant ofdescribeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation.default DescribeClustersResponse
Gets information about AWS CloudHSM clusters.default DescribeClustersResponse
describeClusters
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Gets information about AWS CloudHSM clusters.default DescribeClustersResponse
describeClusters
(DescribeClustersRequest describeClustersRequest) Gets information about AWS CloudHSM clusters.default DescribeClustersIterable
This is a variant ofdescribeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation.default DescribeClustersIterable
describeClustersPaginator
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) This is a variant ofdescribeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation.default DescribeClustersIterable
describeClustersPaginator
(DescribeClustersRequest describeClustersRequest) This is a variant ofdescribeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation.default InitializeClusterResponse
initializeCluster
(Consumer<InitializeClusterRequest.Builder> initializeClusterRequest) Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate.default InitializeClusterResponse
initializeCluster
(InitializeClusterRequest initializeClusterRequest) Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate.default ListTagsResponse
listTags
(Consumer<ListTagsRequest.Builder> listTagsRequest) Gets a list of tags for the specified AWS CloudHSM cluster.default ListTagsResponse
listTags
(ListTagsRequest listTagsRequest) Gets a list of tags for the specified AWS CloudHSM cluster.default ListTagsIterable
listTagsPaginator
(Consumer<ListTagsRequest.Builder> listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest)
operation.default ListTagsIterable
listTagsPaginator
(ListTagsRequest listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest)
operation.default ModifyBackupAttributesResponse
modifyBackupAttributes
(Consumer<ModifyBackupAttributesRequest.Builder> modifyBackupAttributesRequest) Modifies attributes for AWS CloudHSM backup.default ModifyBackupAttributesResponse
modifyBackupAttributes
(ModifyBackupAttributesRequest modifyBackupAttributesRequest) Modifies attributes for AWS CloudHSM backup.default ModifyClusterResponse
modifyCluster
(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest) Modifies AWS CloudHSM cluster.default ModifyClusterResponse
modifyCluster
(ModifyClusterRequest modifyClusterRequest) Modifies AWS CloudHSM cluster.default RestoreBackupResponse
restoreBackup
(Consumer<RestoreBackupRequest.Builder> restoreBackupRequest) Restores a specified AWS CloudHSM backup that is in thePENDING_DELETION
state.default RestoreBackupResponse
restoreBackup
(RestoreBackupRequest restoreBackupRequest) Restores a specified AWS CloudHSM backup that is in thePENDING_DELETION
state.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tag or tags from the specified AWS CloudHSM cluster.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tag or tags from the specified AWS CloudHSM cluster.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
copyBackupToRegion
default CopyBackupToRegionResponse copyBackupToRegion(CopyBackupToRegionRequest copyBackupToRegionRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Copy an AWS CloudHSM cluster backup to a different region.
- Parameters:
copyBackupToRegionRequest
-- Returns:
- Result of the CopyBackupToRegion operation returned by the service.
- See Also:
-
copyBackupToRegion
default CopyBackupToRegionResponse copyBackupToRegion(Consumer<CopyBackupToRegionRequest.Builder> copyBackupToRegionRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Copy an AWS CloudHSM cluster backup to a different region.
This is a convenience which creates an instance of the
CopyBackupToRegionRequest.Builder
avoiding the need to create one manually viaCopyBackupToRegionRequest.builder()
- Parameters:
copyBackupToRegionRequest
- AConsumer
that will call methods onCopyBackupToRegionRequest.Builder
to create a request.- Returns:
- Result of the CopyBackupToRegion operation returned by the service.
- See Also:
-
createCluster
default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Creates a new AWS CloudHSM cluster.
- Parameters:
createClusterRequest
-- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createCluster
default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Creates a new AWS CloudHSM cluster.
This is a convenience which creates an instance of the
CreateClusterRequest.Builder
avoiding the need to create one manually viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.Builder
to create a request.- Returns:
- Result of the CreateCluster operation returned by the service.
- See Also:
-
createHsm
default CreateHsmResponse createHsm(CreateHsmRequest createHsmRequest) throws CloudHsmInternalFailureException, CloudHsmServiceException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmAccessDeniedException, AwsServiceException, SdkClientException, CloudHsmV2Exception Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
- Parameters:
createHsmRequest
-- Returns:
- Result of the CreateHsm operation returned by the service.
- See Also:
-
createHsm
default CreateHsmResponse createHsm(Consumer<CreateHsmRequest.Builder> createHsmRequest) throws CloudHsmInternalFailureException, CloudHsmServiceException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmAccessDeniedException, AwsServiceException, SdkClientException, CloudHsmV2Exception Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
This is a convenience which creates an instance of the
CreateHsmRequest.Builder
avoiding the need to create one manually viaCreateHsmRequest.builder()
- Parameters:
createHsmRequest
- AConsumer
that will call methods onCreateHsmRequest.Builder
to create a request.- Returns:
- Result of the CreateHsm operation returned by the service.
- See Also:
-
deleteBackup
default DeleteBackupResponse deleteBackup(DeleteBackupRequest deleteBackupRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
- Parameters:
deleteBackupRequest
-- Returns:
- Result of the DeleteBackup operation returned by the service.
- See Also:
-
deleteBackup
default DeleteBackupResponse deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
This is a convenience which creates an instance of the
DeleteBackupRequest.Builder
avoiding the need to create one manually viaDeleteBackupRequest.builder()
- Parameters:
deleteBackupRequest
- AConsumer
that will call methods onDeleteBackupRequest.Builder
to create a request.- Returns:
- Result of the DeleteBackup operation returned by the service.
- See Also:
-
deleteCluster
default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
- Parameters:
deleteClusterRequest
-- Returns:
- Result of the DeleteCluster operation returned by the service.
- See Also:
-
deleteCluster
default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
This is a convenience which creates an instance of the
DeleteClusterRequest.Builder
avoiding the need to create one manually viaDeleteClusterRequest.builder()
- Parameters:
deleteClusterRequest
- AConsumer
that will call methods onDeleteClusterRequest.Builder
to create a request.- Returns:
- Result of the DeleteCluster operation returned by the service.
- See Also:
-
deleteHsm
default DeleteHsmResponse deleteHsm(DeleteHsmRequest deleteHsmRequest) throws CloudHsmInternalFailureException, CloudHsmServiceException, CloudHsmResourceNotFoundException, CloudHsmInvalidRequestException, CloudHsmAccessDeniedException, AwsServiceException, SdkClientException, CloudHsmV2Exception 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.
- Parameters:
deleteHsmRequest
-- Returns:
- Result of the DeleteHsm operation returned by the service.
- See Also:
-
deleteHsm
default DeleteHsmResponse deleteHsm(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest) throws CloudHsmInternalFailureException, CloudHsmServiceException, CloudHsmResourceNotFoundException, CloudHsmInvalidRequestException, CloudHsmAccessDeniedException, AwsServiceException, SdkClientException, CloudHsmV2Exception 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.
This is a convenience which creates an instance of the
DeleteHsmRequest.Builder
avoiding the need to create one manually viaDeleteHsmRequest.builder()
- Parameters:
deleteHsmRequest
- AConsumer
that will call methods onDeleteHsmRequest.Builder
to create a request.- Returns:
- Result of the DeleteHsm operation returned by the service.
- See Also:
-
describeBackups
default DescribeBackupsResponse describeBackups(DescribeBackupsRequest describeBackupsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a
NextToken
value. Use this value in a subsequentDescribeBackups
request to get more backups. When you receive a response with noNextToken
(or an empty or null value), that means there are no more backups to get.- Parameters:
describeBackupsRequest
-- Returns:
- Result of the DescribeBackups operation returned by the service.
- See Also:
-
describeBackups
default DescribeBackupsResponse describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a
NextToken
value. Use this value in a subsequentDescribeBackups
request to get more backups. When you receive a response with noNextToken
(or an empty or null value), that means there are no more backups to get.
This is a convenience which creates an instance of the
DescribeBackupsRequest.Builder
avoiding the need to create one manually viaDescribeBackupsRequest.builder()
- Parameters:
describeBackupsRequest
- AConsumer
that will call methods onDescribeBackupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeBackups operation returned by the service.
- See Also:
-
describeBackups
default DescribeBackupsResponse describeBackups() throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2ExceptionGets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a
NextToken
value. Use this value in a subsequentDescribeBackups
request to get more backups. When you receive a response with noNextToken
(or an empty or null value), that means there are no more backups to get.- Returns:
- Result of the DescribeBackups operation returned by the service.
- See Also:
-
describeBackupsPaginator
default DescribeBackupsIterable describeBackupsPaginator() throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2ExceptionThis is a variant of
describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client .describeBackupsPaginator(request); for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeBackupsPaginator
default DescribeBackupsIterable describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception This is a variant of
describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client .describeBackupsPaginator(request); for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeBackupsPaginator
default DescribeBackupsIterable describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception This is a variant of
describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client .describeBackupsPaginator(request); for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeBackupsRequest.builder()
- Parameters:
describeBackupsRequest
- AConsumer
that will call methods onDescribeBackupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClusters
default DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a
NextToken
value. Use this value in a subsequentDescribeClusters
request to get more clusters. When you receive a response with noNextToken
(or an empty or null value), that means there are no more clusters to get.- Parameters:
describeClustersRequest
-- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeClusters
default DescribeClustersResponse describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a
NextToken
value. Use this value in a subsequentDescribeClusters
request to get more clusters. When you receive a response with noNextToken
(or an empty or null value), that means there are no more clusters to get.
This is a convenience which creates an instance of the
DescribeClustersRequest.Builder
avoiding the need to create one manually viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeClusters
default DescribeClustersResponse describeClusters() throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2ExceptionGets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a
NextToken
value. Use this value in a subsequentDescribeClusters
request to get more clusters. When you receive a response with noNextToken
(or an empty or null value), that means there are no more clusters to get.- Returns:
- Result of the DescribeClusters operation returned by the service.
- See Also:
-
describeClustersPaginator
default DescribeClustersIterable describeClustersPaginator() throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2ExceptionThis is a variant of
describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client .describeClustersPaginator(request); for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClustersPaginator
default DescribeClustersIterable describeClustersPaginator(DescribeClustersRequest describeClustersRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception This is a variant of
describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client .describeClustersPaginator(request); for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeClustersPaginator
default DescribeClustersIterable describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception This is a variant of
describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client .describeClustersPaginator(request); for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
initializeCluster
default InitializeClusterResponse initializeCluster(InitializeClusterRequest initializeClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
- Parameters:
initializeClusterRequest
-- Returns:
- Result of the InitializeCluster operation returned by the service.
- See Also:
-
initializeCluster
default InitializeClusterResponse initializeCluster(Consumer<InitializeClusterRequest.Builder> initializeClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
This is a convenience which creates an instance of the
InitializeClusterRequest.Builder
avoiding the need to create one manually viaInitializeClusterRequest.builder()
- Parameters:
initializeClusterRequest
- AConsumer
that will call methods onInitializeClusterRequest.Builder
to create a request.- Returns:
- Result of the InitializeCluster operation returned by the service.
- See Also:
-
listTags
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a
NextToken
value. Use this value in a subsequentListTags
request to get more tags. When you receive a response with noNextToken
(or an empty or null value), that means there are no more tags to get.- Parameters:
listTagsRequest
-- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
listTags
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a
NextToken
value. Use this value in a subsequentListTags
request to get more tags. When you receive a response with noNextToken
(or an empty or null value), that means there are no more tags to get.
This is a convenience which creates an instance of the
ListTagsRequest.Builder
avoiding the need to create one manually viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- Result of the ListTags operation returned by the service.
- See Also:
-
listTagsPaginator
default ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception This is a variant of
listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request); for (software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsPaginator
default ListTagsIterable listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception This is a variant of
listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request); for (software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
modifyBackupAttributes
default ModifyBackupAttributesResponse modifyBackupAttributes(ModifyBackupAttributesRequest modifyBackupAttributesRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception Modifies attributes for AWS CloudHSM backup.
- Parameters:
modifyBackupAttributesRequest
-- Returns:
- Result of the ModifyBackupAttributes operation returned by the service.
- See Also:
-
modifyBackupAttributes
default ModifyBackupAttributesResponse modifyBackupAttributes(Consumer<ModifyBackupAttributesRequest.Builder> modifyBackupAttributesRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception Modifies attributes for AWS CloudHSM backup.
This is a convenience which creates an instance of the
ModifyBackupAttributesRequest.Builder
avoiding the need to create one manually viaModifyBackupAttributesRequest.builder()
- Parameters:
modifyBackupAttributesRequest
- AConsumer
that will call methods onModifyBackupAttributesRequest.Builder
to create a request.- Returns:
- Result of the ModifyBackupAttributes operation returned by the service.
- See Also:
-
modifyCluster
default ModifyClusterResponse modifyCluster(ModifyClusterRequest modifyClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception Modifies AWS CloudHSM cluster.
- Parameters:
modifyClusterRequest
-- Returns:
- Result of the ModifyCluster operation returned by the service.
- See Also:
-
modifyCluster
default ModifyClusterResponse modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception Modifies AWS CloudHSM cluster.
This is a convenience which creates an instance of the
ModifyClusterRequest.Builder
avoiding the need to create one manually viaModifyClusterRequest.builder()
- Parameters:
modifyClusterRequest
- AConsumer
that will call methods onModifyClusterRequest.Builder
to create a request.- Returns:
- Result of the ModifyCluster operation returned by the service.
- See Also:
-
restoreBackup
default RestoreBackupResponse restoreBackup(RestoreBackupRequest restoreBackupRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception Restores a specified AWS CloudHSM backup that is in the
PENDING_DELETION
state. For mor information on deleting a backup, see DeleteBackup.- Parameters:
restoreBackupRequest
-- Returns:
- Result of the RestoreBackup operation returned by the service.
- See Also:
-
restoreBackup
default RestoreBackupResponse restoreBackup(Consumer<RestoreBackupRequest.Builder> restoreBackupRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception Restores a specified AWS CloudHSM backup that is in the
PENDING_DELETION
state. For mor information on deleting a backup, see DeleteBackup.
This is a convenience which creates an instance of the
RestoreBackupRequest.Builder
avoiding the need to create one manually viaRestoreBackupRequest.builder()
- Parameters:
restoreBackupRequest
- AConsumer
that will call methods onRestoreBackupRequest.Builder
to create a request.- Returns:
- Result of the RestoreBackup operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Removes the specified tag or tags from the specified AWS CloudHSM cluster.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception Removes the specified tag or tags from the specified AWS CloudHSM cluster.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
create
Create aCloudHsmV2Client
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCloudHsmV2Client
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-