connections

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

Overview

Name	connections
Type	Resource
Id	datadog.organization.connections

Fields

The following fields are returned by SELECT queries:

list_org_connections

Name	Datatype	Description
id	string (uuid)	The unique identifier of the org connection. (example: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a)
attributes	object	Org connection attributes.
relationships	object	Related organizations and user.
type	string	Org connection type. (example: org_connection)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_org_connections	select	region		Returns a list of org connections.
create_org_connections	insert	region, data__data		Create a new org connection between the current org and a target org.
update_org_connections	update	connection_id, region, data__data		Update an existing org connection.
delete_org_connections	delete	connection_id, region		Delete an existing org connection.

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
connection_id	string (uuid)	The unique identifier of the org connection.
region	string	(default: datadoghq.com)

SELECT examples

list_org_connections

Returns a list of org connections.

SELECT
id,
attributes,
relationships,
type
FROM datadog.organization.connections
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_org_connections

Create a new org connection between the current org and a target org.

INSERT INTO datadog.organization.connections (
data__data,
region
)
SELECT 
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: connections
  props:
    - name: region
      value: string
      description: Required parameter for the connections resource.
    - name: data
      value: object
      description: |
        Org connection creation data.

UPDATE examples

update_org_connections

Update an existing org connection.

UPDATE datadog.organization.connections
SET 
data__data = '{{ data }}'
WHERE 
connection_id = '{{ connection_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_org_connections

Delete an existing org connection.

DELETE FROM datadog.organization.connections
WHERE connection_id = '{{ connection_id }}' --required
AND region = '{{ region }}' --required
;