confluent_resources

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

Overview

Name	confluent_resources
Type	Resource
Id	datadog.integrations.confluent_resources

Fields

The following fields are returned by SELECT queries:

get_confluent_resource

Name	Datatype	Description
id	string	The ID associated with the Confluent resource. (example: resource_id_abc123)
attributes	object	Model representation of a Confluent Cloud resource.
type	string	The JSON:API type for this request. (default: confluent-cloud-resources, example: confluent-cloud-resources)

list_confluent_resource

Name	Datatype	Description
id	string	The ID associated with the Confluent resource. (example: resource_id_abc123)
attributes	object	Model representation of a Confluent Cloud resource.
type	string	The JSON:API type for this request. (default: confluent-cloud-resources, example: confluent-cloud-resources)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_confluent_resource	select	account_id, resource_id, region		Get a Confluent resource with the provided resource id for the account associated with the provided account ID.
list_confluent_resource	select	account_id, region		Get a Confluent resource for the account associated with the provided ID.
create_confluent_resource	insert	account_id, region, data__data		Create a Confluent resource for the account associated with the provided ID.
update_confluent_resource	update	account_id, resource_id, region, data__data		Update a Confluent resource with the provided resource id for the account associated with the provided account ID.
delete_confluent_resource	delete	account_id, resource_id, region		Delete a Confluent resource with the provided resource id for the account associated with the provided account ID.

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
account_id	string	Confluent Account ID.
region	string	(default: datadoghq.com)
resource_id	string	Confluent Account Resource ID.

SELECT examples

get_confluent_resource

Get a Confluent resource with the provided resource id for the account associated with the provided account ID.

SELECT
id,
attributes,
type
FROM datadog.integrations.confluent_resources
WHERE account_id = '{{ account_id }}' -- required
AND resource_id = '{{ resource_id }}' -- required
AND region = '{{ region }}' -- required
;

list_confluent_resource

Get a Confluent resource for the account associated with the provided ID.

SELECT
id,
attributes,
type
FROM datadog.integrations.confluent_resources
WHERE account_id = '{{ account_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_confluent_resource

Create a Confluent resource for the account associated with the provided ID.

INSERT INTO datadog.integrations.confluent_resources (
data__data,
account_id,
region
)
SELECT 
'{{ data }}' /* required */,
'{{ account_id }}',
'{{ region }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: confluent_resources
  props:
    - name: account_id
      value: string
      description: Required parameter for the confluent_resources resource.
    - name: region
      value: string
      description: Required parameter for the confluent_resources resource.
    - name: data
      value: object
      description: |
        JSON:API request for updating a Confluent resource.

UPDATE examples

update_confluent_resource

Update a Confluent resource with the provided resource id for the account associated with the provided account ID.

UPDATE datadog.integrations.confluent_resources
SET 
data__data = '{{ data }}'
WHERE 
account_id = '{{ account_id }}' --required
AND resource_id = '{{ resource_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_confluent_resource

Delete a Confluent resource with the provided resource id for the account associated with the provided account ID.

DELETE FROM datadog.integrations.confluent_resources
WHERE account_id = '{{ account_id }}' --required
AND resource_id = '{{ resource_id }}' --required
AND region = '{{ region }}' --required
;