pulumi-statuspage/component.d.ts

A Pulumi package for creating and managing statuspage cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## Import
 *
 * `statuspage_component` can be imported using the ID of the component, e.g.
 *
 * ```sh
 * $ pulumi import statuspage:index/component:Component my_component my-page-id/my-component-id
 * ```
 */
export declare class Component extends pulumi.CustomResource {
    /**
     * Get an existing Component 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?: ComponentState, opts?: pulumi.CustomResourceOptions): Component;
    /**
     * Returns true if the given object is an instance of Component.  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 Component;
    /**
     * Email address to send automation events to
     */
    readonly automationEmail: pulumi.Output<string>;
    /**
     * Description of the component
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Name of the component
     */
    readonly name: pulumi.Output<string>;
    /**
     * Should this component be shown component only if in degraded state
     */
    readonly onlyShowIfDegraded: pulumi.Output<boolean | undefined>;
    /**
     * the id of the page this component belongs to
     */
    readonly pageId: pulumi.Output<string>;
    /**
     * Should this component be showcased
     *
     * The following attributes are exported:
     */
    readonly showcase: pulumi.Output<boolean | undefined>;
    /**
     * status of the component - must be one of `operational`, `underMaintenance`, `degradedPerformance`, `partialOutage`, `majorOutage` or ` `
     */
    readonly status: pulumi.Output<string | undefined>;
    /**
     * Create a Component 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: ComponentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Component resources.
 */
export interface ComponentState {
    /**
     * Email address to send automation events to
     */
    automationEmail?: pulumi.Input<string>;
    /**
     * Description of the component
     */
    description?: pulumi.Input<string>;
    /**
     * Name of the component
     */
    name?: pulumi.Input<string>;
    /**
     * Should this component be shown component only if in degraded state
     */
    onlyShowIfDegraded?: pulumi.Input<boolean>;
    /**
     * the id of the page this component belongs to
     */
    pageId?: pulumi.Input<string>;
    /**
     * Should this component be showcased
     *
     * The following attributes are exported:
     */
    showcase?: pulumi.Input<boolean>;
    /**
     * status of the component - must be one of `operational`, `underMaintenance`, `degradedPerformance`, `partialOutage`, `majorOutage` or ` `
     */
    status?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Component resource.
 */
export interface ComponentArgs {
    /**
     * Description of the component
     */
    description?: pulumi.Input<string>;
    /**
     * Name of the component
     */
    name?: pulumi.Input<string>;
    /**
     * Should this component be shown component only if in degraded state
     */
    onlyShowIfDegraded?: pulumi.Input<boolean>;
    /**
     * the id of the page this component belongs to
     */
    pageId: pulumi.Input<string>;
    /**
     * Should this component be showcased
     *
     * The following attributes are exported:
     */
    showcase?: pulumi.Input<boolean>;
    /**
     * status of the component - must be one of `operational`, `underMaintenance`, `degradedPerformance`, `partialOutage`, `majorOutage` or ` `
     */
    status?: pulumi.Input<string>;
}