@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSCloudHSM extends Object implements AWSCloudHSM
AWSCloudHSM. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic void setEndpoint(String endpoint)
AWSCloudHSM
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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
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.
setEndpoint in interface AWSCloudHSMendpoint - 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.public void setRegion(Region region)
AWSCloudHSMAWSCloudHSM.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.
setRegion in interface AWSCloudHSMregion - 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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)@Deprecated public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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.
addTagsToResource in interface AWSCloudHSM@Deprecated public CreateHapgResult createHapg(CreateHapgRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
createHapg in interface AWSCloudHSMrequest - Contains the inputs for the CreateHapgRequest action.@Deprecated public CreateHsmResult createHsm(CreateHsmRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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.
createHsm in interface AWSCloudHSMrequest - Contains the inputs for the CreateHsm operation.@Deprecated public CreateLunaClientResult createLunaClient(CreateLunaClientRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Creates an HSM client.
createLunaClient in interface AWSCloudHSMrequest - Contains the inputs for the CreateLunaClient action.@Deprecated public DeleteHapgResult deleteHapg(DeleteHapgRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes a high-availability partition group.
deleteHapg in interface AWSCloudHSMrequest - Contains the inputs for the DeleteHapg action.@Deprecated public DeleteHsmResult deleteHsm(DeleteHsmRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.
deleteHsm in interface AWSCloudHSMrequest - Contains the inputs for the DeleteHsm operation.@Deprecated public DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Deletes a client.
deleteLunaClient in interface AWSCloudHSM@Deprecated public DescribeHapgResult describeHapg(DescribeHapgRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about a high-availability partition group.
describeHapg in interface AWSCloudHSMrequest - Contains the inputs for the DescribeHapg action.@Deprecated public DescribeHsmResult describeHsm(DescribeHsmRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
describeHsm in interface AWSCloudHSMrequest - Contains the inputs for the DescribeHsm operation.@Deprecated public DescribeHsmResult describeHsm()
AWSCloudHSMdescribeHsm in interface AWSCloudHSMAWSCloudHSM.describeHsm(DescribeHsmRequest)@Deprecated public DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Retrieves information about an HSM client.
describeLunaClient in interface AWSCloudHSM@Deprecated public DescribeLunaClientResult describeLunaClient()
AWSCloudHSMdescribeLunaClient in interface AWSCloudHSMAWSCloudHSM.describeLunaClient(DescribeLunaClientRequest)@Deprecated public GetConfigResult getConfig(GetConfigRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
getConfig in interface AWSCloudHSM@Deprecated public ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Lists the Availability Zones that have available AWS CloudHSM capacity.
listAvailableZones in interface AWSCloudHSMrequest - Contains the inputs for the ListAvailableZones action.@Deprecated public ListAvailableZonesResult listAvailableZones()
AWSCloudHSMlistAvailableZones in interface AWSCloudHSMAWSCloudHSM.listAvailableZones(ListAvailableZonesRequest)@Deprecated public ListHapgsResult listHapgs(ListHapgsRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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.
listHapgs in interface AWSCloudHSM@Deprecated public ListHapgsResult listHapgs()
AWSCloudHSMlistHapgs in interface AWSCloudHSMAWSCloudHSM.listHapgs(ListHapgsRequest)@Deprecated public ListHsmsResult listHsms(ListHsmsRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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.
listHsms in interface AWSCloudHSM@Deprecated public ListHsmsResult listHsms()
AWSCloudHSMlistHsms in interface AWSCloudHSMAWSCloudHSM.listHsms(ListHsmsRequest)@Deprecated public ListLunaClientsResult listLunaClients(ListLunaClientsRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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.
listLunaClients in interface AWSCloudHSM@Deprecated public ListLunaClientsResult listLunaClients()
AWSCloudHSMlistLunaClients in interface AWSCloudHSMAWSCloudHSM.listLunaClients(ListLunaClientsRequest)@Deprecated public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Returns a list of all tags for the specified AWS CloudHSM resource.
listTagsForResource in interface AWSCloudHSM@Deprecated public ModifyHapgResult modifyHapg(ModifyHapgRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Modifies an existing high-availability partition group.
modifyHapg in interface AWSCloudHSM@Deprecated public ModifyHsmResult modifyHsm(ModifyHsmRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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.
modifyHsm in interface AWSCloudHSMrequest - Contains the inputs for the ModifyHsm operation.@Deprecated public ModifyLunaClientResult modifyLunaClient(ModifyLunaClientRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
Modifies the certificate used by the client.
This action can potentially start a workflow to install the new certificate on the client's HSMs.
modifyLunaClient in interface AWSCloudHSM@Deprecated public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
AWSCloudHSMThis is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.
For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.
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.
removeTagsFromResource in interface AWSCloudHSMpublic void shutdown()
AWSCloudHSMshutdown in interface AWSCloudHSMpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSCloudHSMResponse 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.
getCachedResponseMetadata in interface AWSCloudHSMrequest - The originally executed request.