AWSCloudHSM (AWS SDK for Java

All Known Subinterfaces:

AWSCloudHSMAsync

All Known Implementing Classes:

AbstractAWSCloudHSM, AbstractAWSCloudHSMAsync, AWSCloudHSMAsyncClient, AWSCloudHSMClient
```
public interface AWSCloudHSM
```
Interface for accessing CloudHSM.
AWS CloudHSM Service

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AddTagsToResourceResult`	`addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)` Adds or overwrites one or more tags for the specified AWS CloudHSM resource.
`CreateHapgResult`	`createHapg(CreateHapgRequest createHapgRequest)` Creates a high-availability partition group.
`CreateHsmResult`	`createHsm(CreateHsmRequest createHsmRequest)` Creates an uninitialized HSM instance.
`CreateLunaClientResult`	`createLunaClient(CreateLunaClientRequest createLunaClientRequest)` Creates an HSM client.
`DeleteHapgResult`	`deleteHapg(DeleteHapgRequest deleteHapgRequest)` Deletes a high-availability partition group.
`DeleteHsmResult`	`deleteHsm(DeleteHsmRequest deleteHsmRequest)` Deletes an HSM.
`DeleteLunaClientResult`	`deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)` Deletes a client.
`DescribeHapgResult`	`describeHapg(DescribeHapgRequest describeHapgRequest)` Retrieves information about a high-availability partition group.
`DescribeHsmResult`	`describeHsm()` Simplified method form for invoking the DescribeHsm operation.
`DescribeHsmResult`	`describeHsm(DescribeHsmRequest describeHsmRequest)` Retrieves information about an HSM.
`DescribeLunaClientResult`	`describeLunaClient()` Simplified method form for invoking the DescribeLunaClient operation.
`DescribeLunaClientResult`	`describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)` Retrieves information about an HSM client.
`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.
`GetConfigResult`	`getConfig(GetConfigRequest getConfigRequest)` Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
`ListAvailableZonesResult`	`listAvailableZones()` Simplified method form for invoking the ListAvailableZones operation.
`ListAvailableZonesResult`	`listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)` Lists the Availability Zones that have available AWS CloudHSM capacity.
`ListHapgsResult`	`listHapgs()` Simplified method form for invoking the ListHapgs operation.
`ListHapgsResult`	`listHapgs(ListHapgsRequest listHapgsRequest)` Lists the high-availability partition groups for the account.
`ListHsmsResult`	`listHsms()` Simplified method form for invoking the ListHsms operation.
`ListHsmsResult`	`listHsms(ListHsmsRequest listHsmsRequest)` Retrieves the identifiers of all of the HSMs provisioned for the current customer.
`ListLunaClientsResult`	`listLunaClients()` Simplified method form for invoking the ListLunaClients operation.
`ListLunaClientsResult`	`listLunaClients(ListLunaClientsRequest listLunaClientsRequest)` Lists all of the clients.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns a list of all tags for the specified AWS CloudHSM resource.
`ModifyHapgResult`	`modifyHapg(ModifyHapgRequest modifyHapgRequest)` Modifies an existing high-availability partition group.
`ModifyHsmResult`	`modifyHsm(ModifyHsmRequest modifyHsmRequest)` Modifies an HSM.
`ModifyLunaClientResult`	`modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)` Modifies the certificate used by the client.
`RemoveTagsFromResourceResult`	`removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)` Removes one or more tags from the specified AWS CloudHSM resource.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://cloudhsm.us-east-1.amazonaws.com/").
`void`	`setRegion(Region region)` An alternative to `setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

- 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
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Overrides the default endpoint for this client ("https://cloudhsm.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "cloudhsm.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudhsm.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    endpoint - The endpoint (ex: "cloudhsm.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudhsm.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
void setRegion(Region region)
```
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addTagsToResource
```
AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
```
    Adds or overwrites one or more tags for the specified AWS CloudHSM resource.
    
    Each tag consists of a key and a value. Tag keys must be unique to each resource.
    
    Parameters:
    
    addTagsToResourceRequest -
    
    Returns:
    
    Result of the AddTagsToResource operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - createHapg
```
CreateHapgResult createHapg(CreateHapgRequest createHapgRequest)
```
    Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
    
    Parameters:
    
    createHapgRequest - Contains the inputs for the CreateHapgRequest action.
    
    Returns:
    
    Result of the CreateHapg operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - createHsm
```
CreateHsmResult createHsm(CreateHsmRequest createHsmRequest)
```
    Creates an uninitialized HSM instance.
    
    There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.
    
    It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.
    
    Parameters:
    
    createHsmRequest - Contains the inputs for the CreateHsm operation.
    
    Returns:
    
    Result of the CreateHsm operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - createLunaClient
```
CreateLunaClientResult createLunaClient(CreateLunaClientRequest createLunaClientRequest)
```
    Creates an HSM client.
    
    Parameters:
    
    createLunaClientRequest - Contains the inputs for the CreateLunaClient action.
    
    Returns:
    
    Result of the CreateLunaClient operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - deleteHapg
```
DeleteHapgResult deleteHapg(DeleteHapgRequest deleteHapgRequest)
```
    Deletes a high-availability partition group.
    
    Parameters:
    
    deleteHapgRequest - Contains the inputs for the DeleteHapg action.
    
    Returns:
    
    Result of the DeleteHapg operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - deleteHsm
```
DeleteHsmResult deleteHsm(DeleteHsmRequest deleteHsmRequest)
```
    Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.
    
    Parameters:
    
    deleteHsmRequest - Contains the inputs for the DeleteHsm operation.
    
    Returns:
    
    Result of the DeleteHsm operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - deleteLunaClient
```
DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)
```
    Deletes a client.
    
    Parameters:
    
    deleteLunaClientRequest -
    
    Returns:
    
    Result of the DeleteLunaClient operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - describeHapg
```
DescribeHapgResult describeHapg(DescribeHapgRequest describeHapgRequest)
```
    Retrieves information about a high-availability partition group.
    
    Parameters:
    
    describeHapgRequest - Contains the inputs for the DescribeHapg action.
    
    Returns:
    
    Result of the DescribeHapg operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - describeHsm
```
DescribeHsmResult describeHsm(DescribeHsmRequest describeHsmRequest)
```
    Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
    
    Parameters:
    
    describeHsmRequest - Contains the inputs for the DescribeHsm operation.
    
    Returns:
    
    Result of the DescribeHsm operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - describeHsm
```
DescribeHsmResult describeHsm()
```
    Simplified method form for invoking the DescribeHsm operation.
    
    See Also:
    
    describeHsm(DescribeHsmRequest)
  - describeLunaClient
```
DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)
```
    Retrieves information about an HSM client.
    
    Parameters:
    
    describeLunaClientRequest -
    
    Returns:
    
    Result of the DescribeLunaClient operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - describeLunaClient
```
DescribeLunaClientResult describeLunaClient()
```
    Simplified method form for invoking the DescribeLunaClient operation.
    
    See Also:
    
    describeLunaClient(DescribeLunaClientRequest)
  - getConfig
```
GetConfigResult getConfig(GetConfigRequest getConfigRequest)
```
    Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
    
    Parameters:
    
    getConfigRequest -
    
    Returns:
    
    Result of the GetConfig operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - listAvailableZones
```
ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)
```
    Lists the Availability Zones that have available AWS CloudHSM capacity.
    
    Parameters:
    
    listAvailableZonesRequest - Contains the inputs for the ListAvailableZones action.
    
    Returns:
    
    Result of the ListAvailableZones operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - listAvailableZones
```
ListAvailableZonesResult listAvailableZones()
```
    Simplified method form for invoking the ListAvailableZones operation.
    
    See Also:
    
    listAvailableZones(ListAvailableZonesRequest)
  - listHapgs
```
ListHapgsResult listHapgs(ListHapgsRequest listHapgsRequest)
```
    Lists the high-availability partition groups for the account.
    
    This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.
    
    Parameters:
    
    listHapgsRequest -
    
    Returns:
    
    Result of the ListHapgs operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - listHapgs
```
ListHapgsResult listHapgs()
```
    Simplified method form for invoking the ListHapgs operation.
    
    See Also:
    
    listHapgs(ListHapgsRequest)
  - listHsms
```
ListHsmsResult listHsms(ListHsmsRequest listHsmsRequest)
```
    Retrieves the identifiers of all of the HSMs provisioned for the current customer.
    
    This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.
    
    Parameters:
    
    listHsmsRequest -
    
    Returns:
    
    Result of the ListHsms operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - listHsms
```
ListHsmsResult listHsms()
```
    Simplified method form for invoking the ListHsms operation.
    
    See Also:
    
    listHsms(ListHsmsRequest)
  - listLunaClients
```
ListLunaClientsResult listLunaClients(ListLunaClientsRequest listLunaClientsRequest)
```
    Lists all of the clients.
    
    This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.
    
    Parameters:
    
    listLunaClientsRequest -
    
    Returns:
    
    Result of the ListLunaClients operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - listLunaClients
```
ListLunaClientsResult listLunaClients()
```
    Simplified method form for invoking the ListLunaClients operation.
    
    See Also:
    
    listLunaClients(ListLunaClientsRequest)
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns a list of all tags for the specified AWS CloudHSM resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - modifyHapg
```
ModifyHapgResult modifyHapg(ModifyHapgRequest modifyHapgRequest)
```
    Modifies an existing high-availability partition group.
    
    Parameters:
    
    modifyHapgRequest -
    
    Returns:
    
    Result of the ModifyHapg operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - modifyHsm
```
ModifyHsmResult modifyHsm(ModifyHsmRequest modifyHsmRequest)
```
    Modifies an HSM.
    
    This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.
    
    Parameters:
    
    modifyHsmRequest - Contains the inputs for the ModifyHsm operation.
    
    Returns:
    
    Result of the ModifyHsm operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - modifyLunaClient
```
ModifyLunaClientResult modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)
```
    Modifies the certificate used by the client.
    
    This action can potentially start a workflow to install the new certificate on the client's HSMs.
    
    Parameters:
    
    modifyLunaClientRequest -
    
    Returns:
    
    Result of the ModifyLunaClient operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
  - removeTagsFromResource
```
RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
```
    Removes one or more tags from the specified AWS CloudHSM resource.
    
    To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.
    
    Parameters:
    
    removeTagsFromResourceRequest -
    
    Returns:
    
    Result of the RemoveTagsFromResource operation returned by the service.
    
    Throws:
    
    CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.
    
    CloudHsmInternalException - Indicates that an internal error occurred.
    
    InvalidRequestException - Indicates that one or more of the request parameters are not valid.
  - 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.

Did this page help you?

Interface AWSCloudHSM

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

addTagsToResource

createHapg

createHsm

createLunaClient

deleteHapg

deleteHsm

deleteLunaClient

describeHapg

describeHsm

describeHsm

describeLunaClient

describeLunaClient

getConfig

listAvailableZones

listAvailableZones

listHapgs

listHapgs

listHsms

listHsms

listLunaClients

listLunaClients

listTagsForResource

modifyHapg

modifyHsm

modifyLunaClient

removeTagsFromResource

shutdown

getCachedResponseMetadata