@pulumi/pagerduty
Version:
A Pulumi package for creating and managing pagerduty cloud resources.
84 lines (83 loc) • 2.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* With [add-ons](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODEwNQ-install-an-add-on), third-party developers can write their own add-ons to PagerDuty's UI. Given a configuration containing a src parameter, that URL will be embedded in an iframe on a page that's available to users from a drop-down menu.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pagerduty from "@pulumi/pagerduty";
*
* const example = new pagerduty.Addon("example", {
* name: "Internal Status Page",
* src: "https://intranet.example.com/status",
* });
* ```
*
* ## Import
*
* Add-ons can be imported using the `id`, e.g.
*
* ```sh
* $ pulumi import pagerduty:index/addon:Addon example P3DH5M6
* ```
*/
export declare class Addon extends pulumi.CustomResource {
/**
* Get an existing Addon 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?: AddonState, opts?: pulumi.CustomResourceOptions): Addon;
/**
* Returns true if the given object is an instance of Addon. 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 Addon;
/**
* The name of the add-on.
*/
readonly name: pulumi.Output<string>;
/**
* The source URL to display in a frame in the PagerDuty UI. `HTTPS` is required.
*/
readonly src: pulumi.Output<string>;
/**
* Create a Addon 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: AddonArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Addon resources.
*/
export interface AddonState {
/**
* The name of the add-on.
*/
name?: pulumi.Input<string>;
/**
* The source URL to display in a frame in the PagerDuty UI. `HTTPS` is required.
*/
src?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Addon resource.
*/
export interface AddonArgs {
/**
* The name of the add-on.
*/
name?: pulumi.Input<string>;
/**
* The source URL to display in a frame in the PagerDuty UI. `HTTPS` is required.
*/
src: pulumi.Input<string>;
}