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. (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		Get a custom framework.
create_custom_framework	insert	data		Create a custom framework.
update_custom_framework	replace	handle, version, data		Update a custom framework.
delete_custom_framework	delete	handle, version		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
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.
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
;

INSERT examples

create_custom_framework

Create a custom framework.

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

Manifest

# Description fields are for documentation purposes
- name: custom_frameworks
props:
  - name: data
    description: |
      Contains type and attributes for custom frameworks.
    value:
      attributes:
        description: "{{ description }}"
        handle: "{{ handle }}"
        icon_url: "{{ icon_url }}"
        name: "{{ name }}"
        requirements:
          - controls: "{{ controls }}"
            name: "{{ name }}"
        version: "{{ version }}"
      type: "{{ type }}"

REPLACE examples

update_custom_framework

Update a custom framework.

REPLACE datadog.security.custom_frameworks
SET 
data = '{{ data }}'
WHERE 
handle = '{{ handle }}' --required
AND version = '{{ version }}' --required
AND 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
;