CreateHsmConfiguration - Amazon Redshift
Request ParametersResponse ElementsErrorsExamplesSee Also

CreateHsmConfiguration

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Description

A text description of the HSM configuration to be created.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

HsmConfigurationIdentifier

The identifier to be assigned to the new Amazon Redshift HSM configuration.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

HsmIpAddress

The IP address that the Amazon Redshift cluster must use to access the HSM.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

HsmPartitionName

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

HsmPartitionPassword

The password required to access the HSM partition.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

HsmServerPublicCertificate

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: Yes

Tags.Tag.N

A list of tag instances.

Type: Array of Tag objects

Required: No

Response Elements

The following element is returned by the service.

HsmConfiguration

Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.

Type: HsmConfiguration object

Errors

For information about the errors that are common to all actions, see Common Errors.

HsmConfigurationAlreadyExistsFault

There is already an existing Amazon Redshift HSM configuration with the specified identifier.

HTTP Status Code: 400

HsmConfigurationQuotaExceededFault

The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

HTTP Status Code: 400

InvalidTagFault

The tag is invalid.

HTTP Status Code: 400

TagLimitExceededFault

You have exceeded the number of tags allowed.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateHsmConfiguration.

Sample Request

https://redshift.us-east-2.amazonaws.com/
       ?Action=CreateHsmConfiguration
&HsmConfigurationIdentifier=myhsmconnection
&Description=My+HSM+connection
&HsmIpAddress=192.0.2.09
&HsmPartitionName=myhsmpartition
&HsmPartitionPassword=A1b2c3d4
&HsmServerPublicCertificate=myhsmclientcert
&SignatureMethod=HmacSHA256&SignatureVersion=4
&Version=2012-12-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request
&X-Amz-Date=20190825T160000Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<CreateHsmConfigurationResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
  <CreateHsmConfigurationResult>
    <HsmConfiguration>
      <Description>My HSM connection</Description>
      <HsmPartitionName>myhsmpartition</HsmPartitionName>
      <HsmConfigurationIdentifier>myhsmconnection</HsmConfigurationIdentifier>
      <Tags/>
      <HsmIpAddress>192.0.2.09</HsmIpAddress>
    </HsmConfiguration>
  </CreateHsmConfigurationResult>
  <ResponseMetadata>
    <RequestId>e106be9e-2833-11ea-9caa-c956bec1ce87</RequestId>
  </ResponseMetadata>
</CreateHsmConfigurationResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: