AbstractAWSCloudHSMV2 (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.cloudhsmv2

Class AbstractAWSCloudHSMV2

java.lang.Object
- com.amazonaws.services.cloudhsmv2.AbstractAWSCloudHSMV2

All Implemented Interfaces:

AWSCloudHSMV2

Direct Known Subclasses:

AbstractAWSCloudHSMV2Async
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSCloudHSMV2
extends Object
implements AWSCloudHSMV2 
```
Abstract implementation of AWSCloudHSMV2. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.cloudhsmv2.AWSCloudHSMV2
  ENDPOINT_PREFIX

Method Summary

All Methods
Modifier and Type	Method and Description
`CopyBackupToRegionResult`	`copyBackupToRegion (CopyBackupToRegionRequest request)` Copy an CloudHSM cluster backup to a different region.
`CreateClusterResult`	`createCluster (CreateClusterRequest request)` Creates a new CloudHSM cluster.
`CreateHsmResult`	`createHsm (CreateHsmRequest request)` Creates a new hardware security module (HSM) in the specified CloudHSM cluster.
`DeleteBackupResult`	`deleteBackup (DeleteBackupRequest request)` Deletes a specified CloudHSM backup.
`DeleteClusterResult`	`deleteCluster (DeleteClusterRequest request)` Deletes the specified CloudHSM cluster.
`DeleteHsmResult`	`deleteHsm (DeleteHsmRequest request)` Deletes the specified HSM.
`DeleteResourcePolicyResult`	`deleteResourcePolicy (DeleteResourcePolicyRequest request)` Deletes an CloudHSM resource policy.
`DescribeBackupsResult`	`describeBackups (DescribeBackupsRequest request)` Gets information about backups of CloudHSM clusters.
`DescribeClustersResult`	`describeClusters (DescribeClustersRequest request)` 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 request)` Retrieves the resource policy document attached to a given resource.
`InitializeClusterResult`	`initializeCluster (InitializeClusterRequest request)` 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 request)` Gets a list of tags for the specified CloudHSM cluster.
`ModifyBackupAttributesResult`	`modifyBackupAttributes (ModifyBackupAttributesRequest request)` Modifies attributes for CloudHSM backup.
`ModifyClusterResult`	`modifyCluster (ModifyClusterRequest request)` Modifies CloudHSM cluster.
`PutResourcePolicyResult`	`putResourcePolicy (PutResourcePolicyRequest request)` Creates or updates an CloudHSM resource policy.
`RestoreBackupResult`	`restoreBackup (RestoreBackupRequest request)` 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 request)` Adds or overwrites one or more tags for the specified CloudHSM cluster.
`UntagResourceResult`	`untagResource (UntagResourceRequest request)` Removes the specified tag or tags from the specified CloudHSM cluster.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - copyBackupToRegion
```
public CopyBackupToRegionResult copyBackupToRegion(CopyBackupToRegionRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    copyBackupToRegion in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the CopyBackupToRegion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCluster
```
public CreateClusterResult createCluster(CreateClusterRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    createCluster in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the CreateCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createHsm
```
public CreateHsmResult createHsm(CreateHsmRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    createHsm in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the CreateHsm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackup
```
public DeleteBackupResult deleteBackup(DeleteBackupRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    deleteBackup in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the DeleteBackup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCluster
```
public DeleteClusterResult deleteCluster(DeleteClusterRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    deleteCluster in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the DeleteCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteHsm
```
public DeleteHsmResult deleteHsm(DeleteHsmRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    deleteHsm in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the DeleteHsm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteResourcePolicy
```
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    deleteResourcePolicy in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the DeleteResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeBackups
```
public DescribeBackupsResult describeBackups(DescribeBackupsRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    describeBackups in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the DescribeBackups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeClusters
```
public DescribeClustersResult describeClusters(DescribeClustersRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    describeClusters in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the DescribeClusters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getResourcePolicy
```
public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    getResourcePolicy in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the GetResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - initializeCluster
```
public InitializeClusterResult initializeCluster(InitializeClusterRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    initializeCluster in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the InitializeCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    listTags in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyBackupAttributes
```
public ModifyBackupAttributesResult modifyBackupAttributes(ModifyBackupAttributesRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    modifyBackupAttributes in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the ModifyBackupAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyCluster
```
public ModifyClusterResult modifyCluster(ModifyClusterRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    Modifies CloudHSM cluster.
    
    Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
    
    Specified by:
    
    modifyCluster in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the ModifyCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putResourcePolicy
```
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    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.
    Specified by:
    
    putResourcePolicy in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the PutResourcePolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - restoreBackup
```
public RestoreBackupResult restoreBackup(RestoreBackupRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    restoreBackup in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the RestoreBackup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    tagResource in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    untagResource in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    shutdown in interface AWSCloudHSMV2
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSCloudHSMV2
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class AbstractAWSCloudHSMV2

Field Summary

Fields inherited from interface com.amazonaws.services.cloudhsmv2.AWSCloudHSMV2

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copyBackupToRegion

createCluster

createHsm

deleteBackup

deleteCluster

deleteHsm

deleteResourcePolicy

describeBackups

describeClusters

getResourcePolicy

initializeCluster

listTags

modifyBackupAttributes

modifyCluster

putResourcePolicy

restoreBackup

tagResource

untagResource

shutdown

getCachedResponseMetadata