EventOrchestration

Global Event Orchestrations allow you define a set of Event Rules, so that when you ingest events using the Orchestration’s Routing Key your events will be routed to the correct Service, based on the event’s content.

Example of configuring a Global Event Orchestration

import * as pulumi from "@pulumi/pulumi";
import * as pagerduty from "@pulumi/pagerduty";

const engineering = new pagerduty.Team("engineering", {});
const myMonitor = new pagerduty.EventOrchestration("myMonitor", {
    description: "Send events to a pair of services",
    team: engineering.id,
});
import pulumi
import pulumi_pagerduty as pagerduty

engineering = pagerduty.Team("engineering")
my_monitor = pagerduty.EventOrchestration("myMonitor",
    description="Send events to a pair of services",
    team=engineering.id)
using System.Collections.Generic;
using Pulumi;
using Pagerduty = Pulumi.Pagerduty;

return await Deployment.RunAsync(() => 
{
    var engineering = new Pagerduty.Team("engineering");

    var myMonitor = new Pagerduty.EventOrchestration("myMonitor", new()
    {
        Description = "Send events to a pair of services",
        Team = engineering.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-pagerduty/sdk/v3/go/pagerduty"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		engineering, err := pagerduty.NewTeam(ctx, "engineering", nil)
		if err != nil {
			return err
		}
		_, err = pagerduty.NewEventOrchestration(ctx, "myMonitor", &pagerduty.EventOrchestrationArgs{
			Description: pulumi.String("Send events to a pair of services"),
			Team:        engineering.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.pagerduty.Team;
import com.pulumi.pagerduty.EventOrchestration;
import com.pulumi.pagerduty.EventOrchestrationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var engineering = new Team("engineering");

        var myMonitor = new EventOrchestration("myMonitor", EventOrchestrationArgs.builder()        
            .description("Send events to a pair of services")
            .team(engineering.id())
            .build());

    }
}
resources:
  engineering:
    type: pagerduty:Team
  myMonitor:
    type: pagerduty:EventOrchestration
    properties:
      description: Send events to a pair of services
      team: ${engineering.id}

Create EventOrchestration Resource

new EventOrchestration(name: string, args?: EventOrchestrationArgs, opts?: CustomResourceOptions);
@overload
def EventOrchestration(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       description: Optional[str] = None,
                       integrations: Optional[Sequence[EventOrchestrationIntegrationArgs]] = None,
                       name: Optional[str] = None,
                       team: Optional[str] = None)
@overload
def EventOrchestration(resource_name: str,
                       args: Optional[EventOrchestrationArgs] = None,
                       opts: Optional[ResourceOptions] = None)
func NewEventOrchestration(ctx *Context, name string, args *EventOrchestrationArgs, opts ...ResourceOption) (*EventOrchestration, error)
public EventOrchestration(string name, EventOrchestrationArgs? args = null, CustomResourceOptions? opts = null)
public EventOrchestration(String name, EventOrchestrationArgs args)
public EventOrchestration(String name, EventOrchestrationArgs args, CustomResourceOptions options)
type: pagerduty:EventOrchestration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EventOrchestrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args EventOrchestrationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EventOrchestrationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EventOrchestrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EventOrchestrationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

EventOrchestration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The EventOrchestration resource accepts the following input properties:

Description string

A human-friendly description of the Event Orchestration.

Integrations List<EventOrchestrationIntegrationArgs>

An integration for the Event Orchestration.

Name string

Name of the Event Orchestration.

Team string

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

Description string

A human-friendly description of the Event Orchestration.

Integrations []EventOrchestrationIntegrationArgs

An integration for the Event Orchestration.

Name string

Name of the Event Orchestration.

Team string

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

description String

A human-friendly description of the Event Orchestration.

integrations List<EventOrchestrationIntegrationArgs>

An integration for the Event Orchestration.

name String

Name of the Event Orchestration.

team String

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

description string

A human-friendly description of the Event Orchestration.

integrations EventOrchestrationIntegrationArgs[]

An integration for the Event Orchestration.

name string

Name of the Event Orchestration.

team string

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

description str

A human-friendly description of the Event Orchestration.

integrations Sequence[EventOrchestrationIntegrationArgs]

An integration for the Event Orchestration.

name str

Name of the Event Orchestration.

team str

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

description String

A human-friendly description of the Event Orchestration.

integrations List<Property Map>

An integration for the Event Orchestration.

name String

Name of the Event Orchestration.

team String

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

Outputs

All input properties are implicitly available as output properties. Additionally, the EventOrchestration resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Routes int
Id string

The provider-assigned unique ID for this managed resource.

Routes int
id String

The provider-assigned unique ID for this managed resource.

routes Integer
id string

The provider-assigned unique ID for this managed resource.

routes number
id str

The provider-assigned unique ID for this managed resource.

routes int
id String

The provider-assigned unique ID for this managed resource.

routes Number

Look up Existing EventOrchestration Resource

Get an existing EventOrchestration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EventOrchestrationState, opts?: CustomResourceOptions): EventOrchestration
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        integrations: Optional[Sequence[EventOrchestrationIntegrationArgs]] = None,
        name: Optional[str] = None,
        routes: Optional[int] = None,
        team: Optional[str] = None) -> EventOrchestration
func GetEventOrchestration(ctx *Context, name string, id IDInput, state *EventOrchestrationState, opts ...ResourceOption) (*EventOrchestration, error)
public static EventOrchestration Get(string name, Input<string> id, EventOrchestrationState? state, CustomResourceOptions? opts = null)
public static EventOrchestration get(String name, Output<String> id, EventOrchestrationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description string

A human-friendly description of the Event Orchestration.

Integrations List<EventOrchestrationIntegrationArgs>

An integration for the Event Orchestration.

Name string

Name of the Event Orchestration.

Routes int
Team string

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

Description string

A human-friendly description of the Event Orchestration.

Integrations []EventOrchestrationIntegrationArgs

An integration for the Event Orchestration.

Name string

Name of the Event Orchestration.

Routes int
Team string

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

description String

A human-friendly description of the Event Orchestration.

integrations List<EventOrchestrationIntegrationArgs>

An integration for the Event Orchestration.

name String

Name of the Event Orchestration.

routes Integer
team String

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

description string

A human-friendly description of the Event Orchestration.

integrations EventOrchestrationIntegrationArgs[]

An integration for the Event Orchestration.

name string

Name of the Event Orchestration.

routes number
team string

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

description str

A human-friendly description of the Event Orchestration.

integrations Sequence[EventOrchestrationIntegrationArgs]

An integration for the Event Orchestration.

name str

Name of the Event Orchestration.

routes int
team str

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

description String

A human-friendly description of the Event Orchestration.

integrations List<Property Map>

An integration for the Event Orchestration.

name String

Name of the Event Orchestration.

routes Number
team String

ID of the team that owns the Event Orchestration. If none is specified, only admins have access.

Supporting Types

EventOrchestrationIntegration

Id string

ID of the integration

  • parameters
Parameters List<EventOrchestrationIntegrationParameter>
Id string

ID of the integration

  • parameters
Parameters []EventOrchestrationIntegrationParameter
id String

ID of the integration

  • parameters
parameters List<EventOrchestrationIntegrationParameter>
id string

ID of the integration

  • parameters
parameters EventOrchestrationIntegrationParameter[]
id String

ID of the integration

  • parameters
parameters List<Property Map>

EventOrchestrationIntegrationParameter

RoutingKey string

Routing key that routes to this Orchestration.

Type string

Type of the routing key. global is the default type.

RoutingKey string

Routing key that routes to this Orchestration.

Type string

Type of the routing key. global is the default type.

routingKey String

Routing key that routes to this Orchestration.

type String

Type of the routing key. global is the default type.

routingKey string

Routing key that routes to this Orchestration.

type string

Type of the routing key. global is the default type.

routing_key str

Routing key that routes to this Orchestration.

type str

Type of the routing key. global is the default type.

routingKey String

Routing key that routes to this Orchestration.

type String

Type of the routing key. global is the default type.

Import

EventOrchestrations can be imported using the id, e.g.

 $ pulumi import pagerduty:index/eventOrchestration:EventOrchestration main 19acac92-027a-4ea0-b06c-bbf516519601

Package Details

Repository
https://github.com/pulumi/pulumi-pagerduty
License
Apache-2.0
Notes

This Pulumi package is based on the pagerduty Terraform Provider.