Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

TimeBoard

Import

Timeboards can be imported using their numeric ID, e.g.

 $ pulumi import datadog:index/timeBoard:TimeBoard my_service_timeboard 2081

Create a TimeBoard Resource

new TimeBoard(name: string, args: TimeBoardArgs, opts?: CustomResourceOptions);

def TimeBoard(resource_name: str, opts: Optional[ResourceOptions] = None, description: Optional[str] = None, graphs: Optional[Sequence[TimeBoardGraphArgs]] = None, read_only: Optional[bool] = None, template_variables: Optional[Sequence[TimeBoardTemplateVariableArgs]] = None, title: Optional[str] = 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<TimeBoardGraphArgs>: A list of graph definitions.
Title string: The name of the dashboard.
ReadOnly bool: The read-only status of the timeboard. Default is false.
TemplateVariables List<TimeBoardTemplateVariableArgs>: A list of template variables for using Dashboard templating.

Description string: A description of the dashboard’s content.
Graphs []TimeBoardGraph: A list of graph definitions.
Title string: The name of the dashboard.
ReadOnly bool: The read-only status of the timeboard. Default is false.
TemplateVariables []TimeBoardTemplateVariable: A list of template variables for using Dashboard templating.

description string: A description of the dashboard’s content.
graphs TimeBoardGraph[]: A list of graph definitions.
title string: The name of the dashboard.
readOnly boolean: The read-only status of the timeboard. Default is false.
templateVariables TimeBoardTemplateVariable[]: A list of template variables for using Dashboard templating.

description str: A description of the dashboard’s content.
graphs Sequence[TimeBoardGraphArgs]: A list of graph definitions.
title str: The name of the dashboard.
read_only bool: The read-only status of the timeboard. Default is false.
template_variables Sequence[TimeBoardTemplateVariableArgs]: 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:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

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): TimeBoard

@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, description: Optional[str] = None, graphs: Optional[Sequence[TimeBoardGraphArgs]] = None, read_only: Optional[bool] = None, template_variables: Optional[Sequence[TimeBoardTemplateVariableArgs]] = None, title: Optional[str] = None) -> TimeBoard

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<TimeBoardGraphArgs>: A list of graph definitions.
ReadOnly bool: The read-only status of the timeboard. Default is false.
TemplateVariables List<TimeBoardTemplateVariableArgs>: 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 []TimeBoardGraph: A list of graph definitions.
ReadOnly bool: The read-only status of the timeboard. Default is false.
TemplateVariables []TimeBoardTemplateVariable: 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 TimeBoardGraph[]: A list of graph definitions.
readOnly boolean: The read-only status of the timeboard. Default is false.
templateVariables TimeBoardTemplateVariable[]: 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 Sequence[TimeBoardGraphArgs]: A list of graph definitions.
read_only bool: The read-only status of the timeboard. Default is false.
template_variables Sequence[TimeBoardTemplateVariableArgs]: A list of template variables for using Dashboard templating.
title str: The name of the dashboard.

Supporting Types

TimeBoardGraph

Requests List<TimeBoardGraphRequestArgs>
Title string
Viz string
Autoscale bool
CustomUnit string
Events List<string>
Groups List<string>
IncludeNoMetricHosts bool
IncludeUngroupedHosts bool
Markers List<TimeBoardGraphMarkerArgs>
NodeType string
Precision string
Scopes List<string>
Style Dictionary<string, object>
TextAlign string
Yaxis Dictionary<string, object>

Requests []TimeBoardGraphRequest
Title string
Viz string
Autoscale bool
CustomUnit string
Events []string
Groups []string
IncludeNoMetricHosts bool
IncludeUngroupedHosts bool
Markers []TimeBoardGraphMarker
NodeType string
Precision string
Scopes []string
Style map[string]interface{}
TextAlign string
Yaxis map[string]interface{}

requests TimeBoardGraphRequest[]
title string
viz string
autoscale boolean
customUnit string
events string[]
groups string[]
includeNoMetricHosts boolean
includeUngroupedHosts boolean
markers TimeBoardGraphMarker[]
nodeType string
precision string
scopes string[]
style {[key: string]: any}
textAlign string
yaxis {[key: string]: any}

requests Sequence[TimeBoardGraphRequestArgs]
title str
viz str
autoscale bool
custom_unit str
events Sequence[str]
groups Sequence[str]
include_no_metric_hosts bool
include_ungrouped_hosts bool
markers Sequence[TimeBoardGraphMarkerArgs]
node_type str
precision str
scopes Sequence[str]
style Mapping[str, Any]
text_align str
yaxis Mapping[str, Any]

TimeBoardGraphMarker

Type string
Value string
Label string

Type string
Value string
Label string

type string
value string
label string

type str
value str
label str

TimeBoardGraphRequest

Aggregator string
ApmQuery TimeBoardGraphRequestApmQueryArgs
ChangeType string
CompareTo string
ConditionalFormats List<TimeBoardGraphRequestConditionalFormatArgs>
ExtraCol string
IncreaseGood bool
LogQuery TimeBoardGraphRequestLogQueryArgs
MetadataJson string
OrderBy string
OrderDirection string
ProcessQuery TimeBoardGraphRequestProcessQueryArgs
Q string
Stacked bool
Style Dictionary<string, object>
Type string

Aggregator string
ApmQuery TimeBoardGraphRequestApmQuery
ChangeType string
CompareTo string
ConditionalFormats []TimeBoardGraphRequestConditionalFormat
ExtraCol string
IncreaseGood bool
LogQuery TimeBoardGraphRequestLogQuery
MetadataJson string
OrderBy string
OrderDirection string
ProcessQuery TimeBoardGraphRequestProcessQuery
Q string
Stacked bool
Style map[string]interface{}
Type string

aggregator string
apmQuery TimeBoardGraphRequestApmQuery
changeType string
compareTo string
conditionalFormats TimeBoardGraphRequestConditionalFormat[]
extraCol string
increaseGood boolean
logQuery TimeBoardGraphRequestLogQuery
metadataJson string
orderBy string
orderDirection string
processQuery TimeBoardGraphRequestProcessQuery
q string
stacked boolean
style {[key: string]: any}
type string

aggregator str
apm_query TimeBoardGraphRequestApmQueryArgs
change_type str
compare_to str
conditional_formats Sequence[TimeBoardGraphRequestConditionalFormatArgs]
extra_col str
increase_good bool
log_query TimeBoardGraphRequestLogQueryArgs
metadata_json str
order_by str
order_direction str
process_query TimeBoardGraphRequestProcessQueryArgs
q str
stacked bool
style Mapping[str, Any]
type str

TimeBoardGraphRequestApmQuery

Compute TimeBoardGraphRequestApmQueryComputeArgs
Index string
GroupBies List<TimeBoardGraphRequestApmQueryGroupByArgs>
Search TimeBoardGraphRequestApmQuerySearchArgs

Compute TimeBoardGraphRequestApmQueryCompute
Index string
GroupBies []TimeBoardGraphRequestApmQueryGroupBy
Search TimeBoardGraphRequestApmQuerySearch

compute TimeBoardGraphRequestApmQueryCompute
index string
groupBies TimeBoardGraphRequestApmQueryGroupBy[]
search TimeBoardGraphRequestApmQuerySearch

compute TimeBoardGraphRequestApmQueryComputeArgs
index str
group_bies Sequence[TimeBoardGraphRequestApmQueryGroupByArgs]
search TimeBoardGraphRequestApmQuerySearchArgs

TimeBoardGraphRequestApmQueryCompute

Aggregation string
Facet string
Interval int

Aggregation string
Facet string
Interval int

aggregation string
facet string
interval number

aggregation str
facet str
interval int

TimeBoardGraphRequestApmQueryGroupBy

Facet string
Limit int
Sort TimeBoardGraphRequestApmQueryGroupBySortArgs

Facet string
Limit int
Sort TimeBoardGraphRequestApmQueryGroupBySort

facet string
limit number
sort TimeBoardGraphRequestApmQueryGroupBySort

facet str
limit int
sort TimeBoardGraphRequestApmQueryGroupBySortArgs

TimeBoardGraphRequestApmQueryGroupBySort

Aggregation string
Order string
Facet string

Aggregation string
Order string
Facet string

aggregation string
order string
facet string

aggregation str
order str
facet str

TimeBoardGraphRequestApmQuerySearch

Query string

Query string

query string

query str

TimeBoardGraphRequestConditionalFormat

Comparator string
CustomBgColor string
CustomFgColor string
Palette string
Value string

Comparator string
CustomBgColor string
CustomFgColor string
Palette string
Value string

comparator string
customBgColor string
customFgColor string
palette string
value string

comparator str
custom_bg_color str
custom_fg_color str
palette str
value str

TimeBoardGraphRequestLogQuery

Compute TimeBoardGraphRequestLogQueryComputeArgs
Index string
GroupBies List<TimeBoardGraphRequestLogQueryGroupByArgs>
Search TimeBoardGraphRequestLogQuerySearchArgs

Compute TimeBoardGraphRequestLogQueryCompute
Index string
GroupBies []TimeBoardGraphRequestLogQueryGroupBy
Search TimeBoardGraphRequestLogQuerySearch

compute TimeBoardGraphRequestLogQueryCompute
index string
groupBies TimeBoardGraphRequestLogQueryGroupBy[]
search TimeBoardGraphRequestLogQuerySearch

compute TimeBoardGraphRequestLogQueryComputeArgs
index str
group_bies Sequence[TimeBoardGraphRequestLogQueryGroupByArgs]
search TimeBoardGraphRequestLogQuerySearchArgs

TimeBoardGraphRequestLogQueryCompute

Aggregation string
Facet string
Interval int

Aggregation string
Facet string
Interval int

aggregation string
facet string
interval number

aggregation str
facet str
interval int

TimeBoardGraphRequestLogQueryGroupBy

Facet string
Limit int
Sort TimeBoardGraphRequestLogQueryGroupBySortArgs

Facet string
Limit int
Sort TimeBoardGraphRequestLogQueryGroupBySort

facet string
limit number
sort TimeBoardGraphRequestLogQueryGroupBySort

facet str
limit int
sort TimeBoardGraphRequestLogQueryGroupBySortArgs

TimeBoardGraphRequestLogQueryGroupBySort

Aggregation string
Order string
Facet string

Aggregation string
Order string
Facet string

aggregation string
order string
facet string

aggregation str
order str
facet str

TimeBoardGraphRequestLogQuerySearch

Query string

Query string

query string

query str

TimeBoardGraphRequestProcessQuery

Metric string
FilterBies List<string>
Limit int
SearchBy string

Metric string
FilterBies []string
Limit int
SearchBy string

metric string
filterBies string[]
limit number
searchBy string

metric str
filter_bies Sequence[str]
limit int
search_by str

TimeBoardTemplateVariable

Name string
Default string
Prefix string

Name string
Default string
Prefix string

name string
default string
prefix string

name str
default str
prefix str

Package Details

Repository: https://github.com/pulumi/pulumi-datadog
License: Apache-2.0
Notes: This Pulumi package is based on the datadog Terraform Provider.