keys
Creates, updates, deletes, gets or lists a keys
resource.
Overview
Name | keys |
Type | Resource |
Id | confluent.encryption_keys.keys |
Fields
Name | Datatype | Description |
---|---|---|
id | string | ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). |
api_version | string | APIVersion defines the schema version of this representation of a resource. |
key | object | The cloud-specific key details. For AWS, provide the corresponding key_arn . For Azure, provide the corresponding key_id . For GCP, provide the corresponding key_id . |
kind | string | Kind defines the object this REST resource represents. |
metadata | `` | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. |
provider | string | The cloud provider of the Key. |
state | string | The state of the key: AVAILABLE: key can be used for a Kafka cluster provisioning IN_USE: key is already in use by a Kafka cluster provisioning |
Methods
SELECT
examples
Retrieve a sorted, filtered, paginated list of all keys.
SELECT
id,
api_version,
key,
kind,
metadata,
provider,
state
FROM confluent.encryption_keys.keys
;
INSERT
example
Use the following StackQL query and manifest file to create a new keys
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO confluent.encryption_keys.keys (
data__key
)
SELECT
'{{ key }}'
;
- name: keys
props:
- name: key
props:
- name: key_arn
value: string
- name: kind
value: string
DELETE
example
Deletes the specified keys
resource.
/*+ delete */
DELETE FROM confluent.encryption_keys.keys
WHERE id = '{{ id }}';