ScreenBoard
Provides a Datadog screenboard resource. This can be used to create and manage Datadog screenboards.
Note: This resource is outdated. Use the new
datadog..Dashboardresource instead.
Create a ScreenBoard Resource
new ScreenBoard(name: string, args: ScreenBoardArgs, opts?: CustomResourceOptions);def ScreenBoard(resource_name, opts=None, height=None, read_only=None, shared=None, template_variables=None, title=None, widgets=None, width=None, __props__=None);func NewScreenBoard(ctx *Context, name string, args ScreenBoardArgs, opts ...ResourceOption) (*ScreenBoard, error)public ScreenBoard(string name, ScreenBoardArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args ScreenBoardArgs
- 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 ScreenBoardArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ScreenBoardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
ScreenBoard Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The ScreenBoard resource accepts the following input properties:
- Title string
Name of the screenboard
- Widgets
List<Screen
Board Widget Args> A list of widget definitions.
- Height string
Height of the screenboard
- Read
Only bool - bool
Whether the screenboard is shared or not
- Template
Variables List<ScreenBoard Template Variable Args> A list of template variables for using Dashboard templating.
- Width string
Width of the screenboard
- Title string
Name of the screenboard
- Widgets
[]Screen
Board Widget A list of widget definitions.
- Height string
Height of the screenboard
- Read
Only bool - bool
Whether the screenboard is shared or not
- Template
Variables []ScreenBoard Template Variable A list of template variables for using Dashboard templating.
- Width string
Width of the screenboard
- title string
Name of the screenboard
- widgets
Screen
Board Widget[] A list of widget definitions.
- height string
Height of the screenboard
- read
Only boolean - boolean
Whether the screenboard is shared or not
- template
Variables ScreenBoard Template Variable[] A list of template variables for using Dashboard templating.
- width string
Width of the screenboard
- title str
Name of the screenboard
- widgets
List[Screen
Board Widget] A list of widget definitions.
- height str
Height of the screenboard
- read_
only bool - bool
Whether the screenboard is shared or not
- template_
variables List[ScreenBoard Template Variable] A list of template variables for using Dashboard templating.
- width str
Width of the screenboard
Outputs
All input properties are implicitly available as output properties. Additionally, the ScreenBoard resource produces the following output properties:
Look up an Existing ScreenBoard Resource
Get an existing ScreenBoard 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?: ScreenBoardState, opts?: CustomResourceOptions): ScreenBoardstatic get(resource_name, id, opts=None, height=None, read_only=None, shared=None, template_variables=None, title=None, widgets=None, width=None, __props__=None);func GetScreenBoard(ctx *Context, name string, id IDInput, state *ScreenBoardState, opts ...ResourceOption) (*ScreenBoard, error)public static ScreenBoard Get(string name, Input<string> id, ScreenBoardState? 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:
- Height string
Height of the screenboard
- Read
Only bool - bool
Whether the screenboard is shared or not
- Template
Variables List<ScreenBoard Template Variable Args> A list of template variables for using Dashboard templating.
- Title string
Name of the screenboard
- Widgets
List<Screen
Board Widget Args> A list of widget definitions.
- Width string
Width of the screenboard
- Height string
Height of the screenboard
- Read
Only bool - bool
Whether the screenboard is shared or not
- Template
Variables []ScreenBoard Template Variable A list of template variables for using Dashboard templating.
- Title string
Name of the screenboard
- Widgets
[]Screen
Board Widget A list of widget definitions.
- Width string
Width of the screenboard
- height string
Height of the screenboard
- read
Only boolean - boolean
Whether the screenboard is shared or not
- template
Variables ScreenBoard Template Variable[] A list of template variables for using Dashboard templating.
- title string
Name of the screenboard
- widgets
Screen
Board Widget[] A list of widget definitions.
- width string
Width of the screenboard
- height str
Height of the screenboard
- read_
only bool - bool
Whether the screenboard is shared or not
- template_
variables List[ScreenBoard Template Variable] A list of template variables for using Dashboard templating.
- title str
Name of the screenboard
- widgets
List[Screen
Board Widget] A list of widget definitions.
- width str
Width of the screenboard
Supporting Types
ScreenBoardTemplateVariable
ScreenBoardWidget
- Type string
- X int
- Y int
- Alert
Id int - Auto
Refresh bool - Bgcolor string
- Check string
- Color string
- Color
Preference string - Columns string
- Display
Format string - Env string
- Event
Size string - Font
Size string - Group string
- Group
Bies List<string> - Grouping string
- Height int
- Hide
Zero boolCounts - Html string
- Layout
Version string - Legend bool
- Legend
Size string - Logset string
- Manage
Status boolShow Title - Manage
Status stringTitle Align - Manage
Status stringTitle Size - Manage
Status stringTitle Text - Margin string
- Monitor Dictionary<string, string>
- Must
Show boolBreakdown - Must
Show boolDistribution - Must
Show boolErrors - Must
Show boolHits - Must
Show boolLatency - Must
Show boolResource List - Params Dictionary<string, string>
- Precision string
- Query string
- Rules
List<Screen
Board Widget Rule Args> - Service
Name string - Service
Service string - Show
Last boolTriggered - Size
Version string - Sizing string
- Summary
Type string - List<string>
- Text string
- Text
Align string - Text
Size string - Tick bool
- Tick
Edge string - Tick
Pos string - Tile
Deves List<ScreenBoard Widget Tile Def Args> - Time Dictionary<string, string>
- Timeframes List<string>
- Title string
- Title
Align string - Title
Size int - Unit string
- Url string
- Viz
Type string - Width int
- Type string
- X int
- Y int
- Alert
Id int - Auto
Refresh bool - Bgcolor string
- Check string
- Color string
- Color
Preference string - Columns string
- Display
Format string - Env string
- Event
Size string - Font
Size string - Group string
- Group
Bies []string - Grouping string
- Height int
- Hide
Zero boolCounts - Html string
- Layout
Version string - Legend bool
- Legend
Size string - Logset string
- Manage
Status boolShow Title - Manage
Status stringTitle Align - Manage
Status stringTitle Size - Manage
Status stringTitle Text - Margin string
- Monitor map[string]string
- Must
Show boolBreakdown - Must
Show boolDistribution - Must
Show boolErrors - Must
Show boolHits - Must
Show boolLatency - Must
Show boolResource List - Params map[string]string
- Precision string
- Query string
- Rules
[]Screen
Board Widget Rule - Service
Name string - Service
Service string - Show
Last boolTriggered - Size
Version string - Sizing string
- Summary
Type string - []string
- Text string
- Text
Align string - Text
Size string - Tick bool
- Tick
Edge string - Tick
Pos string - Tile
Deves []ScreenBoard Widget Tile Def - Time map[string]string
- Timeframes []string
- Title string
- Title
Align string - Title
Size int - Unit string
- Url string
- Viz
Type string - Width int
- type string
- x number
- y number
- alert
Id number - auto
Refresh boolean - bgcolor string
- check string
- color string
- color
Preference string - columns string
- display
Format string - env string
- event
Size string - font
Size string - group string
- group
Bies string[] - grouping string
- height number
- hide
Zero booleanCounts - html string
- layout
Version string - legend boolean
- legend
Size string - logset string
- manage
Status booleanShow Title - manage
Status stringTitle Align - manage
Status stringTitle Size - manage
Status stringTitle Text - margin string
- monitor {[key: string]: string}
- must
Show booleanBreakdown - must
Show booleanDistribution - must
Show booleanErrors - must
Show booleanHits - must
Show booleanLatency - must
Show booleanResource List - params {[key: string]: string}
- precision string
- query string
- rules
Screen
Board Widget Rule[] - service
Name string - service
Service string - show
Last booleanTriggered - size
Version string - sizing string
- summary
Type string - string[]
- text string
- text
Align string - text
Size string - tick boolean
- tick
Edge string - tick
Pos string - tile
Deves ScreenBoard Widget Tile Def[] - time {[key: string]: string}
- timeframes string[]
- title string
- title
Align string - title
Size number - unit string
- url string
- viz
Type string - width number
- type str
- x float
- y float
- alert
Id float - auto
Refresh bool - bgcolor str
- check str
- color str
- color
Preference str - columns str
- display
Format str - env str
- event
Size str - font
Size str - group str
- group
Bies List[str] - grouping str
- height float
- hide
Zero boolCounts - html str
- layout
Version str - legend bool
- legend
Size str - logset str
- manage
Status boolShow Title - manage
Status strTitle Align - manage
Status strTitle Size - manage
Status strTitle Text - margin str
- monitor Dict[str, str]
- must
Show boolBreakdown - must
Show boolDistribution - must
Show boolErrors - must
Show boolHits - must
Show boolLatency - must
Show boolResource List - params Dict[str, str]
- precision str
- query str
- rules
List[Screen
Board Widget Rule] - service
Service str - service_
name str - show
Last boolTriggered - size
Version str - sizing str
- summary
Type str - List[str]
- text str
- text
Align str - text
Size str - tick bool
- tick
Edge str - tick
Pos str - tile
Deves List[ScreenBoard Widget Tile Def] - time Dict[str, str]
- timeframes List[str]
- title str
- title
Align str - title
Size float - unit str
- url str
- viz
Type str - width float
ScreenBoardWidgetRule
ScreenBoardWidgetTileDef
- Requests
List<Screen
Board Widget Tile Def Request Args> - Viz string
- Autoscale bool
- Custom
Unit string - Events
List<Screen
Board Widget Tile Def Event Args> - Groups List<string>
- Markers
List<Screen
Board Widget Tile Def Marker Args> - No
Group boolHosts - No
Metric boolHosts - Node
Type string - Precision string
- Scopes List<string>
- Style Dictionary<string, object>
- Text
Align string
- Requests
[]Screen
Board Widget Tile Def Request - Viz string
- Autoscale bool
- Custom
Unit string - Events
[]Screen
Board Widget Tile Def Event - Groups []string
- Markers
[]Screen
Board Widget Tile Def Marker - No
Group boolHosts - No
Metric boolHosts - Node
Type string - Precision string
- Scopes []string
- Style map[string]interface{}
- Text
Align string
- requests
Screen
Board Widget Tile Def Request[] - viz string
- autoscale boolean
- custom
Unit string - events
Screen
Board Widget Tile Def Event[] - groups string[]
- markers
Screen
Board Widget Tile Def Marker[] - no
Group booleanHosts - no
Metric booleanHosts - node
Type string - precision string
- scopes string[]
- style {[key: string]: any}
- text
Align string
ScreenBoardWidgetTileDefEvent
ScreenBoardWidgetTileDefMarker
ScreenBoardWidgetTileDefRequest
- Aggregator string
- Apm
Query ScreenBoard Widget Tile Def Request Apm Query Args - Change
Type string - Compare
To string - Conditional
Formats List<ScreenBoard Widget Tile Def Request Conditional Format Args> - Extra
Col string - Increase
Good bool - Limit int
- Log
Query ScreenBoard Widget Tile Def Request Log Query Args - Metadata
Json string - Metric string
- Order
By string - Order
Dir string - Process
Query ScreenBoard Widget Tile Def Request Process Query Args - Q string
- Query
Type string - Style Dictionary<string, object>
- Tag
Filters List<string> - Text
Filter string - Type string
- Aggregator string
- Apm
Query ScreenBoard Widget Tile Def Request Apm Query - Change
Type string - Compare
To string - Conditional
Formats []ScreenBoard Widget Tile Def Request Conditional Format - Extra
Col string - Increase
Good bool - Limit int
- Log
Query ScreenBoard Widget Tile Def Request Log Query - Metadata
Json string - Metric string
- Order
By string - Order
Dir string - Process
Query ScreenBoard Widget Tile Def Request Process Query - Q string
- Query
Type string - Style map[string]interface{}
- Tag
Filters []string - Text
Filter string - Type string
- aggregator string
- apm
Query ScreenBoard Widget Tile Def Request Apm Query - change
Type string - compare
To string - conditional
Formats ScreenBoard Widget Tile Def Request Conditional Format[] - extra
Col string - increase
Good boolean - limit number
- log
Query ScreenBoard Widget Tile Def Request Log Query - metadata
Json string - metric string
- order
By string - order
Dir string - process
Query ScreenBoard Widget Tile Def Request Process Query - q string
- query
Type string - style {[key: string]: any}
- tag
Filters string[] - text
Filter string - type string
- aggregator str
- apm
Query Dict[ScreenBoard Widget Tile Def Request Apm Query] - change
Type str - compare
To str - conditional
Formats List[ScreenBoard Widget Tile Def Request Conditional Format] - extra
Col str - increase
Good bool - limit float
- log
Query Dict[ScreenBoard Widget Tile Def Request Log Query] - metadata
Json str - metric str
- order
By str - order
Dir str - process
Query Dict[ScreenBoard Widget Tile Def Request Process Query] - q str
- query
Type str - style Dict[str, Any]
- tag
Filters List[str] - text
Filter str - type str
ScreenBoardWidgetTileDefRequestApmQuery
ScreenBoardWidgetTileDefRequestApmQueryCompute
ScreenBoardWidgetTileDefRequestApmQueryGroupBy
ScreenBoardWidgetTileDefRequestApmQueryGroupBySort
ScreenBoardWidgetTileDefRequestApmQuerySearch
ScreenBoardWidgetTileDefRequestConditionalFormat
ScreenBoardWidgetTileDefRequestLogQuery
ScreenBoardWidgetTileDefRequestLogQueryCompute
ScreenBoardWidgetTileDefRequestLogQueryGroupBy
ScreenBoardWidgetTileDefRequestLogQueryGroupBySort
ScreenBoardWidgetTileDefRequestLogQuerySearch
ScreenBoardWidgetTileDefRequestProcessQuery
Package Details
- Repository
- https://github.com/pulumi/pulumi-datadog
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
datadogTerraform Provider.