Checkly

Community
Package contributed by a community member
v1.1.2 published on Wednesday, Aug 3, 2022 by checkly

Dashboard

Example Usage

using Pulumi;
using Checkly = Pulumi.Checkly;

class MyStack : Stack
{
    public MyStack()
    {
        var dashboard_1 = new Checkly.Dashboard("dashboard-1", new Checkly.DashboardArgs
        {
            CustomDomain = "status.example.com",
            CustomUrl = "checkly",
            Header = "Public dashboard",
            HideTags = false,
            Logo = "https://www.checklyhq.com/logo.png",
            Paginate = false,
            PaginationRate = 30,
            RefreshRate = 60,
            Tags = 
            {
                "production",
            },
            Width = "FULL",
        });
    }

}
package main

import (
	"github.com/checkly/pulumi-checkly/sdk/go/checkly"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkly.NewDashboard(ctx, "dashboard-1", &checkly.DashboardArgs{
			CustomDomain:   pulumi.String("status.example.com"),
			CustomUrl:      pulumi.String("checkly"),
			Header:         pulumi.String("Public dashboard"),
			HideTags:       pulumi.Bool(false),
			Logo:           pulumi.String("https://www.checklyhq.com/logo.png"),
			Paginate:       pulumi.Bool(false),
			PaginationRate: pulumi.Int(30),
			RefreshRate:    pulumi.Int(60),
			Tags: pulumi.StringArray{
				pulumi.String("production"),
			},
			Width: pulumi.String("FULL"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_checkly as checkly

dashboard_1 = checkly.Dashboard("dashboard-1",
    custom_domain="status.example.com",
    custom_url="checkly",
    header="Public dashboard",
    hide_tags=False,
    logo="https://www.checklyhq.com/logo.png",
    paginate=False,
    pagination_rate=30,
    refresh_rate=60,
    tags=["production"],
    width="FULL")
import * as pulumi from "@pulumi/pulumi";
import * as checkly from "@pulumi/checkly";

const dashboard_1 = new checkly.Dashboard("dashboard-1", {
    customDomain: "status.example.com",
    customUrl: "checkly",
    header: "Public dashboard",
    hideTags: false,
    logo: "https://www.checklyhq.com/logo.png",
    paginate: false,
    paginationRate: 30,
    refreshRate: 60,
    tags: ["production"],
    width: "FULL",
});

Coming soon!

Create a Dashboard Resource

new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
@overload
def Dashboard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              custom_domain: Optional[str] = None,
              custom_url: Optional[str] = None,
              header: Optional[str] = None,
              hide_tags: Optional[bool] = None,
              logo: Optional[str] = None,
              paginate: Optional[bool] = None,
              pagination_rate: Optional[int] = None,
              refresh_rate: Optional[int] = None,
              tags: Optional[Sequence[str]] = None,
              width: Optional[str] = None)
@overload
def Dashboard(resource_name: str,
              args: DashboardArgs,
              opts: Optional[ResourceOptions] = None)
func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
type: checkly:Dashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DashboardArgs
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 DashboardArgs
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 DashboardArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DashboardArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DashboardArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Dashboard Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Dashboard resource accepts the following input properties:

CustomUrl string

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

CustomDomain string

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

Header string

A piece of text displayed at the top of your dashboard.

HideTags bool

Show or hide the tags on the dashboard.

Logo string

A URL pointing to an image file.

Paginate bool

Determines if pagination is on or off.

PaginationRate int

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

RefreshRate int

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

Tags List<string>

A list of one or more tags that filter which checks to display on the dashboard.

Width string

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

CustomUrl string

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

CustomDomain string

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

Header string

A piece of text displayed at the top of your dashboard.

HideTags bool

Show or hide the tags on the dashboard.

Logo string

A URL pointing to an image file.

Paginate bool

Determines if pagination is on or off.

PaginationRate int

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

RefreshRate int

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

Tags []string

A list of one or more tags that filter which checks to display on the dashboard.

Width string

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

customUrl String

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

customDomain String

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

header String

A piece of text displayed at the top of your dashboard.

hideTags Boolean

Show or hide the tags on the dashboard.

logo String

A URL pointing to an image file.

paginate Boolean

Determines if pagination is on or off.

paginationRate Integer

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

refreshRate Integer

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

tags List<String>

A list of one or more tags that filter which checks to display on the dashboard.

width String

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

customUrl string

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

customDomain string

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

header string

A piece of text displayed at the top of your dashboard.

hideTags boolean

Show or hide the tags on the dashboard.

logo string

A URL pointing to an image file.

paginate boolean

Determines if pagination is on or off.

paginationRate number

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

refreshRate number

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

tags string[]

A list of one or more tags that filter which checks to display on the dashboard.

width string

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

custom_url str

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

custom_domain str

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

header str

A piece of text displayed at the top of your dashboard.

hide_tags bool

Show or hide the tags on the dashboard.

logo str

A URL pointing to an image file.

paginate bool

Determines if pagination is on or off.

pagination_rate int

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

refresh_rate int

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

tags Sequence[str]

A list of one or more tags that filter which checks to display on the dashboard.

width str

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

customUrl String

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

customDomain String

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

header String

A piece of text displayed at the top of your dashboard.

hideTags Boolean

Show or hide the tags on the dashboard.

logo String

A URL pointing to an image file.

paginate Boolean

Determines if pagination is on or off.

paginationRate Number

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

refreshRate Number

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

tags List<String>

A list of one or more tags that filter which checks to display on the dashboard.

width String

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

Outputs

All input properties are implicitly available as output properties. Additionally, the Dashboard 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 an Existing Dashboard Resource

Get an existing Dashboard 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?: DashboardState, opts?: CustomResourceOptions): Dashboard
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_domain: Optional[str] = None,
        custom_url: Optional[str] = None,
        header: Optional[str] = None,
        hide_tags: Optional[bool] = None,
        logo: Optional[str] = None,
        paginate: Optional[bool] = None,
        pagination_rate: Optional[int] = None,
        refresh_rate: Optional[int] = None,
        tags: Optional[Sequence[str]] = None,
        width: Optional[str] = None) -> Dashboard
func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
public static Dashboard get(String name, Output<String> id, DashboardState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
The following state arguments are supported:
CustomDomain string

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

CustomUrl string

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

Header string

A piece of text displayed at the top of your dashboard.

HideTags bool

Show or hide the tags on the dashboard.

Logo string

A URL pointing to an image file.

Paginate bool

Determines if pagination is on or off.

PaginationRate int

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

RefreshRate int

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

Tags List<string>

A list of one or more tags that filter which checks to display on the dashboard.

Width string

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

CustomDomain string

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

CustomUrl string

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

Header string

A piece of text displayed at the top of your dashboard.

HideTags bool

Show or hide the tags on the dashboard.

Logo string

A URL pointing to an image file.

Paginate bool

Determines if pagination is on or off.

PaginationRate int

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

RefreshRate int

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

Tags []string

A list of one or more tags that filter which checks to display on the dashboard.

Width string

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

customDomain String

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

customUrl String

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

header String

A piece of text displayed at the top of your dashboard.

hideTags Boolean

Show or hide the tags on the dashboard.

logo String

A URL pointing to an image file.

paginate Boolean

Determines if pagination is on or off.

paginationRate Integer

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

refreshRate Integer

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

tags List<String>

A list of one or more tags that filter which checks to display on the dashboard.

width String

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

customDomain string

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

customUrl string

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

header string

A piece of text displayed at the top of your dashboard.

hideTags boolean

Show or hide the tags on the dashboard.

logo string

A URL pointing to an image file.

paginate boolean

Determines if pagination is on or off.

paginationRate number

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

refreshRate number

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

tags string[]

A list of one or more tags that filter which checks to display on the dashboard.

width string

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

custom_domain str

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

custom_url str

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

header str

A piece of text displayed at the top of your dashboard.

hide_tags bool

Show or hide the tags on the dashboard.

logo str

A URL pointing to an image file.

paginate bool

Determines if pagination is on or off.

pagination_rate int

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

refresh_rate int

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

tags Sequence[str]

A list of one or more tags that filter which checks to display on the dashboard.

width str

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

customDomain String

A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.

customUrl String

A subdomain name under 'checklyhq.com'. Needs to be unique across all users.

header String

A piece of text displayed at the top of your dashboard.

hideTags Boolean

Show or hide the tags on the dashboard.

logo String

A URL pointing to an image file.

paginate Boolean

Determines if pagination is on or off.

paginationRate Number

How often to trigger pagination in seconds. Possible values 30, 60 and 300.

refreshRate Number

How often to refresh the dashboard in seconds. Possible values 60, '300' and 600.

tags List<String>

A list of one or more tags that filter which checks to display on the dashboard.

width String

Determines whether to use the full screen or focus in the center. Possible values FULL and 960PX.

Package Details

Repository
https://github.com/checkly/pulumi-checkly
License
MIT
Notes

This Pulumi package is based on the checkly Terraform Provider.