custom_frameworks

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

Overview

Name	custom_frameworks
Type	Resource
Id	datadog.security.custom_frameworks

Fields

The following fields are returned by SELECT queries:

get_custom_framework

Name	Datatype	Description
id	string	The ID of the custom framework. (example: handle-version)
attributes	object	Full Framework Data Attributes.
type	string	The type of the resource. The value must be custom_framework. (default: custom_framework, example: custom_framework)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_custom_framework	select	handle, version, region		Get a custom framework.
create_custom_framework	insert	region, data__data		Create a custom framework.
update_custom_framework	replace	handle, version, region, data__data		Update a custom framework.
delete_custom_framework	delete	handle, version, region		Delete a custom framework.

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
handle	string	The framework handle
region	string	(default: datadoghq.com)
version	string	The framework version

SELECT examples

get_custom_framework

Get a custom framework.

SELECT
id,
attributes,
type
FROM datadog.security.custom_frameworks
WHERE handle = '{{ handle }}' -- required
AND version = '{{ version }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_custom_framework

Create a custom framework.

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

Manifest

# Description fields are for documentation purposes
- name: custom_frameworks
  props:
    - name: region
      value: string
      description: Required parameter for the custom_frameworks resource.
    - name: data
      value: object
      description: |
        Contains type and attributes for custom frameworks.

REPLACE examples

update_custom_framework

Update a custom framework.

REPLACE datadog.security.custom_frameworks
SET 
data__data = '{{ data }}'
WHERE 
handle = '{{ handle }}' --required
AND version = '{{ version }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_custom_framework

Delete a custom framework.

DELETE FROM datadog.security.custom_frameworks
WHERE handle = '{{ handle }}' --required
AND version = '{{ version }}' --required
AND region = '{{ region }}' --required
;