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

rootly.WorkflowTaskUpdateJiraIssue

Explore with Pulumi AI

Manages workflow update_jira_issue task.

Create WorkflowTaskUpdateJiraIssue Resource

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

Constructor syntax

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

@overload
def WorkflowTaskUpdateJiraIssue(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                task_params: Optional[WorkflowTaskUpdateJiraIssueTaskParamsArgs] = 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 NewWorkflowTaskUpdateJiraIssue(ctx *Context, name string, args WorkflowTaskUpdateJiraIssueArgs, opts ...ResourceOption) (*WorkflowTaskUpdateJiraIssue, error)
public WorkflowTaskUpdateJiraIssue(string name, WorkflowTaskUpdateJiraIssueArgs args, CustomResourceOptions? opts = null)
public WorkflowTaskUpdateJiraIssue(String name, WorkflowTaskUpdateJiraIssueArgs args)
public WorkflowTaskUpdateJiraIssue(String name, WorkflowTaskUpdateJiraIssueArgs args, CustomResourceOptions options)
type: rootly:WorkflowTaskUpdateJiraIssue
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. WorkflowTaskUpdateJiraIssueArgs
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. WorkflowTaskUpdateJiraIssueArgs
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. WorkflowTaskUpdateJiraIssueArgs
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. WorkflowTaskUpdateJiraIssueArgs
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. WorkflowTaskUpdateJiraIssueArgs
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 workflowTaskUpdateJiraIssueResource = new Rootly.WorkflowTaskUpdateJiraIssue("workflowTaskUpdateJiraIssueResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskUpdateJiraIssueTaskParamsArgs
    {
        IssueId = "string",
        ProjectKey = "string",
        Priority = 
        {
            { "string", "any" },
        },
        DueDate = "string",
        Description = "string",
        Labels = "string",
        AssignUserEmail = "string",
        CustomFieldsMapping = "string",
        ReporterUserEmail = "string",
        Status = 
        {
            { "string", "any" },
        },
        TaskType = "string",
        Title = "string",
        UpdatePayload = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});
Copy
example, err := rootly.NewWorkflowTaskUpdateJiraIssue(ctx, "workflowTaskUpdateJiraIssueResource", &rootly.WorkflowTaskUpdateJiraIssueArgs{
	TaskParams: &rootly.WorkflowTaskUpdateJiraIssueTaskParamsArgs{
		IssueId:    pulumi.String("string"),
		ProjectKey: pulumi.String("string"),
		Priority: pulumi.Map{
			"string": pulumi.Any("any"),
		},
		DueDate:             pulumi.String("string"),
		Description:         pulumi.String("string"),
		Labels:              pulumi.String("string"),
		AssignUserEmail:     pulumi.String("string"),
		CustomFieldsMapping: pulumi.String("string"),
		ReporterUserEmail:   pulumi.String("string"),
		Status: pulumi.Map{
			"string": pulumi.Any("any"),
		},
		TaskType:      pulumi.String("string"),
		Title:         pulumi.String("string"),
		UpdatePayload: 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 workflowTaskUpdateJiraIssueResource = new WorkflowTaskUpdateJiraIssue("workflowTaskUpdateJiraIssueResource", WorkflowTaskUpdateJiraIssueArgs.builder()
    .taskParams(WorkflowTaskUpdateJiraIssueTaskParamsArgs.builder()
        .issueId("string")
        .projectKey("string")
        .priority(Map.of("string", "any"))
        .dueDate("string")
        .description("string")
        .labels("string")
        .assignUserEmail("string")
        .customFieldsMapping("string")
        .reporterUserEmail("string")
        .status(Map.of("string", "any"))
        .taskType("string")
        .title("string")
        .updatePayload("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());
Copy
workflow_task_update_jira_issue_resource = rootly.WorkflowTaskUpdateJiraIssue("workflowTaskUpdateJiraIssueResource",
    task_params={
        "issue_id": "string",
        "project_key": "string",
        "priority": {
            "string": "any",
        },
        "due_date": "string",
        "description": "string",
        "labels": "string",
        "assign_user_email": "string",
        "custom_fields_mapping": "string",
        "reporter_user_email": "string",
        "status": {
            "string": "any",
        },
        "task_type": "string",
        "title": "string",
        "update_payload": "string",
    },
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)
Copy
const workflowTaskUpdateJiraIssueResource = new rootly.WorkflowTaskUpdateJiraIssue("workflowTaskUpdateJiraIssueResource", {
    taskParams: {
        issueId: "string",
        projectKey: "string",
        priority: {
            string: "any",
        },
        dueDate: "string",
        description: "string",
        labels: "string",
        assignUserEmail: "string",
        customFieldsMapping: "string",
        reporterUserEmail: "string",
        status: {
            string: "any",
        },
        taskType: "string",
        title: "string",
        updatePayload: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});
Copy
type: rootly:WorkflowTaskUpdateJiraIssue
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        assignUserEmail: string
        customFieldsMapping: string
        description: string
        dueDate: string
        issueId: string
        labels: string
        priority:
            string: any
        projectKey: string
        reporterUserEmail: string
        status:
            string: any
        taskType: string
        title: string
        updatePayload: string
    workflowId: string
Copy

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

TaskParams This property is required. WorkflowTaskUpdateJiraIssueTaskParams
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. WorkflowTaskUpdateJiraIssueTaskParamsArgs
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. WorkflowTaskUpdateJiraIssueTaskParams
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. WorkflowTaskUpdateJiraIssueTaskParams
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. WorkflowTaskUpdateJiraIssueTaskParamsArgs
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 WorkflowTaskUpdateJiraIssue 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 WorkflowTaskUpdateJiraIssue Resource

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

WorkflowTaskUpdateJiraIssueTaskParams
, WorkflowTaskUpdateJiraIssueTaskParamsArgs

IssueId This property is required. string
The issue id
ProjectKey This property is required. string
The project key
AssignUserEmail string
The assigned user's email
CustomFieldsMapping string
Custom field mappings. Can contain liquid markup and need to be valid JSON
Description string
The issue description
DueDate string
The due date
Labels string
The issue labels
Priority Dictionary<string, object>
Map must contain two fields, id and name. The priority id and display name
ReporterUserEmail string
The reporter user's email
Status Dictionary<string, object>
Map must contain two fields, id and name. The status id and display name
TaskType string
Title string
The issue title
UpdatePayload string
Update payload. Can contain liquid markup and need to be valid JSON
IssueId This property is required. string
The issue id
ProjectKey This property is required. string
The project key
AssignUserEmail string
The assigned user's email
CustomFieldsMapping string
Custom field mappings. Can contain liquid markup and need to be valid JSON
Description string
The issue description
DueDate string
The due date
Labels string
The issue labels
Priority map[string]interface{}
Map must contain two fields, id and name. The priority id and display name
ReporterUserEmail string
The reporter user's email
Status map[string]interface{}
Map must contain two fields, id and name. The status id and display name
TaskType string
Title string
The issue title
UpdatePayload string
Update payload. Can contain liquid markup and need to be valid JSON
issueId This property is required. String
The issue id
projectKey This property is required. String
The project key
assignUserEmail String
The assigned user's email
customFieldsMapping String
Custom field mappings. Can contain liquid markup and need to be valid JSON
description String
The issue description
dueDate String
The due date
labels String
The issue labels
priority Map<String,Object>
Map must contain two fields, id and name. The priority id and display name
reporterUserEmail String
The reporter user's email
status Map<String,Object>
Map must contain two fields, id and name. The status id and display name
taskType String
title String
The issue title
updatePayload String
Update payload. Can contain liquid markup and need to be valid JSON
issueId This property is required. string
The issue id
projectKey This property is required. string
The project key
assignUserEmail string
The assigned user's email
customFieldsMapping string
Custom field mappings. Can contain liquid markup and need to be valid JSON
description string
The issue description
dueDate string
The due date
labels string
The issue labels
priority {[key: string]: any}
Map must contain two fields, id and name. The priority id and display name
reporterUserEmail string
The reporter user's email
status {[key: string]: any}
Map must contain two fields, id and name. The status id and display name
taskType string
title string
The issue title
updatePayload string
Update payload. Can contain liquid markup and need to be valid JSON
issue_id This property is required. str
The issue id
project_key This property is required. str
The project key
assign_user_email str
The assigned user's email
custom_fields_mapping str
Custom field mappings. Can contain liquid markup and need to be valid JSON
description str
The issue description
due_date str
The due date
labels str
The issue labels
priority Mapping[str, Any]
Map must contain two fields, id and name. The priority id and display name
reporter_user_email str
The reporter user's email
status Mapping[str, Any]
Map must contain two fields, id and name. The status id and display name
task_type str
title str
The issue title
update_payload str
Update payload. Can contain liquid markup and need to be valid JSON
issueId This property is required. String
The issue id
projectKey This property is required. String
The project key
assignUserEmail String
The assigned user's email
customFieldsMapping String
Custom field mappings. Can contain liquid markup and need to be valid JSON
description String
The issue description
dueDate String
The due date
labels String
The issue labels
priority Map<Any>
Map must contain two fields, id and name. The priority id and display name
reporterUserEmail String
The reporter user's email
status Map<Any>
Map must contain two fields, id and name. The status id and display name
taskType String
title String
The issue title
updatePayload String
Update payload. Can contain liquid markup and need to be valid JSON

Package Details

Repository
rootly rootlyhq/pulumi-rootly
License
Apache-2.0
Notes
This Pulumi package is based on the rootly Terraform Provider.