Class AbstractAWSCloudHSM

java.lang.Object
com.amazonaws.services.cloudhsm.AbstractAWSCloudHSM
All Implemented Interfaces:
AWSCloudHSM
Direct Known Subclasses:
AbstractAWSCloudHSMAsync

public class AbstractAWSCloudHSM extends Object implements AWSCloudHSM
Abstract implementation of AWSCloudHSM. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.
  • Constructor Details

    • AbstractAWSCloudHSM

      protected AbstractAWSCloudHSM()
  • Method Details

    • setEndpoint

      public void setEndpoint(String endpoint)
      Description copied from interface: AWSCloudHSM
      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.

      Specified by:
      setEndpoint in interface AWSCloudHSM
      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

      public void setRegion(Region region)
      Description copied from interface: AWSCloudHSM
      An alternative to AWSCloudHSM.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.

      Specified by:
      setRegion in interface AWSCloudHSM
      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:
    • addTagsToResource

      public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
      Description copied from interface: AWSCloudHSM

      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.

      Specified by:
      addTagsToResource in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the AddTagsToResource operation returned by the service.
    • createHapg

      public CreateHapgResult createHapg(CreateHapgRequest request)
      Description copied from interface: AWSCloudHSM

      Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

      Specified by:
      createHapg in interface AWSCloudHSM
      Parameters:
      request - Contains the inputs for the CreateHapgRequest action.
      Returns:
      Result of the CreateHapg operation returned by the service.
    • createHsm

      public CreateHsmResult createHsm(CreateHsmRequest request)
      Description copied from interface: AWSCloudHSM

      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.

      Specified by:
      createHsm in interface AWSCloudHSM
      Parameters:
      request - Contains the inputs for the CreateHsm operation.
      Returns:
      Result of the CreateHsm operation returned by the service.
    • createLunaClient

      public CreateLunaClientResult createLunaClient(CreateLunaClientRequest request)
      Description copied from interface: AWSCloudHSM

      Creates an HSM client.

      Specified by:
      createLunaClient in interface AWSCloudHSM
      Parameters:
      request - Contains the inputs for the CreateLunaClient action.
      Returns:
      Result of the CreateLunaClient operation returned by the service.
    • deleteHapg

      public DeleteHapgResult deleteHapg(DeleteHapgRequest request)
      Description copied from interface: AWSCloudHSM

      Deletes a high-availability partition group.

      Specified by:
      deleteHapg in interface AWSCloudHSM
      Parameters:
      request - Contains the inputs for the DeleteHapg action.
      Returns:
      Result of the DeleteHapg operation returned by the service.
    • deleteHsm

      public DeleteHsmResult deleteHsm(DeleteHsmRequest request)
      Description copied from interface: AWSCloudHSM

      Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

      Specified by:
      deleteHsm in interface AWSCloudHSM
      Parameters:
      request - Contains the inputs for the DeleteHsm operation.
      Returns:
      Result of the DeleteHsm operation returned by the service.
    • deleteLunaClient

      public DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest request)
      Description copied from interface: AWSCloudHSM

      Deletes a client.

      Specified by:
      deleteLunaClient in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the DeleteLunaClient operation returned by the service.
    • describeHapg

      public DescribeHapgResult describeHapg(DescribeHapgRequest request)
      Description copied from interface: AWSCloudHSM

      Retrieves information about a high-availability partition group.

      Specified by:
      describeHapg in interface AWSCloudHSM
      Parameters:
      request - Contains the inputs for the DescribeHapg action.
      Returns:
      Result of the DescribeHapg operation returned by the service.
    • describeHsm

      public DescribeHsmResult describeHsm(DescribeHsmRequest request)
      Description copied from interface: AWSCloudHSM

      Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

      Specified by:
      describeHsm in interface AWSCloudHSM
      Parameters:
      request - Contains the inputs for the DescribeHsm operation.
      Returns:
      Result of the DescribeHsm operation returned by the service.
    • describeHsm

      public DescribeHsmResult describeHsm()
      Description copied from interface: AWSCloudHSM
      Simplified method form for invoking the DescribeHsm operation.
      Specified by:
      describeHsm in interface AWSCloudHSM
      See Also:
    • describeLunaClient

      public DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest request)
      Description copied from interface: AWSCloudHSM

      Retrieves information about an HSM client.

      Specified by:
      describeLunaClient in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the DescribeLunaClient operation returned by the service.
    • describeLunaClient

      public DescribeLunaClientResult describeLunaClient()
      Description copied from interface: AWSCloudHSM
      Simplified method form for invoking the DescribeLunaClient operation.
      Specified by:
      describeLunaClient in interface AWSCloudHSM
      See Also:
    • getConfig

      public GetConfigResult getConfig(GetConfigRequest request)
      Description copied from interface: AWSCloudHSM

      Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

      Specified by:
      getConfig in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the GetConfig operation returned by the service.
    • listAvailableZones

      public ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest request)
      Description copied from interface: AWSCloudHSM

      Lists the Availability Zones that have available AWS CloudHSM capacity.

      Specified by:
      listAvailableZones in interface AWSCloudHSM
      Parameters:
      request - Contains the inputs for the ListAvailableZones action.
      Returns:
      Result of the ListAvailableZones operation returned by the service.
    • listAvailableZones

      public ListAvailableZonesResult listAvailableZones()
      Description copied from interface: AWSCloudHSM
      Simplified method form for invoking the ListAvailableZones operation.
      Specified by:
      listAvailableZones in interface AWSCloudHSM
      See Also:
    • listHapgs

      public ListHapgsResult listHapgs(ListHapgsRequest request)
      Description copied from interface: AWSCloudHSM

      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.

      Specified by:
      listHapgs in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the ListHapgs operation returned by the service.
    • listHapgs

      public ListHapgsResult listHapgs()
      Description copied from interface: AWSCloudHSM
      Simplified method form for invoking the ListHapgs operation.
      Specified by:
      listHapgs in interface AWSCloudHSM
      See Also:
    • listHsms

      public ListHsmsResult listHsms(ListHsmsRequest request)
      Description copied from interface: AWSCloudHSM

      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.

      Specified by:
      listHsms in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the ListHsms operation returned by the service.
    • listHsms

      public ListHsmsResult listHsms()
      Description copied from interface: AWSCloudHSM
      Simplified method form for invoking the ListHsms operation.
      Specified by:
      listHsms in interface AWSCloudHSM
      See Also:
    • listLunaClients

      public ListLunaClientsResult listLunaClients(ListLunaClientsRequest request)
      Description copied from interface: AWSCloudHSM

      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.

      Specified by:
      listLunaClients in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the ListLunaClients operation returned by the service.
    • listLunaClients

      public ListLunaClientsResult listLunaClients()
      Description copied from interface: AWSCloudHSM
      Simplified method form for invoking the ListLunaClients operation.
      Specified by:
      listLunaClients in interface AWSCloudHSM
      See Also:
    • listTagsForResource

      public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
      Description copied from interface: AWSCloudHSM

      Returns a list of all tags for the specified AWS CloudHSM resource.

      Specified by:
      listTagsForResource in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the ListTagsForResource operation returned by the service.
    • modifyHapg

      public ModifyHapgResult modifyHapg(ModifyHapgRequest request)
      Description copied from interface: AWSCloudHSM

      Modifies an existing high-availability partition group.

      Specified by:
      modifyHapg in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the ModifyHapg operation returned by the service.
    • modifyHsm

      public ModifyHsmResult modifyHsm(ModifyHsmRequest request)
      Description copied from interface: AWSCloudHSM

      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.

      Specified by:
      modifyHsm in interface AWSCloudHSM
      Parameters:
      request - Contains the inputs for the ModifyHsm operation.
      Returns:
      Result of the ModifyHsm operation returned by the service.
    • modifyLunaClient

      public ModifyLunaClientResult modifyLunaClient(ModifyLunaClientRequest request)
      Description copied from interface: AWSCloudHSM

      Modifies the certificate used by the client.

      This action can potentially start a workflow to install the new certificate on the client's HSMs.

      Specified by:
      modifyLunaClient in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the ModifyLunaClient operation returned by the service.
    • removeTagsFromResource

      public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
      Description copied from interface: AWSCloudHSM

      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.

      Specified by:
      removeTagsFromResource in interface AWSCloudHSM
      Parameters:
      request -
      Returns:
      Result of the RemoveTagsFromResource operation returned by the service.
    • shutdown

      public void shutdown()
      Description copied from interface: AWSCloudHSM
      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 AWSCloudHSM
    • getCachedResponseMetadata

      public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
      Description copied from interface: AWSCloudHSM
      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 AWSCloudHSM
      Parameters:
      request - The originally executed request.
      Returns:
      The response metadata for the specified request, or null if none is available.