key_encryption_keys

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

Overview

Name	key_encryption_keys
Type	Resource
Id	confluent.encryption_keys.key_encryption_keys

Fields

Name	Datatype	Description
name	string	Name of the kek
deleted	boolean	Whether the kek is deleted
doc	string	Description of the kek
kmsKeyId	string	KMS key ID of the kek
kmsProps	object	Properties of the kek
kmsType	string	KMS type of the kek
shared	boolean	Whether the kek is shared
ts	integer	Timestamp of the kek

Methods

Name	Accessible by	Required Params	Description
get_kek	SELECT	name
get_kek_names	SELECT
create_kek	INSERT
delete_kek	DELETE	name
put_kek	REPLACE	name
undelete_kek	EXEC	name

SELECT examples

SELECT
name,
deleted,
doc,
kmsKeyId,
kmsProps,
kmsType,
shared,
ts
FROM confluent.encryption_keys.key_encryption_keys
;

INSERT example

Use the following StackQL query and manifest file to create a new key_encryption_keys resource.

All Properties

/*+ create */
INSERT INTO confluent.encryption_keys.key_encryption_keys (
data__name,
data__kmsType,
data__kmsKeyId,
data__kmsProps,
data__doc,
data__shared,
data__deleted
)
SELECT 
'{{ name }}',
'{{ kmsType }}',
'{{ kmsKeyId }}',
'{{ kmsProps }}',
'{{ doc }}',
'{{ shared }}',
'{{ deleted }}'
;

Manifest

- name: key_encryption_keys
  props:
    - name: name
      value: string
    - name: kmsType
      value: string
    - name: kmsKeyId
      value: string
    - name: kmsProps
      value: object
    - name: doc
      value: string
    - name: shared
      value: boolean
    - name: deleted
      value: boolean

REPLACE example

Replaces all fields in the specified key_encryption_keys resource.

/*+ update */
REPLACE confluent.encryption_keys.key_encryption_keys
SET 
kmsProps = '{{ kmsProps }}',
doc = '{{ doc }}',
shared = true|false
WHERE 
name = '{{ name }}';

DELETE example

Deletes the specified key_encryption_keys resource.

/*+ delete */
DELETE FROM confluent.encryption_keys.key_encryption_keys
WHERE name = '{{ name }}';