Redshift / Client / create_hsm_client_certificate

create_hsm_client_certificate

Redshift.Client.create_hsm_client_certificate(**kwargs)

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client’s HSM in order to store and retrieve the keys used to encrypt the cluster databases.

The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. 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_client_certificate(
    HsmClientCertificateIdentifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• HsmClientCertificateIdentifier (string) –

  [REQUIRED]

  The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

• 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

{
    'HsmClientCertificate': {
        'HsmClientCertificateIdentifier': 'string',
        'HsmClientCertificatePublicKey': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • HsmClientCertificate (dict) –

    Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.

    • HsmClientCertificateIdentifier (string) –

      The identifier of the HSM client certificate.

    • HsmClientCertificatePublicKey (string) –

      The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.

    • Tags (list) –

      The list of tags for the HSM client certificate.

      • (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.HsmClientCertificateAlreadyExistsFault

• Redshift.Client.exceptions.HsmClientCertificateQuotaExceededFault

• Redshift.Client.exceptions.TagLimitExceededFault

• Redshift.Client.exceptions.InvalidTagFault