TimeBoard
Provides a Datadog timeboard resource. This can be used to create and manage Datadog timeboards.
Note:This resource is outdated. Use the new
datadog..Dashboardresource instead.
Create a TimeBoard Resource
new TimeBoard(name: string, args: TimeBoardArgs, opts?: CustomResourceOptions);def TimeBoard(resource_name, opts=None, description=None, graphs=None, read_only=None, template_variables=None, title=None, __props__=None);func NewTimeBoard(ctx *Context, name string, args TimeBoardArgs, opts ...ResourceOption) (*TimeBoard, error)public TimeBoard(string name, TimeBoardArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args TimeBoardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TimeBoardArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TimeBoardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
TimeBoard Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The TimeBoard resource accepts the following input properties:
- Description string
A description of the dashboard’s content.
- Graphs
List<Time
Board Graph Args> A list of graph definitions.
- Title string
The name of the dashboard.
- Read
Only bool - Template
Variables List<TimeBoard Template Variable Args> A list of template variables for using Dashboard templating.
- Description string
A description of the dashboard’s content.
- Graphs
[]Time
Board Graph A list of graph definitions.
- Title string
The name of the dashboard.
- Read
Only bool - Template
Variables []TimeBoard Template Variable A list of template variables for using Dashboard templating.
- description string
A description of the dashboard’s content.
- graphs
Time
Board Graph[] A list of graph definitions.
- title string
The name of the dashboard.
- read
Only boolean - template
Variables TimeBoard Template Variable[] A list of template variables for using Dashboard templating.
- description str
A description of the dashboard’s content.
- graphs
List[Time
Board Graph] A list of graph definitions.
- title str
The name of the dashboard.
- read_
only bool - template_
variables List[TimeBoard Template Variable] A list of template variables for using Dashboard templating.
Outputs
All input properties are implicitly available as output properties. Additionally, the TimeBoard resource produces the following output properties:
Look up an Existing TimeBoard Resource
Get an existing TimeBoard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TimeBoardState, opts?: CustomResourceOptions): TimeBoardstatic get(resource_name, id, opts=None, description=None, graphs=None, read_only=None, template_variables=None, title=None, __props__=None);func GetTimeBoard(ctx *Context, name string, id IDInput, state *TimeBoardState, opts ...ResourceOption) (*TimeBoard, error)public static TimeBoard Get(string name, Input<string> id, TimeBoardState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Description string
A description of the dashboard’s content.
- Graphs
List<Time
Board Graph Args> A list of graph definitions.
- Read
Only bool - Template
Variables List<TimeBoard Template Variable Args> A list of template variables for using Dashboard templating.
- Title string
The name of the dashboard.
- Description string
A description of the dashboard’s content.
- Graphs
[]Time
Board Graph A list of graph definitions.
- Read
Only bool - Template
Variables []TimeBoard Template Variable A list of template variables for using Dashboard templating.
- Title string
The name of the dashboard.
- description string
A description of the dashboard’s content.
- graphs
Time
Board Graph[] A list of graph definitions.
- read
Only boolean - template
Variables TimeBoard Template Variable[] A list of template variables for using Dashboard templating.
- title string
The name of the dashboard.
- description str
A description of the dashboard’s content.
- graphs
List[Time
Board Graph] A list of graph definitions.
- read_
only bool - template_
variables List[TimeBoard Template Variable] A list of template variables for using Dashboard templating.
- title str
The name of the dashboard.
Supporting Types
TimeBoardGraph
- Requests
List<Time
Board Graph Request Args> - Title string
- Viz string
- Autoscale bool
- Custom
Unit string - Events List<string>
- Groups List<string>
- Include
No boolMetric Hosts - Include
Ungrouped boolHosts - Markers
List<Time
Board Graph Marker Args> - Node
Type string - Precision string
- Scopes List<string>
- Style Dictionary<string, object>
- Text
Align string - Yaxis Dictionary<string, object>
- Requests
[]Time
Board Graph Request - Title string
- Viz string
- Autoscale bool
- Custom
Unit string - Events []string
- Groups []string
- Include
No boolMetric Hosts - Include
Ungrouped boolHosts - Markers
[]Time
Board Graph Marker - Node
Type string - Precision string
- Scopes []string
- Style map[string]interface{}
- Text
Align string - Yaxis map[string]interface{}
- requests
Time
Board Graph Request[] - title string
- viz string
- autoscale boolean
- custom
Unit string - events string[]
- groups string[]
- include
No booleanMetric Hosts - include
Ungrouped booleanHosts - markers
Time
Board Graph Marker[] - node
Type string - precision string
- scopes string[]
- style {[key: string]: any}
- text
Align string - yaxis {[key: string]: any}
TimeBoardGraphMarker
TimeBoardGraphRequest
- Aggregator string
- Apm
Query TimeBoard Graph Request Apm Query Args - Change
Type string - Compare
To string - Conditional
Formats List<TimeBoard Graph Request Conditional Format Args> - Extra
Col string - Increase
Good bool - Log
Query TimeBoard Graph Request Log Query Args - Metadata
Json string - Order
By string - Order
Direction string - Process
Query TimeBoard Graph Request Process Query Args - Q string
- Stacked bool
- Style Dictionary<string, object>
- Type string
- Aggregator string
- Apm
Query TimeBoard Graph Request Apm Query - Change
Type string - Compare
To string - Conditional
Formats []TimeBoard Graph Request Conditional Format - Extra
Col string - Increase
Good bool - Log
Query TimeBoard Graph Request Log Query - Metadata
Json string - Order
By string - Order
Direction string - Process
Query TimeBoard Graph Request Process Query - Q string
- Stacked bool
- Style map[string]interface{}
- Type string
- aggregator string
- apm
Query TimeBoard Graph Request Apm Query - change
Type string - compare
To string - conditional
Formats TimeBoard Graph Request Conditional Format[] - extra
Col string - increase
Good boolean - log
Query TimeBoard Graph Request Log Query - metadata
Json string - order
By string - order
Direction string - process
Query TimeBoard Graph Request Process Query - q string
- stacked boolean
- style {[key: string]: any}
- type string
- aggregator str
- apm
Query Dict[TimeBoard Graph Request Apm Query] - change
Type str - compare
To str - conditional
Formats List[TimeBoard Graph Request Conditional Format] - extra
Col str - increase
Good bool - log
Query Dict[TimeBoard Graph Request Log Query] - metadata
Json str - order
By str - order
Direction str - process
Query Dict[TimeBoard Graph Request Process Query] - q str
- stacked bool
- style Dict[str, Any]
- type str
TimeBoardGraphRequestApmQuery
TimeBoardGraphRequestApmQueryCompute
TimeBoardGraphRequestApmQueryGroupBy
TimeBoardGraphRequestApmQueryGroupBySort
TimeBoardGraphRequestApmQuerySearch
TimeBoardGraphRequestConditionalFormat
TimeBoardGraphRequestLogQuery
TimeBoardGraphRequestLogQueryCompute
TimeBoardGraphRequestLogQueryGroupBy
TimeBoardGraphRequestLogQueryGroupBySort
TimeBoardGraphRequestLogQuerySearch
TimeBoardGraphRequestProcessQuery
TimeBoardTemplateVariable
Package Details
- Repository
- https://github.com/pulumi/pulumi-datadog
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
datadogTerraform Provider.