hsm_client_certificates

Creates, updates, deletes, gets or lists a hsm_client_certificates resource.

Overview

Name	hsm_client_certificates
Type	Resource
Id	aws.redshift.hsm_client_certificates

Fields

The following fields are returned by SELECT queries:

describe_hsm_client_certificates

Name	Datatype	Description
hsm_client_certificate_identifier	string	The identifier of the HSM client certificate.
hsm_client_certificate_public_key	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	string	The list of tags for the HSM client certificate.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_hsm_client_certificates	select	region	HsmClientCertificateIdentifier, MaxRecords, Marker, TagKeys, TagValues	Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
create_hsm_client_certificate	insert	HsmClientCertificateIdentifier, region	Tags	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.
delete_hsm_client_certificate	delete	HsmClientCertificateIdentifier, region		Deletes the specified HSM client certificate.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
HsmClientCertificateIdentifier	string	The identifier of the HSM client certificate to be deleted.
region	string	AWS region (default: us-east-1)
HsmClientCertificateIdentifier	string	The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your Amazon Web Services account.
Marker	string	An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
MaxRecords	integer	The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
TagKeys	array	A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.
TagValues	array	A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.
Tags	array	A list of tag instances.

SELECT examples

describe_hsm_client_certificates

Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account. If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned. If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.

SELECT
hsm_client_certificate_identifier,
hsm_client_certificate_public_key,
tags
FROM aws.redshift.hsm_client_certificates
WHERE region = '{{ region }}' -- required
AND HsmClientCertificateIdentifier = '{{ HsmClientCertificateIdentifier }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
AND TagKeys = '{{ TagKeys }}'
AND TagValues = '{{ TagValues }}'
;

INSERT examples

create_hsm_client_certificate

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.

INSERT INTO aws.redshift.hsm_client_certificates (
HsmClientCertificateIdentifier,
region,
Tags
)
SELECT 
'{{ HsmClientCertificateIdentifier }}',
'{{ region }}',
'{{ Tags }}'
RETURNING
hsm_client_certificate_identifier,
hsm_client_certificate_public_key,
tags
;

Manifest

# Description fields are for documentation purposes
- name: hsm_client_certificates
props:
  - name: HsmClientCertificateIdentifier
    value: "{{ HsmClientCertificateIdentifier }}"
    description: Required parameter for the hsm_client_certificates resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the hsm_client_certificates resource.
  - name: Tags
    value: "{{ Tags }}"
    description: A list of tag instances.
    description: A list of tag instances.

DELETE examples

delete_hsm_client_certificate

Deletes the specified HSM client certificate.

DELETE FROM aws.redshift.hsm_client_certificates
WHERE HsmClientCertificateIdentifier = '{{ HsmClientCertificateIdentifier }}' --required
AND region = '{{ region }}' --required
;