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

rootly.WorkflowTaskUpdateOpsgenieAlert

Explore with Pulumi AI

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

    Manages workflow update_opsgenie_alert task.

    Create WorkflowTaskUpdateOpsgenieAlert Resource

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

    Constructor syntax

    new WorkflowTaskUpdateOpsgenieAlert(name: string, args: WorkflowTaskUpdateOpsgenieAlertArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskUpdateOpsgenieAlert(resource_name: str,
                                        args: WorkflowTaskUpdateOpsgenieAlertArgs,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowTaskUpdateOpsgenieAlert(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        task_params: Optional[WorkflowTaskUpdateOpsgenieAlertTaskParamsArgs] = 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 NewWorkflowTaskUpdateOpsgenieAlert(ctx *Context, name string, args WorkflowTaskUpdateOpsgenieAlertArgs, opts ...ResourceOption) (*WorkflowTaskUpdateOpsgenieAlert, error)
    public WorkflowTaskUpdateOpsgenieAlert(string name, WorkflowTaskUpdateOpsgenieAlertArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskUpdateOpsgenieAlert(String name, WorkflowTaskUpdateOpsgenieAlertArgs args)
    public WorkflowTaskUpdateOpsgenieAlert(String name, WorkflowTaskUpdateOpsgenieAlertArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskUpdateOpsgenieAlert
    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 WorkflowTaskUpdateOpsgenieAlertArgs
    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 WorkflowTaskUpdateOpsgenieAlertArgs
    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 WorkflowTaskUpdateOpsgenieAlertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskUpdateOpsgenieAlertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskUpdateOpsgenieAlertArgs
    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 workflowTaskUpdateOpsgenieAlertResource = new Rootly.WorkflowTaskUpdateOpsgenieAlert("workflowTaskUpdateOpsgenieAlertResource", new()
    {
        TaskParams = new Rootly.Inputs.WorkflowTaskUpdateOpsgenieAlertTaskParamsArgs
        {
            AlertId = "string",
            Completion = 
            {
                { "string", "any" },
            },
            Priority = "string",
            Description = "string",
            Message = "string",
            TaskType = "string",
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskUpdateOpsgenieAlert(ctx, "workflowTaskUpdateOpsgenieAlertResource", &rootly.WorkflowTaskUpdateOpsgenieAlertArgs{
    	TaskParams: &rootly.WorkflowTaskUpdateOpsgenieAlertTaskParamsArgs{
    		AlertId: pulumi.String("string"),
    		Completion: pulumi.Map{
    			"string": pulumi.Any("any"),
    		},
    		Priority:    pulumi.String("string"),
    		Description: pulumi.String("string"),
    		Message:     pulumi.String("string"),
    		TaskType:    pulumi.String("string"),
    	},
    	WorkflowId:    pulumi.String("string"),
    	Enabled:       pulumi.Bool(false),
    	Name:          pulumi.String("string"),
    	Position:      pulumi.Int(0),
    	SkipOnFailure: pulumi.Bool(false),
    })
    
    var workflowTaskUpdateOpsgenieAlertResource = new WorkflowTaskUpdateOpsgenieAlert("workflowTaskUpdateOpsgenieAlertResource", WorkflowTaskUpdateOpsgenieAlertArgs.builder()
        .taskParams(WorkflowTaskUpdateOpsgenieAlertTaskParamsArgs.builder()
            .alertId("string")
            .completion(Map.of("string", "any"))
            .priority("string")
            .description("string")
            .message("string")
            .taskType("string")
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_update_opsgenie_alert_resource = rootly.WorkflowTaskUpdateOpsgenieAlert("workflowTaskUpdateOpsgenieAlertResource",
        task_params={
            "alert_id": "string",
            "completion": {
                "string": "any",
            },
            "priority": "string",
            "description": "string",
            "message": "string",
            "task_type": "string",
        },
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskUpdateOpsgenieAlertResource = new rootly.WorkflowTaskUpdateOpsgenieAlert("workflowTaskUpdateOpsgenieAlertResource", {
        taskParams: {
            alertId: "string",
            completion: {
                string: "any",
            },
            priority: "string",
            description: "string",
            message: "string",
            taskType: "string",
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskUpdateOpsgenieAlert
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            alertId: string
            completion:
                string: any
            description: string
            message: string
            priority: string
            taskType: string
        workflowId: string
    

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

    TaskParams WorkflowTaskUpdateOpsgenieAlertTaskParams
    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 WorkflowTaskUpdateOpsgenieAlertTaskParamsArgs
    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 WorkflowTaskUpdateOpsgenieAlertTaskParams
    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 WorkflowTaskUpdateOpsgenieAlertTaskParams
    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 WorkflowTaskUpdateOpsgenieAlertTaskParamsArgs
    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 WorkflowTaskUpdateOpsgenieAlert 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 WorkflowTaskUpdateOpsgenieAlert Resource

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

    WorkflowTaskUpdateOpsgenieAlertTaskParams, WorkflowTaskUpdateOpsgenieAlertTaskParamsArgs

    AlertId string
    Opsgenie Alert ID
    Completion Dictionary<string, object>
    Map must contain two fields, id and name.
    Priority string
    Value must be one of P1, P2, P3, P4, P5, auto.
    Description string
    Description field of the alert that is generally used to provide a detailed information about the alert
    Message string
    Message of the alert
    TaskType string
    AlertId string
    Opsgenie Alert ID
    Completion map[string]interface{}
    Map must contain two fields, id and name.
    Priority string
    Value must be one of P1, P2, P3, P4, P5, auto.
    Description string
    Description field of the alert that is generally used to provide a detailed information about the alert
    Message string
    Message of the alert
    TaskType string
    alertId String
    Opsgenie Alert ID
    completion Map<String,Object>
    Map must contain two fields, id and name.
    priority String
    Value must be one of P1, P2, P3, P4, P5, auto.
    description String
    Description field of the alert that is generally used to provide a detailed information about the alert
    message String
    Message of the alert
    taskType String
    alertId string
    Opsgenie Alert ID
    completion {[key: string]: any}
    Map must contain two fields, id and name.
    priority string
    Value must be one of P1, P2, P3, P4, P5, auto.
    description string
    Description field of the alert that is generally used to provide a detailed information about the alert
    message string
    Message of the alert
    taskType string
    alert_id str
    Opsgenie Alert ID
    completion Mapping[str, Any]
    Map must contain two fields, id and name.
    priority str
    Value must be one of P1, P2, P3, P4, P5, auto.
    description str
    Description field of the alert that is generally used to provide a detailed information about the alert
    message str
    Message of the alert
    task_type str
    alertId String
    Opsgenie Alert ID
    completion Map<Any>
    Map must contain two fields, id and name.
    priority String
    Value must be one of P1, P2, P3, P4, P5, auto.
    description String
    Description field of the alert that is generally used to provide a detailed information about the alert
    message String
    Message of the alert
    taskType 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