pulumi-better-uptime
Version:
A Pulumi provider for managing Better Uptime monitoring, alerting, and incident management resources, dynamically bridged from the Terraform Better Uptime provider with support for monitors, heartbeats, integrations, status pages, and policies.
197 lines (196 loc) • 8.66 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class StatusPageResource extends pulumi.CustomResource {
/**
* Get an existing StatusPageResource 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<pulumi.ID>, state?: StatusPageResourceState, opts?: pulumi.CustomResourceOptions): StatusPageResource;
/**
* Returns true if the given object is an instance of StatusPageResource. 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 StatusPageResource;
/**
* The availability of this resource (from 0.0 to 1.0).
*/
readonly availability: pulumi.Output<number>;
/**
* A detailed text displayed as a help icon.
*/
readonly explanation: pulumi.Output<string>;
/**
* Do you want to display detailed historical status for this item? This field is deprecated, use widget_type instead.
*
* @deprecated Deprecated
*/
readonly history: pulumi.Output<boolean>;
/**
* The position of this resource on your status page, indexed from zero. If you don't specify a position, we add the
* resource to the end of the status page. When you specify a position of an existing resource, we add the resource to this
* position and shift resources below to accommodate.
*/
readonly position: pulumi.Output<number>;
/**
* The resource name displayed publicly on your status page.
*/
readonly publicName: pulumi.Output<string>;
/**
* The ID of the resource you are adding.
*/
readonly resourceId: pulumi.Output<number>;
/**
* The type of the resource you are adding. Available values: Monitor, MonitorGroup, Heartbeat, HeartbeatGroup,
* WebhookIntegration, EmailIntegration, IncomingWebhook, ResourceGroup, LogsChart, CatalogReference.
*/
readonly resourceType: pulumi.Output<string>;
/**
* The current status of the resource. Can be one of `not_monitored` (when the underlying monitor is paused),
* `operational`, `maintenance`, `degraded`, or `downtime`
*/
readonly status: pulumi.Output<string>;
/**
* History of a single status page resource history
*/
readonly statusHistories: pulumi.Output<outputs.StatusPageResourceStatusHistory[]>;
/**
* The ID of the Status Page.
*/
readonly statusPageId: pulumi.Output<string>;
/**
* The ID of the Status Page Section. If you don't specify a status_page_section_id, we add the resource to the first
* section. If there are no sections in the status page yet, one will be automatically created for you.
*/
readonly statusPageSectionId: pulumi.Output<number>;
/**
* What widget to display for this resource. Expects one of three values: plain - only display status, history - display
* detailed historical status, response_times - add a response times chart (only for Monitor resource type). This takes
* preference over history when both parameters are present.
*/
readonly widgetType: pulumi.Output<string>;
/**
* Create a StatusPageResource 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: StatusPageResourceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering StatusPageResource resources.
*/
export interface StatusPageResourceState {
/**
* The availability of this resource (from 0.0 to 1.0).
*/
availability?: pulumi.Input<number>;
/**
* A detailed text displayed as a help icon.
*/
explanation?: pulumi.Input<string>;
/**
* Do you want to display detailed historical status for this item? This field is deprecated, use widget_type instead.
*
* @deprecated Deprecated
*/
history?: pulumi.Input<boolean>;
/**
* The position of this resource on your status page, indexed from zero. If you don't specify a position, we add the
* resource to the end of the status page. When you specify a position of an existing resource, we add the resource to this
* position and shift resources below to accommodate.
*/
position?: pulumi.Input<number>;
/**
* The resource name displayed publicly on your status page.
*/
publicName?: pulumi.Input<string>;
/**
* The ID of the resource you are adding.
*/
resourceId?: pulumi.Input<number>;
/**
* The type of the resource you are adding. Available values: Monitor, MonitorGroup, Heartbeat, HeartbeatGroup,
* WebhookIntegration, EmailIntegration, IncomingWebhook, ResourceGroup, LogsChart, CatalogReference.
*/
resourceType?: pulumi.Input<string>;
/**
* The current status of the resource. Can be one of `not_monitored` (when the underlying monitor is paused),
* `operational`, `maintenance`, `degraded`, or `downtime`
*/
status?: pulumi.Input<string>;
/**
* History of a single status page resource history
*/
statusHistories?: pulumi.Input<pulumi.Input<inputs.StatusPageResourceStatusHistory>[]>;
/**
* The ID of the Status Page.
*/
statusPageId?: pulumi.Input<string>;
/**
* The ID of the Status Page Section. If you don't specify a status_page_section_id, we add the resource to the first
* section. If there are no sections in the status page yet, one will be automatically created for you.
*/
statusPageSectionId?: pulumi.Input<number>;
/**
* What widget to display for this resource. Expects one of three values: plain - only display status, history - display
* detailed historical status, response_times - add a response times chart (only for Monitor resource type). This takes
* preference over history when both parameters are present.
*/
widgetType?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a StatusPageResource resource.
*/
export interface StatusPageResourceArgs {
/**
* A detailed text displayed as a help icon.
*/
explanation?: pulumi.Input<string>;
/**
* Do you want to display detailed historical status for this item? This field is deprecated, use widget_type instead.
*
* @deprecated Deprecated
*/
history?: pulumi.Input<boolean>;
/**
* The position of this resource on your status page, indexed from zero. If you don't specify a position, we add the
* resource to the end of the status page. When you specify a position of an existing resource, we add the resource to this
* position and shift resources below to accommodate.
*/
position?: pulumi.Input<number>;
/**
* The resource name displayed publicly on your status page.
*/
publicName: pulumi.Input<string>;
/**
* The ID of the resource you are adding.
*/
resourceId: pulumi.Input<number>;
/**
* The type of the resource you are adding. Available values: Monitor, MonitorGroup, Heartbeat, HeartbeatGroup,
* WebhookIntegration, EmailIntegration, IncomingWebhook, ResourceGroup, LogsChart, CatalogReference.
*/
resourceType: pulumi.Input<string>;
/**
* The ID of the Status Page.
*/
statusPageId: pulumi.Input<string>;
/**
* The ID of the Status Page Section. If you don't specify a status_page_section_id, we add the resource to the first
* section. If there are no sections in the status page yet, one will be automatically created for you.
*/
statusPageSectionId?: pulumi.Input<number>;
/**
* What widget to display for this resource. Expects one of three values: plain - only display status, history - display
* detailed historical status, response_times - add a response times chart (only for Monitor resource type). This takes
* preference over history when both parameters are present.
*/
widgetType?: pulumi.Input<string>;
}