1. Packages
  2. Rootly
  3. API Docs
  4. WorkflowPulse
Rootly v1.0.1 published on Friday, Jun 2, 2023 by Rootly

rootly.WorkflowPulse

Explore with Pulumi AI

rootly logo
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.WorkflowPulse("my-workflow", new Rootly.WorkflowPulseArgs
            {
                Description = "This workflow will trigger when a pulse is created",
                Enabled = true,
                TriggerParams = new Rootly.Inputs.WorkflowPulseTriggerParamsArgs
                {
                    Triggers = 
                    {
                        "pulse_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.NewWorkflowPulse(ctx, "my-workflow", &rootly.WorkflowPulseArgs{
    			Description: pulumi.String("This workflow will trigger when a pulse is created"),
    			Enabled:     pulumi.Bool(true),
    			TriggerParams: &WorkflowPulseTriggerParamsArgs{
    				Triggers: pulumi.StringArray{
    					pulumi.String("pulse_created"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_rootly as rootly
    
    my_workflow = rootly.WorkflowPulse("my-workflow",
        description="This workflow will trigger when a pulse is created",
        enabled=True,
        trigger_params=rootly.WorkflowPulseTriggerParamsArgs(
            triggers=["pulse_created"],
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as rootly from "@pulumi/rootly";
    
    const my_workflow = new rootly.WorkflowPulse("my-workflow", {
        description: "This workflow will trigger when a pulse is created",
        enabled: true,
        triggerParams: {
            triggers: ["pulse_created"],
        },
    });
    

    Coming soon!

    Create WorkflowPulse Resource

    new WorkflowPulse(name: string, args?: WorkflowPulseArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowPulse(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[WorkflowPulseTriggerParamsArgs] = None,
                      wait: Optional[str] = None,
                      workflow_group_id: Optional[str] = None)
    @overload
    def WorkflowPulse(resource_name: str,
                      args: Optional[WorkflowPulseArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    func NewWorkflowPulse(ctx *Context, name string, args *WorkflowPulseArgs, opts ...ResourceOption) (*WorkflowPulse, error)
    public WorkflowPulse(string name, WorkflowPulseArgs? args = null, CustomResourceOptions? opts = null)
    public WorkflowPulse(String name, WorkflowPulseArgs args)
    public WorkflowPulse(String name, WorkflowPulseArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowPulse
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args WorkflowPulseArgs
    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 WorkflowPulseArgs
    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 WorkflowPulseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowPulseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowPulseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    WorkflowPulse 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 WorkflowPulse 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 WorkflowPulseTriggerParams
    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 WorkflowPulseTriggerParamsArgs
    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 WorkflowPulseTriggerParams
    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 WorkflowPulseTriggerParams
    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 WorkflowPulseTriggerParamsArgs
    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 WorkflowPulse 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 WorkflowPulse Resource

    Get an existing WorkflowPulse 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?: WorkflowPulseState, opts?: CustomResourceOptions): WorkflowPulse
    @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[WorkflowPulseTriggerParamsArgs] = None,
            wait: Optional[str] = None,
            workflow_group_id: Optional[str] = None) -> WorkflowPulse
    func GetWorkflowPulse(ctx *Context, name string, id IDInput, state *WorkflowPulseState, opts ...ResourceOption) (*WorkflowPulse, error)
    public static WorkflowPulse Get(string name, Input<string> id, WorkflowPulseState? state, CustomResourceOptions? opts = null)
    public static WorkflowPulse get(String name, Output<String> id, WorkflowPulseState 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 WorkflowPulseTriggerParams
    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 WorkflowPulseTriggerParamsArgs
    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 WorkflowPulseTriggerParams
    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 WorkflowPulseTriggerParams
    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 WorkflowPulseTriggerParamsArgs
    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.

    Supporting Types

    WorkflowPulseTriggerParams, WorkflowPulseTriggerParamsArgs

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the rootly Terraform Provider.

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