AbstractAWSCloudHSMV2 (AWS SDK for Java

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 Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateClusterResult`	`createCluster(CreateClusterRequest request)` Creates a new AWS CloudHSM cluster.
`CreateHsmResult`	`createHsm(CreateHsmRequest request)` Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
`DeleteClusterResult`	`deleteCluster(DeleteClusterRequest request)` Deletes the specified AWS CloudHSM cluster.
`DeleteHsmResult`	`deleteHsm(DeleteHsmRequest request)` Deletes the specified HSM.
`DescribeBackupsResult`	`describeBackups(DescribeBackupsRequest request)` Gets information about backups of AWS CloudHSM clusters.
`DescribeClustersResult`	`describeClusters(DescribeClustersRequest request)` 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 request)` 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 request)` Gets a list of tags for the specified AWS CloudHSM cluster.
`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 AWS CloudHSM cluster.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the specified tag or tags from the specified AWS CloudHSM cluster.

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

- Method Detail
  - createCluster
```
public CreateClusterResult createCluster(CreateClusterRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    Creates a new AWS CloudHSM cluster.
    
    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 AWS CloudHSM cluster.
    
    Specified by:
    
    createHsm in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the CreateHsm operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteCluster
```
public DeleteClusterResult deleteCluster(DeleteClusterRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    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.
    
    Specified by:
    
    deleteHsm in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the DeleteHsm 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 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.
    
    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 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.
    
    Specified by:
    
    describeClusters in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the DescribeClusters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - initializeCluster
```
public InitializeClusterResult initializeCluster(InitializeClusterRequest request)
```
    Description copied from interface: AWSCloudHSMV2
    
    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.
    
    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 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.
    
    Specified by:
    
    listTags in interface AWSCloudHSMV2
    
    Returns:
    
    Result of the ListTags 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 AWS CloudHSM cluster.
    
    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 AWS CloudHSM cluster.
    
    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.

Did this page help you?

Class AbstractAWSCloudHSMV2

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createCluster

createHsm

deleteCluster

deleteHsm

describeBackups

describeClusters

initializeCluster

listTags

tagResource

untagResource

shutdown

getCachedResponseMetadata