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.| Modifier and Type | Method and Description |
|---|---|
CreateHapgResult |
createHapg(CreateHapgRequest request)
Creates a high-availability partition group.
|
CreateHsmResult |
createHsm(CreateHsmRequest request)
Creates an uninitialized HSM instance.
|
CreateLunaClientResult |
createLunaClient(CreateLunaClientRequest request)
Creates an HSM client.
|
DeleteHapgResult |
deleteHapg(DeleteHapgRequest request)
Deletes a high-availability partition group.
|
DeleteHsmResult |
deleteHsm(DeleteHsmRequest request)
Deletes an HSM.
|
DeleteLunaClientResult |
deleteLunaClient(DeleteLunaClientRequest request)
Deletes a client.
|
DescribeHapgResult |
describeHapg(DescribeHapgRequest request)
Retrieves information about a high-availability partition group.
|
DescribeHsmResult |
describeHsm()
Simplified method form for invoking the DescribeHsm operation.
|
DescribeHsmResult |
describeHsm(DescribeHsmRequest request)
Retrieves information about an HSM.
|
DescribeLunaClientResult |
describeLunaClient()
Simplified method form for invoking the DescribeLunaClient operation.
|
DescribeLunaClientResult |
describeLunaClient(DescribeLunaClientRequest request)
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 request)
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 request)
Lists the Availability Zones that have available AWS CloudHSM capacity.
|
ListHapgsResult |
listHapgs()
Simplified method form for invoking the ListHapgs operation.
|
ListHapgsResult |
listHapgs(ListHapgsRequest request)
Lists the high-availability partition groups for the account.
|
ListHsmsResult |
listHsms()
Simplified method form for invoking the ListHsms operation.
|
ListHsmsResult |
listHsms(ListHsmsRequest request)
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 request)
Lists all of the clients.
|
ModifyHapgResult |
modifyHapg(ModifyHapgRequest request)
Modifies an existing high-availability partition group.
|
ModifyHsmResult |
modifyHsm(ModifyHsmRequest request)
Modifies an HSM.
|
ModifyLunaClientResult |
modifyLunaClient(ModifyLunaClientRequest request)
Modifies the certificate used by the client.
|
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
AWSCloudHSM.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.
|
public 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: 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.
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)public CreateHapgResult createHapg(CreateHapgRequest request)
AWSCloudHSMCreates 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.public CreateHsmResult createHsm(CreateHsmRequest request)
AWSCloudHSMCreates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM.
createHsm in interface AWSCloudHSMrequest - Contains the inputs for the CreateHsm action.public CreateLunaClientResult createLunaClient(CreateLunaClientRequest request)
AWSCloudHSMCreates an HSM client.
createLunaClient in interface AWSCloudHSMrequest - Contains the inputs for the CreateLunaClient action.public DeleteHapgResult deleteHapg(DeleteHapgRequest request)
AWSCloudHSMDeletes a high-availability partition group.
deleteHapg in interface AWSCloudHSMrequest - Contains the inputs for the DeleteHapg action.public DeleteHsmResult deleteHsm(DeleteHsmRequest request)
AWSCloudHSMDeletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered.
deleteHsm in interface AWSCloudHSMrequest - Contains the inputs for the DeleteHsm action.public DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest request)
AWSCloudHSMDeletes a client.
deleteLunaClient in interface AWSCloudHSMpublic DescribeHapgResult describeHapg(DescribeHapgRequest request)
AWSCloudHSMRetrieves information about a high-availability partition group.
describeHapg in interface AWSCloudHSMrequest - Contains the inputs for the DescribeHapg action.public DescribeHsmResult describeHsm(DescribeHsmRequest request)
AWSCloudHSMRetrieves 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 action.public DescribeHsmResult describeHsm()
AWSCloudHSMdescribeHsm in interface AWSCloudHSMAWSCloudHSM.describeHsm(DescribeHsmRequest)public DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest request)
AWSCloudHSMRetrieves information about an HSM client.
describeLunaClient in interface AWSCloudHSMpublic DescribeLunaClientResult describeLunaClient()
AWSCloudHSMdescribeLunaClient in interface AWSCloudHSMAWSCloudHSM.describeLunaClient(DescribeLunaClientRequest)public GetConfigResult getConfig(GetConfigRequest request)
AWSCloudHSMGets the configuration files necessary to connect to all high availability partition groups the client is associated with.
getConfig in interface AWSCloudHSMpublic ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest request)
AWSCloudHSMLists the Availability Zones that have available AWS CloudHSM capacity.
listAvailableZones in interface AWSCloudHSMrequest - Contains the inputs for the ListAvailableZones action.public ListAvailableZonesResult listAvailableZones()
AWSCloudHSMlistAvailableZones in interface AWSCloudHSMAWSCloudHSM.listAvailableZones(ListAvailableZonesRequest)public ListHapgsResult listHapgs(ListHapgsRequest request)
AWSCloudHSMLists 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 AWSCloudHSMpublic ListHapgsResult listHapgs()
AWSCloudHSMlistHapgs in interface AWSCloudHSMAWSCloudHSM.listHapgs(ListHapgsRequest)public ListHsmsResult listHsms(ListHsmsRequest request)
AWSCloudHSMRetrieves 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 AWSCloudHSMpublic ListHsmsResult listHsms()
AWSCloudHSMlistHsms in interface AWSCloudHSMAWSCloudHSM.listHsms(ListHsmsRequest)public ListLunaClientsResult listLunaClients(ListLunaClientsRequest request)
AWSCloudHSMLists 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 AWSCloudHSMpublic ListLunaClientsResult listLunaClients()
AWSCloudHSMlistLunaClients in interface AWSCloudHSMAWSCloudHSM.listLunaClients(ListLunaClientsRequest)public ModifyHapgResult modifyHapg(ModifyHapgRequest request)
AWSCloudHSMModifies an existing high-availability partition group.
modifyHapg in interface AWSCloudHSMpublic ModifyHsmResult modifyHsm(ModifyHsmRequest request)
AWSCloudHSMModifies an HSM.
modifyHsm in interface AWSCloudHSMrequest - Contains the inputs for the ModifyHsm action.public ModifyLunaClientResult modifyLunaClient(ModifyLunaClientRequest request)
AWSCloudHSMModifies 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 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.