confluent_accounts

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

Overview

Name	confluent_accounts
Type	Resource
Id	datadog.integrations.confluent_accounts

Fields

The following fields are returned by SELECT queries:

get_confluent_account

Name	Datatype	Description
id	string	A randomly generated ID associated with a Confluent account. (example: account_id_abc123)
attributes	object	The attributes of a Confluent account.
type	string	The JSON:API type for this API. Should always be confluent-cloud-accounts. (confluent-cloud-accounts) (default: confluent-cloud-accounts, example: confluent-cloud-accounts)

list_confluent_account

Name	Datatype	Description
id	string	A randomly generated ID associated with a Confluent account. (example: account_id_abc123)
attributes	object	The attributes of a Confluent account.
type	string	The JSON:API type for this API. Should always be confluent-cloud-accounts. (confluent-cloud-accounts) (default: confluent-cloud-accounts, example: confluent-cloud-accounts)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_confluent_account	select	account_id		Get the Confluent account with the provided account ID.
list_confluent_account	select			List Confluent accounts.
create_confluent_account	insert	data		Create a Confluent account.
update_confluent_account	update	account_id, data		Update the Confluent account with the provided account ID.
delete_confluent_account	delete	account_id		Delete a Confluent account 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.
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_account

Get the Confluent account with the provided account ID.

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

list_confluent_account

List Confluent accounts.

SELECT
id,
attributes,
type
FROM datadog.integrations.confluent_accounts
;

INSERT examples

create_confluent_account

Create a Confluent account.

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

Manifest

# Description fields are for documentation purposes
- name: confluent_accounts
props:
  - name: data
    description: |
      The data body for adding a Confluent account.
    value:
      attributes:
        api_key: "{{ api_key }}"
        api_secret: "{{ api_secret }}"
        resources:
          - enable_custom_metrics: {{ enable_custom_metrics }}
            id: "{{ id }}"
            resource_type: "{{ resource_type }}"
            tags: "{{ tags }}"
        tags:
          - "{{ tags }}"
      type: "{{ type }}"

UPDATE examples

update_confluent_account

Update the Confluent account with the provided account ID.

UPDATE datadog.integrations.confluent_accounts
SET 
data = '{{ data }}'
WHERE 
account_id = '{{ account_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_confluent_account

Delete a Confluent account with the provided account ID.

DELETE FROM datadog.integrations.confluent_accounts
WHERE account_id = '{{ account_id }}' --required
;