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

rootly.WorkflowTaskUpdateIncident

Explore with Pulumi AI

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

    Manages workflow update_incident task.

    Create WorkflowTaskUpdateIncident Resource

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

    Constructor syntax

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

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

    type: rootly:WorkflowTaskUpdateIncident
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 WorkflowTaskUpdateIncidentArgs
    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 WorkflowTaskUpdateIncidentArgs
    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 WorkflowTaskUpdateIncidentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskUpdateIncidentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskUpdateIncidentArgs
    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 workflowTaskUpdateIncidentResource = new Rootly.WorkflowTaskUpdateIncident("workflowTaskUpdateIncidentResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskUpdateIncidentTaskParamsArgs
    {
        IncidentId = "string",
        IncidentTypeIds = new[]
        {
            "string",
        },
        DetectedAt = "string",
        Private = false,
        ResolvedAt = "string",
        FunctionalityIds = new[]
        {
            "string",
        },
        GroupIds = new[]
        {
            "string",
        },
        AttributeToQueryBy = "string",
        AcknowledgedAt = "string",
        Title = "string",
        CustomFieldsMapping = "string",
        EnvironmentIds = new[]
        {
            "string",
        },
        ServiceIds = new[]
        {
            "string",
        },
        SeverityId = "string",
        StartedAt = "string",
        Status = "string",
        Summary = "string",
        TaskType = "string",
        MitigatedAt = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});

    example, err := rootly.NewWorkflowTaskUpdateIncident(ctx, "workflowTaskUpdateIncidentResource", &rootly.WorkflowTaskUpdateIncidentArgs{
	TaskParams: &rootly.WorkflowTaskUpdateIncidentTaskParamsArgs{
		IncidentId: pulumi.String("string"),
		IncidentTypeIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		DetectedAt: pulumi.String("string"),
		Private:    pulumi.Bool(false),
		ResolvedAt: pulumi.String("string"),
		FunctionalityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		GroupIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		AttributeToQueryBy:  pulumi.String("string"),
		AcknowledgedAt:      pulumi.String("string"),
		Title:               pulumi.String("string"),
		CustomFieldsMapping: pulumi.String("string"),
		EnvironmentIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		ServiceIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		SeverityId:  pulumi.String("string"),
		StartedAt:   pulumi.String("string"),
		Status:      pulumi.String("string"),
		Summary:     pulumi.String("string"),
		TaskType:    pulumi.String("string"),
		MitigatedAt: pulumi.String("string"),
	},
	WorkflowId:    pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	Name:          pulumi.String("string"),
	Position:      pulumi.Int(0),
	SkipOnFailure: pulumi.Bool(false),
})

    var workflowTaskUpdateIncidentResource = new WorkflowTaskUpdateIncident("workflowTaskUpdateIncidentResource", WorkflowTaskUpdateIncidentArgs.builder()
    .taskParams(WorkflowTaskUpdateIncidentTaskParamsArgs.builder()
        .incidentId("string")
        .incidentTypeIds("string")
        .detectedAt("string")
        .private_(false)
        .resolvedAt("string")
        .functionalityIds("string")
        .groupIds("string")
        .attributeToQueryBy("string")
        .acknowledgedAt("string")
        .title("string")
        .customFieldsMapping("string")
        .environmentIds("string")
        .serviceIds("string")
        .severityId("string")
        .startedAt("string")
        .status("string")
        .summary("string")
        .taskType("string")
        .mitigatedAt("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());

    workflow_task_update_incident_resource = rootly.WorkflowTaskUpdateIncident("workflowTaskUpdateIncidentResource",
    task_params={
        "incident_id": "string",
        "incident_type_ids": ["string"],
        "detected_at": "string",
        "private": False,
        "resolved_at": "string",
        "functionality_ids": ["string"],
        "group_ids": ["string"],
        "attribute_to_query_by": "string",
        "acknowledged_at": "string",
        "title": "string",
        "custom_fields_mapping": "string",
        "environment_ids": ["string"],
        "service_ids": ["string"],
        "severity_id": "string",
        "started_at": "string",
        "status": "string",
        "summary": "string",
        "task_type": "string",
        "mitigated_at": "string",
    },
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)

    const workflowTaskUpdateIncidentResource = new rootly.WorkflowTaskUpdateIncident("workflowTaskUpdateIncidentResource", {
    taskParams: {
        incidentId: "string",
        incidentTypeIds: ["string"],
        detectedAt: "string",
        "private": false,
        resolvedAt: "string",
        functionalityIds: ["string"],
        groupIds: ["string"],
        attributeToQueryBy: "string",
        acknowledgedAt: "string",
        title: "string",
        customFieldsMapping: "string",
        environmentIds: ["string"],
        serviceIds: ["string"],
        severityId: "string",
        startedAt: "string",
        status: "string",
        summary: "string",
        taskType: "string",
        mitigatedAt: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});

    type: rootly:WorkflowTaskUpdateIncident
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        acknowledgedAt: string
        attributeToQueryBy: string
        customFieldsMapping: string
        detectedAt: string
        environmentIds:
            - string
        functionalityIds:
            - string
        groupIds:
            - string
        incidentId: string
        incidentTypeIds:
            - string
        mitigatedAt: string
        private: false
        resolvedAt: string
        serviceIds:
            - string
        severityId: string
        startedAt: string
        status: string
        summary: string
        taskType: string
        title: string
    workflowId: string

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

    TaskParams WorkflowTaskUpdateIncidentTaskParams
    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 WorkflowTaskUpdateIncidentTaskParamsArgs
    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 WorkflowTaskUpdateIncidentTaskParams
    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 WorkflowTaskUpdateIncidentTaskParams
    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 WorkflowTaskUpdateIncidentTaskParamsArgs
    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 WorkflowTaskUpdateIncident 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 WorkflowTaskUpdateIncident Resource

    Get an existing WorkflowTaskUpdateIncident 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?: WorkflowTaskUpdateIncidentState, opts?: CustomResourceOptions): WorkflowTaskUpdateIncident
    @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[WorkflowTaskUpdateIncidentTaskParamsArgs] = None,
        workflow_id: Optional[str] = None) -> WorkflowTaskUpdateIncident
    func GetWorkflowTaskUpdateIncident(ctx *Context, name string, id IDInput, state *WorkflowTaskUpdateIncidentState, opts ...ResourceOption) (*WorkflowTaskUpdateIncident, error)
    public static WorkflowTaskUpdateIncident Get(string name, Input<string> id, WorkflowTaskUpdateIncidentState? state, CustomResourceOptions? opts = null)
    public static WorkflowTaskUpdateIncident get(String name, Output<String> id, WorkflowTaskUpdateIncidentState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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 WorkflowTaskUpdateIncidentTaskParams
    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 WorkflowTaskUpdateIncidentTaskParamsArgs
    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 WorkflowTaskUpdateIncidentTaskParams
    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 WorkflowTaskUpdateIncidentTaskParams
    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 WorkflowTaskUpdateIncidentTaskParamsArgs
    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

    WorkflowTaskUpdateIncidentTaskParams, WorkflowTaskUpdateIncidentTaskParamsArgs

    IncidentId string
    The incident id to update or id of any attribute on the incident
    AcknowledgedAt string
    AttributeToQueryBy string
    Value must be one of id, slug, sequential_id, pagerduty_incident_id, opsgenie_incident_id, victor_ops_incident_id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    CustomFieldsMapping string
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    DetectedAt string
    EnvironmentIds List<string>
    FunctionalityIds List<string>
    GroupIds List<string>
    IncidentTypeIds List<string>
    MitigatedAt string
    Private bool
    Value must be one of true or false
    ResolvedAt string
    ServiceIds List<string>
    SeverityId string
    StartedAt string
    Status string
    Summary string
    The incident summary
    TaskType string
    Title string
    The incident title
    IncidentId string
    The incident id to update or id of any attribute on the incident
    AcknowledgedAt string
    AttributeToQueryBy string
    Value must be one of id, slug, sequential_id, pagerduty_incident_id, opsgenie_incident_id, victor_ops_incident_id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    CustomFieldsMapping string
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    DetectedAt string
    EnvironmentIds []string
    FunctionalityIds []string
    GroupIds []string
    IncidentTypeIds []string
    MitigatedAt string
    Private bool
    Value must be one of true or false
    ResolvedAt string
    ServiceIds []string
    SeverityId string
    StartedAt string
    Status string
    Summary string
    The incident summary
    TaskType string
    Title string
    The incident title
    incidentId String
    The incident id to update or id of any attribute on the incident
    acknowledgedAt String
    attributeToQueryBy String
    Value must be one of id, slug, sequential_id, pagerduty_incident_id, opsgenie_incident_id, victor_ops_incident_id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    customFieldsMapping String
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    detectedAt String
    environmentIds List<String>
    functionalityIds List<String>
    groupIds List<String>
    incidentTypeIds List<String>
    mitigatedAt String
    private_ Boolean
    Value must be one of true or false
    resolvedAt String
    serviceIds List<String>
    severityId String
    startedAt String
    status String
    summary String
    The incident summary
    taskType String
    title String
    The incident title
    incidentId string
    The incident id to update or id of any attribute on the incident
    acknowledgedAt string
    attributeToQueryBy string
    Value must be one of id, slug, sequential_id, pagerduty_incident_id, opsgenie_incident_id, victor_ops_incident_id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    customFieldsMapping string
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    detectedAt string
    environmentIds string[]
    functionalityIds string[]
    groupIds string[]
    incidentTypeIds string[]
    mitigatedAt string
    private boolean
    Value must be one of true or false
    resolvedAt string
    serviceIds string[]
    severityId string
    startedAt string
    status string
    summary string
    The incident summary
    taskType string
    title string
    The incident title
    incident_id str
    The incident id to update or id of any attribute on the incident
    acknowledged_at str
    attribute_to_query_by str
    Value must be one of id, slug, sequential_id, pagerduty_incident_id, opsgenie_incident_id, victor_ops_incident_id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    custom_fields_mapping str
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    detected_at str
    environment_ids Sequence[str]
    functionality_ids Sequence[str]
    group_ids Sequence[str]
    incident_type_ids Sequence[str]
    mitigated_at str
    private bool
    Value must be one of true or false
    resolved_at str
    service_ids Sequence[str]
    severity_id str
    started_at str
    status str
    summary str
    The incident summary
    task_type str
    title str
    The incident title
    incidentId String
    The incident id to update or id of any attribute on the incident
    acknowledgedAt String
    attributeToQueryBy String
    Value must be one of id, slug, sequential_id, pagerduty_incident_id, opsgenie_incident_id, victor_ops_incident_id, jira_issue_id, asana_task_id, shortcut_task_id, linear_issue_id, zendesk_ticket_id, trello_card_id, airtable_record_id, shortcut_story_id, github_issue_id, gitlab_issue_id, freshservice_ticket_id, freshservice_task_id, clickup_task_id.
    customFieldsMapping String
    Custom field mappings. Can contain liquid markup and need to be valid JSON
    detectedAt String
    environmentIds List<String>
    functionalityIds List<String>
    groupIds List<String>
    incidentTypeIds List<String>
    mitigatedAt String
    private Boolean
    Value must be one of true or false
    resolvedAt String
    serviceIds List<String>
    severityId String
    startedAt String
    status String
    summary String
    The incident summary
    taskType String
    title String
    The incident title

    Package Details

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