web_integration_accounts

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

Overview

Name	web_integration_accounts
Type	Resource
Id	datadog.integrations.web_integration_accounts

Fields

The following fields are returned by SELECT queries:

get_web_integration_account

Name	Datatype	Description
id	string	The unique identifier of the web integration account. (example: abc123def456)
attributes	object	Attributes object of a web integration account. Secrets are never returned.
type	string	Account resource type. (Account) (default: Account, example: Account)

list_web_integration_accounts

Name	Datatype	Description
id	string	The unique identifier of the web integration account. (example: abc123def456)
attributes	object	Attributes object of a web integration account. Secrets are never returned.
type	string	Account resource type. (Account) (default: Account, example: Account)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_web_integration_account	select	integration_name, account_id		Get a single account for a given web integration.
list_web_integration_accounts	select	integration_name		List accounts for a given web integration.
create_web_integration_account	insert	integration_name, data		Create a new account for a given web integration.
update_web_integration_account	update	integration_name, account_id, data		Update an existing account for a given web integration.
delete_web_integration_account	delete	integration_name, account_id		Delete an account for a given web integration.

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	The unique identifier of the web integration account.
integration_name	string	The name of the integration (for example, databricks).
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_web_integration_account

Get a single account for a given web integration.

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

list_web_integration_accounts

List accounts for a given web integration.

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

INSERT examples

create_web_integration_account

Create a new account for a given web integration.

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

Manifest

# Description fields are for documentation purposes
- name: web_integration_accounts
props:
  - name: integration_name
    value: "{{ integration_name }}"
    description: Required parameter for the web_integration_accounts resource.
  - name: data
    description: |
      Data object for creating a web integration account.
    value:
      attributes:
        name: "{{ name }}"
        secrets: "{{ secrets }}"
        settings: "{{ settings }}"
      type: "{{ type }}"

UPDATE examples

update_web_integration_account

Update an existing account for a given web integration.

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

DELETE examples

delete_web_integration_account

Delete an account for a given web integration.

DELETE FROM datadog.integrations.web_integration_accounts
WHERE integration_name = '{{ integration_name }}' --required
AND account_id = '{{ account_id }}' --required
;