1. Packages
  2. Rootly
  3. API Docs
  4. WorkflowTaskSendWhatsappMessage
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly

rootly.WorkflowTaskSendWhatsappMessage

Explore with Pulumi AI

rootly logo
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly

    Manages workflow send_whatsapp_message task.

    Create WorkflowTaskSendWhatsappMessage Resource

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

    Constructor syntax

    new WorkflowTaskSendWhatsappMessage(name: string, args: WorkflowTaskSendWhatsappMessageArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskSendWhatsappMessage(resource_name: str,
                                        args: WorkflowTaskSendWhatsappMessageArgs,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowTaskSendWhatsappMessage(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        task_params: Optional[WorkflowTaskSendWhatsappMessageTaskParamsArgs] = None,
                                        workflow_id: Optional[str] = None,
                                        enabled: Optional[bool] = None,
                                        name: Optional[str] = None,
                                        position: Optional[int] = None,
                                        skip_on_failure: Optional[bool] = None)
    func NewWorkflowTaskSendWhatsappMessage(ctx *Context, name string, args WorkflowTaskSendWhatsappMessageArgs, opts ...ResourceOption) (*WorkflowTaskSendWhatsappMessage, error)
    public WorkflowTaskSendWhatsappMessage(string name, WorkflowTaskSendWhatsappMessageArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskSendWhatsappMessage(String name, WorkflowTaskSendWhatsappMessageArgs args)
    public WorkflowTaskSendWhatsappMessage(String name, WorkflowTaskSendWhatsappMessageArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskSendWhatsappMessage
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

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

    var workflowTaskSendWhatsappMessageResource = new Rootly.WorkflowTaskSendWhatsappMessage("workflowTaskSendWhatsappMessageResource", new()
    {
        TaskParams = new Rootly.Inputs.WorkflowTaskSendWhatsappMessageTaskParamsArgs
        {
            Content = "string",
            Name = "string",
            PhoneNumbers = new[]
            {
                "string",
            },
            TaskType = "string",
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskSendWhatsappMessage(ctx, "workflowTaskSendWhatsappMessageResource", &rootly.WorkflowTaskSendWhatsappMessageArgs{
    	TaskParams: &rootly.WorkflowTaskSendWhatsappMessageTaskParamsArgs{
    		Content: pulumi.String("string"),
    		Name:    pulumi.String("string"),
    		PhoneNumbers: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		TaskType: pulumi.String("string"),
    	},
    	WorkflowId:    pulumi.String("string"),
    	Enabled:       pulumi.Bool(false),
    	Name:          pulumi.String("string"),
    	Position:      pulumi.Int(0),
    	SkipOnFailure: pulumi.Bool(false),
    })
    
    var workflowTaskSendWhatsappMessageResource = new WorkflowTaskSendWhatsappMessage("workflowTaskSendWhatsappMessageResource", WorkflowTaskSendWhatsappMessageArgs.builder()
        .taskParams(WorkflowTaskSendWhatsappMessageTaskParamsArgs.builder()
            .content("string")
            .name("string")
            .phoneNumbers("string")
            .taskType("string")
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_send_whatsapp_message_resource = rootly.WorkflowTaskSendWhatsappMessage("workflowTaskSendWhatsappMessageResource",
        task_params={
            "content": "string",
            "name": "string",
            "phone_numbers": ["string"],
            "task_type": "string",
        },
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskSendWhatsappMessageResource = new rootly.WorkflowTaskSendWhatsappMessage("workflowTaskSendWhatsappMessageResource", {
        taskParams: {
            content: "string",
            name: "string",
            phoneNumbers: ["string"],
            taskType: "string",
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskSendWhatsappMessage
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            content: string
            name: string
            phoneNumbers:
                - string
            taskType: string
        workflowId: string
    

    WorkflowTaskSendWhatsappMessage Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkflowTaskSendWhatsappMessage resource accepts the following input properties:

    TaskParams WorkflowTaskSendWhatsappMessageTaskParams
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    The name
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskSendWhatsappMessageTaskParamsArgs
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    The name
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    taskParams WorkflowTaskSendWhatsappMessageTaskParams
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    The name
    position Integer
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskSendWhatsappMessageTaskParams
    The parameters for this workflow task.
    workflowId string
    The ID of the parent workflow
    enabled boolean
    Enable/disable this workflow task
    name string
    The name
    position number
    The position of the workflow task (1 being top of list)
    skipOnFailure boolean
    Skip workflow task if any failures
    task_params WorkflowTaskSendWhatsappMessageTaskParamsArgs
    The parameters for this workflow task.
    workflow_id str
    The ID of the parent workflow
    enabled bool
    Enable/disable this workflow task
    name str
    The name
    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
    name String
    The name
    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 WorkflowTaskSendWhatsappMessage 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 WorkflowTaskSendWhatsappMessage Resource

    Get an existing WorkflowTaskSendWhatsappMessage 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?: WorkflowTaskSendWhatsappMessageState, opts?: CustomResourceOptions): WorkflowTaskSendWhatsappMessage
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enabled: Optional[bool] = None,
            name: Optional[str] = None,
            position: Optional[int] = None,
            skip_on_failure: Optional[bool] = None,
            task_params: Optional[WorkflowTaskSendWhatsappMessageTaskParamsArgs] = None,
            workflow_id: Optional[str] = None) -> WorkflowTaskSendWhatsappMessage
    func GetWorkflowTaskSendWhatsappMessage(ctx *Context, name string, id IDInput, state *WorkflowTaskSendWhatsappMessageState, opts ...ResourceOption) (*WorkflowTaskSendWhatsappMessage, error)
    public static WorkflowTaskSendWhatsappMessage Get(string name, Input<string> id, WorkflowTaskSendWhatsappMessageState? state, CustomResourceOptions? opts = null)
    public static WorkflowTaskSendWhatsappMessage get(String name, Output<String> id, WorkflowTaskSendWhatsappMessageState 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
    Name string
    The name
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskSendWhatsappMessageTaskParams
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    Enabled bool
    Enable/disable this workflow task
    Name string
    The name
    Position int
    The position of the workflow task (1 being top of list)
    SkipOnFailure bool
    Skip workflow task if any failures
    TaskParams WorkflowTaskSendWhatsappMessageTaskParamsArgs
    The parameters for this workflow task.
    WorkflowId string
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    The name
    position Integer
    The position of the workflow task (1 being top of list)
    skipOnFailure Boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskSendWhatsappMessageTaskParams
    The parameters for this workflow task.
    workflowId String
    The ID of the parent workflow
    enabled boolean
    Enable/disable this workflow task
    name string
    The name
    position number
    The position of the workflow task (1 being top of list)
    skipOnFailure boolean
    Skip workflow task if any failures
    taskParams WorkflowTaskSendWhatsappMessageTaskParams
    The parameters for this workflow task.
    workflowId string
    The ID of the parent workflow
    enabled bool
    Enable/disable this workflow task
    name str
    The name
    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 WorkflowTaskSendWhatsappMessageTaskParamsArgs
    The parameters for this workflow task.
    workflow_id str
    The ID of the parent workflow
    enabled Boolean
    Enable/disable this workflow task
    name String
    The name
    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

    WorkflowTaskSendWhatsappMessageTaskParams, WorkflowTaskSendWhatsappMessageTaskParamsArgs

    Content string
    The WhatsApp message
    Name string
    The name
    PhoneNumbers List<string>
    TaskType string
    Content string
    The WhatsApp message
    Name string
    The name
    PhoneNumbers []string
    TaskType string
    content String
    The WhatsApp message
    name String
    The name
    phoneNumbers List<String>
    taskType String
    content string
    The WhatsApp message
    name string
    The name
    phoneNumbers string[]
    taskType string
    content str
    The WhatsApp message
    name str
    The name
    phone_numbers Sequence[str]
    task_type str
    content String
    The WhatsApp message
    name String
    The name
    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.5.0 published on Thursday, Apr 25, 2024 by Rootly