Interface CloudHsmV2Client

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CloudHsmV2Client
extends AwsClient

Service client for accessing CloudHSM V2. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static CloudHsmV2ClientBuilder	builder()	Create a builder that can be used to configure and create a CloudHsmV2Client.
default CopyBackupToRegionResponse	copyBackupToRegion(Consumer<CopyBackupToRegionRequest.Builder> copyBackupToRegionRequest)	Copy an CloudHSM cluster backup to a different region.
default CopyBackupToRegionResponse	copyBackupToRegion(CopyBackupToRegionRequest copyBackupToRegionRequest)	Copy an CloudHSM cluster backup to a different region.
static CloudHsmV2Client	create()	Create a CloudHsmV2Client with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateClusterResponse	createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)	Creates a new CloudHSM cluster.
default CreateClusterResponse	createCluster(CreateClusterRequest createClusterRequest)	Creates a new CloudHSM cluster.
default CreateHsmResponse	createHsm(Consumer<CreateHsmRequest.Builder> createHsmRequest)	Creates a new hardware security module (HSM) in the specified CloudHSM cluster.
default CreateHsmResponse	createHsm(CreateHsmRequest createHsmRequest)	Creates a new hardware security module (HSM) in the specified CloudHSM cluster.
default DeleteBackupResponse	deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)	Deletes a specified CloudHSM backup.
default DeleteBackupResponse	deleteBackup(DeleteBackupRequest deleteBackupRequest)	Deletes a specified CloudHSM backup.
default DeleteClusterResponse	deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)	Deletes the specified CloudHSM cluster.
default DeleteClusterResponse	deleteCluster(DeleteClusterRequest deleteClusterRequest)	Deletes the specified CloudHSM cluster.
default DeleteHsmResponse	deleteHsm(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest)	Deletes the specified HSM.
default DeleteHsmResponse	deleteHsm(DeleteHsmRequest deleteHsmRequest)	Deletes the specified HSM.
default DeleteResourcePolicyResponse	deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)	Deletes an CloudHSM resource policy.
default DeleteResourcePolicyResponse	deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)	Deletes an CloudHSM resource policy.
default DescribeBackupsResponse	describeBackups()	Gets information about backups of CloudHSM clusters.
default DescribeBackupsResponse	describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)	Gets information about backups of CloudHSM clusters.
default DescribeBackupsResponse	describeBackups(DescribeBackupsRequest describeBackupsRequest)	Gets information about backups of CloudHSM clusters.
default DescribeBackupsIterable	describeBackupsPaginator()	This is a variant of describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest) operation.
default DescribeBackupsIterable	describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)	This is a variant of describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest) operation.
default DescribeBackupsIterable	describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest)	This is a variant of describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest) operation.
default DescribeClustersResponse	describeClusters()	Gets information about CloudHSM clusters.
default DescribeClustersResponse	describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)	Gets information about CloudHSM clusters.
default DescribeClustersResponse	describeClusters(DescribeClustersRequest describeClustersRequest)	Gets information about CloudHSM clusters.
default DescribeClustersIterable	describeClustersPaginator()	This is a variant of describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation.
default DescribeClustersIterable	describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)	This is a variant of describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation.
default DescribeClustersIterable	describeClustersPaginator(DescribeClustersRequest describeClustersRequest)	This is a variant of describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation.
default GetResourcePolicyResponse	getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)	Retrieves the resource policy document attached to a given resource.
default GetResourcePolicyResponse	getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)	Retrieves the resource policy document attached to a given resource.
default 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.
default 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.
default ListTagsResponse	listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)	Gets a list of tags for the specified CloudHSM cluster.
default ListTagsResponse	listTags(ListTagsRequest listTagsRequest)	Gets a list of tags for the specified CloudHSM cluster.
default ListTagsIterable	listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)	This is a variant of listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest) operation.
default ListTagsIterable	listTagsPaginator(ListTagsRequest listTagsRequest)	This is a variant of listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest) operation.
default ModifyBackupAttributesResponse	modifyBackupAttributes(Consumer<ModifyBackupAttributesRequest.Builder> modifyBackupAttributesRequest)	Modifies attributes for CloudHSM backup.
default ModifyBackupAttributesResponse	modifyBackupAttributes(ModifyBackupAttributesRequest modifyBackupAttributesRequest)	Modifies attributes for CloudHSM backup.
default ModifyClusterResponse	modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest)	Modifies CloudHSM cluster.
default ModifyClusterResponse	modifyCluster(ModifyClusterRequest modifyClusterRequest)	Modifies CloudHSM cluster.
default PutResourcePolicyResponse	putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)	Creates or updates an CloudHSM resource policy.
default PutResourcePolicyResponse	putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)	Creates or updates an CloudHSM resource policy.
default RestoreBackupResponse	restoreBackup(Consumer<RestoreBackupRequest.Builder> restoreBackupRequest)	Restores a specified CloudHSM backup that is in the PENDING_DELETION state.
default RestoreBackupResponse	restoreBackup(RestoreBackupRequest restoreBackupRequest)	Restores a specified CloudHSM backup that is in the PENDING_DELETION state.
default CloudHsmV2ServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds or overwrites one or more tags for the specified CloudHSM cluster.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds or overwrites one or more tags for the specified CloudHSM cluster.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the specified tag or tags from the specified CloudHSM cluster.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the specified tag or tags from the specified 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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

copyBackupToRegion

default CopyBackupToRegionResponse copyBackupToRegion(CopyBackupToRegionRequest copyBackupToRegionRequest)
                                               throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the CopyBackupToRegion operation returned by the service.

See Also:

• AWS API Documentation

copyBackupToRegion

default CopyBackupToRegionResponse copyBackupToRegion(Consumer<CopyBackupToRegionRequest.Builder> copyBackupToRegionRequest)
                                               throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the CopyBackupToRegion operation returned by the service.

See Also:

• AWS API Documentation

createCluster

default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest)
                                     throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

createCluster

default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
                                     throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

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 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:

Result of the CreateHsm operation returned by the service.

See Also:

• AWS API Documentation

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 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:

Result of the CreateHsm operation returned by the service.

See Also:

• AWS API Documentation

deleteBackup

default DeleteBackupResponse deleteBackup(DeleteBackupRequest deleteBackupRequest)
                                   throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DeleteBackup operation returned by the service.

See Also:

• AWS API Documentation

deleteBackup

default DeleteBackupResponse deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
                                   throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DeleteBackup operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                     throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
                                     throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

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.

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

Parameters:

deleteHsmRequest -

Returns:

Result of the DeleteHsm operation returned by the service.

See Also:

• AWS API Documentation

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.

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:

Result of the DeleteHsm operation returned by the service.

See Also:

• AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
                                                   throws CloudHsmInternalFailureException,
CloudHsmServiceException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmAccessDeniedException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DeleteResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteResourcePolicy

default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
                                                   throws CloudHsmInternalFailureException,
CloudHsmServiceException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmAccessDeniedException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DeleteResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

describeBackups

default DescribeBackupsResponse describeBackups(DescribeBackupsRequest describeBackupsRequest)
                                         throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DescribeBackups operation returned by the service.

See Also:

• AWS API Documentation

describeBackups

default DescribeBackupsResponse describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
                                         throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DescribeBackups operation returned by the service.

See Also:

• AWS API Documentation

describeBackups

default DescribeBackupsResponse describeBackups()
                                         throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DescribeBackups operation returned by the service.

See Also:

• describeBackups(DescribeBackupsRequest)
• AWS API Documentation

describeBackupsPaginator

default DescribeBackupsIterable describeBackupsPaginator()
                                                  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 Stream

 
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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(DescribeBackupsRequest)
• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via DescribeBackupsRequest.builder()

Parameters:

describeBackupsRequest - A Consumer that will call methods on DescribeBackupsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

describeClusters

default DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest)
                                           throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DescribeClusters operation returned by the service.

See Also:

• AWS API Documentation

describeClusters

default DescribeClustersResponse describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
                                           throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DescribeClusters operation returned by the service.

See Also:

• AWS API Documentation

describeClusters

default DescribeClustersResponse describeClusters()
                                           throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the DescribeClusters operation returned by the service.

See Also:

• describeClusters(DescribeClustersRequest)
• AWS API Documentation

describeClustersPaginator

default DescribeClustersIterable describeClustersPaginator()
                                                    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 Stream

 
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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(DescribeClustersRequest)
• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via DescribeClustersRequest.builder()

Parameters:

describeClustersRequest - A Consumer that will call methods on DescribeClustersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
                                             throws CloudHsmInternalFailureException,
CloudHsmServiceException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmAccessDeniedException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

getResourcePolicy

default GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
                                             throws CloudHsmInternalFailureException,
CloudHsmServiceException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmAccessDeniedException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the GetResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

initializeCluster

default InitializeClusterResponse initializeCluster(InitializeClusterRequest initializeClusterRequest)
                                             throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the InitializeCluster operation returned by the service.

See Also:

• AWS API Documentation

initializeCluster

default InitializeClusterResponse initializeCluster(Consumer<InitializeClusterRequest.Builder> initializeClusterRequest)
                                             throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the InitializeCluster operation returned by the service.

See Also:

• AWS API Documentation

listTags

default ListTagsResponse listTags(ListTagsRequest listTagsRequest)
                           throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the ListTags operation returned by the service.

See Also:

• AWS API Documentation

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 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:

Result of the ListTags operation returned by the service.

See Also:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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:

• AWS API Documentation

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 Stream

 
 software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListTagsRequest.builder()

Parameters:

listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

modifyBackupAttributes

default ModifyBackupAttributesResponse modifyBackupAttributes(ModifyBackupAttributesRequest modifyBackupAttributesRequest)
                                                       throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the ModifyBackupAttributes operation returned by the service.

See Also:

• AWS API Documentation

modifyBackupAttributes

default ModifyBackupAttributesResponse modifyBackupAttributes(Consumer<ModifyBackupAttributesRequest.Builder> modifyBackupAttributesRequest)
                                                       throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the ModifyBackupAttributes operation returned by the service.

See Also:

• AWS API Documentation

modifyCluster

default ModifyClusterResponse modifyCluster(ModifyClusterRequest modifyClusterRequest)
                                     throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the ModifyCluster operation returned by the service.

See Also:

• AWS API Documentation

modifyCluster

default ModifyClusterResponse modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest)
                                     throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the ModifyCluster operation returned by the service.

See Also:

• AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
                                             throws CloudHsmInternalFailureException,
CloudHsmServiceException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmAccessDeniedException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the PutResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

putResourcePolicy

default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
                                             throws CloudHsmInternalFailureException,
CloudHsmServiceException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmAccessDeniedException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the PutResourcePolicy operation returned by the service.

See Also:

• AWS API Documentation

restoreBackup

default RestoreBackupResponse restoreBackup(RestoreBackupRequest restoreBackupRequest)
                                     throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the RestoreBackup operation returned by the service.

See Also:

• AWS API Documentation

restoreBackup

default RestoreBackupResponse restoreBackup(Consumer<RestoreBackupRequest.Builder> restoreBackupRequest)
                                     throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the RestoreBackup operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceLimitExceededException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws CloudHsmAccessDeniedException,
CloudHsmInternalFailureException,
CloudHsmInvalidRequestException,
CloudHsmResourceLimitExceededException,
CloudHsmResourceNotFoundException,
CloudHsmServiceException,
CloudHsmTagException,
AwsServiceException,
SdkClientException,
CloudHsmV2Exception

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:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

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 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:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

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 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:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static CloudHsmV2Client create()

Create a CloudHsmV2Client with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CloudHsmV2ClientBuilder builder()

Create a builder that can be used to configure and create a CloudHsmV2Client.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default CloudHsmV2ServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration