Welcome to Pulumi Registry, your window into the cloud. Read the announcement.
Pulumi Registry
← All packages

Opsgenie

v1.1.0 published on Thursday, Nov 11, 2021 by Pulumi
Source code
  1. Opsgenie
  2. IntegrationAction

IntegrationAction

Manages advanced actions for Integrations within Opsgenie. This applies for the following resources:

  • opsgenie.ApiIntegration
  • opsgenie.EmailIntegration

The actions that are supported are:

  • create
  • close
  • acknowledge
  • add_note
  • ignore

Example Usage

using Pulumi;
using Opsgenie = Pulumi.Opsgenie;

class MyStack : Stack
{
    public MyStack()
    {
        var testAction = new Opsgenie.IntegrationAction("testAction", new Opsgenie.IntegrationActionArgs
        {
            IntegrationId = opsgenie_api_integration.Test.Id,
            Creates = 
            {
                new Opsgenie.Inputs.IntegrationActionCreateArgs
                {
                    Name = "create action",
                    Tags = 
                    {
                        "CRITICAL",
                        "SEV-0",
                    },
                    User = "Example-service",
                    Note = "{{note}}",
                    Alias = "{{alias}}",
                    Source = "{{source}}",
                    Message = "{{message}}",
                    Description = "{{description}}",
                    Entity = "{{entity}}",
                    AlertActions = 
                    {
                        "Runbook ID#342",
                    },
                    Filters = 
                    {
                        new Opsgenie.Inputs.IntegrationActionCreateFilterArgs
                        {
                            Type = "match-all-conditions",
                            Conditions = 
                            {
                                new Opsgenie.Inputs.IntegrationActionCreateFilterConditionArgs
                                {
                                    Field = "priority",
                                    Operation = "equals",
                                    ExpectedValue = "P1",
                                },
                            },
                        },
                    },
                    Responders = 
                    {
                        new Opsgenie.Inputs.IntegrationActionCreateResponderArgs
                        {
                            Id = opsgenie_team.Test.Id,
                            Type = "team",
                        },
                    },
                },
                new Opsgenie.Inputs.IntegrationActionCreateArgs
                {
                    Name = "Create medium priority alerts",
                    Tags = 
                    {
                        "SEVERE",
                        "SEV-1",
                    },
                    Priority = "P3",
                    Filters = 
                    {
                        new Opsgenie.Inputs.IntegrationActionCreateFilterArgs
                        {
                            Type = "match-all-conditions",
                            Conditions = 
                            {
                                new Opsgenie.Inputs.IntegrationActionCreateFilterConditionArgs
                                {
                                    Field = "priority",
                                    Operation = "equals",
                                    ExpectedValue = "P2",
                                },
                            },
                        },
                    },
                },
                new Opsgenie.Inputs.IntegrationActionCreateArgs
                {
                    Name = "Create alert with priority from message",
                    CustomPriority = "{{message.substringAfter(\"[custom]\")}}",
                    Filters = 
                    {
                        new Opsgenie.Inputs.IntegrationActionCreateFilterArgs
                        {
                            Type = "match-all-conditions",
                            Conditions = 
                            {
                                new Opsgenie.Inputs.IntegrationActionCreateFilterConditionArgs
                                {
                                    Field = "tags",
                                    Operation = "contains",
                                    ExpectedValue = "P5",
                                },
                                new Opsgenie.Inputs.IntegrationActionCreateFilterConditionArgs
                                {
                                    Field = "message",
                                    Operation = "Starts With",
                                    ExpectedValue = "[custom]",
                                },
                            },
                        },
                    },
                },
            },
            Closes = 
            {
                new Opsgenie.Inputs.IntegrationActionCloseArgs
                {
                    Name = "Low priority alerts",
                    Filters = 
                    {
                        new Opsgenie.Inputs.IntegrationActionCloseFilterArgs
                        {
                            Type = "match-any-condition",
                            Conditions = 
                            {
                                new Opsgenie.Inputs.IntegrationActionCloseFilterConditionArgs
                                {
                                    Field = "priority",
                                    Operation = "equals",
                                    ExpectedValue = "P5",
                                },
                                new Opsgenie.Inputs.IntegrationActionCloseFilterConditionArgs
                                {
                                    Field = "message",
                                    Operation = "contains",
                                    ExpectedValue = "DEBUG",
                                },
                            },
                        },
                    },
                },
            },
            Acknowledges = 
            {
                new Opsgenie.Inputs.IntegrationActionAcknowledgeArgs
                {
                    Name = "Auto-ack test alerts",
                    Filters = 
                    {
                        new Opsgenie.Inputs.IntegrationActionAcknowledgeFilterArgs
                        {
                            Type = "match-all-conditions",
                            Conditions = 
                            {
                                new Opsgenie.Inputs.IntegrationActionAcknowledgeFilterConditionArgs
                                {
                                    Field = "message",
                                    Operation = "contains",
                                    ExpectedValue = "TEST",
                                },
                                new Opsgenie.Inputs.IntegrationActionAcknowledgeFilterConditionArgs
                                {
                                    Field = "priority",
                                    Operation = "equals",
                                    ExpectedValue = "P5",
                                },
                            },
                        },
                    },
                },
            },
            AddNotes = 
            {
                new Opsgenie.Inputs.IntegrationActionAddNoteArgs
                {
                    Name = "Add note to all alerts",
                    Note = "Created from test integration",
                    Filters = 
                    {
                        new Opsgenie.Inputs.IntegrationActionAddNoteFilterArgs
                        {
                            Type = "match-all",
                        },
                    },
                },
            },
            Ignores = 
            {
                new Opsgenie.Inputs.IntegrationActionIgnoreArgs
                {
                    Name = "Ignore alerts with ignore tag",
                    Filters = 
                    {
                        new Opsgenie.Inputs.IntegrationActionIgnoreFilterArgs
                        {
                            Type = "match-all-conditions",
                            Conditions = 
                            {
                                new Opsgenie.Inputs.IntegrationActionIgnoreFilterConditionArgs
                                {
                                    Field = "tags",
                                    Operation = "contains",
                                    ExpectedValue = "ignore",
                                },
                            },
                        },
                    },
                },
            },
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opsgenie.NewIntegrationAction(ctx, "testAction", &opsgenie.IntegrationActionArgs{
			IntegrationId: pulumi.Any(opsgenie_api_integration.Test.Id),
			Creates: IntegrationActionCreateArray{
				&IntegrationActionCreateArgs{
					Name: pulumi.String("create action"),
					Tags: pulumi.StringArray{
						pulumi.String("CRITICAL"),
						pulumi.String("SEV-0"),
					},
					User:        pulumi.String("Example-service"),
					Note:        pulumi.String("{{note}}"),
					Alias:       pulumi.String("{{alias}}"),
					Source:      pulumi.String("{{source}}"),
					Message:     pulumi.String("{{message}}"),
					Description: pulumi.String("{{description}}"),
					Entity:      pulumi.String("{{entity}}"),
					AlertActions: pulumi.StringArray{
						pulumi.String("Runbook ID#342"),
					},
					Filters: IntegrationActionCreateFilterArray{
						&IntegrationActionCreateFilterArgs{
							Type: pulumi.String("match-all-conditions"),
							Conditions: IntegrationActionCreateFilterConditionArray{
								&IntegrationActionCreateFilterConditionArgs{
									Field:         pulumi.String("priority"),
									Operation:     pulumi.String("equals"),
									ExpectedValue: pulumi.String("P1"),
								},
							},
						},
					},
					Responders: IntegrationActionCreateResponderArray{
						&IntegrationActionCreateResponderArgs{
							Id:   pulumi.Any(opsgenie_team.Test.Id),
							Type: pulumi.String("team"),
						},
					},
				},
				&IntegrationActionCreateArgs{
					Name: pulumi.String("Create medium priority alerts"),
					Tags: pulumi.StringArray{
						pulumi.String("SEVERE"),
						pulumi.String("SEV-1"),
					},
					Priority: pulumi.String("P3"),
					Filters: IntegrationActionCreateFilterArray{
						&IntegrationActionCreateFilterArgs{
							Type: pulumi.String("match-all-conditions"),
							Conditions: IntegrationActionCreateFilterConditionArray{
								&IntegrationActionCreateFilterConditionArgs{
									Field:         pulumi.String("priority"),
									Operation:     pulumi.String("equals"),
									ExpectedValue: pulumi.String("P2"),
								},
							},
						},
					},
				},
				&IntegrationActionCreateArgs{
					Name:           pulumi.String("Create alert with priority from message"),
					CustomPriority: pulumi.String("{{message.substringAfter(\"[custom]\")}}"),
					Filters: IntegrationActionCreateFilterArray{
						&IntegrationActionCreateFilterArgs{
							Type: pulumi.String("match-all-conditions"),
							Conditions: IntegrationActionCreateFilterConditionArray{
								&IntegrationActionCreateFilterConditionArgs{
									Field:         pulumi.String("tags"),
									Operation:     pulumi.String("contains"),
									ExpectedValue: pulumi.String("P5"),
								},
								&IntegrationActionCreateFilterConditionArgs{
									Field:         pulumi.String("message"),
									Operation:     pulumi.String("Starts With"),
									ExpectedValue: pulumi.String("[custom]"),
								},
							},
						},
					},
				},
			},
			Closes: IntegrationActionCloseArray{
				&IntegrationActionCloseArgs{
					Name: pulumi.String("Low priority alerts"),
					Filters: IntegrationActionCloseFilterArray{
						&IntegrationActionCloseFilterArgs{
							Type: pulumi.String("match-any-condition"),
							Conditions: IntegrationActionCloseFilterConditionArray{
								&IntegrationActionCloseFilterConditionArgs{
									Field:         pulumi.String("priority"),
									Operation:     pulumi.String("equals"),
									ExpectedValue: pulumi.String("P5"),
								},
								&IntegrationActionCloseFilterConditionArgs{
									Field:         pulumi.String("message"),
									Operation:     pulumi.String("contains"),
									ExpectedValue: pulumi.String("DEBUG"),
								},
							},
						},
					},
				},
			},
			Acknowledges: IntegrationActionAcknowledgeArray{
				&IntegrationActionAcknowledgeArgs{
					Name: pulumi.String("Auto-ack test alerts"),
					Filters: IntegrationActionAcknowledgeFilterArray{
						&IntegrationActionAcknowledgeFilterArgs{
							Type: pulumi.String("match-all-conditions"),
							Conditions: IntegrationActionAcknowledgeFilterConditionArray{
								&IntegrationActionAcknowledgeFilterConditionArgs{
									Field:         pulumi.String("message"),
									Operation:     pulumi.String("contains"),
									ExpectedValue: pulumi.String("TEST"),
								},
								&IntegrationActionAcknowledgeFilterConditionArgs{
									Field:         pulumi.String("priority"),
									Operation:     pulumi.String("equals"),
									ExpectedValue: pulumi.String("P5"),
								},
							},
						},
					},
				},
			},
			AddNotes: IntegrationActionAddNoteArray{
				&IntegrationActionAddNoteArgs{
					Name: pulumi.String("Add note to all alerts"),
					Note: pulumi.String("Created from test integration"),
					Filters: IntegrationActionAddNoteFilterArray{
						&IntegrationActionAddNoteFilterArgs{
							Type: pulumi.String("match-all"),
						},
					},
				},
			},
			Ignores: IntegrationActionIgnoreArray{
				&IntegrationActionIgnoreArgs{
					Name: pulumi.String("Ignore alerts with ignore tag"),
					Filters: IntegrationActionIgnoreFilterArray{
						&IntegrationActionIgnoreFilterArgs{
							Type: pulumi.String("match-all-conditions"),
							Conditions: IntegrationActionIgnoreFilterConditionArray{
								&IntegrationActionIgnoreFilterConditionArgs{
									Field:         pulumi.String("tags"),
									Operation:     pulumi.String("contains"),
									ExpectedValue: pulumi.String("ignore"),
								},
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

import pulumi
import pulumi_opsgenie as opsgenie

test_action = opsgenie.IntegrationAction("testAction",
    integration_id=opsgenie_api_integration["test"]["id"],
    creates=[
        opsgenie.IntegrationActionCreateArgs(
            name="create action",
            tags=[
                "CRITICAL",
                "SEV-0",
            ],
            user="Example-service",
            note="{{note}}",
            alias="{{alias}}",
            source="{{source}}",
            message="{{message}}",
            description="{{description}}",
            entity="{{entity}}",
            alert_actions=["Runbook ID#342"],
            filters=[opsgenie.IntegrationActionCreateFilterArgs(
                type="match-all-conditions",
                conditions=[opsgenie.IntegrationActionCreateFilterConditionArgs(
                    field="priority",
                    operation="equals",
                    expected_value="P1",
                )],
            )],
            responders=[opsgenie.IntegrationActionCreateResponderArgs(
                id=opsgenie_team["test"]["id"],
                type="team",
            )],
        ),
        opsgenie.IntegrationActionCreateArgs(
            name="Create medium priority alerts",
            tags=[
                "SEVERE",
                "SEV-1",
            ],
            priority="P3",
            filters=[opsgenie.IntegrationActionCreateFilterArgs(
                type="match-all-conditions",
                conditions=[opsgenie.IntegrationActionCreateFilterConditionArgs(
                    field="priority",
                    operation="equals",
                    expected_value="P2",
                )],
            )],
        ),
        opsgenie.IntegrationActionCreateArgs(
            name="Create alert with priority from message",
            custom_priority="{{message.substringAfter(\"[custom]\")}}",
            filters=[opsgenie.IntegrationActionCreateFilterArgs(
                type="match-all-conditions",
                conditions=[
                    opsgenie.IntegrationActionCreateFilterConditionArgs(
                        field="tags",
                        operation="contains",
                        expected_value="P5",
                    ),
                    opsgenie.IntegrationActionCreateFilterConditionArgs(
                        field="message",
                        operation="Starts With",
                        expected_value="[custom]",
                    ),
                ],
            )],
        ),
    ],
    closes=[opsgenie.IntegrationActionCloseArgs(
        name="Low priority alerts",
        filters=[opsgenie.IntegrationActionCloseFilterArgs(
            type="match-any-condition",
            conditions=[
                opsgenie.IntegrationActionCloseFilterConditionArgs(
                    field="priority",
                    operation="equals",
                    expected_value="P5",
                ),
                opsgenie.IntegrationActionCloseFilterConditionArgs(
                    field="message",
                    operation="contains",
                    expected_value="DEBUG",
                ),
            ],
        )],
    )],
    acknowledges=[opsgenie.IntegrationActionAcknowledgeArgs(
        name="Auto-ack test alerts",
        filters=[opsgenie.IntegrationActionAcknowledgeFilterArgs(
            type="match-all-conditions",
            conditions=[
                opsgenie.IntegrationActionAcknowledgeFilterConditionArgs(
                    field="message",
                    operation="contains",
                    expected_value="TEST",
                ),
                opsgenie.IntegrationActionAcknowledgeFilterConditionArgs(
                    field="priority",
                    operation="equals",
                    expected_value="P5",
                ),
            ],
        )],
    )],
    add_notes=[opsgenie.IntegrationActionAddNoteArgs(
        name="Add note to all alerts",
        note="Created from test integration",
        filters=[opsgenie.IntegrationActionAddNoteFilterArgs(
            type="match-all",
        )],
    )],
    ignores=[opsgenie.IntegrationActionIgnoreArgs(
        name="Ignore alerts with ignore tag",
        filters=[opsgenie.IntegrationActionIgnoreFilterArgs(
            type="match-all-conditions",
            conditions=[opsgenie.IntegrationActionIgnoreFilterConditionArgs(
                field="tags",
                operation="contains",
                expected_value="ignore",
            )],
        )],
    )])

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

const testAction = new opsgenie.IntegrationAction("testAction", {
    integrationId: opsgenie_api_integration.test.id,
    creates: [
        {
            name: "create action",
            tags: [
                "CRITICAL",
                "SEV-0",
            ],
            user: "Example-service",
            note: "{{note}}",
            alias: "{{alias}}",
            source: "{{source}}",
            message: "{{message}}",
            description: "{{description}}",
            entity: "{{entity}}",
            alertActions: ["Runbook ID#342"],
            filters: [{
                type: "match-all-conditions",
                conditions: [{
                    field: "priority",
                    operation: "equals",
                    expectedValue: "P1",
                }],
            }],
            responders: [{
                id: opsgenie_team.test.id,
                type: "team",
            }],
        },
        {
            name: "Create medium priority alerts",
            tags: [
                "SEVERE",
                "SEV-1",
            ],
            priority: "P3",
            filters: [{
                type: "match-all-conditions",
                conditions: [{
                    field: "priority",
                    operation: "equals",
                    expectedValue: "P2",
                }],
            }],
        },
        {
            name: "Create alert with priority from message",
            customPriority: "{{message.substringAfter(\"[custom]\")}}",
            filters: [{
                type: "match-all-conditions",
                conditions: [
                    {
                        field: "tags",
                        operation: "contains",
                        expectedValue: "P5",
                    },
                    {
                        field: "message",
                        operation: "Starts With",
                        expectedValue: "[custom]",
                    },
                ],
            }],
        },
    ],
    closes: [{
        name: "Low priority alerts",
        filters: [{
            type: "match-any-condition",
            conditions: [
                {
                    field: "priority",
                    operation: "equals",
                    expectedValue: "P5",
                },
                {
                    field: "message",
                    operation: "contains",
                    expectedValue: "DEBUG",
                },
            ],
        }],
    }],
    acknowledges: [{
        name: "Auto-ack test alerts",
        filters: [{
            type: "match-all-conditions",
            conditions: [
                {
                    field: "message",
                    operation: "contains",
                    expectedValue: "TEST",
                },
                {
                    field: "priority",
                    operation: "equals",
                    expectedValue: "P5",
                },
            ],
        }],
    }],
    addNotes: [{
        name: "Add note to all alerts",
        note: "Created from test integration",
        filters: [{
            type: "match-all",
        }],
    }],
    ignores: [{
        name: "Ignore alerts with ignore tag",
        filters: [{
            type: "match-all-conditions",
            conditions: [{
                field: "tags",
                operation: "contains",
                expectedValue: "ignore",
            }],
        }],
    }],
});

Create a IntegrationAction Resource

new IntegrationAction(name: string, args: IntegrationActionArgs, opts?: CustomResourceOptions);
@overload
def IntegrationAction(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      acknowledges: Optional[Sequence[IntegrationActionAcknowledgeArgs]] = None,
                      add_notes: Optional[Sequence[IntegrationActionAddNoteArgs]] = None,
                      closes: Optional[Sequence[IntegrationActionCloseArgs]] = None,
                      creates: Optional[Sequence[IntegrationActionCreateArgs]] = None,
                      ignores: Optional[Sequence[IntegrationActionIgnoreArgs]] = None,
                      integration_id: Optional[str] = None)
@overload
def IntegrationAction(resource_name: str,
                      args: IntegrationActionArgs,
                      opts: Optional[ResourceOptions] = None)
func NewIntegrationAction(ctx *Context, name string, args IntegrationActionArgs, opts ...ResourceOption) (*IntegrationAction, error)
public IntegrationAction(string name, IntegrationActionArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args IntegrationActionArgs
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 IntegrationActionArgs
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 IntegrationActionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args IntegrationActionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing IntegrationAction Resource

Get an existing IntegrationAction 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?: IntegrationActionState, opts?: CustomResourceOptions): IntegrationAction
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acknowledges: Optional[Sequence[IntegrationActionAcknowledgeArgs]] = None,
        add_notes: Optional[Sequence[IntegrationActionAddNoteArgs]] = None,
        closes: Optional[Sequence[IntegrationActionCloseArgs]] = None,
        creates: Optional[Sequence[IntegrationActionCreateArgs]] = None,
        ignores: Optional[Sequence[IntegrationActionIgnoreArgs]] = None,
        integration_id: Optional[str] = None) -> IntegrationAction
func GetIntegrationAction(ctx *Context, name string, id IDInput, state *IntegrationActionState, opts ...ResourceOption) (*IntegrationAction, error)
public static IntegrationAction Get(string name, Input<string> id, IntegrationActionState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Supporting Types

IntegrationActionAcknowledge

Name string
Name of the integration action.
Alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
Filters List<IntegrationActionAcknowledgeFilter>

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
Note string
Additional alert action note.
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Type string
The responder type - can be escalation, team or user.
User string
Owner of the execution for integration action.
Name string
Name of the integration action.
Alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
Filters []IntegrationActionAcknowledgeFilter

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
Note string
Additional alert action note.
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Type string
The responder type - can be escalation, team or user.
User string
Owner of the execution for integration action.
name string
Name of the integration action.
alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
filters IntegrationActionAcknowledgeFilter[]

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
note string
Additional alert action note.
order number
Integer value that defines in which order the action will be performed. Default: 1.
type string
The responder type - can be escalation, team or user.
user string
Owner of the execution for integration action.
name str
Name of the integration action.
alias str
An identifier that is used for alert deduplication. Default: {{alias}}.
filters Sequence[IntegrationActionAcknowledgeFilter]

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
note str
Additional alert action note.
order int
Integer value that defines in which order the action will be performed. Default: 1.
type str
The responder type - can be escalation, team or user.
user str
Owner of the execution for integration action.

IntegrationActionAcknowledgeFilter

Type string
The responder type - can be escalation, team or user.
Conditions List<IntegrationActionAcknowledgeFilterCondition>
Type string
The responder type - can be escalation, team or user.
Conditions []IntegrationActionAcknowledgeFilterCondition
type string
The responder type - can be escalation, team or user.
conditions IntegrationActionAcknowledgeFilterCondition[]
type str
The responder type - can be escalation, team or user.
conditions Sequence[IntegrationActionAcknowledgeFilterCondition]

IntegrationActionAcknowledgeFilterCondition

Field string
Operation string
ExpectedValue string
Key string
Not bool
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Field string
Operation string
ExpectedValue string
Key string
Not bool
Order int
Integer value that defines in which order the action will be performed. Default: 1.
field string
operation string
expectedValue string
key string
not boolean
order number
Integer value that defines in which order the action will be performed. Default: 1.
field str
operation str
expected_value str
key str
not_ bool
order int
Integer value that defines in which order the action will be performed. Default: 1.

IntegrationActionAddNote

Name string
Name of the integration action.
Alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
Filters List<IntegrationActionAddNoteFilter>

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
Note string
Additional alert action note.
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Type string
The responder type - can be escalation, team or user.
User string
Owner of the execution for integration action.
Name string
Name of the integration action.
Alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
Filters []IntegrationActionAddNoteFilter

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
Note string
Additional alert action note.
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Type string
The responder type - can be escalation, team or user.
User string
Owner of the execution for integration action.
name string
Name of the integration action.
alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
filters IntegrationActionAddNoteFilter[]

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
note string
Additional alert action note.
order number
Integer value that defines in which order the action will be performed. Default: 1.
type string
The responder type - can be escalation, team or user.
user string
Owner of the execution for integration action.
name str
Name of the integration action.
alias str
An identifier that is used for alert deduplication. Default: {{alias}}.
filters Sequence[IntegrationActionAddNoteFilter]

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
note str
Additional alert action note.
order int
Integer value that defines in which order the action will be performed. Default: 1.
type str
The responder type - can be escalation, team or user.
user str
Owner of the execution for integration action.

IntegrationActionAddNoteFilter

Type string
The responder type - can be escalation, team or user.
Conditions List<IntegrationActionAddNoteFilterCondition>
Type string
The responder type - can be escalation, team or user.
Conditions []IntegrationActionAddNoteFilterCondition
type string
The responder type - can be escalation, team or user.
conditions IntegrationActionAddNoteFilterCondition[]
type str
The responder type - can be escalation, team or user.
conditions Sequence[IntegrationActionAddNoteFilterCondition]

IntegrationActionAddNoteFilterCondition

Field string
Operation string
ExpectedValue string
Key string
Not bool
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Field string
Operation string
ExpectedValue string
Key string
Not bool
Order int
Integer value that defines in which order the action will be performed. Default: 1.
field string
operation string
expectedValue string
key string
not boolean
order number
Integer value that defines in which order the action will be performed. Default: 1.
field str
operation str
expected_value str
key str
not_ bool
order int
Integer value that defines in which order the action will be performed. Default: 1.

IntegrationActionClose

Name string
Name of the integration action.
Alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
Filters List<IntegrationActionCloseFilter>

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
Note string
Additional alert action note.
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Type string
The responder type - can be escalation, team or user.
User string
Owner of the execution for integration action.
Name string
Name of the integration action.
Alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
Filters []IntegrationActionCloseFilter

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
Note string
Additional alert action note.
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Type string
The responder type - can be escalation, team or user.
User string
Owner of the execution for integration action.
name string
Name of the integration action.
alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
filters IntegrationActionCloseFilter[]

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
note string
Additional alert action note.
order number
Integer value that defines in which order the action will be performed. Default: 1.
type string
The responder type - can be escalation, team or user.
user string
Owner of the execution for integration action.
name str
Name of the integration action.
alias str
An identifier that is used for alert deduplication. Default: {{alias}}.
filters Sequence[IntegrationActionCloseFilter]

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
note str
Additional alert action note.
order int
Integer value that defines in which order the action will be performed. Default: 1.
type str
The responder type - can be escalation, team or user.
user str
Owner of the execution for integration action.

IntegrationActionCloseFilter

Type string
The responder type - can be escalation, team or user.
Conditions List<IntegrationActionCloseFilterCondition>
Type string
The responder type - can be escalation, team or user.
Conditions []IntegrationActionCloseFilterCondition
type string
The responder type - can be escalation, team or user.
conditions IntegrationActionCloseFilterCondition[]
type str
The responder type - can be escalation, team or user.
conditions Sequence[IntegrationActionCloseFilterCondition]

IntegrationActionCloseFilterCondition

Field string
Operation string
ExpectedValue string
Key string
Not bool
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Field string
Operation string
ExpectedValue string
Key string
Not bool
Order int
Integer value that defines in which order the action will be performed. Default: 1.
field string
operation string
expectedValue string
key string
not boolean
order number
Integer value that defines in which order the action will be performed. Default: 1.
field str
operation str
expected_value str
key str
not_ bool
order int
Integer value that defines in which order the action will be performed. Default: 1.

IntegrationActionCreate

Name string
Name of the integration action.
AlertActions List<string>
Alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
AppendAttachments bool
CustomPriority string
Custom alert priority. e.g. {{message.substring(0,2)}}
Description string
Detailed description of the alert, anything that may not have fit in the message field.
Entity string
The entity the alert is related to.
ExtraProperties Dictionary<string, string>
Set of user defined properties specified as a map.
Filters List<IntegrationActionCreateFilter>

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
IgnoreAlertActionsFromPayload bool
IgnoreExtraPropertiesFromPayload bool
IgnoreRespondersFromPayload bool
If enabled, the integration will ignore responders sent in request payloads.
IgnoreTagsFromPayload bool
IgnoreTeamsFromPayload bool
If enabled, the integration will ignore teams sent in request payloads.
Message string
Alert text limited to 130 characters.
Note string
Additional alert action note.
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Priority string
Alert priority.
Responders List<IntegrationActionCreateResponder>
User, schedule, teams or escalation names to calculate which users will receive notifications of the alert.
Source string
User defined field to specify source of action.
Tags List<string>
Comma separated list of labels to be attached to the alert.
Type string
The responder type - can be escalation, team or user.
User string
Owner of the execution for integration action.
Name string
Name of the integration action.
AlertActions []string
Alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
AppendAttachments bool
CustomPriority string
Custom alert priority. e.g. {{message.substring(0,2)}}
Description string
Detailed description of the alert, anything that may not have fit in the message field.
Entity string
The entity the alert is related to.
ExtraProperties map[string]string
Set of user defined properties specified as a map.
Filters []IntegrationActionCreateFilter

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
IgnoreAlertActionsFromPayload bool
IgnoreExtraPropertiesFromPayload bool
IgnoreRespondersFromPayload bool
If enabled, the integration will ignore responders sent in request payloads.
IgnoreTagsFromPayload bool
IgnoreTeamsFromPayload bool
If enabled, the integration will ignore teams sent in request payloads.
Message string
Alert text limited to 130 characters.
Note string
Additional alert action note.
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Priority string
Alert priority.
Responders []IntegrationActionCreateResponder
User, schedule, teams or escalation names to calculate which users will receive notifications of the alert.
Source string
User defined field to specify source of action.
Tags []string
Comma separated list of labels to be attached to the alert.
Type string
The responder type - can be escalation, team or user.
User string
Owner of the execution for integration action.
name string
Name of the integration action.
alertActions string[]
alias string
An identifier that is used for alert deduplication. Default: {{alias}}.
appendAttachments boolean
customPriority string
Custom alert priority. e.g. {{message.substring(0,2)}}
description string
Detailed description of the alert, anything that may not have fit in the message field.
entity string
The entity the alert is related to.
extraProperties {[key: string]: string}
Set of user defined properties specified as a map.
filters IntegrationActionCreateFilter[]

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
ignoreAlertActionsFromPayload boolean
ignoreExtraPropertiesFromPayload boolean
ignoreRespondersFromPayload boolean
If enabled, the integration will ignore responders sent in request payloads.
ignoreTagsFromPayload boolean
ignoreTeamsFromPayload boolean
If enabled, the integration will ignore teams sent in request payloads.
message string
Alert text limited to 130 characters.
note string
Additional alert action note.
order number
Integer value that defines in which order the action will be performed. Default: 1.
priority string
Alert priority.
responders IntegrationActionCreateResponder[]
User, schedule, teams or escalation names to calculate which users will receive notifications of the alert.
source string
User defined field to specify source of action.
tags string[]
Comma separated list of labels to be attached to the alert.
type string
The responder type - can be escalation, team or user.
user string
Owner of the execution for integration action.
name str
Name of the integration action.
alert_actions Sequence[str]
alias str
An identifier that is used for alert deduplication. Default: {{alias}}.
append_attachments bool
custom_priority str
Custom alert priority. e.g. {{message.substring(0,2)}}
description str
Detailed description of the alert, anything that may not have fit in the message field.
entity str
The entity the alert is related to.
extra_properties Mapping[str, str]
Set of user defined properties specified as a map.
filters Sequence[IntegrationActionCreateFilter]

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
ignore_alert_actions_from_payload bool
ignore_extra_properties_from_payload bool
ignore_responders_from_payload bool
If enabled, the integration will ignore responders sent in request payloads.
ignore_tags_from_payload bool
ignore_teams_from_payload bool
If enabled, the integration will ignore teams sent in request payloads.
message str
Alert text limited to 130 characters.
note str
Additional alert action note.
order int
Integer value that defines in which order the action will be performed. Default: 1.
priority str
Alert priority.
responders Sequence[IntegrationActionCreateResponder]
User, schedule, teams or escalation names to calculate which users will receive notifications of the alert.
source str
User defined field to specify source of action.
tags Sequence[str]
Comma separated list of labels to be attached to the alert.
type str
The responder type - can be escalation, team or user.
user str
Owner of the execution for integration action.

IntegrationActionCreateFilter

Type string
The responder type - can be escalation, team or user.
Conditions List<IntegrationActionCreateFilterCondition>
Type string
The responder type - can be escalation, team or user.
Conditions []IntegrationActionCreateFilterCondition
type string
The responder type - can be escalation, team or user.
conditions IntegrationActionCreateFilterCondition[]
type str
The responder type - can be escalation, team or user.
conditions Sequence[IntegrationActionCreateFilterCondition]

IntegrationActionCreateFilterCondition

Field string
Operation string
ExpectedValue string
Key string
Not bool
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Field string
Operation string
ExpectedValue string
Key string
Not bool
Order int
Integer value that defines in which order the action will be performed. Default: 1.
field string
operation string
expectedValue string
key string
not boolean
order number
Integer value that defines in which order the action will be performed. Default: 1.
field str
operation str
expected_value str
key str
not_ bool
order int
Integer value that defines in which order the action will be performed. Default: 1.

IntegrationActionCreateResponder

Id string
The id of the responder.
Type string
The responder type - can be escalation, team or user.
Id string
The id of the responder.
Type string
The responder type - can be escalation, team or user.
id string
The id of the responder.
type string
The responder type - can be escalation, team or user.
id str
The id of the responder.
type str
The responder type - can be escalation, team or user.

IntegrationActionIgnore

Name string
Name of the integration action.
Filters List<IntegrationActionIgnoreFilter>

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Type string
The responder type - can be escalation, team or user.
Name string
Name of the integration action.
Filters []IntegrationActionIgnoreFilter

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Type string
The responder type - can be escalation, team or user.
name string
Name of the integration action.
filters IntegrationActionIgnoreFilter[]

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
order number
Integer value that defines in which order the action will be performed. Default: 1.
type string
The responder type - can be escalation, team or user.
name str
Name of the integration action.
filters Sequence[IntegrationActionIgnoreFilter]

Used to specify rules for matching alerts and the filter type. Please note that depending on the integration type the field names in the filter conditions are:

  • For SNS integration: actions, alias, entity, Message, recipients, responders, Subject, tags, teams, eventType, Timestamp, TopicArn.
  • For API integration: message, alias, description, source, entity, tags, actions, details, extra-properties, recipients, teams, priority, eventType.
  • For Email integration: from_address, from_name, conversationSubject, subject
order int
Integer value that defines in which order the action will be performed. Default: 1.
type str
The responder type - can be escalation, team or user.

IntegrationActionIgnoreFilter

Type string
The responder type - can be escalation, team or user.
Conditions List<IntegrationActionIgnoreFilterCondition>
Type string
The responder type - can be escalation, team or user.
Conditions []IntegrationActionIgnoreFilterCondition
type string
The responder type - can be escalation, team or user.
conditions IntegrationActionIgnoreFilterCondition[]
type str
The responder type - can be escalation, team or user.
conditions Sequence[IntegrationActionIgnoreFilterCondition]

IntegrationActionIgnoreFilterCondition

Field string
Operation string
ExpectedValue string
Key string
Not bool
Order int
Integer value that defines in which order the action will be performed. Default: 1.
Field string
Operation string
ExpectedValue string
Key string
Not bool
Order int
Integer value that defines in which order the action will be performed. Default: 1.
field string
operation string
expectedValue string
key string
not boolean
order number
Integer value that defines in which order the action will be performed. Default: 1.
field str
operation str
expected_value str
key str
not_ bool
order int
Integer value that defines in which order the action will be performed. Default: 1.

Package Details

Repository
https://github.com/pulumi/pulumi-opsgenie
License
Apache-2.0
Notes
This Pulumi package is based on the opsgenie Terraform Provider.