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. (confluent-cloud-resources) (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. (confluent-cloud-resources) (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		Get a Confluent resource with the provided resource id for the account associated with the provided account ID.
list_confluent_resource	select	account_id		Get a Confluent resource for the account associated with the provided ID.
create_confluent_resource	insert	account_id, data		Create a Confluent resource for the account associated with the provided ID.
update_confluent_resource	update	account_id, resource_id, 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		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.
resource_id	string	Confluent Account Resource ID.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.

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
;

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
;

INSERT examples

create_confluent_resource

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

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

Manifest

# Description fields are for documentation purposes
- name: confluent_resources
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the confluent_resources resource.
  - name: data
    description: |
      JSON:API request for updating a Confluent resource.
    value:
      attributes:
        enable_custom_metrics: {{ enable_custom_metrics }}
        resource_type: "{{ resource_type }}"
        tags:
          - "{{ tags }}"
      id: "{{ id }}"
      type: "{{ type }}"

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 }}'
WHERE 
account_id = '{{ account_id }}' --required
AND resource_id = '{{ resource_id }}' --required
AND 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
;