pulumi-statuspage/metric.d.ts

A Pulumi package for creating and managing statuspage cloud resources.

import * as pulumi from "@pulumi/pulumi";
export declare class Metric extends pulumi.CustomResource {
    /**
     * Get an existing Metric 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?: MetricState, opts?: pulumi.CustomResourceOptions): Metric;
    /**
     * Returns true if the given object is an instance of Metric.  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 Metric;
    /**
     * How many decimal places to render on the graph
     */
    readonly decimalPlaces: pulumi.Output<number | undefined>;
    /**
     * Should the metric be displayed
     */
    readonly display: pulumi.Output<boolean | undefined>;
    /**
     * The identifier used to look up the metric data from the provider
     */
    readonly metricIdentifier: pulumi.Output<string | undefined>;
    /**
     * ID of the metric provider
     */
    readonly metricsProviderId: pulumi.Output<string>;
    /**
     * Display name for the metric
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the page this metric belongs to
     */
    readonly pageId: pulumi.Output<string>;
    /**
     * Suffix to describe the units on the graph
     */
    readonly suffix: pulumi.Output<string | undefined>;
    /**
     * Tooltip for the metric
     */
    readonly tooltipDescription: pulumi.Output<string | undefined>;
    /**
     * The transform to apply to metric before pulling into Statuspage. One of: 'average', 'count', 'max', 'min', 'sum',
     * 'response_time' or 'uptime'
     */
    readonly transform: pulumi.Output<string | undefined>;
    /**
     * Should the values on the y axis be hidden on render
     */
    readonly yAxisHidden: pulumi.Output<boolean | undefined>;
    /**
     * The upper bound of the y axis
     */
    readonly yAxisMax: pulumi.Output<number | undefined>;
    /**
     * The lower bound of the y axis
     */
    readonly yAxisMin: pulumi.Output<number | undefined>;
    /**
     * Create a Metric 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: MetricArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Metric resources.
 */
export interface MetricState {
    /**
     * How many decimal places to render on the graph
     */
    decimalPlaces?: pulumi.Input<number>;
    /**
     * Should the metric be displayed
     */
    display?: pulumi.Input<boolean>;
    /**
     * The identifier used to look up the metric data from the provider
     */
    metricIdentifier?: pulumi.Input<string>;
    /**
     * ID of the metric provider
     */
    metricsProviderId?: pulumi.Input<string>;
    /**
     * Display name for the metric
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the page this metric belongs to
     */
    pageId?: pulumi.Input<string>;
    /**
     * Suffix to describe the units on the graph
     */
    suffix?: pulumi.Input<string>;
    /**
     * Tooltip for the metric
     */
    tooltipDescription?: pulumi.Input<string>;
    /**
     * The transform to apply to metric before pulling into Statuspage. One of: 'average', 'count', 'max', 'min', 'sum',
     * 'response_time' or 'uptime'
     */
    transform?: pulumi.Input<string>;
    /**
     * Should the values on the y axis be hidden on render
     */
    yAxisHidden?: pulumi.Input<boolean>;
    /**
     * The upper bound of the y axis
     */
    yAxisMax?: pulumi.Input<number>;
    /**
     * The lower bound of the y axis
     */
    yAxisMin?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a Metric resource.
 */
export interface MetricArgs {
    /**
     * How many decimal places to render on the graph
     */
    decimalPlaces?: pulumi.Input<number>;
    /**
     * Should the metric be displayed
     */
    display?: pulumi.Input<boolean>;
    /**
     * The identifier used to look up the metric data from the provider
     */
    metricIdentifier?: pulumi.Input<string>;
    /**
     * ID of the metric provider
     */
    metricsProviderId: pulumi.Input<string>;
    /**
     * Display name for the metric
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the page this metric belongs to
     */
    pageId: pulumi.Input<string>;
    /**
     * Suffix to describe the units on the graph
     */
    suffix?: pulumi.Input<string>;
    /**
     * Tooltip for the metric
     */
    tooltipDescription?: pulumi.Input<string>;
    /**
     * The transform to apply to metric before pulling into Statuspage. One of: 'average', 'count', 'max', 'min', 'sum',
     * 'response_time' or 'uptime'
     */
    transform?: pulumi.Input<string>;
    /**
     * Should the values on the y axis be hidden on render
     */
    yAxisHidden?: pulumi.Input<boolean>;
    /**
     * The upper bound of the y axis
     */
    yAxisMax?: pulumi.Input<number>;
    /**
     * The lower bound of the y axis
     */
    yAxisMin?: pulumi.Input<number>;
}