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

rootly.WorkflowTaskUpdatePagertreeAlert

Explore with Pulumi AI

rootly logo
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly

    Manages workflow update_pagertree_alert task.

    Create WorkflowTaskUpdatePagertreeAlert Resource

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

    Constructor syntax

    new WorkflowTaskUpdatePagertreeAlert(name: string, args: WorkflowTaskUpdatePagertreeAlertArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskUpdatePagertreeAlert(resource_name: str,
                                         args: WorkflowTaskUpdatePagertreeAlertArgs,
                                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowTaskUpdatePagertreeAlert(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         task_params: Optional[WorkflowTaskUpdatePagertreeAlertTaskParamsArgs] = 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 NewWorkflowTaskUpdatePagertreeAlert(ctx *Context, name string, args WorkflowTaskUpdatePagertreeAlertArgs, opts ...ResourceOption) (*WorkflowTaskUpdatePagertreeAlert, error)
    public WorkflowTaskUpdatePagertreeAlert(string name, WorkflowTaskUpdatePagertreeAlertArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskUpdatePagertreeAlert(String name, WorkflowTaskUpdatePagertreeAlertArgs args)
    public WorkflowTaskUpdatePagertreeAlert(String name, WorkflowTaskUpdatePagertreeAlertArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskUpdatePagertreeAlert
    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 WorkflowTaskUpdatePagertreeAlertArgs
    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 WorkflowTaskUpdatePagertreeAlertArgs
    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 WorkflowTaskUpdatePagertreeAlertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskUpdatePagertreeAlertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskUpdatePagertreeAlertArgs
    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 workflowTaskUpdatePagertreeAlertResource = new Rootly.WorkflowTaskUpdatePagertreeAlert("workflowTaskUpdatePagertreeAlertResource", new()
    {
        TaskParams = new Rootly.Inputs.WorkflowTaskUpdatePagertreeAlertTaskParamsArgs
        {
            Description = "string",
            Incident = false,
            PagertreeAlertId = "string",
            Severity = "string",
            TaskType = "string",
            Teams = new[]
            {
                new Rootly.Inputs.WorkflowTaskUpdatePagertreeAlertTaskParamsTeamArgs
                {
                    Id = "string",
                    Name = "string",
                },
            },
            Title = "string",
            Urgency = "string",
            Users = new[]
            {
                new Rootly.Inputs.WorkflowTaskUpdatePagertreeAlertTaskParamsUserArgs
                {
                    Id = "string",
                    Name = "string",
                },
            },
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskUpdatePagertreeAlert(ctx, "workflowTaskUpdatePagertreeAlertResource", &rootly.WorkflowTaskUpdatePagertreeAlertArgs{
    	TaskParams: &rootly.WorkflowTaskUpdatePagertreeAlertTaskParamsArgs{
    		Description:      pulumi.String("string"),
    		Incident:         pulumi.Bool(false),
    		PagertreeAlertId: pulumi.String("string"),
    		Severity:         pulumi.String("string"),
    		TaskType:         pulumi.String("string"),
    		Teams: rootly.WorkflowTaskUpdatePagertreeAlertTaskParamsTeamArray{
    			&rootly.WorkflowTaskUpdatePagertreeAlertTaskParamsTeamArgs{
    				Id:   pulumi.String("string"),
    				Name: pulumi.String("string"),
    			},
    		},
    		Title:   pulumi.String("string"),
    		Urgency: pulumi.String("string"),
    		Users: rootly.WorkflowTaskUpdatePagertreeAlertTaskParamsUserArray{
    			&rootly.WorkflowTaskUpdatePagertreeAlertTaskParamsUserArgs{
    				Id:   pulumi.String("string"),
    				Name: pulumi.String("string"),
    			},
    		},
    	},
    	WorkflowId:    pulumi.String("string"),
    	Enabled:       pulumi.Bool(false),
    	Name:          pulumi.String("string"),
    	Position:      pulumi.Int(0),
    	SkipOnFailure: pulumi.Bool(false),
    })
    
    var workflowTaskUpdatePagertreeAlertResource = new WorkflowTaskUpdatePagertreeAlert("workflowTaskUpdatePagertreeAlertResource", WorkflowTaskUpdatePagertreeAlertArgs.builder()
        .taskParams(WorkflowTaskUpdatePagertreeAlertTaskParamsArgs.builder()
            .description("string")
            .incident(false)
            .pagertreeAlertId("string")
            .severity("string")
            .taskType("string")
            .teams(WorkflowTaskUpdatePagertreeAlertTaskParamsTeamArgs.builder()
                .id("string")
                .name("string")
                .build())
            .title("string")
            .urgency("string")
            .users(WorkflowTaskUpdatePagertreeAlertTaskParamsUserArgs.builder()
                .id("string")
                .name("string")
                .build())
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_update_pagertree_alert_resource = rootly.WorkflowTaskUpdatePagertreeAlert("workflowTaskUpdatePagertreeAlertResource",
        task_params={
            "description": "string",
            "incident": False,
            "pagertree_alert_id": "string",
            "severity": "string",
            "task_type": "string",
            "teams": [{
                "id": "string",
                "name": "string",
            }],
            "title": "string",
            "urgency": "string",
            "users": [{
                "id": "string",
                "name": "string",
            }],
        },
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskUpdatePagertreeAlertResource = new rootly.WorkflowTaskUpdatePagertreeAlert("workflowTaskUpdatePagertreeAlertResource", {
        taskParams: {
            description: "string",
            incident: false,
            pagertreeAlertId: "string",
            severity: "string",
            taskType: "string",
            teams: [{
                id: "string",
                name: "string",
            }],
            title: "string",
            urgency: "string",
            users: [{
                id: "string",
                name: "string",
            }],
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskUpdatePagertreeAlert
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            description: string
            incident: false
            pagertreeAlertId: string
            severity: string
            taskType: string
            teams:
                - id: string
                  name: string
            title: string
            urgency: string
            users:
                - id: string
                  name: string
        workflowId: string
    

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

    TaskParams WorkflowTaskUpdatePagertreeAlertTaskParams
    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 WorkflowTaskUpdatePagertreeAlertTaskParamsArgs
    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 WorkflowTaskUpdatePagertreeAlertTaskParams
    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 WorkflowTaskUpdatePagertreeAlertTaskParams
    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 WorkflowTaskUpdatePagertreeAlertTaskParamsArgs
    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 WorkflowTaskUpdatePagertreeAlert 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 WorkflowTaskUpdatePagertreeAlert Resource

    Get an existing WorkflowTaskUpdatePagertreeAlert 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?: WorkflowTaskUpdatePagertreeAlertState, opts?: CustomResourceOptions): WorkflowTaskUpdatePagertreeAlert
    @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[WorkflowTaskUpdatePagertreeAlertTaskParamsArgs] = None,
            workflow_id: Optional[str] = None) -> WorkflowTaskUpdatePagertreeAlert
    func GetWorkflowTaskUpdatePagertreeAlert(ctx *Context, name string, id IDInput, state *WorkflowTaskUpdatePagertreeAlertState, opts ...ResourceOption) (*WorkflowTaskUpdatePagertreeAlert, error)
    public static WorkflowTaskUpdatePagertreeAlert Get(string name, Input<string> id, WorkflowTaskUpdatePagertreeAlertState? state, CustomResourceOptions? opts = null)
    public static WorkflowTaskUpdatePagertreeAlert get(String name, Output<String> id, WorkflowTaskUpdatePagertreeAlertState 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 WorkflowTaskUpdatePagertreeAlertTaskParams
    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 WorkflowTaskUpdatePagertreeAlertTaskParamsArgs
    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 WorkflowTaskUpdatePagertreeAlertTaskParams
    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 WorkflowTaskUpdatePagertreeAlertTaskParams
    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 WorkflowTaskUpdatePagertreeAlertTaskParamsArgs
    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

    WorkflowTaskUpdatePagertreeAlertTaskParams, WorkflowTaskUpdatePagertreeAlertTaskParamsArgs

    Description string
    Description of alert as text
    Incident bool
    Setting to true makes an alert a Pagertree incident. Value must be one of true or false
    PagertreeAlertId string
    The prefix ID of the Pagertree alert
    Severity string
    Value must be one of auto, SEV-1, SEV-2, SEV-3, SEV-4.
    TaskType string
    Teams List<WorkflowTaskUpdatePagertreeAlertTaskParamsTeam>
    Title string
    Title of alert as text
    Urgency string
    Value must be one of auto, critical, high, medium, low.
    Users List<WorkflowTaskUpdatePagertreeAlertTaskParamsUser>
    Description string
    Description of alert as text
    Incident bool
    Setting to true makes an alert a Pagertree incident. Value must be one of true or false
    PagertreeAlertId string
    The prefix ID of the Pagertree alert
    Severity string
    Value must be one of auto, SEV-1, SEV-2, SEV-3, SEV-4.
    TaskType string
    Teams []WorkflowTaskUpdatePagertreeAlertTaskParamsTeam
    Title string
    Title of alert as text
    Urgency string
    Value must be one of auto, critical, high, medium, low.
    Users []WorkflowTaskUpdatePagertreeAlertTaskParamsUser
    description String
    Description of alert as text
    incident Boolean
    Setting to true makes an alert a Pagertree incident. Value must be one of true or false
    pagertreeAlertId String
    The prefix ID of the Pagertree alert
    severity String
    Value must be one of auto, SEV-1, SEV-2, SEV-3, SEV-4.
    taskType String
    teams List<WorkflowTaskUpdatePagertreeAlertTaskParamsTeam>
    title String
    Title of alert as text
    urgency String
    Value must be one of auto, critical, high, medium, low.
    users List<WorkflowTaskUpdatePagertreeAlertTaskParamsUser>
    description string
    Description of alert as text
    incident boolean
    Setting to true makes an alert a Pagertree incident. Value must be one of true or false
    pagertreeAlertId string
    The prefix ID of the Pagertree alert
    severity string
    Value must be one of auto, SEV-1, SEV-2, SEV-3, SEV-4.
    taskType string
    teams WorkflowTaskUpdatePagertreeAlertTaskParamsTeam[]
    title string
    Title of alert as text
    urgency string
    Value must be one of auto, critical, high, medium, low.
    users WorkflowTaskUpdatePagertreeAlertTaskParamsUser[]
    description str
    Description of alert as text
    incident bool
    Setting to true makes an alert a Pagertree incident. Value must be one of true or false
    pagertree_alert_id str
    The prefix ID of the Pagertree alert
    severity str
    Value must be one of auto, SEV-1, SEV-2, SEV-3, SEV-4.
    task_type str
    teams Sequence[WorkflowTaskUpdatePagertreeAlertTaskParamsTeam]
    title str
    Title of alert as text
    urgency str
    Value must be one of auto, critical, high, medium, low.
    users Sequence[WorkflowTaskUpdatePagertreeAlertTaskParamsUser]
    description String
    Description of alert as text
    incident Boolean
    Setting to true makes an alert a Pagertree incident. Value must be one of true or false
    pagertreeAlertId String
    The prefix ID of the Pagertree alert
    severity String
    Value must be one of auto, SEV-1, SEV-2, SEV-3, SEV-4.
    taskType String
    teams List<Property Map>
    title String
    Title of alert as text
    urgency String
    Value must be one of auto, critical, high, medium, low.
    users List<Property Map>

    WorkflowTaskUpdatePagertreeAlertTaskParamsTeam, WorkflowTaskUpdatePagertreeAlertTaskParamsTeamArgs

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

    WorkflowTaskUpdatePagertreeAlertTaskParamsUser, WorkflowTaskUpdatePagertreeAlertTaskParamsUserArgs

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

    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