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

rootly.WorkflowTaskAddRole

Explore with Pulumi AI

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

Manages workflow add_role task.

Create WorkflowTaskAddRole Resource

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

Constructor syntax

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

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

type: rootly:WorkflowTaskAddRole
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. WorkflowTaskAddRoleArgs
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. WorkflowTaskAddRoleArgs
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. WorkflowTaskAddRoleArgs
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. WorkflowTaskAddRoleArgs
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. WorkflowTaskAddRoleArgs
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 workflowTaskAddRoleResource = new Rootly.WorkflowTaskAddRole("workflowTaskAddRoleResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskAddRoleTaskParamsArgs
    {
        IncidentRoleId = "string",
        AssignedToUser = 
        {
            { "string", "any" },
        },
        AssignedToUserId = "string",
        TaskType = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});
Copy
example, err := rootly.NewWorkflowTaskAddRole(ctx, "workflowTaskAddRoleResource", &rootly.WorkflowTaskAddRoleArgs{
	TaskParams: &rootly.WorkflowTaskAddRoleTaskParamsArgs{
		IncidentRoleId: pulumi.String("string"),
		AssignedToUser: pulumi.Map{
			"string": pulumi.Any("any"),
		},
		AssignedToUserId: 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 workflowTaskAddRoleResource = new WorkflowTaskAddRole("workflowTaskAddRoleResource", WorkflowTaskAddRoleArgs.builder()
    .taskParams(WorkflowTaskAddRoleTaskParamsArgs.builder()
        .incidentRoleId("string")
        .assignedToUser(Map.of("string", "any"))
        .assignedToUserId("string")
        .taskType("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());
Copy
workflow_task_add_role_resource = rootly.WorkflowTaskAddRole("workflowTaskAddRoleResource",
    task_params={
        "incident_role_id": "string",
        "assigned_to_user": {
            "string": "any",
        },
        "assigned_to_user_id": "string",
        "task_type": "string",
    },
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)
Copy
const workflowTaskAddRoleResource = new rootly.WorkflowTaskAddRole("workflowTaskAddRoleResource", {
    taskParams: {
        incidentRoleId: "string",
        assignedToUser: {
            string: "any",
        },
        assignedToUserId: "string",
        taskType: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});
Copy
type: rootly:WorkflowTaskAddRole
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        assignedToUser:
            string: any
        assignedToUserId: string
        incidentRoleId: string
        taskType: string
    workflowId: string
Copy

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

TaskParams This property is required. WorkflowTaskAddRoleTaskParams
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. WorkflowTaskAddRoleTaskParamsArgs
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. WorkflowTaskAddRoleTaskParams
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. WorkflowTaskAddRoleTaskParams
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. WorkflowTaskAddRoleTaskParamsArgs
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 WorkflowTaskAddRole 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 WorkflowTaskAddRole Resource

Get an existing WorkflowTaskAddRole 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?: WorkflowTaskAddRoleState, opts?: CustomResourceOptions): WorkflowTaskAddRole
@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[WorkflowTaskAddRoleTaskParamsArgs] = None,
        workflow_id: Optional[str] = None) -> WorkflowTaskAddRole
func GetWorkflowTaskAddRole(ctx *Context, name string, id IDInput, state *WorkflowTaskAddRoleState, opts ...ResourceOption) (*WorkflowTaskAddRole, error)
public static WorkflowTaskAddRole Get(string name, Input<string> id, WorkflowTaskAddRoleState? state, CustomResourceOptions? opts = null)
public static WorkflowTaskAddRole get(String name, Output<String> id, WorkflowTaskAddRoleState state, CustomResourceOptions options)
resources:  _:    type: rootly:WorkflowTaskAddRole    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 WorkflowTaskAddRoleTaskParams
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 WorkflowTaskAddRoleTaskParamsArgs
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 WorkflowTaskAddRoleTaskParams
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 WorkflowTaskAddRoleTaskParams
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 WorkflowTaskAddRoleTaskParamsArgs
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

WorkflowTaskAddRoleTaskParams
, WorkflowTaskAddRoleTaskParamsArgs

IncidentRoleId This property is required. string
The role id to add to the incident
AssignedToUser Dictionary<string, object>
Map must contain two fields, id and name. The user this role is assigned to
AssignedToUserId string
[DEPRECATED] Use assignedtouser attribute instead. The user id this role is assigned to
TaskType string
IncidentRoleId This property is required. string
The role id to add to the incident
AssignedToUser map[string]interface{}
Map must contain two fields, id and name. The user this role is assigned to
AssignedToUserId string
[DEPRECATED] Use assignedtouser attribute instead. The user id this role is assigned to
TaskType string
incidentRoleId This property is required. String
The role id to add to the incident
assignedToUser Map<String,Object>
Map must contain two fields, id and name. The user this role is assigned to
assignedToUserId String
[DEPRECATED] Use assignedtouser attribute instead. The user id this role is assigned to
taskType String
incidentRoleId This property is required. string
The role id to add to the incident
assignedToUser {[key: string]: any}
Map must contain two fields, id and name. The user this role is assigned to
assignedToUserId string
[DEPRECATED] Use assignedtouser attribute instead. The user id this role is assigned to
taskType string
incident_role_id This property is required. str
The role id to add to the incident
assigned_to_user Mapping[str, Any]
Map must contain two fields, id and name. The user this role is assigned to
assigned_to_user_id str
[DEPRECATED] Use assignedtouser attribute instead. The user id this role is assigned to
task_type str
incidentRoleId This property is required. String
The role id to add to the incident
assignedToUser Map<Any>
Map must contain two fields, id and name. The user this role is assigned to
assignedToUserId String
[DEPRECATED] Use assignedtouser attribute instead. The user id this role is assigned to
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 v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly