@pulumi/pagerduty
Version:
A Pulumi package for creating and managing pagerduty cloud resources.
97 lines (96 loc) • 4.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* An Event Orchestration Integration allows you to create and manage multiple Integrations (and Routing Keys) per Event Orchestration _and_ will allow you to move (migrate) Integrations _between_ two Event Orchestrations.
*
* ## Example of configuring an Integration for an Event Orchestration
*
* This example shows creating `Event Orchestration` and `Team` resources followed by creating an Event Orchestration Integration to handle Events sent to that Event Orchestration.
*
* > When a new Event Orchestration is created there will be one Integration (and Routing Key) included by default. Example below shows how to create an extra Integration associated with this Event Orchestration.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pagerduty from "@pulumi/pagerduty";
*
* const databaseTeam = new pagerduty.Team("database_team", {name: "Database Team"});
* const eventOrchestration = new pagerduty.EventOrchestration("event_orchestration", {
* name: "Example Orchestration",
* team: databaseTeam.id,
* });
* const integration = new pagerduty.EventOrchestrationIntegration("integration", {
* eventOrchestration: eventOrchestration.id,
* label: "Example integration",
* });
* ```
*
* ## Import
*
* Event Orchestration Integration can be imported using colon-separated IDs, which is the combination of the Event Orchestration ID followed by the Event Orchestration Integration ID, e.g.
*
* ```sh
* $ pulumi import pagerduty:index/eventOrchestrationIntegration:EventOrchestrationIntegration integration 19acac92-027a-4ea0-b06c-bbf516519601:1b49abe7-26db-4439-a715-c6d883acfb3e
* ```
*/
export declare class EventOrchestrationIntegration extends pulumi.CustomResource {
/**
* Get an existing EventOrchestrationIntegration 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?: EventOrchestrationIntegrationState, opts?: pulumi.CustomResourceOptions): EventOrchestrationIntegration;
/**
* Returns true if the given object is an instance of EventOrchestrationIntegration. 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 EventOrchestrationIntegration;
/**
* ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
*/
readonly eventOrchestration: pulumi.Output<string>;
/**
* Name/description of the Integration.
*/
readonly label: pulumi.Output<string>;
readonly parameters: pulumi.Output<outputs.EventOrchestrationIntegrationParameter[]>;
/**
* Create a EventOrchestrationIntegration 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: EventOrchestrationIntegrationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering EventOrchestrationIntegration resources.
*/
export interface EventOrchestrationIntegrationState {
/**
* ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
*/
eventOrchestration?: pulumi.Input<string>;
/**
* Name/description of the Integration.
*/
label?: pulumi.Input<string>;
parameters?: pulumi.Input<pulumi.Input<inputs.EventOrchestrationIntegrationParameter>[]>;
}
/**
* The set of arguments for constructing a EventOrchestrationIntegration resource.
*/
export interface EventOrchestrationIntegrationArgs {
/**
* ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
*/
eventOrchestration: pulumi.Input<string>;
/**
* Name/description of the Integration.
*/
label: pulumi.Input<string>;
}