fastly.CustomDashboard
Explore with Pulumi AI
Provides a Custom Dashboard which can be viewed in the Fastly Control Panel.
Create CustomDashboard Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CustomDashboard(name: string, args?: CustomDashboardArgs, opts?: CustomResourceOptions);
@overload
def CustomDashboard(resource_name: str,
args: Optional[CustomDashboardArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def CustomDashboard(resource_name: str,
opts: Optional[ResourceOptions] = None,
dashboard_items: Optional[Sequence[CustomDashboardDashboardItemArgs]] = None,
description: Optional[str] = None,
name: Optional[str] = None)
func NewCustomDashboard(ctx *Context, name string, args *CustomDashboardArgs, opts ...ResourceOption) (*CustomDashboard, error)
public CustomDashboard(string name, CustomDashboardArgs? args = null, CustomResourceOptions? opts = null)
public CustomDashboard(String name, CustomDashboardArgs args)
public CustomDashboard(String name, CustomDashboardArgs args, CustomResourceOptions options)
type: fastly:CustomDashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CustomDashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CustomDashboardArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CustomDashboardArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CustomDashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CustomDashboardArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var customDashboardResource = new Fastly.CustomDashboard("customDashboardResource", new()
{
DashboardItems = new[]
{
new Fastly.Inputs.CustomDashboardDashboardItemArgs
{
DataSource = new Fastly.Inputs.CustomDashboardDashboardItemDataSourceArgs
{
Config = new Fastly.Inputs.CustomDashboardDashboardItemDataSourceConfigArgs
{
Metrics = new[]
{
"string",
},
},
Type = "string",
},
Id = "string",
Subtitle = "string",
Title = "string",
Visualization = new Fastly.Inputs.CustomDashboardDashboardItemVisualizationArgs
{
Config = new Fastly.Inputs.CustomDashboardDashboardItemVisualizationConfigArgs
{
PlotType = "string",
CalculationMethod = "string",
Format = "string",
},
Type = "string",
},
Span = 0,
},
},
Description = "string",
Name = "string",
});
example, err := fastly.NewCustomDashboard(ctx, "customDashboardResource", &fastly.CustomDashboardArgs{
DashboardItems: fastly.CustomDashboardDashboardItemArray{
&fastly.CustomDashboardDashboardItemArgs{
DataSource: &fastly.CustomDashboardDashboardItemDataSourceArgs{
Config: &fastly.CustomDashboardDashboardItemDataSourceConfigArgs{
Metrics: pulumi.StringArray{
pulumi.String("string"),
},
},
Type: pulumi.String("string"),
},
Id: pulumi.String("string"),
Subtitle: pulumi.String("string"),
Title: pulumi.String("string"),
Visualization: &fastly.CustomDashboardDashboardItemVisualizationArgs{
Config: &fastly.CustomDashboardDashboardItemVisualizationConfigArgs{
PlotType: pulumi.String("string"),
CalculationMethod: pulumi.String("string"),
Format: pulumi.String("string"),
},
Type: pulumi.String("string"),
},
Span: pulumi.Int(0),
},
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
})
var customDashboardResource = new CustomDashboard("customDashboardResource", CustomDashboardArgs.builder()
.dashboardItems(CustomDashboardDashboardItemArgs.builder()
.dataSource(CustomDashboardDashboardItemDataSourceArgs.builder()
.config(CustomDashboardDashboardItemDataSourceConfigArgs.builder()
.metrics("string")
.build())
.type("string")
.build())
.id("string")
.subtitle("string")
.title("string")
.visualization(CustomDashboardDashboardItemVisualizationArgs.builder()
.config(CustomDashboardDashboardItemVisualizationConfigArgs.builder()
.plotType("string")
.calculationMethod("string")
.format("string")
.build())
.type("string")
.build())
.span(0)
.build())
.description("string")
.name("string")
.build());
custom_dashboard_resource = fastly.CustomDashboard("customDashboardResource",
dashboard_items=[{
"data_source": {
"config": {
"metrics": ["string"],
},
"type": "string",
},
"id": "string",
"subtitle": "string",
"title": "string",
"visualization": {
"config": {
"plot_type": "string",
"calculation_method": "string",
"format": "string",
},
"type": "string",
},
"span": 0,
}],
description="string",
name="string")
const customDashboardResource = new fastly.CustomDashboard("customDashboardResource", {
dashboardItems: [{
dataSource: {
config: {
metrics: ["string"],
},
type: "string",
},
id: "string",
subtitle: "string",
title: "string",
visualization: {
config: {
plotType: "string",
calculationMethod: "string",
format: "string",
},
type: "string",
},
span: 0,
}],
description: "string",
name: "string",
});
type: fastly:CustomDashboard
properties:
dashboardItems:
- dataSource:
config:
metrics:
- string
type: string
id: string
span: 0
subtitle: string
title: string
visualization:
config:
calculationMethod: string
format: string
plotType: string
type: string
description: string
name: string
CustomDashboard Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CustomDashboard resource accepts the following input properties:
- Dashboard
Items List<CustomDashboard Dashboard Item> - A list of dashboard items.
- Description string
- A short description of the dashboard.
- Name string
- A human-readable name.
- Dashboard
Items []CustomDashboard Dashboard Item Args - A list of dashboard items.
- Description string
- A short description of the dashboard.
- Name string
- A human-readable name.
- dashboard
Items List<CustomDashboard Dashboard Item> - A list of dashboard items.
- description String
- A short description of the dashboard.
- name String
- A human-readable name.
- dashboard
Items CustomDashboard Dashboard Item[] - A list of dashboard items.
- description string
- A short description of the dashboard.
- name string
- A human-readable name.
- dashboard_
items Sequence[CustomDashboard Dashboard Item Args] - A list of dashboard items.
- description str
- A short description of the dashboard.
- name str
- A human-readable name.
- dashboard
Items List<Property Map> - A list of dashboard items.
- description String
- A short description of the dashboard.
- name String
- A human-readable name.
Outputs
All input properties are implicitly available as output properties. Additionally, the CustomDashboard 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 string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing CustomDashboard Resource
Get an existing CustomDashboard 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?: CustomDashboardState, opts?: CustomResourceOptions): CustomDashboard
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
dashboard_items: Optional[Sequence[CustomDashboardDashboardItemArgs]] = None,
description: Optional[str] = None,
name: Optional[str] = None) -> CustomDashboard
func GetCustomDashboard(ctx *Context, name string, id IDInput, state *CustomDashboardState, opts ...ResourceOption) (*CustomDashboard, error)
public static CustomDashboard Get(string name, Input<string> id, CustomDashboardState? state, CustomResourceOptions? opts = null)
public static CustomDashboard get(String name, Output<String> id, CustomDashboardState state, CustomResourceOptions options)
resources: _: type: fastly:CustomDashboard get: id: ${id}
- 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.
- 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.
- Dashboard
Items List<CustomDashboard Dashboard Item> - A list of dashboard items.
- Description string
- A short description of the dashboard.
- Name string
- A human-readable name.
- Dashboard
Items []CustomDashboard Dashboard Item Args - A list of dashboard items.
- Description string
- A short description of the dashboard.
- Name string
- A human-readable name.
- dashboard
Items List<CustomDashboard Dashboard Item> - A list of dashboard items.
- description String
- A short description of the dashboard.
- name String
- A human-readable name.
- dashboard
Items CustomDashboard Dashboard Item[] - A list of dashboard items.
- description string
- A short description of the dashboard.
- name string
- A human-readable name.
- dashboard_
items Sequence[CustomDashboard Dashboard Item Args] - A list of dashboard items.
- description str
- A short description of the dashboard.
- name str
- A human-readable name.
- dashboard
Items List<Property Map> - A list of dashboard items.
- description String
- A short description of the dashboard.
- name String
- A human-readable name.
Supporting Types
CustomDashboardDashboardItem, CustomDashboardDashboardItemArgs
- Data
Source CustomDashboard Dashboard Item Data Source - An object which describes the data to display.
- Id string
- Dashboard item identifier (alphanumeric). Must be unique, relative to other items in the same dashboard.
- Subtitle string
- A human-readable subtitle for the dashboard item. Often a description of the visualization.
- Title string
- A human-readable title for the dashboard item.
- Visualization
Custom
Dashboard Dashboard Item Visualization - An object which describes the data visualization to display.
- Span int
- The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on "desktop" screen sizes.
- Data
Source CustomDashboard Dashboard Item Data Source - An object which describes the data to display.
- Id string
- Dashboard item identifier (alphanumeric). Must be unique, relative to other items in the same dashboard.
- Subtitle string
- A human-readable subtitle for the dashboard item. Often a description of the visualization.
- Title string
- A human-readable title for the dashboard item.
- Visualization
Custom
Dashboard Dashboard Item Visualization - An object which describes the data visualization to display.
- Span int
- The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on "desktop" screen sizes.
- data
Source CustomDashboard Dashboard Item Data Source - An object which describes the data to display.
- id String
- Dashboard item identifier (alphanumeric). Must be unique, relative to other items in the same dashboard.
- subtitle String
- A human-readable subtitle for the dashboard item. Often a description of the visualization.
- title String
- A human-readable title for the dashboard item.
- visualization
Custom
Dashboard Dashboard Item Visualization - An object which describes the data visualization to display.
- span Integer
- The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on "desktop" screen sizes.
- data
Source CustomDashboard Dashboard Item Data Source - An object which describes the data to display.
- id string
- Dashboard item identifier (alphanumeric). Must be unique, relative to other items in the same dashboard.
- subtitle string
- A human-readable subtitle for the dashboard item. Often a description of the visualization.
- title string
- A human-readable title for the dashboard item.
- visualization
Custom
Dashboard Dashboard Item Visualization - An object which describes the data visualization to display.
- span number
- The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on "desktop" screen sizes.
- data_
source CustomDashboard Dashboard Item Data Source - An object which describes the data to display.
- id str
- Dashboard item identifier (alphanumeric). Must be unique, relative to other items in the same dashboard.
- subtitle str
- A human-readable subtitle for the dashboard item. Often a description of the visualization.
- title str
- A human-readable title for the dashboard item.
- visualization
Custom
Dashboard Dashboard Item Visualization - An object which describes the data visualization to display.
- span int
- The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on "desktop" screen sizes.
- data
Source Property Map - An object which describes the data to display.
- id String
- Dashboard item identifier (alphanumeric). Must be unique, relative to other items in the same dashboard.
- subtitle String
- A human-readable subtitle for the dashboard item. Often a description of the visualization.
- title String
- A human-readable title for the dashboard item.
- visualization Property Map
- An object which describes the data visualization to display.
- span Number
- The number of columns for the dashboard item to span. Dashboards are rendered on a 12-column grid on "desktop" screen sizes.
CustomDashboardDashboardItemDataSource, CustomDashboardDashboardItemDataSourceArgs
- Config
Custom
Dashboard Dashboard Item Data Source Config - Configuration options for the selected data source.
- Type string
- The source of the data to display. One of:
stats.edge
,stats.domain
,stats.origin
.
- Config
Custom
Dashboard Dashboard Item Data Source Config - Configuration options for the selected data source.
- Type string
- The source of the data to display. One of:
stats.edge
,stats.domain
,stats.origin
.
- config
Custom
Dashboard Dashboard Item Data Source Config - Configuration options for the selected data source.
- type String
- The source of the data to display. One of:
stats.edge
,stats.domain
,stats.origin
.
- config
Custom
Dashboard Dashboard Item Data Source Config - Configuration options for the selected data source.
- type string
- The source of the data to display. One of:
stats.edge
,stats.domain
,stats.origin
.
- config
Custom
Dashboard Dashboard Item Data Source Config - Configuration options for the selected data source.
- type str
- The source of the data to display. One of:
stats.edge
,stats.domain
,stats.origin
.
- config Property Map
- Configuration options for the selected data source.
- type String
- The source of the data to display. One of:
stats.edge
,stats.domain
,stats.origin
.
CustomDashboardDashboardItemDataSourceConfig, CustomDashboardDashboardItemDataSourceConfigArgs
- Metrics List<string>
- The metrics to visualize. Valid options are defined by the selected data source: stats.edge, stats.domain, stats.origin.
- Metrics []string
- The metrics to visualize. Valid options are defined by the selected data source: stats.edge, stats.domain, stats.origin.
- metrics List<String>
- The metrics to visualize. Valid options are defined by the selected data source: stats.edge, stats.domain, stats.origin.
- metrics string[]
- The metrics to visualize. Valid options are defined by the selected data source: stats.edge, stats.domain, stats.origin.
- metrics Sequence[str]
- The metrics to visualize. Valid options are defined by the selected data source: stats.edge, stats.domain, stats.origin.
- metrics List<String>
- The metrics to visualize. Valid options are defined by the selected data source: stats.edge, stats.domain, stats.origin.
CustomDashboardDashboardItemVisualization, CustomDashboardDashboardItemVisualizationArgs
- Config
Custom
Dashboard Dashboard Item Visualization Config - Configuration options for the selected data source.
- Type string
- The type of visualization to display. One of:
chart
.
- Config
Custom
Dashboard Dashboard Item Visualization Config - Configuration options for the selected data source.
- Type string
- The type of visualization to display. One of:
chart
.
- config
Custom
Dashboard Dashboard Item Visualization Config - Configuration options for the selected data source.
- type String
- The type of visualization to display. One of:
chart
.
- config
Custom
Dashboard Dashboard Item Visualization Config - Configuration options for the selected data source.
- type string
- The type of visualization to display. One of:
chart
.
- config
Custom
Dashboard Dashboard Item Visualization Config - Configuration options for the selected data source.
- type str
- The type of visualization to display. One of:
chart
.
- config Property Map
- Configuration options for the selected data source.
- type String
- The type of visualization to display. One of:
chart
.
CustomDashboardDashboardItemVisualizationConfig, CustomDashboardDashboardItemVisualizationConfigArgs
- Plot
Type string - The type of chart to display. One of:
line
,bar
,single-metric
,donut
. - Calculation
Method string - The aggregation function to apply to the dataset. One of:
avg
,sum
,min
,max
,latest
,p95
. - Format string
- The units to use to format the data. One of:
number
,bytes
,percent
,requests
,responses
,seconds
,milliseconds
,ratio
,bitrate
.
- Plot
Type string - The type of chart to display. One of:
line
,bar
,single-metric
,donut
. - Calculation
Method string - The aggregation function to apply to the dataset. One of:
avg
,sum
,min
,max
,latest
,p95
. - Format string
- The units to use to format the data. One of:
number
,bytes
,percent
,requests
,responses
,seconds
,milliseconds
,ratio
,bitrate
.
- plot
Type String - The type of chart to display. One of:
line
,bar
,single-metric
,donut
. - calculation
Method String - The aggregation function to apply to the dataset. One of:
avg
,sum
,min
,max
,latest
,p95
. - format String
- The units to use to format the data. One of:
number
,bytes
,percent
,requests
,responses
,seconds
,milliseconds
,ratio
,bitrate
.
- plot
Type string - The type of chart to display. One of:
line
,bar
,single-metric
,donut
. - calculation
Method string - The aggregation function to apply to the dataset. One of:
avg
,sum
,min
,max
,latest
,p95
. - format string
- The units to use to format the data. One of:
number
,bytes
,percent
,requests
,responses
,seconds
,milliseconds
,ratio
,bitrate
.
- plot_
type str - The type of chart to display. One of:
line
,bar
,single-metric
,donut
. - calculation_
method str - The aggregation function to apply to the dataset. One of:
avg
,sum
,min
,max
,latest
,p95
. - format str
- The units to use to format the data. One of:
number
,bytes
,percent
,requests
,responses
,seconds
,milliseconds
,ratio
,bitrate
.
- plot
Type String - The type of chart to display. One of:
line
,bar
,single-metric
,donut
. - calculation
Method String - The aggregation function to apply to the dataset. One of:
avg
,sum
,min
,max
,latest
,p95
. - format String
- The units to use to format the data. One of:
number
,bytes
,percent
,requests
,responses
,seconds
,milliseconds
,ratio
,bitrate
.
Import
Fastly Custom Dashboards can be imported using their ID, e.g.
$ pulumi import fastly:index/customDashboard:CustomDashboard example xxxxxxxxxxxxxxxxxxxx
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Fastly pulumi/pulumi-fastly
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
fastly
Terraform Provider.