Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rootly
  3. API Docs
  4. WorkflowTaskUpdateActionItem
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly

rootly.WorkflowTaskUpdateActionItem

Explore with Pulumi AI

rootly logo
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly

    Manages workflow update_action_item task.

    Create WorkflowTaskUpdateActionItem Resource

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

    Constructor syntax

    new WorkflowTaskUpdateActionItem(name: string, args: WorkflowTaskUpdateActionItemArgs, opts?: CustomResourceOptions);
    @overload
def WorkflowTaskUpdateActionItem(resource_name: str,
                                 args: WorkflowTaskUpdateActionItemArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def WorkflowTaskUpdateActionItem(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 task_params: Optional[WorkflowTaskUpdateActionItemTaskParamsArgs] = 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 NewWorkflowTaskUpdateActionItem(ctx *Context, name string, args WorkflowTaskUpdateActionItemArgs, opts ...ResourceOption) (*WorkflowTaskUpdateActionItem, error)
    public WorkflowTaskUpdateActionItem(string name, WorkflowTaskUpdateActionItemArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskUpdateActionItem(String name, WorkflowTaskUpdateActionItemArgs args)
public WorkflowTaskUpdateActionItem(String name, WorkflowTaskUpdateActionItemArgs args, CustomResourceOptions options)

    type: rootly:WorkflowTaskUpdateActionItem
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 WorkflowTaskUpdateActionItemArgs
    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 WorkflowTaskUpdateActionItemArgs
    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 WorkflowTaskUpdateActionItemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskUpdateActionItemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskUpdateActionItemArgs
    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 workflowTaskUpdateActionItemResource = new Rootly.WorkflowTaskUpdateActionItem("workflowTaskUpdateActionItemResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskUpdateActionItemTaskParamsArgs
    {
        AttributeToQueryBy = "string",
        QueryValue = "string",
        AssignedToUser = 
        {
            { "string", "any" },
        },
        AssignedToUserId = "string",
        CustomFieldsMapping = "string",
        Description = "string",
        GroupIds = new[]
        {
            "string",
        },
        PostToIncidentTimeline = false,
        Priority = "string",
        Status = "string",
        Summary = "string",
        TaskType = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});

    example, err := rootly.NewWorkflowTaskUpdateActionItem(ctx, "workflowTaskUpdateActionItemResource", &rootly.WorkflowTaskUpdateActionItemArgs{
	TaskParams: &rootly.WorkflowTaskUpdateActionItemTaskParamsArgs{
		AttributeToQueryBy: pulumi.String("string"),
		QueryValue:         pulumi.String("string"),
		AssignedToUser: pulumi.Map{
			"string": pulumi.Any("any"),
		},
		AssignedToUserId:    pulumi.String("string"),
		CustomFieldsMapping: pulumi.String("string"),
		Description:         pulumi.String("string"),
		GroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PostToIncidentTimeline: pulumi.Bool(false),
		Priority:               pulumi.String("string"),
		Status:                 pulumi.String("string"),
		Summary:                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 workflowTaskUpdateActionItemResource = new WorkflowTaskUpdateActionItem("workflowTaskUpdateActionItemResource", WorkflowTaskUpdateActionItemArgs.builder()
    .taskParams(WorkflowTaskUpdateActionItemTaskParamsArgs.builder()
        .attributeToQueryBy("string")
        .queryValue("string")
        .assignedToUser(Map.of("string", "any"))
        .assignedToUserId("string")
        .customFieldsMapping("string")
        .description("string")
        .groupIds("string")
        .postToIncidentTimeline(false)
        .priority("string")
        .status("string")
        .summary("string")
        .taskType("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());

    workflow_task_update_action_item_resource = rootly.WorkflowTaskUpdateActionItem("workflowTaskUpdateActionItemResource",
    task_params={
        "attribute_to_query_by": "string",
        "query_value": "string",
        "assigned_to_user": {
            "string": "any",
        },
        "assigned_to_user_id": "string",
        "custom_fields_mapping": "string",
        "description": "string",
        "group_ids": ["string"],
        "post_to_incident_timeline": False,
        "priority": "string",
        "status": "string",
        "summary": "string",
        "task_type": "string",
    },
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)

    const workflowTaskUpdateActionItemResource = new rootly.WorkflowTaskUpdateActionItem("workflowTaskUpdateActionItemResource", {
    taskParams: {
        attributeToQueryBy: "string",
        queryValue: "string",
        assignedToUser: {
            string: "any",
        },
        assignedToUserId: "string",
        customFieldsMapping: "string",
        description: "string",
        groupIds: ["string"],
        postToIncidentTimeline: false,
        priority: "string",
        status: "string",
        summary: "string",
        taskType: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});

    type: rootly:WorkflowTaskUpdateActionItem
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        assignedToUser:
            string: any
        assignedToUserId: string
        attributeToQueryBy: string
        customFieldsMapping: string
        description: string
        groupIds:
            - string
        postToIncidentTimeline: false
        priority: string
        queryValue: string
        status: string
        summary: string
        taskType: string
    workflowId: string

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

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

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

    WorkflowTaskUpdateActionItemTaskParams, WorkflowTaskUpdateActionItemTaskParamsArgs

    AttributeToQueryBy string
    Attribute of the action item to match against. Value must be one of id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    QueryValue string
    Value that attributetoquery_by to uses to match against
    AssignedToUser Dictionary<string, object>
    Map must contain two fields, id and name. The user this action item is assigned to
    AssignedToUserId string
    [DEPRECATED] Use assignedtouser attribute instead. The user id this action item is assigned to
    CustomFieldsMapping string
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    Description string
    The action item description
    GroupIds List<string>
    PostToIncidentTimeline bool
    Value must be one of true or false
    Priority string
    The action item priority. Value must be one of high, medium, low.
    Status string
    The action item status. Value must be one of open, in_progress, cancelled, done.
    Summary string
    Brief description of the action item
    TaskType string
    AttributeToQueryBy string
    Attribute of the action item to match against. Value must be one of id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    QueryValue string
    Value that attributetoquery_by to uses to match against
    AssignedToUser map[string]interface{}
    Map must contain two fields, id and name. The user this action item is assigned to
    AssignedToUserId string
    [DEPRECATED] Use assignedtouser attribute instead. The user id this action item is assigned to
    CustomFieldsMapping string
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    Description string
    The action item description
    GroupIds []string
    PostToIncidentTimeline bool
    Value must be one of true or false
    Priority string
    The action item priority. Value must be one of high, medium, low.
    Status string
    The action item status. Value must be one of open, in_progress, cancelled, done.
    Summary string
    Brief description of the action item
    TaskType string
    attributeToQueryBy String
    Attribute of the action item to match against. Value must be one of id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    queryValue String
    Value that attributetoquery_by to uses to match against
    assignedToUser Map<String,Object>
    Map must contain two fields, id and name. The user this action item is assigned to
    assignedToUserId String
    [DEPRECATED] Use assignedtouser attribute instead. The user id this action item is assigned to
    customFieldsMapping String
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    description String
    The action item description
    groupIds List<String>
    postToIncidentTimeline Boolean
    Value must be one of true or false
    priority String
    The action item priority. Value must be one of high, medium, low.
    status String
    The action item status. Value must be one of open, in_progress, cancelled, done.
    summary String
    Brief description of the action item
    taskType String
    attributeToQueryBy string
    Attribute of the action item to match against. Value must be one of id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    queryValue string
    Value that attributetoquery_by to uses to match against
    assignedToUser {[key: string]: any}
    Map must contain two fields, id and name. The user this action item is assigned to
    assignedToUserId string
    [DEPRECATED] Use assignedtouser attribute instead. The user id this action item is assigned to
    customFieldsMapping string
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    description string
    The action item description
    groupIds string[]
    postToIncidentTimeline boolean
    Value must be one of true or false
    priority string
    The action item priority. Value must be one of high, medium, low.
    status string
    The action item status. Value must be one of open, in_progress, cancelled, done.
    summary string
    Brief description of the action item
    taskType string
    attribute_to_query_by str
    Attribute of the action item to match against. Value must be one of id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    query_value str
    Value that attributetoquery_by to uses to match against
    assigned_to_user Mapping[str, Any]
    Map must contain two fields, id and name. The user this action item is assigned to
    assigned_to_user_id str
    [DEPRECATED] Use assignedtouser attribute instead. The user id this action item is assigned to
    custom_fields_mapping str
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    description str
    The action item description
    group_ids Sequence[str]
    post_to_incident_timeline bool
    Value must be one of true or false
    priority str
    The action item priority. Value must be one of high, medium, low.
    status str
    The action item status. Value must be one of open, in_progress, cancelled, done.
    summary str
    Brief description of the action item
    task_type str
    attributeToQueryBy String
    Attribute of the action item to match against. Value must be one of id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    queryValue String
    Value that attributetoquery_by to uses to match against
    assignedToUser Map<Any>
    Map must contain two fields, id and name. The user this action item is assigned to
    assignedToUserId String
    [DEPRECATED] Use assignedtouser attribute instead. The user id this action item is assigned to
    customFieldsMapping String
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    description String
    The action item description
    groupIds List<String>
    postToIncidentTimeline Boolean
    Value must be one of true or false
    priority String
    The action item priority. Value must be one of high, medium, low.
    status String
    The action item status. Value must be one of open, in_progress, cancelled, done.
    summary String
    Brief description of the action item
    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
    rootlyhq/pulumi-rootly