Redshift / Client / create_hsm_configuration

create_hsm_configuration

Redshift.Client.create_hsm_configuration(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_hsm_configuration(
    HsmConfigurationIdentifier='string',
    Description='string',
    HsmIpAddress='string',
    HsmPartitionName='string',
    HsmPartitionPassword='string',
    HsmServerPublicCertificate='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• HsmConfigurationIdentifier (string) –

  [REQUIRED]

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

• Description (string) –

  [REQUIRED]

  A text description of the HSM configuration to be created.

• HsmIpAddress (string) –

  [REQUIRED]

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

• HsmPartitionName (string) –

  [REQUIRED]

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

• HsmPartitionPassword (string) –

  [REQUIRED]

  The password required to access the HSM partition.

• HsmServerPublicCertificate (string) –

  [REQUIRED]

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

• Tags (list) –

  A list of tag instances.

  • (dict) –

    A tag consisting of a name/value pair for a resource.

    • Key (string) –

      The key, or name, for the resource tag.

    • Value (string) –

      The value for the resource tag.

Return type:

dict

Returns:

Response Syntax

{
    'HsmConfiguration': {
        'HsmConfigurationIdentifier': 'string',
        'Description': 'string',
        'HsmIpAddress': 'string',
        'HsmPartitionName': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • HsmConfiguration (dict) –

    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.

    • HsmConfigurationIdentifier (string) –

      The name of the Amazon Redshift HSM configuration.

    • Description (string) –

      A text description of the HSM configuration.

    • HsmIpAddress (string) –

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

    • HsmPartitionName (string) –

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

    • Tags (list) –

      The list of tags for the HSM configuration.

      • (dict) –

        A tag consisting of a name/value pair for a resource.

        • Key (string) –

          The key, or name, for the resource tag.

        • Value (string) –

          The value for the resource tag.

Exceptions

• Redshift.Client.exceptions.HsmConfigurationAlreadyExistsFault

• Redshift.Client.exceptions.HsmConfigurationQuotaExceededFault

• Redshift.Client.exceptions.TagLimitExceededFault

• Redshift.Client.exceptions.InvalidTagFault