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

rootly.WorkflowTaskUpdateGithubIssue

Explore with Pulumi AI

Manages workflow update_github_issue task.

Create WorkflowTaskUpdateGithubIssue Resource

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

Constructor syntax

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

@overload
def WorkflowTaskUpdateGithubIssue(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  task_params: Optional[WorkflowTaskUpdateGithubIssueTaskParamsArgs] = 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 NewWorkflowTaskUpdateGithubIssue(ctx *Context, name string, args WorkflowTaskUpdateGithubIssueArgs, opts ...ResourceOption) (*WorkflowTaskUpdateGithubIssue, error)
public WorkflowTaskUpdateGithubIssue(string name, WorkflowTaskUpdateGithubIssueArgs args, CustomResourceOptions? opts = null)
public WorkflowTaskUpdateGithubIssue(String name, WorkflowTaskUpdateGithubIssueArgs args)
public WorkflowTaskUpdateGithubIssue(String name, WorkflowTaskUpdateGithubIssueArgs args, CustomResourceOptions options)
type: rootly:WorkflowTaskUpdateGithubIssue
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. WorkflowTaskUpdateGithubIssueArgs
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. WorkflowTaskUpdateGithubIssueArgs
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. WorkflowTaskUpdateGithubIssueArgs
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. WorkflowTaskUpdateGithubIssueArgs
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. WorkflowTaskUpdateGithubIssueArgs
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 workflowTaskUpdateGithubIssueResource = new Rootly.WorkflowTaskUpdateGithubIssue("workflowTaskUpdateGithubIssueResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskUpdateGithubIssueTaskParamsArgs
    {
        Completion = 
        {
            { "string", "any" },
        },
        IssueId = "string",
        Body = "string",
        TaskType = "string",
        Title = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});
Copy
example, err := rootly.NewWorkflowTaskUpdateGithubIssue(ctx, "workflowTaskUpdateGithubIssueResource", &rootly.WorkflowTaskUpdateGithubIssueArgs{
	TaskParams: &rootly.WorkflowTaskUpdateGithubIssueTaskParamsArgs{
		Completion: pulumi.Map{
			"string": pulumi.Any("any"),
		},
		IssueId:  pulumi.String("string"),
		Body:     pulumi.String("string"),
		TaskType: pulumi.String("string"),
		Title:    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 workflowTaskUpdateGithubIssueResource = new WorkflowTaskUpdateGithubIssue("workflowTaskUpdateGithubIssueResource", WorkflowTaskUpdateGithubIssueArgs.builder()
    .taskParams(WorkflowTaskUpdateGithubIssueTaskParamsArgs.builder()
        .completion(Map.of("string", "any"))
        .issueId("string")
        .body("string")
        .taskType("string")
        .title("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());
Copy
workflow_task_update_github_issue_resource = rootly.WorkflowTaskUpdateGithubIssue("workflowTaskUpdateGithubIssueResource",
    task_params={
        "completion": {
            "string": "any",
        },
        "issue_id": "string",
        "body": "string",
        "task_type": "string",
        "title": "string",
    },
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)
Copy
const workflowTaskUpdateGithubIssueResource = new rootly.WorkflowTaskUpdateGithubIssue("workflowTaskUpdateGithubIssueResource", {
    taskParams: {
        completion: {
            string: "any",
        },
        issueId: "string",
        body: "string",
        taskType: "string",
        title: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});
Copy
type: rootly:WorkflowTaskUpdateGithubIssue
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        body: string
        completion:
            string: any
        issueId: string
        taskType: string
        title: string
    workflowId: string
Copy

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

TaskParams This property is required. WorkflowTaskUpdateGithubIssueTaskParams
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. WorkflowTaskUpdateGithubIssueTaskParamsArgs
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. WorkflowTaskUpdateGithubIssueTaskParams
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. WorkflowTaskUpdateGithubIssueTaskParams
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. WorkflowTaskUpdateGithubIssueTaskParamsArgs
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 WorkflowTaskUpdateGithubIssue 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 WorkflowTaskUpdateGithubIssue Resource

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

WorkflowTaskUpdateGithubIssueTaskParams
, WorkflowTaskUpdateGithubIssueTaskParamsArgs

Completion This property is required. Dictionary<string, object>
Map must contain two fields, id and name.
IssueId This property is required. string
The issue id
Body string
The issue body
TaskType string
Title string
The issue title
Completion This property is required. map[string]interface{}
Map must contain two fields, id and name.
IssueId This property is required. string
The issue id
Body string
The issue body
TaskType string
Title string
The issue title
completion This property is required. Map<String,Object>
Map must contain two fields, id and name.
issueId This property is required. String
The issue id
body String
The issue body
taskType String
title String
The issue title
completion This property is required. {[key: string]: any}
Map must contain two fields, id and name.
issueId This property is required. string
The issue id
body string
The issue body
taskType string
title string
The issue title
completion This property is required. Mapping[str, Any]
Map must contain two fields, id and name.
issue_id This property is required. str
The issue id
body str
The issue body
task_type str
title str
The issue title
completion This property is required. Map<Any>
Map must contain two fields, id and name.
issueId This property is required. String
The issue id
body String
The issue body
taskType String
title String
The issue title

Package Details

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