import * as pulumi from "@pulumi/pulumi"; /** * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as checkly from "@checkly/pulumi"; * * const dashboard1 = new checkly.Dashboard("dashboard_1", { * customUrl: "checkly", * customDomain: "status.example.com", * logo: "https://www.checklyhq.com/logo.png", * header: "Public dashboard", * refreshRate: 60, * paginate: false, * paginationRate: 30, * hideTags: false, * width: "FULL", * tags: ["production"], * }); * ``` */ export declare class Dashboard extends pulumi.CustomResource { /** * Get an existing Dashboard resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: DashboardState, opts?: pulumi.CustomResourceOptions): Dashboard; /** * Returns true if the given object is an instance of Dashboard. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Dashboard; /** * Determines how many checks to show per page. Possible values are between 1 and 20. (Default `15`). */ readonly checksPerPage: pulumi.Output; /** * Custom CSS to be applied to the dashboard. */ readonly customCss: pulumi.Output; /** * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage. */ readonly customDomain: pulumi.Output; /** * A subdomain name under 'checklyhq.com'. Needs to be unique across all users. */ readonly customUrl: pulumi.Output; /** * HTML \n\n description for the dashboard. */ readonly description: pulumi.Output; /** * Enable incident support for the dashboard. (Default `false`). */ readonly enableIncidents: pulumi.Output; /** * Expand or collapse checks on the dashboard. (Default `false`). */ readonly expandChecks: pulumi.Output; /** * A URL pointing to an image file to use as browser favicon. */ readonly favicon: pulumi.Output; /** * A piece of text displayed at the top of your dashboard. */ readonly header: pulumi.Output; /** * Show or hide the tags on the dashboard. (Default `false`). */ readonly hideTags: pulumi.Output; /** * Set your dashboard as private and generate key. */ readonly isPrivate: pulumi.Output; /** * The access key when the dashboard is private. */ readonly key: pulumi.Output; /** * A link to for the dashboard logo. */ readonly link: pulumi.Output; /** * A URL pointing to an image file to use for the dashboard logo. */ readonly logo: pulumi.Output; /** * Determines if pagination is on or off. (Default `true`). */ readonly paginate: pulumi.Output; /** * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`. (Default `60`). */ readonly paginationRate: pulumi.Output; /** * How often to refresh the dashboard in seconds. Possible values `60`, '300' and `600`. (Default `60`). */ readonly refreshRate: pulumi.Output; /** * Show or hide check run links on the dashboard. (Default `false`). */ readonly showCheckRunLinks: pulumi.Output; /** * Show or hide header and description on the dashboard. (Default `true`). */ readonly showHeader: pulumi.Output; /** * Show or hide the P95 stats on the dashboard. (Default `true`). */ readonly showP95: pulumi.Output; /** * Show or hide the P99 stats on the dashboard. (Default `true`). */ readonly showP99: pulumi.Output; /** * A list of one or more tags that filter which checks to display on the dashboard. */ readonly tags: pulumi.Output; /** * Set when to use AND operator for fetching dashboard tags. (Default `false`). */ readonly useTagsAndOperator: pulumi.Output; /** * Determines whether to use the full screen or focus in the center. Possible values are `FULL` and `960PX`. (Default `FULL`). */ readonly width: pulumi.Output; /** * Create a Dashboard resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: DashboardArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Dashboard resources. */ export interface DashboardState { /** * Determines how many checks to show per page. Possible values are between 1 and 20. (Default `15`). */ checksPerPage?: pulumi.Input; /** * Custom CSS to be applied to the dashboard. */ customCss?: pulumi.Input; /** * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage. */ customDomain?: pulumi.Input; /** * A subdomain name under 'checklyhq.com'. Needs to be unique across all users. */ customUrl?: pulumi.Input; /** * HTML \n\n description for the dashboard. */ description?: pulumi.Input; /** * Enable incident support for the dashboard. (Default `false`). */ enableIncidents?: pulumi.Input; /** * Expand or collapse checks on the dashboard. (Default `false`). */ expandChecks?: pulumi.Input; /** * A URL pointing to an image file to use as browser favicon. */ favicon?: pulumi.Input; /** * A piece of text displayed at the top of your dashboard. */ header?: pulumi.Input; /** * Show or hide the tags on the dashboard. (Default `false`). */ hideTags?: pulumi.Input; /** * Set your dashboard as private and generate key. */ isPrivate?: pulumi.Input; /** * The access key when the dashboard is private. */ key?: pulumi.Input; /** * A link to for the dashboard logo. */ link?: pulumi.Input; /** * A URL pointing to an image file to use for the dashboard logo. */ logo?: pulumi.Input; /** * Determines if pagination is on or off. (Default `true`). */ paginate?: pulumi.Input; /** * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`. (Default `60`). */ paginationRate?: pulumi.Input; /** * How often to refresh the dashboard in seconds. Possible values `60`, '300' and `600`. (Default `60`). */ refreshRate?: pulumi.Input; /** * Show or hide check run links on the dashboard. (Default `false`). */ showCheckRunLinks?: pulumi.Input; /** * Show or hide header and description on the dashboard. (Default `true`). */ showHeader?: pulumi.Input; /** * Show or hide the P95 stats on the dashboard. (Default `true`). */ showP95?: pulumi.Input; /** * Show or hide the P99 stats on the dashboard. (Default `true`). */ showP99?: pulumi.Input; /** * A list of one or more tags that filter which checks to display on the dashboard. */ tags?: pulumi.Input[]>; /** * Set when to use AND operator for fetching dashboard tags. (Default `false`). */ useTagsAndOperator?: pulumi.Input; /** * Determines whether to use the full screen or focus in the center. Possible values are `FULL` and `960PX`. (Default `FULL`). */ width?: pulumi.Input; } /** * The set of arguments for constructing a Dashboard resource. */ export interface DashboardArgs { /** * Determines how many checks to show per page. Possible values are between 1 and 20. (Default `15`). */ checksPerPage?: pulumi.Input; /** * Custom CSS to be applied to the dashboard. */ customCss?: pulumi.Input; /** * A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage. */ customDomain?: pulumi.Input; /** * A subdomain name under 'checklyhq.com'. Needs to be unique across all users. */ customUrl: pulumi.Input; /** * HTML \n\n description for the dashboard. */ description?: pulumi.Input; /** * Enable incident support for the dashboard. (Default `false`). */ enableIncidents?: pulumi.Input; /** * Expand or collapse checks on the dashboard. (Default `false`). */ expandChecks?: pulumi.Input; /** * A URL pointing to an image file to use as browser favicon. */ favicon?: pulumi.Input; /** * A piece of text displayed at the top of your dashboard. */ header: pulumi.Input; /** * Show or hide the tags on the dashboard. (Default `false`). */ hideTags?: pulumi.Input; /** * Set your dashboard as private and generate key. */ isPrivate?: pulumi.Input; /** * A link to for the dashboard logo. */ link?: pulumi.Input; /** * A URL pointing to an image file to use for the dashboard logo. */ logo?: pulumi.Input; /** * Determines if pagination is on or off. (Default `true`). */ paginate?: pulumi.Input; /** * How often to trigger pagination in seconds. Possible values `30`, `60` and `300`. (Default `60`). */ paginationRate?: pulumi.Input; /** * How often to refresh the dashboard in seconds. Possible values `60`, '300' and `600`. (Default `60`). */ refreshRate?: pulumi.Input; /** * Show or hide check run links on the dashboard. (Default `false`). */ showCheckRunLinks?: pulumi.Input; /** * Show or hide header and description on the dashboard. (Default `true`). */ showHeader?: pulumi.Input; /** * Show or hide the P95 stats on the dashboard. (Default `true`). */ showP95?: pulumi.Input; /** * Show or hide the P99 stats on the dashboard. (Default `true`). */ showP99?: pulumi.Input; /** * A list of one or more tags that filter which checks to display on the dashboard. */ tags?: pulumi.Input[]>; /** * Set when to use AND operator for fetching dashboard tags. (Default `false`). */ useTagsAndOperator?: pulumi.Input; /** * Determines whether to use the full screen or focus in the center. Possible values are `FULL` and `960PX`. (Default `FULL`). */ width?: pulumi.Input; }