@pulumi/pagerduty/incidentWorkflow.d.ts

A Pulumi package for creating and managing pagerduty cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * An [Incident Workflow](https://support.pagerduty.com/docs/incident-workflows) is a series of steps which can be executed on an incident.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as pagerduty from "@pulumi/pagerduty";
 *
 * const myFirstWorkflow = new pagerduty.IncidentWorkflow("my_first_workflow", {
 *     name: "Example Incident Workflow",
 *     description: "This Incident Workflow is an example",
 *     steps: [{
 *         name: "Send Status Update",
 *         action: "pagerduty.com:incident-workflows:send-status-update:1",
 *         inputs: [{
 *             name: "Message",
 *             value: "Example status message sent on {{current_date}}",
 *         }],
 *     }],
 * });
 * ```
 *
 * ## Import
 *
 * Incident workflows can be imported using the `id`, e.g.
 *
 * ```sh
 * $ pulumi import pagerduty:index/incidentWorkflow:IncidentWorkflow major_incident_workflow PLBP09X
 * ```
 */
export declare class IncidentWorkflow extends pulumi.CustomResource {
    /**
     * Get an existing IncidentWorkflow 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?: IncidentWorkflowState, opts?: pulumi.CustomResourceOptions): IncidentWorkflow;
    /**
     * Returns true if the given object is an instance of IncidentWorkflow.  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 IncidentWorkflow;
    /**
     * The description of the workflow.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Indicates whether the Incident Workflow is enabled or not. Disabled workflows will not be triggered, and will not count toward the account's enabled workflow limit.
     */
    readonly isEnabled: pulumi.Output<string>;
    /**
     * The name of the workflow.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The steps in the workflow.
     */
    readonly steps: pulumi.Output<outputs.IncidentWorkflowStep[]>;
    /**
     * A team ID. If specified then workflow edit permissions will be scoped to members of this team.
     */
    readonly team: pulumi.Output<string | undefined>;
    /**
     * Create a IncidentWorkflow 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?: IncidentWorkflowArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering IncidentWorkflow resources.
 */
export interface IncidentWorkflowState {
    /**
     * The description of the workflow.
     */
    description?: pulumi.Input<string>;
    /**
     * Indicates whether the Incident Workflow is enabled or not. Disabled workflows will not be triggered, and will not count toward the account's enabled workflow limit.
     */
    isEnabled?: pulumi.Input<string>;
    /**
     * The name of the workflow.
     */
    name?: pulumi.Input<string>;
    /**
     * The steps in the workflow.
     */
    steps?: pulumi.Input<pulumi.Input<inputs.IncidentWorkflowStep>[]>;
    /**
     * A team ID. If specified then workflow edit permissions will be scoped to members of this team.
     */
    team?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a IncidentWorkflow resource.
 */
export interface IncidentWorkflowArgs {
    /**
     * The description of the workflow.
     */
    description?: pulumi.Input<string>;
    /**
     * Indicates whether the Incident Workflow is enabled or not. Disabled workflows will not be triggered, and will not count toward the account's enabled workflow limit.
     */
    isEnabled?: pulumi.Input<string>;
    /**
     * The name of the workflow.
     */
    name?: pulumi.Input<string>;
    /**
     * The steps in the workflow.
     */
    steps?: pulumi.Input<pulumi.Input<inputs.IncidentWorkflowStep>[]>;
    /**
     * A team ID. If specified then workflow edit permissions will be scoped to members of this team.
     */
    team?: pulumi.Input<string>;
}