@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCloudHSMV2
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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.
|
static final String ENDPOINT_PREFIX
CopyBackupToRegionResult copyBackupToRegion(CopyBackupToRegionRequest copyBackupToRegionRequest)
Copy an AWS CloudHSM cluster backup to a different region.
copyBackupToRegionRequest
- 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.CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)
Creates a new AWS CloudHSM cluster.
createClusterRequest
- 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.CreateHsmResult createHsm(CreateHsmRequest createHsmRequest)
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
createHsmRequest
- 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.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.
deleteBackupRequest
- 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.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.
deleteClusterRequest
- 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.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.
deleteHsmRequest
- 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.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.
describeBackupsRequest
- 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.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.
describeClustersRequest
- 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.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.
initializeClusterRequest
- 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.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.
listTagsRequest
- 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.ModifyBackupAttributesResult modifyBackupAttributes(ModifyBackupAttributesRequest modifyBackupAttributesRequest)
Modifies attributes for AWS CloudHSM backup.
modifyBackupAttributesRequest
- 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.ModifyClusterResult modifyCluster(ModifyClusterRequest modifyClusterRequest)
Modifies AWS CloudHSM cluster.
modifyClusterRequest
- 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.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.
restoreBackupRequest
- 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
tagResourceRequest
- 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tag or tags from the specified AWS CloudHSM cluster.
untagResourceRequest
- 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.