AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This 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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginModifyHsm and EndModifyHsm.

Namespace: Amazon.CloudHSM
Assembly: AWSSDK.CloudHSM.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<ModifyHsmResponse> ModifyHsmAsync(
         ModifyHsmRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudHSM.Model.ModifyHsmRequest

Container for the necessary parameters to execute the ModifyHsm service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ModifyHsm service method, as returned by CloudHSM.

Exceptions

ExceptionCondition
CloudHsmInternalException Indicates that an internal error occurred.
CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
InvalidRequestException Indicates that one or more of the request parameters are not valid.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also