Class AWSCloudHSMClient
- All Implemented Interfaces:
AWSCloudHSM
- Direct Known Subclasses:
AWSCloudHSMAsyncClient
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final ClientConfigurationFactory
Client configuration factory providing ClientConfigurations tailored to this clientFields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new client to invoke service methods on CloudHSM.AWSCloudHSMClient
(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials.AWSCloudHSMClient
(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials provider.AWSCloudHSMClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials provider and client configuration options.AWSCloudHSMClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials provider, client configuration options, and request metric collector.AWSCloudHSMClient
(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials and client configuration options.AWSCloudHSMClient
(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CloudHSM. -
Method Summary
Modifier and TypeMethodDescriptionaddTagsToResource
(AddTagsToResourceRequest addTagsToResourceRequest) Adds or overwrites one or more tags for the specified AWS CloudHSM resource.createHapg
(CreateHapgRequest createHapgRequest) Creates a high-availability partition group.createHsm
(CreateHsmRequest createHsmRequest) Creates an uninitialized HSM instance.createLunaClient
(CreateLunaClientRequest createLunaClientRequest) Creates an HSM client.deleteHapg
(DeleteHapgRequest deleteHapgRequest) Deletes a high-availability partition group.deleteHsm
(DeleteHsmRequest deleteHsmRequest) Deletes an HSM.deleteLunaClient
(DeleteLunaClientRequest deleteLunaClientRequest) Deletes a client.describeHapg
(DescribeHapgRequest describeHapgRequest) Retrieves information about a high-availability partition group.Simplified method form for invoking the DescribeHsm operation.describeHsm
(DescribeHsmRequest describeHsmRequest) Retrieves information about an HSM.Simplified method form for invoking the DescribeLunaClient operation.describeLunaClient
(DescribeLunaClientRequest describeLunaClientRequest) Retrieves information about an HSM client.Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.getConfig
(GetConfigRequest getConfigRequest) Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.Simplified method form for invoking the ListAvailableZones operation.listAvailableZones
(ListAvailableZonesRequest listAvailableZonesRequest) Lists the Availability Zones that have available AWS CloudHSM capacity.Simplified method form for invoking the ListHapgs operation.listHapgs
(ListHapgsRequest listHapgsRequest) Lists the high-availability partition groups for the account.listHsms()
Simplified method form for invoking the ListHsms operation.listHsms
(ListHsmsRequest listHsmsRequest) Retrieves the identifiers of all of the HSMs provisioned for the current customer.Simplified method form for invoking the ListLunaClients operation.listLunaClients
(ListLunaClientsRequest listLunaClientsRequest) Lists all of the clients.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of all tags for the specified AWS CloudHSM resource.modifyHapg
(ModifyHapgRequest modifyHapgRequest) Modifies an existing high-availability partition group.modifyHsm
(ModifyHsmRequest modifyHsmRequest) Modifies an HSM.modifyLunaClient
(ModifyLunaClientRequest modifyLunaClientRequest) Modifies the certificate used by the client.removeTagsFromResource
(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes one or more tags from the specified AWS CloudHSM resource.Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.cloudhsm.AWSCloudHSM
setEndpoint, setRegion, shutdown
-
Field Details
-
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
-
-
Constructor Details
-
AWSCloudHSMClient
public AWSCloudHSMClient()Constructs a new client to invoke service methods on CloudHSM. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
-
AWSCloudHSMClient
Constructs a new client to invoke service methods on CloudHSM. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to CloudHSM (ex: proxy settings, retry counts, etc.).- See Also:
-
AWSCloudHSMClient
Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AWSCloudHSMClient
Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to CloudHSM (ex: proxy settings, retry counts, etc.).
-
AWSCloudHSMClient
Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AWSCloudHSMClient
public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to CloudHSM (ex: proxy settings, retry counts, etc.).
-
AWSCloudHSMClient
public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to CloudHSM (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collector
-
-
Method Details
-
addTagsToResource
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 interfaceAWSCloudHSM
- 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
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 interfaceAWSCloudHSM
- 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
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 interfaceAWSCloudHSM
- 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
Creates an HSM client.
- Specified by:
createLunaClient
in interfaceAWSCloudHSM
- 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
Deletes a high-availability partition group.
- Specified by:
deleteHapg
in interfaceAWSCloudHSM
- 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
Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.
- Specified by:
deleteHsm
in interfaceAWSCloudHSM
- 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
Deletes a client.
- Specified by:
deleteLunaClient
in interfaceAWSCloudHSM
- 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
Retrieves information about a high-availability partition group.
- Specified by:
describeHapg
in interfaceAWSCloudHSM
- 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
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
- Specified by:
describeHsm
in interfaceAWSCloudHSM
- 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
Description copied from interface:AWSCloudHSM
Simplified method form for invoking the DescribeHsm operation.- Specified by:
describeHsm
in interfaceAWSCloudHSM
- See Also:
-
describeLunaClient
public DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest) Retrieves information about an HSM client.
- Specified by:
describeLunaClient
in interfaceAWSCloudHSM
- 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
Description copied from interface:AWSCloudHSM
Simplified method form for invoking the DescribeLunaClient operation.- Specified by:
describeLunaClient
in interfaceAWSCloudHSM
- See Also:
-
getConfig
Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
- Specified by:
getConfig
in interfaceAWSCloudHSM
- 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
public ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest) Lists the Availability Zones that have available AWS CloudHSM capacity.
- Specified by:
listAvailableZones
in interfaceAWSCloudHSM
- 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
Description copied from interface:AWSCloudHSM
Simplified method form for invoking the ListAvailableZones operation.- Specified by:
listAvailableZones
in interfaceAWSCloudHSM
- See Also:
-
listHapgs
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 interfaceAWSCloudHSM
- 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
Description copied from interface:AWSCloudHSM
Simplified method form for invoking the ListHapgs operation.- Specified by:
listHapgs
in interfaceAWSCloudHSM
- See Also:
-
listHsms
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 interfaceAWSCloudHSM
- 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
Description copied from interface:AWSCloudHSM
Simplified method form for invoking the ListHsms operation.- Specified by:
listHsms
in interfaceAWSCloudHSM
- See Also:
-
listLunaClients
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 interfaceAWSCloudHSM
- 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
Description copied from interface:AWSCloudHSM
Simplified method form for invoking the ListLunaClients operation.- Specified by:
listLunaClients
in interfaceAWSCloudHSM
- See Also:
-
listTagsForResource
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of all tags for the specified AWS CloudHSM resource.
- Specified by:
listTagsForResource
in interfaceAWSCloudHSM
- 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
Modifies an existing high-availability partition group.
- Specified by:
modifyHapg
in interfaceAWSCloudHSM
- 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
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 interfaceAWSCloudHSM
- 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
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 interfaceAWSCloudHSM
- 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
public 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.
- Specified by:
removeTagsFromResource
in interfaceAWSCloudHSM
- 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.
-
getCachedResponseMetadata
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 the request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSCloudHSM
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-