Rootly v1.0.1, Jun 2 23

Rootly v1.0.1 published on Friday, Jun 2, 2023 by Rootly

rootly.WorkflowAlert

Explore with Pulumi AI

Rootly v1.0.1 published on Friday, Jun 2, 2023 by Rootly

Example Usage

using Pulumi;
using Rootly = Pulumi.Rootly;

class MyStack : Stack
{
    public MyStack()
    {
        var my_workflow = new Rootly.WorkflowAlert("my-workflow", new Rootly.WorkflowAlertArgs
        {
            Description = "This workflow will trigger when an alert is created",
            Enabled = true,
            TriggerParams = new Rootly.Inputs.WorkflowAlertTriggerParamsArgs
            {
                Triggers = 
                {
                    "alert_created",
                },
            },
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rootly.NewWorkflowAlert(ctx, "my-workflow", &rootly.WorkflowAlertArgs{
			Description: pulumi.String("This workflow will trigger when an alert is created"),
			Enabled:     pulumi.Bool(true),
			TriggerParams: &WorkflowAlertTriggerParamsArgs{
				Triggers: pulumi.StringArray{
					pulumi.String("alert_created"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_rootly as rootly

my_workflow = rootly.WorkflowAlert("my-workflow",
    description="This workflow will trigger when an alert is created",
    enabled=True,
    trigger_params=rootly.WorkflowAlertTriggerParamsArgs(
        triggers=["alert_created"],
    ))

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

const my_workflow = new rootly.WorkflowAlert("my-workflow", {
    description: "This workflow will trigger when an alert is created",
    enabled: true,
    triggerParams: {
        triggers: ["alert_created"],
    },
});

Coming soon!

Create WorkflowAlert Resource

new WorkflowAlert(name: string, args?: WorkflowAlertArgs, opts?: CustomResourceOptions);

@overload
def WorkflowAlert(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  command: Optional[str] = None,
                  description: Optional[str] = None,
                  enabled: Optional[bool] = None,
                  environment_ids: Optional[Sequence[str]] = None,
                  group_ids: Optional[Sequence[str]] = None,
                  incident_role_ids: Optional[Sequence[str]] = None,
                  incident_type_ids: Optional[Sequence[str]] = None,
                  name: Optional[str] = None,
                  position: Optional[int] = None,
                  repeat_every_duration: Optional[str] = None,
                  repeat_ons: Optional[Sequence[str]] = None,
                  service_ids: Optional[Sequence[str]] = None,
                  severity_ids: Optional[Sequence[str]] = None,
                  slug: Optional[str] = None,
                  trigger_params: Optional[WorkflowAlertTriggerParamsArgs] = None,
                  wait: Optional[str] = None,
                  workflow_group_id: Optional[str] = None)
@overload
def WorkflowAlert(resource_name: str,
                  args: Optional[WorkflowAlertArgs] = None,
                  opts: Optional[ResourceOptions] = None)

func NewWorkflowAlert(ctx *Context, name string, args *WorkflowAlertArgs, opts ...ResourceOption) (*WorkflowAlert, error)

public WorkflowAlert(string name, WorkflowAlertArgs? args = null, CustomResourceOptions? opts = null)

public WorkflowAlert(String name, WorkflowAlertArgs args)
public WorkflowAlert(String name, WorkflowAlertArgs args, CustomResourceOptions options)

type: rootly:WorkflowAlert
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

name string: The unique name of the resource.
args WorkflowAlertArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WorkflowAlertArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Command string: Workflow command.
Description string: The description of the workflow
Enabled bool
EnvironmentIds List<string>
GroupIds List<string>
IncidentRoleIds List<string>
IncidentTypeIds List<string>
Name string: The title of the workflow
Position int: The order which the workflow should run with other workflows.
RepeatEveryDuration string: Repeat workflow every duration.
RepeatOns List<string>: Value must be one of S, M, T, W, R, F, U.
ServiceIds List<string>
SeverityIds List<string>
Slug string: The slug of the workflow
TriggerParams WorkflowAlertTriggerParams
Wait string: Wait this duration before executing.
WorkflowGroupId string: The group this workflow belongs to.

Command string: Workflow command.
Description string: The description of the workflow
Enabled bool
EnvironmentIds []string
GroupIds []string
IncidentRoleIds []string
IncidentTypeIds []string
Name string: The title of the workflow
Position int: The order which the workflow should run with other workflows.
RepeatEveryDuration string: Repeat workflow every duration.
RepeatOns []string: Value must be one of S, M, T, W, R, F, U.
ServiceIds []string
SeverityIds []string
Slug string: The slug of the workflow
TriggerParams WorkflowAlertTriggerParamsArgs
Wait string: Wait this duration before executing.
WorkflowGroupId string: The group this workflow belongs to.

command String: Workflow command.
description String: The description of the workflow
enabled Boolean
environmentIds List<String>
groupIds List<String>
incidentRoleIds List<String>
incidentTypeIds List<String>
name String: The title of the workflow
position Integer: The order which the workflow should run with other workflows.
repeatEveryDuration String: Repeat workflow every duration.
repeatOns List<String>: Value must be one of S, M, T, W, R, F, U.
serviceIds List<String>
severityIds List<String>
slug String: The slug of the workflow
triggerParams WorkflowAlertTriggerParams
wait_ String: Wait this duration before executing.
workflowGroupId String: The group this workflow belongs to.

command string: Workflow command.
description string: The description of the workflow
enabled boolean
environmentIds string[]
groupIds string[]
incidentRoleIds string[]
incidentTypeIds string[]
name string: The title of the workflow
position number: The order which the workflow should run with other workflows.
repeatEveryDuration string: Repeat workflow every duration.
repeatOns string[]: Value must be one of S, M, T, W, R, F, U.
serviceIds string[]
severityIds string[]
slug string: The slug of the workflow
triggerParams WorkflowAlertTriggerParams
wait string: Wait this duration before executing.
workflowGroupId string: The group this workflow belongs to.

command str: Workflow command.
description str: The description of the workflow
enabled bool
environment_ids Sequence[str]
group_ids Sequence[str]
incident_role_ids Sequence[str]
incident_type_ids Sequence[str]
name str: The title of the workflow
position int: The order which the workflow should run with other workflows.
repeat_every_duration str: Repeat workflow every duration.
repeat_ons Sequence[str]: Value must be one of S, M, T, W, R, F, U.
service_ids Sequence[str]
severity_ids Sequence[str]
slug str: The slug of the workflow
trigger_params WorkflowAlertTriggerParamsArgs
wait str: Wait this duration before executing.
workflow_group_id str: The group this workflow belongs to.

command String: Workflow command.
description String: The description of the workflow
enabled Boolean
environmentIds List<String>
groupIds List<String>
incidentRoleIds List<String>
incidentTypeIds List<String>
name String: The title of the workflow
position Number: The order which the workflow should run with other workflows.
repeatEveryDuration String: Repeat workflow every duration.
repeatOns List<String>: Value must be one of S, M, T, W, R, F, U.
serviceIds List<String>
severityIds List<String>
slug String: The slug of the workflow
triggerParams Property Map
wait String: Wait this duration before executing.
workflowGroupId String: The group this workflow belongs to.

Outputs

All input properties are implicitly available as output properties. Additionally, the WorkflowAlert 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 string: The provider-assigned unique ID for this managed resource.

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

id String: The provider-assigned unique ID for this managed resource.

Look up Existing WorkflowAlert Resource

Get an existing WorkflowAlert 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?: WorkflowAlertState, opts?: CustomResourceOptions): WorkflowAlert

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        command: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        environment_ids: Optional[Sequence[str]] = None,
        group_ids: Optional[Sequence[str]] = None,
        incident_role_ids: Optional[Sequence[str]] = None,
        incident_type_ids: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        position: Optional[int] = None,
        repeat_every_duration: Optional[str] = None,
        repeat_ons: Optional[Sequence[str]] = None,
        service_ids: Optional[Sequence[str]] = None,
        severity_ids: Optional[Sequence[str]] = None,
        slug: Optional[str] = None,
        trigger_params: Optional[WorkflowAlertTriggerParamsArgs] = None,
        wait: Optional[str] = None,
        workflow_group_id: Optional[str] = None) -> WorkflowAlert

func GetWorkflowAlert(ctx *Context, name string, id IDInput, state *WorkflowAlertState, opts ...ResourceOption) (*WorkflowAlert, error)

public static WorkflowAlert Get(string name, Input<string> id, WorkflowAlertState? state, CustomResourceOptions? opts = null)

public static WorkflowAlert get(String name, Output<String> id, WorkflowAlertState 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:

Command string: Workflow command.
Description string: The description of the workflow
Enabled bool
EnvironmentIds List<string>
GroupIds List<string>
IncidentRoleIds List<string>
IncidentTypeIds List<string>
Name string: The title of the workflow
Position int: The order which the workflow should run with other workflows.
RepeatEveryDuration string: Repeat workflow every duration.
RepeatOns List<string>: Value must be one of S, M, T, W, R, F, U.
ServiceIds List<string>
SeverityIds List<string>
Slug string: The slug of the workflow
TriggerParams WorkflowAlertTriggerParams
Wait string: Wait this duration before executing.
WorkflowGroupId string: The group this workflow belongs to.

Command string: Workflow command.
Description string: The description of the workflow
Enabled bool
EnvironmentIds []string
GroupIds []string
IncidentRoleIds []string
IncidentTypeIds []string
Name string: The title of the workflow
Position int: The order which the workflow should run with other workflows.
RepeatEveryDuration string: Repeat workflow every duration.
RepeatOns []string: Value must be one of S, M, T, W, R, F, U.
ServiceIds []string
SeverityIds []string
Slug string: The slug of the workflow
TriggerParams WorkflowAlertTriggerParamsArgs
Wait string: Wait this duration before executing.
WorkflowGroupId string: The group this workflow belongs to.

command String: Workflow command.
description String: The description of the workflow
enabled Boolean
environmentIds List<String>
groupIds List<String>
incidentRoleIds List<String>
incidentTypeIds List<String>
name String: The title of the workflow
position Integer: The order which the workflow should run with other workflows.
repeatEveryDuration String: Repeat workflow every duration.
repeatOns List<String>: Value must be one of S, M, T, W, R, F, U.
serviceIds List<String>
severityIds List<String>
slug String: The slug of the workflow
triggerParams WorkflowAlertTriggerParams
wait_ String: Wait this duration before executing.
workflowGroupId String: The group this workflow belongs to.

command string: Workflow command.
description string: The description of the workflow
enabled boolean
environmentIds string[]
groupIds string[]
incidentRoleIds string[]
incidentTypeIds string[]
name string: The title of the workflow
position number: The order which the workflow should run with other workflows.
repeatEveryDuration string: Repeat workflow every duration.
repeatOns string[]: Value must be one of S, M, T, W, R, F, U.
serviceIds string[]
severityIds string[]
slug string: The slug of the workflow
triggerParams WorkflowAlertTriggerParams
wait string: Wait this duration before executing.
workflowGroupId string: The group this workflow belongs to.

command str: Workflow command.
description str: The description of the workflow
enabled bool
environment_ids Sequence[str]
group_ids Sequence[str]
incident_role_ids Sequence[str]
incident_type_ids Sequence[str]
name str: The title of the workflow
position int: The order which the workflow should run with other workflows.
repeat_every_duration str: Repeat workflow every duration.
repeat_ons Sequence[str]: Value must be one of S, M, T, W, R, F, U.
service_ids Sequence[str]
severity_ids Sequence[str]
slug str: The slug of the workflow
trigger_params WorkflowAlertTriggerParamsArgs
wait str: Wait this duration before executing.
workflow_group_id str: The group this workflow belongs to.

command String: Workflow command.
description String: The description of the workflow
enabled Boolean
environmentIds List<String>
groupIds List<String>
incidentRoleIds List<String>
incidentTypeIds List<String>
name String: The title of the workflow
position Number: The order which the workflow should run with other workflows.
repeatEveryDuration String: Repeat workflow every duration.
repeatOns List<String>: Value must be one of S, M, T, W, R, F, U.
serviceIds List<String>
severityIds List<String>
slug String: The slug of the workflow
triggerParams Property Map
wait String: Wait this duration before executing.
workflowGroupId String: The group this workflow belongs to.