Skip to main content

kafka_user_accesses

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

Overview​

Namekafka_user_accesses
TypeResource
Idovh.cloud_database.kafka_user_accesses

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
certstringUser cert
keystring (password)User key for the cert

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcluster_id, user_id, service_nameRetrieve the user acces for the cluster

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.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
cluster_idstring (uuid)Cluster ID (wire: clusterId)
service_namestringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
user_idstring (uuid)User ID (wire: userId)

SELECT examples​

Retrieve the user acces for the cluster

SELECT
cert,
key
FROM ovh.cloud_database.kafka_user_accesses
WHERE cluster_id = '{{ cluster_id }}' -- required
AND user_id = '{{ user_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;