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

rootly.WorkflowTaskAddActionItem

Explore with Pulumi AI

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

Manages workflow add_action_item task.

Create WorkflowTaskAddActionItem Resource

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

Constructor syntax

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

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

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkflowTaskAddActionItemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkflowTaskAddActionItemArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkflowTaskAddActionItemArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkflowTaskAddActionItemArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkflowTaskAddActionItemArgs
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 workflowTaskAddActionItemResource = new Rootly.WorkflowTaskAddActionItem("workflowTaskAddActionItemResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskAddActionItemTaskParamsArgs
    {
        Priority = "string",
        Status = "string",
        Summary = "string",
        AssignedToUser = 
        {
            { "string", "any" },
        },
        AssignedToUserId = "string",
        Description = "string",
        IncidentRoleId = "string",
        Kind = "string",
        PostToIncidentTimeline = false,
        PostToSlackChannels = new[]
        {
            new Rootly.Inputs.WorkflowTaskAddActionItemTaskParamsPostToSlackChannelArgs
            {
                Id = "string",
                Name = "string",
            },
        },
        TaskType = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});
Copy
example, err := rootly.NewWorkflowTaskAddActionItem(ctx, "workflowTaskAddActionItemResource", &rootly.WorkflowTaskAddActionItemArgs{
	TaskParams: &rootly.WorkflowTaskAddActionItemTaskParamsArgs{
		Priority: pulumi.String("string"),
		Status:   pulumi.String("string"),
		Summary:  pulumi.String("string"),
		AssignedToUser: pulumi.Map{
			"string": pulumi.Any("any"),
		},
		AssignedToUserId:       pulumi.String("string"),
		Description:            pulumi.String("string"),
		IncidentRoleId:         pulumi.String("string"),
		Kind:                   pulumi.String("string"),
		PostToIncidentTimeline: pulumi.Bool(false),
		PostToSlackChannels: rootly.WorkflowTaskAddActionItemTaskParamsPostToSlackChannelArray{
			&rootly.WorkflowTaskAddActionItemTaskParamsPostToSlackChannelArgs{
				Id:   pulumi.String("string"),
				Name: 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),
})
Copy
var workflowTaskAddActionItemResource = new WorkflowTaskAddActionItem("workflowTaskAddActionItemResource", WorkflowTaskAddActionItemArgs.builder()
    .taskParams(WorkflowTaskAddActionItemTaskParamsArgs.builder()
        .priority("string")
        .status("string")
        .summary("string")
        .assignedToUser(Map.of("string", "any"))
        .assignedToUserId("string")
        .description("string")
        .incidentRoleId("string")
        .kind("string")
        .postToIncidentTimeline(false)
        .postToSlackChannels(WorkflowTaskAddActionItemTaskParamsPostToSlackChannelArgs.builder()
            .id("string")
            .name("string")
            .build())
        .taskType("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());
Copy
workflow_task_add_action_item_resource = rootly.WorkflowTaskAddActionItem("workflowTaskAddActionItemResource",
    task_params={
        "priority": "string",
        "status": "string",
        "summary": "string",
        "assigned_to_user": {
            "string": "any",
        },
        "assigned_to_user_id": "string",
        "description": "string",
        "incident_role_id": "string",
        "kind": "string",
        "post_to_incident_timeline": False,
        "post_to_slack_channels": [{
            "id": "string",
            "name": "string",
        }],
        "task_type": "string",
    },
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)
Copy
const workflowTaskAddActionItemResource = new rootly.WorkflowTaskAddActionItem("workflowTaskAddActionItemResource", {
    taskParams: {
        priority: "string",
        status: "string",
        summary: "string",
        assignedToUser: {
            string: "any",
        },
        assignedToUserId: "string",
        description: "string",
        incidentRoleId: "string",
        kind: "string",
        postToIncidentTimeline: false,
        postToSlackChannels: [{
            id: "string",
            name: "string",
        }],
        taskType: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});
Copy
type: rootly:WorkflowTaskAddActionItem
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        assignedToUser:
            string: any
        assignedToUserId: string
        description: string
        incidentRoleId: string
        kind: string
        postToIncidentTimeline: false
        postToSlackChannels:
            - id: string
              name: string
        priority: string
        status: string
        summary: string
        taskType: string
    workflowId: string
Copy

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

TaskParams This property is required. WorkflowTaskAddActionItemTaskParams
The parameters for this workflow task.
WorkflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskAddActionItemTaskParamsArgs
The parameters for this workflow task.
WorkflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskAddActionItemTaskParams
The parameters for this workflow task.
workflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskAddActionItemTaskParams
The parameters for this workflow task.
workflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskAddActionItemTaskParamsArgs
The parameters for this workflow task.
workflow_id
This property is required.
Changes to this property will trigger replacement.
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 This property is required. Property Map
The parameters for this workflow task.
workflowId
This property is required.
Changes to this property will trigger replacement.
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 WorkflowTaskAddActionItem 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 WorkflowTaskAddActionItem Resource

Get an existing WorkflowTaskAddActionItem 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?: WorkflowTaskAddActionItemState, opts?: CustomResourceOptions): WorkflowTaskAddActionItem
@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[WorkflowTaskAddActionItemTaskParamsArgs] = None,
        workflow_id: Optional[str] = None) -> WorkflowTaskAddActionItem
func GetWorkflowTaskAddActionItem(ctx *Context, name string, id IDInput, state *WorkflowTaskAddActionItemState, opts ...ResourceOption) (*WorkflowTaskAddActionItem, error)
public static WorkflowTaskAddActionItem Get(string name, Input<string> id, WorkflowTaskAddActionItemState? state, CustomResourceOptions? opts = null)
public static WorkflowTaskAddActionItem get(String name, Output<String> id, WorkflowTaskAddActionItemState state, CustomResourceOptions options)
resources:  _:    type: rootly:WorkflowTaskAddActionItem    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 WorkflowTaskAddActionItemTaskParams
The parameters for this workflow task.
WorkflowId Changes to this property will trigger replacement. 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 WorkflowTaskAddActionItemTaskParamsArgs
The parameters for this workflow task.
WorkflowId Changes to this property will trigger replacement. 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 WorkflowTaskAddActionItemTaskParams
The parameters for this workflow task.
workflowId Changes to this property will trigger replacement. 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 WorkflowTaskAddActionItemTaskParams
The parameters for this workflow task.
workflowId Changes to this property will trigger replacement. 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 WorkflowTaskAddActionItemTaskParamsArgs
The parameters for this workflow task.
workflow_id Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The ID of the parent workflow

Supporting Types

WorkflowTaskAddActionItemTaskParams
, WorkflowTaskAddActionItemTaskParamsArgs

Priority This property is required. string
The action item priority. Value must be one of high, medium, low.
Status This property is required. string
The action item status. Value must be one of open, in_progress, cancelled, done.
Summary This property is required. string
The action item summary
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
Description string
The action item description
IncidentRoleId string
The role id this action item is associated with
Kind string
The action item kind
PostToIncidentTimeline bool
Value must be one of true or false
PostToSlackChannels List<WorkflowTaskAddActionItemTaskParamsPostToSlackChannel>
TaskType string
Priority This property is required. string
The action item priority. Value must be one of high, medium, low.
Status This property is required. string
The action item status. Value must be one of open, in_progress, cancelled, done.
Summary This property is required. string
The action item summary
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
Description string
The action item description
IncidentRoleId string
The role id this action item is associated with
Kind string
The action item kind
PostToIncidentTimeline bool
Value must be one of true or false
PostToSlackChannels []WorkflowTaskAddActionItemTaskParamsPostToSlackChannel
TaskType string
priority This property is required. String
The action item priority. Value must be one of high, medium, low.
status This property is required. String
The action item status. Value must be one of open, in_progress, cancelled, done.
summary This property is required. String
The action item summary
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
description String
The action item description
incidentRoleId String
The role id this action item is associated with
kind String
The action item kind
postToIncidentTimeline Boolean
Value must be one of true or false
postToSlackChannels List<WorkflowTaskAddActionItemTaskParamsPostToSlackChannel>
taskType String
priority This property is required. string
The action item priority. Value must be one of high, medium, low.
status This property is required. string
The action item status. Value must be one of open, in_progress, cancelled, done.
summary This property is required. string
The action item summary
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
description string
The action item description
incidentRoleId string
The role id this action item is associated with
kind string
The action item kind
postToIncidentTimeline boolean
Value must be one of true or false
postToSlackChannels WorkflowTaskAddActionItemTaskParamsPostToSlackChannel[]
taskType string
priority This property is required. str
The action item priority. Value must be one of high, medium, low.
status This property is required. str
The action item status. Value must be one of open, in_progress, cancelled, done.
summary This property is required. str
The action item summary
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
description str
The action item description
incident_role_id str
The role id this action item is associated with
kind str
The action item kind
post_to_incident_timeline bool
Value must be one of true or false
post_to_slack_channels Sequence[WorkflowTaskAddActionItemTaskParamsPostToSlackChannel]
task_type str
priority This property is required. String
The action item priority. Value must be one of high, medium, low.
status This property is required. String
The action item status. Value must be one of open, in_progress, cancelled, done.
summary This property is required. String
The action item summary
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
description String
The action item description
incidentRoleId String
The role id this action item is associated with
kind String
The action item kind
postToIncidentTimeline Boolean
Value must be one of true or false
postToSlackChannels List<Property Map>
taskType String

WorkflowTaskAddActionItemTaskParamsPostToSlackChannel
, WorkflowTaskAddActionItemTaskParamsPostToSlackChannelArgs

Id This property is required. string
Name This property is required. string
Id This property is required. string
Name This property is required. string
id This property is required. String
name This property is required. String
id This property is required. string
name This property is required. string
id This property is required. str
name This property is required. str
id This property is required. String
name This property is required. String

Package Details

Repository
rootly rootlyhq/pulumi-rootly
License
Apache-2.0
Notes
This Pulumi package is based on the rootly Terraform Provider.
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly