1. Packages
  2. PagerDuty
  3. API Docs
  4. EventOrchestrationIntegration
PagerDuty v4.13.2 published on Thursday, Jun 27, 2024 by Pulumi

pagerduty.EventOrchestrationIntegration

Explore with Pulumi AI

pagerduty logo
PagerDuty v4.13.2 published on Thursday, Jun 27, 2024 by Pulumi

    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.

    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 pulumi
    import pulumi_pagerduty as pagerduty
    
    database_team = pagerduty.Team("database_team", name="Database Team")
    event_orchestration = pagerduty.EventOrchestration("event_orchestration",
        name="Example Orchestration",
        team=database_team.id)
    integration = pagerduty.EventOrchestrationIntegration("integration",
        event_orchestration=event_orchestration.id,
        label="Example integration")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-pagerduty/sdk/v4/go/pagerduty"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		databaseTeam, err := pagerduty.NewTeam(ctx, "database_team", &pagerduty.TeamArgs{
    			Name: pulumi.String("Database Team"),
    		})
    		if err != nil {
    			return err
    		}
    		eventOrchestration, err := pagerduty.NewEventOrchestration(ctx, "event_orchestration", &pagerduty.EventOrchestrationArgs{
    			Name: pulumi.String("Example Orchestration"),
    			Team: databaseTeam.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = pagerduty.NewEventOrchestrationIntegration(ctx, "integration", &pagerduty.EventOrchestrationIntegrationArgs{
    			EventOrchestration: eventOrchestration.ID(),
    			Label:              pulumi.String("Example integration"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Pagerduty = Pulumi.Pagerduty;
    
    return await Deployment.RunAsync(() => 
    {
        var databaseTeam = new Pagerduty.Team("database_team", new()
        {
            Name = "Database Team",
        });
    
        var eventOrchestration = new Pagerduty.EventOrchestration("event_orchestration", new()
        {
            Name = "Example Orchestration",
            Team = databaseTeam.Id,
        });
    
        var integration = new Pagerduty.EventOrchestrationIntegration("integration", new()
        {
            EventOrchestration = eventOrchestration.Id,
            Label = "Example integration",
        });
    
    });
    
    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.TeamArgs;
    import com.pulumi.pagerduty.EventOrchestration;
    import com.pulumi.pagerduty.EventOrchestrationArgs;
    import com.pulumi.pagerduty.EventOrchestrationIntegration;
    import com.pulumi.pagerduty.EventOrchestrationIntegrationArgs;
    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 databaseTeam = new Team("databaseTeam", TeamArgs.builder()
                .name("Database Team")
                .build());
    
            var eventOrchestration = new EventOrchestration("eventOrchestration", EventOrchestrationArgs.builder()
                .name("Example Orchestration")
                .team(databaseTeam.id())
                .build());
    
            var integration = new EventOrchestrationIntegration("integration", EventOrchestrationIntegrationArgs.builder()
                .eventOrchestration(eventOrchestration.id())
                .label("Example integration")
                .build());
    
        }
    }
    
    resources:
      databaseTeam:
        type: pagerduty:Team
        name: database_team
        properties:
          name: Database Team
      eventOrchestration:
        type: pagerduty:EventOrchestration
        name: event_orchestration
        properties:
          name: Example Orchestration
          team: ${databaseTeam.id}
      integration:
        type: pagerduty:EventOrchestrationIntegration
        properties:
          eventOrchestration: ${eventOrchestration.id}
          label: Example integration
    

    Create EventOrchestrationIntegration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

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

    Parameters

    name string
    The unique name of the resource.
    args EventOrchestrationIntegrationArgs
    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 EventOrchestrationIntegrationInitArgs
    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 EventOrchestrationIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EventOrchestrationIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EventOrchestrationIntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var eventOrchestrationIntegrationResource = new Pagerduty.EventOrchestrationIntegration("eventOrchestrationIntegrationResource", new()
    {
        EventOrchestration = "string",
        Label = "string",
    });
    
    example, err := pagerduty.NewEventOrchestrationIntegration(ctx, "eventOrchestrationIntegrationResource", &pagerduty.EventOrchestrationIntegrationArgs{
    	EventOrchestration: pulumi.String("string"),
    	Label:              pulumi.String("string"),
    })
    
    var eventOrchestrationIntegrationResource = new EventOrchestrationIntegration("eventOrchestrationIntegrationResource", EventOrchestrationIntegrationArgs.builder()
        .eventOrchestration("string")
        .label("string")
        .build());
    
    event_orchestration_integration_resource = pagerduty.EventOrchestrationIntegration("eventOrchestrationIntegrationResource",
        event_orchestration="string",
        label="string")
    
    const eventOrchestrationIntegrationResource = new pagerduty.EventOrchestrationIntegration("eventOrchestrationIntegrationResource", {
        eventOrchestration: "string",
        label: "string",
    });
    
    type: pagerduty:EventOrchestrationIntegration
    properties:
        eventOrchestration: string
        label: string
    

    EventOrchestrationIntegration 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 EventOrchestrationIntegration resource accepts the following input properties:

    EventOrchestration string
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    Label string
    Name/description of the Integration.
    EventOrchestration string
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    Label string
    Name/description of the Integration.
    eventOrchestration String
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    label String
    Name/description of the Integration.
    eventOrchestration string
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    label string
    Name/description of the Integration.
    event_orchestration str
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    label str
    Name/description of the Integration.
    eventOrchestration String
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    label String
    Name/description of the Integration.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Parameters List<EventOrchestrationIntegrationParameter>
    Id string
    The provider-assigned unique ID for this managed resource.
    Parameters []EventOrchestrationIntegrationParameter
    id String
    The provider-assigned unique ID for this managed resource.
    parameters List<EventOrchestrationIntegrationParameter>
    id string
    The provider-assigned unique ID for this managed resource.
    parameters EventOrchestrationIntegrationParameter[]
    id str
    The provider-assigned unique ID for this managed resource.
    parameters Sequence[EventOrchestrationIntegrationParameter]
    id String
    The provider-assigned unique ID for this managed resource.
    parameters List<Property Map>

    Look up Existing EventOrchestrationIntegration Resource

    Get an existing EventOrchestrationIntegration 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?: EventOrchestrationIntegrationState, opts?: CustomResourceOptions): EventOrchestrationIntegration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            event_orchestration: Optional[str] = None,
            label: Optional[str] = None,
            parameters: Optional[Sequence[EventOrchestrationIntegrationParameterArgs]] = None) -> EventOrchestrationIntegration
    func GetEventOrchestrationIntegration(ctx *Context, name string, id IDInput, state *EventOrchestrationIntegrationState, opts ...ResourceOption) (*EventOrchestrationIntegration, error)
    public static EventOrchestrationIntegration Get(string name, Input<string> id, EventOrchestrationIntegrationState? state, CustomResourceOptions? opts = null)
    public static EventOrchestrationIntegration get(String name, Output<String> id, EventOrchestrationIntegrationState 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:
    EventOrchestration string
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    Label string
    Name/description of the Integration.
    Parameters List<EventOrchestrationIntegrationParameter>
    EventOrchestration string
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    Label string
    Name/description of the Integration.
    Parameters []EventOrchestrationIntegrationParameterArgs
    eventOrchestration String
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    label String
    Name/description of the Integration.
    parameters List<EventOrchestrationIntegrationParameter>
    eventOrchestration string
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    label string
    Name/description of the Integration.
    parameters EventOrchestrationIntegrationParameter[]
    event_orchestration str
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    label str
    Name/description of the Integration.
    parameters Sequence[EventOrchestrationIntegrationParameterArgs]
    eventOrchestration String
    ID of the Event Orchestration to which this Integration belongs to. If value is changed, current Integration is associated with a newly provided ID.
    label String
    Name/description of the Integration.
    parameters List<Property Map>

    Supporting Types

    EventOrchestrationIntegrationParameter, EventOrchestrationIntegrationParameterArgs

    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

    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.

    $ pulumi import pagerduty:index/eventOrchestrationIntegration:EventOrchestrationIntegration integration 19acac92-027a-4ea0-b06c-bbf516519601:1b49abe7-26db-4439-a715-c6d883acfb3e
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    PagerDuty pulumi/pulumi-pagerduty
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pagerduty Terraform Provider.
    pagerduty logo
    PagerDuty v4.13.2 published on Thursday, Jun 27, 2024 by Pulumi