1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. WorkflowTaskUpdateGithubIssue
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

    Manages workflow updateGithubIssue 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 string
    The unique name of the resource.
    args WorkflowTaskUpdateGithubIssueArgs
    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 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 string
    The unique name of the resource.
    args WorkflowTaskUpdateGithubIssueArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskUpdateGithubIssueArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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", "string" },
            },
            IssueId = "string",
            Body = "string",
            IssueType = 
            {
                { "string", "string" },
            },
            Labels = new[]
            {
                new Rootly.Inputs.WorkflowTaskUpdateGithubIssueTaskParamsLabelArgs
                {
                    Id = "string",
                    Name = "string",
                },
            },
            LabelsMode = "string",
            Repository = 
            {
                { "string", "string" },
            },
            TaskType = "string",
            Title = "string",
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskUpdateGithubIssue(ctx, "workflowTaskUpdateGithubIssueResource", &rootly.WorkflowTaskUpdateGithubIssueArgs{
    	TaskParams: &rootly.WorkflowTaskUpdateGithubIssueTaskParamsArgs{
    		Completion: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		IssueId: pulumi.String("string"),
    		Body:    pulumi.String("string"),
    		IssueType: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		Labels: rootly.WorkflowTaskUpdateGithubIssueTaskParamsLabelArray{
    			&rootly.WorkflowTaskUpdateGithubIssueTaskParamsLabelArgs{
    				Id:   pulumi.String("string"),
    				Name: pulumi.String("string"),
    			},
    		},
    		LabelsMode: pulumi.String("string"),
    		Repository: pulumi.StringMap{
    			"string": 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),
    })
    
    var workflowTaskUpdateGithubIssueResource = new WorkflowTaskUpdateGithubIssue("workflowTaskUpdateGithubIssueResource", WorkflowTaskUpdateGithubIssueArgs.builder()
        .taskParams(WorkflowTaskUpdateGithubIssueTaskParamsArgs.builder()
            .completion(Map.of("string", "string"))
            .issueId("string")
            .body("string")
            .issueType(Map.of("string", "string"))
            .labels(WorkflowTaskUpdateGithubIssueTaskParamsLabelArgs.builder()
                .id("string")
                .name("string")
                .build())
            .labelsMode("string")
            .repository(Map.of("string", "string"))
            .taskType("string")
            .title("string")
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_update_github_issue_resource = rootly.WorkflowTaskUpdateGithubIssue("workflowTaskUpdateGithubIssueResource",
        task_params={
            "completion": {
                "string": "string",
            },
            "issue_id": "string",
            "body": "string",
            "issue_type": {
                "string": "string",
            },
            "labels": [{
                "id": "string",
                "name": "string",
            }],
            "labels_mode": "string",
            "repository": {
                "string": "string",
            },
            "task_type": "string",
            "title": "string",
        },
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskUpdateGithubIssueResource = new rootly.WorkflowTaskUpdateGithubIssue("workflowTaskUpdateGithubIssueResource", {
        taskParams: {
            completion: {
                string: "string",
            },
            issueId: "string",
            body: "string",
            issueType: {
                string: "string",
            },
            labels: [{
                id: "string",
                name: "string",
            }],
            labelsMode: "string",
            repository: {
                string: "string",
            },
            taskType: "string",
            title: "string",
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskUpdateGithubIssue
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            body: string
            completion:
                string: string
            issueId: string
            issueType:
                string: string
            labels:
                - id: string
                  name: string
            labelsMode: string
            repository:
                string: string
            taskType: string
            title: string
        workflowId: string
    

    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 WorkflowTaskUpdateGithubIssueTaskParams
    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 WorkflowTaskUpdateGithubIssueTaskParamsArgs
    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 WorkflowTaskUpdateGithubIssueTaskParams
    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 WorkflowTaskUpdateGithubIssueTaskParams
    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 WorkflowTaskUpdateGithubIssueTaskParamsArgs
    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 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
    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 WorkflowTaskUpdateGithubIssueTaskParams
    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 WorkflowTaskUpdateGithubIssueTaskParamsArgs
    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 WorkflowTaskUpdateGithubIssueTaskParams
    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 WorkflowTaskUpdateGithubIssueTaskParams
    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 WorkflowTaskUpdateGithubIssueTaskParamsArgs
    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

    WorkflowTaskUpdateGithubIssueTaskParams, WorkflowTaskUpdateGithubIssueTaskParamsArgs

    Completion Dictionary<string, string>
    Map must contain two fields, id and name.
    IssueId string
    The issue id
    Body string
    The issue body
    IssueType Dictionary<string, string>
    Map must contain two fields, id and name. The issue type
    Labels List<WorkflowTaskUpdateGithubIssueTaskParamsLabel>
    The issue labels
    LabelsMode string
    How to apply labels. 'replace' (default) overwrites all existing labels. 'append' adds to existing labels without removing them.. Value must be one of replace, append.
    Repository Dictionary<string, string>
    Map must contain two fields, id and name. The repository (used for loading labels and issue types)
    TaskType string
    Title string
    The issue title
    Completion map[string]string
    Map must contain two fields, id and name.
    IssueId string
    The issue id
    Body string
    The issue body
    IssueType map[string]string
    Map must contain two fields, id and name. The issue type
    Labels []WorkflowTaskUpdateGithubIssueTaskParamsLabel
    The issue labels
    LabelsMode string
    How to apply labels. 'replace' (default) overwrites all existing labels. 'append' adds to existing labels without removing them.. Value must be one of replace, append.
    Repository map[string]string
    Map must contain two fields, id and name. The repository (used for loading labels and issue types)
    TaskType string
    Title string
    The issue title
    completion Map<String,String>
    Map must contain two fields, id and name.
    issueId String
    The issue id
    body String
    The issue body
    issueType Map<String,String>
    Map must contain two fields, id and name. The issue type
    labels List<WorkflowTaskUpdateGithubIssueTaskParamsLabel>
    The issue labels
    labelsMode String
    How to apply labels. 'replace' (default) overwrites all existing labels. 'append' adds to existing labels without removing them.. Value must be one of replace, append.
    repository Map<String,String>
    Map must contain two fields, id and name. The repository (used for loading labels and issue types)
    taskType String
    title String
    The issue title
    completion {[key: string]: string}
    Map must contain two fields, id and name.
    issueId string
    The issue id
    body string
    The issue body
    issueType {[key: string]: string}
    Map must contain two fields, id and name. The issue type
    labels WorkflowTaskUpdateGithubIssueTaskParamsLabel[]
    The issue labels
    labelsMode string
    How to apply labels. 'replace' (default) overwrites all existing labels. 'append' adds to existing labels without removing them.. Value must be one of replace, append.
    repository {[key: string]: string}
    Map must contain two fields, id and name. The repository (used for loading labels and issue types)
    taskType string
    title string
    The issue title
    completion Mapping[str, str]
    Map must contain two fields, id and name.
    issue_id str
    The issue id
    body str
    The issue body
    issue_type Mapping[str, str]
    Map must contain two fields, id and name. The issue type
    labels Sequence[WorkflowTaskUpdateGithubIssueTaskParamsLabel]
    The issue labels
    labels_mode str
    How to apply labels. 'replace' (default) overwrites all existing labels. 'append' adds to existing labels without removing them.. Value must be one of replace, append.
    repository Mapping[str, str]
    Map must contain two fields, id and name. The repository (used for loading labels and issue types)
    task_type str
    title str
    The issue title
    completion Map<String>
    Map must contain two fields, id and name.
    issueId String
    The issue id
    body String
    The issue body
    issueType Map<String>
    Map must contain two fields, id and name. The issue type
    labels List<Property Map>
    The issue labels
    labelsMode String
    How to apply labels. 'replace' (default) overwrites all existing labels. 'append' adds to existing labels without removing them.. Value must be one of replace, append.
    repository Map<String>
    Map must contain two fields, id and name. The repository (used for loading labels and issue types)
    taskType String
    title String
    The issue title

    WorkflowTaskUpdateGithubIssueTaskParamsLabel, WorkflowTaskUpdateGithubIssueTaskParamsLabelArgs

    Id string
    Name string
    Id string
    Name string
    id String
    name String
    id string
    name string
    id str
    name str
    id String
    name String

    Import

    rootly.WorkflowTaskUpdateGithubIssue can be imported using the import command.

    $ pulumi import rootly:index/workflowTaskUpdateGithubIssue:WorkflowTaskUpdateGithubIssue primary a816421c-6ceb-481a-87c4-585e47451f24
    

    Or using an import block.

    Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v3.3.0
    published on Thursday, May 7, 2026 by rootlyhq
      Try Pulumi Cloud free. Your team will thank you.