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

rootly.WorkflowTaskSendSms

Explore with Pulumi AI

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

    Manages workflow send_sms task.

    Example Usage

    using Pulumi;
    using Rootly = Pulumi.Rootly;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var sendSmsWorkflowIncident = new Rootly.WorkflowIncident("sendSmsWorkflowIncident", new Rootly.WorkflowIncidentArgs
            {
                Description = "Automatically send SMS to a specific teammate.",
                TriggerParams = new Rootly.Inputs.WorkflowIncidentTriggerParamsArgs
                {
                    Triggers = 
                    {
                        "incident_created",
                    },
                    IncidentStatuses = 
                    {
                        "started",
                    },
                    IncidentConditionStatus = "IS",
                },
                Enabled = true,
            });
            var sendSmsWorkflowTaskSendSms = new Rootly.WorkflowTaskSendSms("sendSmsWorkflowTaskSendSms", new Rootly.WorkflowTaskSendSmsArgs
            {
                WorkflowId = sendSmsWorkflowIncident.Id,
                SkipOnFailure = false,
                Enabled = true,
                TaskParams = new Rootly.Inputs.WorkflowTaskSendSmsTaskParamsArgs
                {
                    Name = "Send SMS",
                    Content = "We have an ongoing incident {{ incident.title }} of severity {{ incident.severity }} and your assistance is required.",
                    PhoneNumbers = 
                    {
                        "+11231231231",
                        "+11231231232",
                    },
                },
            });
        }
    
    }
    
    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 {
    		sendSmsWorkflowIncident, err := rootly.NewWorkflowIncident(ctx, "sendSmsWorkflowIncident", &rootly.WorkflowIncidentArgs{
    			Description: pulumi.String("Automatically send SMS to a specific teammate."),
    			TriggerParams: &WorkflowIncidentTriggerParamsArgs{
    				Triggers: pulumi.StringArray{
    					pulumi.String("incident_created"),
    				},
    				IncidentStatuses: pulumi.StringArray{
    					pulumi.String("started"),
    				},
    				IncidentConditionStatus: pulumi.String("IS"),
    			},
    			Enabled: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = rootly.NewWorkflowTaskSendSms(ctx, "sendSmsWorkflowTaskSendSms", &rootly.WorkflowTaskSendSmsArgs{
    			WorkflowId:    sendSmsWorkflowIncident.ID(),
    			SkipOnFailure: pulumi.Bool(false),
    			Enabled:       pulumi.Bool(true),
    			TaskParams: &WorkflowTaskSendSmsTaskParamsArgs{
    				Name:    pulumi.String("Send SMS"),
    				Content: pulumi.String("We have an ongoing incident {{ incident.title }} of severity {{ incident.severity }} and your assistance is required."),
    				PhoneNumbers: pulumi.StringArray{
    					pulumi.String("+11231231231"),
    					pulumi.String("+11231231232"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_rootly as rootly
    
    send_sms_workflow_incident = rootly.WorkflowIncident("sendSmsWorkflowIncident",
        description="Automatically send SMS to a specific teammate.",
        trigger_params=rootly.WorkflowIncidentTriggerParamsArgs(
            triggers=["incident_created"],
            incident_statuses=["started"],
            incident_condition_status="IS",
        ),
        enabled=True)
    send_sms_workflow_task_send_sms = rootly.WorkflowTaskSendSms("sendSmsWorkflowTaskSendSms",
        workflow_id=send_sms_workflow_incident.id,
        skip_on_failure=False,
        enabled=True,
        task_params=rootly.WorkflowTaskSendSmsTaskParamsArgs(
            name="Send SMS",
            content="We have an ongoing incident {{ incident.title }} of severity {{ incident.severity }} and your assistance is required.",
            phone_numbers=[
                "+11231231231",
                "+11231231232",
            ],
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as rootly from "@pulumi/rootly";
    
    const sendSmsWorkflowIncident = new rootly.WorkflowIncident("sendSmsWorkflowIncident", {
        description: "Automatically send SMS to a specific teammate.",
        triggerParams: {
            triggers: ["incident_created"],
            incidentStatuses: ["started"],
            incidentConditionStatus: "IS",
        },
        enabled: true,
    });
    const sendSmsWorkflowTaskSendSms = new rootly.WorkflowTaskSendSms("sendSmsWorkflowTaskSendSms", {
        workflowId: sendSmsWorkflowIncident.id,
        skipOnFailure: false,
        enabled: true,
        taskParams: {
            name: "Send SMS",
            content: "We have an ongoing incident {{ incident.title }} of severity {{ incident.severity }} and your assistance is required.",
            phoneNumbers: [
                "+11231231231",
                "+11231231232",
            ],
        },
    });
    

    Coming soon!

    Create WorkflowTaskSendSms Resource

    new WorkflowTaskSendSms(name: string, args: WorkflowTaskSendSmsArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskSendSms(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            enabled: Optional[bool] = None,
                            position: Optional[int] = None,
                            skip_on_failure: Optional[bool] = None,
                            task_params: Optional[WorkflowTaskSendSmsTaskParamsArgs] = None,
                            workflow_id: Optional[str] = None)
    @overload
    def WorkflowTaskSendSms(resource_name: str,
                            args: WorkflowTaskSendSmsArgs,
                            opts: Optional[ResourceOptions] = None)
    func NewWorkflowTaskSendSms(ctx *Context, name string, args WorkflowTaskSendSmsArgs, opts ...ResourceOption) (*WorkflowTaskSendSms, error)
    public WorkflowTaskSendSms(string name, WorkflowTaskSendSmsArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskSendSms(String name, WorkflowTaskSendSmsArgs args)
    public WorkflowTaskSendSms(String name, WorkflowTaskSendSmsArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskSendSms
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args WorkflowTaskSendSmsArgs
    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 WorkflowTaskSendSmsArgs
    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 WorkflowTaskSendSmsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskSendSmsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskSendSmsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    TaskParams WorkflowTaskSendSmsTaskParams

    The parameters for this workflow task.

    WorkflowId string

    The ID of the parent workflow

    Enabled bool

    Enable/disable this workflow task

    Position int

    The position of the workflow task (1 being top of list)

    SkipOnFailure bool

    Skip workflow task if any failures

    TaskParams WorkflowTaskSendSmsTaskParamsArgs

    The parameters for this workflow task.

    WorkflowId string

    The ID of the parent workflow

    Enabled bool

    Enable/disable this workflow task

    Position int

    The position of the workflow task (1 being top of list)

    SkipOnFailure bool

    Skip workflow task if any failures

    taskParams WorkflowTaskSendSmsTaskParams

    The parameters for this workflow task.

    workflowId String

    The ID of the parent workflow

    enabled Boolean

    Enable/disable this workflow task

    position Integer

    The position of the workflow task (1 being top of list)

    skipOnFailure Boolean

    Skip workflow task if any failures

    taskParams WorkflowTaskSendSmsTaskParams

    The parameters for this workflow task.

    workflowId string

    The ID of the parent workflow

    enabled boolean

    Enable/disable this workflow task

    position number

    The position of the workflow task (1 being top of list)

    skipOnFailure boolean

    Skip workflow task if any failures

    task_params WorkflowTaskSendSmsTaskParamsArgs

    The parameters for this workflow task.

    workflow_id str

    The ID of the parent workflow

    enabled bool

    Enable/disable this workflow task

    position int

    The position of the workflow task (1 being top of list)

    skip_on_failure bool

    Skip workflow task if any failures

    taskParams Property Map

    The parameters for this workflow task.

    workflowId String

    The ID of the parent workflow

    enabled Boolean

    Enable/disable this workflow task

    position Number

    The position of the workflow task (1 being top of list)

    skipOnFailure Boolean

    Skip workflow task if any failures

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkflowTaskSendSms 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 WorkflowTaskSendSms Resource

    Get an existing WorkflowTaskSendSms 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?: WorkflowTaskSendSmsState, opts?: CustomResourceOptions): WorkflowTaskSendSms
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            position: Optional[int] = None,
            skip_on_failure: Optional[bool] = None,
            task_params: Optional[WorkflowTaskSendSmsTaskParamsArgs] = None,
            workflow_id: Optional[str] = None) -> WorkflowTaskSendSms
    func GetWorkflowTaskSendSms(ctx *Context, name string, id IDInput, state *WorkflowTaskSendSmsState, opts ...ResourceOption) (*WorkflowTaskSendSms, error)
    public static WorkflowTaskSendSms Get(string name, Input<string> id, WorkflowTaskSendSmsState? state, CustomResourceOptions? opts = null)
    public static WorkflowTaskSendSms get(String name, Output<String> id, WorkflowTaskSendSmsState 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:
    Enabled bool

    Enable/disable this workflow task

    Position int

    The position of the workflow task (1 being top of list)

    SkipOnFailure bool

    Skip workflow task if any failures

    TaskParams WorkflowTaskSendSmsTaskParams

    The parameters for this workflow task.

    WorkflowId string

    The ID of the parent workflow

    Enabled bool

    Enable/disable this workflow task

    Position int

    The position of the workflow task (1 being top of list)

    SkipOnFailure bool

    Skip workflow task if any failures

    TaskParams WorkflowTaskSendSmsTaskParamsArgs

    The parameters for this workflow task.

    WorkflowId string

    The ID of the parent workflow

    enabled Boolean

    Enable/disable this workflow task

    position Integer

    The position of the workflow task (1 being top of list)

    skipOnFailure Boolean

    Skip workflow task if any failures

    taskParams WorkflowTaskSendSmsTaskParams

    The parameters for this workflow task.

    workflowId String

    The ID of the parent workflow

    enabled boolean

    Enable/disable this workflow task

    position number

    The position of the workflow task (1 being top of list)

    skipOnFailure boolean

    Skip workflow task if any failures

    taskParams WorkflowTaskSendSmsTaskParams

    The parameters for this workflow task.

    workflowId string

    The ID of the parent workflow

    enabled bool

    Enable/disable this workflow task

    position int

    The position of the workflow task (1 being top of list)

    skip_on_failure bool

    Skip workflow task if any failures

    task_params WorkflowTaskSendSmsTaskParamsArgs

    The parameters for this workflow task.

    workflow_id str

    The ID of the parent workflow

    enabled Boolean

    Enable/disable this workflow task

    position Number

    The position of the workflow task (1 being top of list)

    skipOnFailure Boolean

    Skip workflow task if any failures

    taskParams Property Map

    The parameters for this workflow task.

    workflowId String

    The ID of the parent workflow

    Supporting Types

    WorkflowTaskSendSmsTaskParams, WorkflowTaskSendSmsTaskParamsArgs

    Content string
    Name string
    PhoneNumbers List<string>
    TaskType string
    Content string
    Name string
    PhoneNumbers []string
    TaskType string
    content String
    name String
    phoneNumbers List<String>
    taskType String
    content string
    name string
    phoneNumbers string[]
    taskType string
    content str
    name str
    phone_numbers Sequence[str]
    task_type str
    content String
    name String
    phoneNumbers List<String>
    taskType String

    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