kafka_schema_registry_acls

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

Overview

Name	kafka_schema_registry_acls
Type	Resource
Id	ovh.cloud_database.kafka_schema_registry_acls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Acl ID
permission	string	Permission to give to this username on this resource. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions
resource	string	Resource affected by this acl
username	string	Username affected by this acl

list

Cloud databases kafka schema registry acl definition

Name	Datatype	Description
id	string (uuid)	Acl ID
permission	string	Permission to give to this username on this resource. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions
resource	string	Resource affected by this acl
username	string	Username affected by this acl

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	acl_id, cluster_id, service_name		Get kafka schema registry acls
list	select	cluster_id, service_name	x_pagination_mode	List schema registry acls of the kafka
create	insert	cluster_id, service_name, permission, resource, username		Create a new schema registry acl on the kafka cluster
delete	delete	acl_id, cluster_id, service_name		Delete a kafka schema registry acl

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
acl_id	string (uuid)	Acl ID (wire: aclId)
api_host	string	The 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_id	string (uuid)	Cluster ID (wire: clusterId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get kafka schema registry acls

SELECT
id,
permission,
resource,
username
FROM ovh.cloud_database.kafka_schema_registry_acls
WHERE acl_id = '{{ acl_id }}' -- required
AND cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List schema registry acls of the kafka

SELECT
id,
permission,
resource,
username
FROM ovh.cloud_database.kafka_schema_registry_acls
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a new schema registry acl on the kafka cluster

INSERT INTO ovh.cloud_database.kafka_schema_registry_acls (
permission,
resource,
username,
cluster_id,
service_name
)
SELECT 
'{{ permission }}' /* required */,
'{{ resource }}' /* required */,
'{{ username }}' /* required */,
'{{ cluster_id }}',
'{{ service_name }}'
RETURNING
id,
permission,
resource,
username
;

Manifest

# Description fields are for documentation purposes
- name: kafka_schema_registry_acls
props:
  - name: cluster_id
    value: "{{ cluster_id }}"
    description: Required parameter for the kafka_schema_registry_acls resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the kafka_schema_registry_acls resource.
  - name: permission
    value: "{{ permission }}"
    description: |
      Permission to give to this username on this resource. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions
  - name: resource
    value: "{{ resource }}"
    description: |
      Resource affected by this acl
  - name: username
    value: "{{ username }}"
    description: |
      Username affected by this acl

DELETE examples

delete

Delete a kafka schema registry acl

DELETE FROM ovh.cloud_database.kafka_schema_registry_acls
WHERE acl_id = '{{ acl_id }}' --required
AND cluster_id = '{{ cluster_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;