powerpacks

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

Overview

Name	powerpacks
Type	Resource
Id	datadog.dashboards.powerpacks

Fields

The following fields are returned by SELECT queries:

get_powerpack

Name	Datatype	Description
id	string	ID of the powerpack.
attributes	object	Powerpack attribute object.
relationships	object	Powerpack relationship object.
type	string	Type of widget, must be powerpack. (example: powerpack)

list_powerpacks

Name	Datatype	Description
id	string	ID of the powerpack.
attributes	object	Powerpack attribute object.
relationships	object	Powerpack relationship object.
type	string	Type of widget, must be powerpack. (example: powerpack)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_powerpack	select	powerpack_id		Get a powerpack.
list_powerpacks	select		page[limit], page[offset]	Get a list of all powerpacks.
create_powerpack	insert			Create a powerpack.
update_powerpack	update	powerpack_id		Update a powerpack.
delete_powerpack	delete	powerpack_id		Delete a powerpack.

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
powerpack_id	string	Powerpack 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.
page[limit]	integer (int64)	Maximum number of powerpacks in the response. (example: 25)
page[offset]	integer (int64)	Specific offset to use as the beginning of the returned page.

SELECT examples

get_powerpack

Get a powerpack.

SELECT
id,
attributes,
relationships,
type
FROM datadog.dashboards.powerpacks
WHERE powerpack_id = '{{ powerpack_id }}' -- required
;

list_powerpacks

Get a list of all powerpacks.

SELECT
id,
attributes,
relationships,
type
FROM datadog.dashboards.powerpacks
WHERE page[limit] = '{{ page[limit] }}'
AND page[offset] = '{{ page[offset] }}'
;

INSERT examples

create_powerpack

Create a powerpack.

INSERT INTO datadog.dashboards.powerpacks (
data
)
SELECT 
'{{ data }}'
RETURNING
data,
included
;

Manifest

# Description fields are for documentation purposes
- name: powerpacks
props:
  - name: data
    description: |
      Powerpack data object.
    value:
      attributes:
        description: "{{ description }}"
        group_widget:
          definition:
            layout_type: "{{ layout_type }}"
            show_title: {{ show_title }}
            title: "{{ title }}"
            type: "{{ type }}"
            widgets:
              - definition: "{{ definition }}"
                layout:
                  height: {{ height }}
                  width: {{ width }}
                  x: {{ x }}
                  y: {{ y }}
          layout:
            height: {{ height }}
            width: {{ width }}
            x: {{ x }}
            y: {{ y }}
          live_span: "{{ live_span }}"
        name: "{{ name }}"
        tags:
          - "{{ tags }}"
        template_variables:
          - available_values: "{{ available_values }}"
            defaults: "{{ defaults }}"
            name: "{{ name }}"
            prefix: "{{ prefix }}"
      id: "{{ id }}"
      relationships:
        author:
          data:
            id: "{{ id }}"
            type: "{{ type }}"
      type: "{{ type }}"

UPDATE examples

update_powerpack

Update a powerpack.

UPDATE datadog.dashboards.powerpacks
SET 
data = '{{ data }}'
WHERE 
powerpack_id = '{{ powerpack_id }}' --required
RETURNING
data,
included;

DELETE examples

delete_powerpack

Delete a powerpack.

DELETE FROM datadog.dashboards.powerpacks
WHERE powerpack_id = '{{ powerpack_id }}' --required
;