@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 CloudHSM, see CloudHSM and the 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 CloudHSM cluster backup to a different region.
|
CreateClusterResult |
createCluster(CreateClusterRequest createClusterRequest)
Creates a new CloudHSM cluster.
|
CreateHsmResult |
createHsm(CreateHsmRequest createHsmRequest)
Creates a new hardware security module (HSM) in the specified CloudHSM cluster.
|
DeleteBackupResult |
deleteBackup(DeleteBackupRequest deleteBackupRequest)
Deletes a specified CloudHSM backup.
|
DeleteClusterResult |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes the specified CloudHSM cluster.
|
DeleteHsmResult |
deleteHsm(DeleteHsmRequest deleteHsmRequest)
Deletes the specified HSM.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes an CloudHSM resource policy.
|
DescribeBackupsResult |
describeBackups(DescribeBackupsRequest describeBackupsRequest)
Gets information about backups of CloudHSM clusters.
|
DescribeClustersResult |
describeClusters(DescribeClustersRequest describeClustersRequest)
Gets information about 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.
|
GetResourcePolicyResult |
getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Retrieves the resource policy document attached to a given resource.
|
InitializeClusterResult |
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.
|
ListTagsResult |
listTags(ListTagsRequest listTagsRequest)
Gets a list of tags for the specified CloudHSM cluster.
|
ModifyBackupAttributesResult |
modifyBackupAttributes(ModifyBackupAttributesRequest modifyBackupAttributesRequest)
Modifies attributes for CloudHSM backup.
|
ModifyClusterResult |
modifyCluster(ModifyClusterRequest modifyClusterRequest)
Modifies CloudHSM cluster.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates an CloudHSM resource policy.
|
RestoreBackupResult |
restoreBackup(RestoreBackupRequest restoreBackupRequest)
Restores a specified 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 CloudHSM cluster.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tag or tags from the specified CloudHSM cluster.
|
static final String ENDPOINT_PREFIX
CopyBackupToRegionResult copyBackupToRegion(CopyBackupToRegionRequest copyBackupToRegionRequest)
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.
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 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 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.
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 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 CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.
createHsmRequest
- CloudHsmInternalFailureException
- The request was rejected because of an 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 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.
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 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 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.
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 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.
Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.
deleteHsmRequest
- CloudHsmInternalFailureException
- The request was rejected because of an 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.DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
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.
deleteResourcePolicyRequest
- CloudHsmInternalFailureException
- The request was rejected because of an 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.DescribeBackupsResult describeBackups(DescribeBackupsRequest describeBackupsRequest)
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.
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 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 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.
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 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.GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
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.
getResourcePolicyRequest
- CloudHsmInternalFailureException
- The request was rejected because of an 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.InitializeClusterResult 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. 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.
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 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 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.
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 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 CloudHSM backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
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 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 CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
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 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.PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
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.
putResourcePolicyRequest
- CloudHsmInternalFailureException
- The request was rejected because of an 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.RestoreBackupResult restoreBackup(RestoreBackupRequest restoreBackupRequest)
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.
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 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 CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
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 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 CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
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 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.