com.amazonaws.services.cloudhsmv2

Interface AWSCloudHSMV2

All Known Subinterfaces:

AWSCloudHSMV2Async

All Known Implementing Classes:

AbstractAWSCloudHSMV2, AbstractAWSCloudHSMV2Async, AWSCloudHSMV2AsyncClient, AWSCloudHSMV2Client

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCloudHSMV2

Interface for accessing CloudHSM V2.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCloudHSMV2 instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CopyBackupToRegionResult	copyBackupToRegion(CopyBackupToRegionRequest copyBackupToRegionRequest) Copy an AWS CloudHSM cluster backup to a different region.
CreateClusterResult	createCluster(CreateClusterRequest createClusterRequest) Creates a new AWS CloudHSM cluster.
CreateHsmResult	createHsm(CreateHsmRequest createHsmRequest) Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
DeleteBackupResult	deleteBackup(DeleteBackupRequest deleteBackupRequest) Deletes a specified AWS CloudHSM backup.
DeleteClusterResult	deleteCluster(DeleteClusterRequest deleteClusterRequest) Deletes the specified AWS CloudHSM cluster.
DeleteHsmResult	deleteHsm(DeleteHsmRequest deleteHsmRequest) Deletes the specified HSM.
DescribeBackupsResult	describeBackups(DescribeBackupsRequest describeBackupsRequest) Gets information about backups of AWS CloudHSM clusters.
DescribeClustersResult	describeClusters(DescribeClustersRequest describeClustersRequest) Gets information about AWS CloudHSM clusters.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
InitializeClusterResult	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.
ListTagsResult	listTags(ListTagsRequest listTagsRequest) Gets a list of tags for the specified AWS CloudHSM cluster.
ModifyBackupAttributesResult	modifyBackupAttributes(ModifyBackupAttributesRequest modifyBackupAttributesRequest) Modifies attributes for AWS CloudHSM backup.
ModifyClusterResult	modifyCluster(ModifyClusterRequest modifyClusterRequest) Modifies AWS CloudHSM cluster.
RestoreBackupResult	restoreBackup(RestoreBackupRequest restoreBackupRequest) Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tag or tags from the specified AWS CloudHSM cluster.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

copyBackupToRegion

CopyBackupToRegionResult copyBackupToRegion(CopyBackupToRegionRequest copyBackupToRegionRequest)

Copy an AWS CloudHSM cluster backup to a different region.

Parameters:

copyBackupToRegionRequest -

Returns:

Result of the CopyBackupToRegion operation returned by the service.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

CloudHsmTagException - The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

See Also:

AWS API Documentation

createCluster

CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)

Creates a new AWS CloudHSM cluster.

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

CloudHsmTagException - The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

See Also:

AWS API Documentation

createHsm

CreateHsmResult createHsm(CreateHsmRequest createHsmRequest)

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.

Throws:

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmServiceException - The request was rejected because an error occurred.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

See Also:

AWS API Documentation

deleteBackup

DeleteBackupResult deleteBackup(DeleteBackupRequest deleteBackupRequest)

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.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

See Also:

AWS API Documentation

deleteCluster

DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)

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.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

CloudHsmTagException - The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

See Also:

AWS API Documentation

deleteHsm

DeleteHsmResult deleteHsm(DeleteHsmRequest deleteHsmRequest)

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

Parameters:

deleteHsmRequest -

Returns:

Result of the DeleteHsm operation returned by the service.

Throws:

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmServiceException - The request was rejected because an error occurred.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

See Also:

AWS API Documentation

describeBackups

DescribeBackupsResult describeBackups(DescribeBackupsRequest describeBackupsRequest)

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

Parameters:

describeBackupsRequest -

Returns:

Result of the DescribeBackups operation returned by the service.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

CloudHsmTagException - The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

See Also:

AWS API Documentation

describeClusters

DescribeClustersResult describeClusters(DescribeClustersRequest describeClustersRequest)

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

Parameters:

describeClustersRequest -

Returns:

Result of the DescribeClusters operation returned by the service.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmServiceException - The request was rejected because an error occurred.

CloudHsmTagException - The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

See Also:

AWS API Documentation

initializeCluster

InitializeClusterResult 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. 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.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

See Also:

AWS API Documentation

listTags

ListTagsResult listTags(ListTagsRequest listTagsRequest)

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

Parameters:

listTagsRequest -

Returns:

Result of the ListTags operation returned by the service.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

CloudHsmTagException - The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

See Also:

AWS API Documentation

modifyBackupAttributes

ModifyBackupAttributesResult modifyBackupAttributes(ModifyBackupAttributesRequest modifyBackupAttributesRequest)

Modifies attributes for AWS CloudHSM backup.

Parameters:

modifyBackupAttributesRequest -

Returns:

Result of the ModifyBackupAttributes operation returned by the service.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

See Also:

AWS API Documentation

modifyCluster

ModifyClusterResult modifyCluster(ModifyClusterRequest modifyClusterRequest)

Modifies AWS CloudHSM cluster.

Parameters:

modifyClusterRequest -

Returns:

Result of the ModifyCluster operation returned by the service.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

See Also:

AWS API Documentation

restoreBackup

RestoreBackupResult restoreBackup(RestoreBackupRequest restoreBackupRequest)

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.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

CloudHsmTagException - The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

CloudHsmAccessDeniedException - The request was rejected because the requester does not have permission to perform the requested operation.

CloudHsmInternalFailureException - The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

CloudHsmInvalidRequestException - The request was rejected because it is not a valid request.

CloudHsmResourceNotFoundException - The request was rejected because it refers to a resource that cannot be found.

CloudHsmServiceException - The request was rejected because an error occurred.

CloudHsmTagException - The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.