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

rootly.WorkflowTaskCreateOpsgenieAlert

Explore with Pulumi AI

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

    Manages workflow create_opsgenie_alert task.

    Create WorkflowTaskCreateOpsgenieAlert Resource

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

    Constructor syntax

    new WorkflowTaskCreateOpsgenieAlert(name: string, args: WorkflowTaskCreateOpsgenieAlertArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskCreateOpsgenieAlert(resource_name: str,
                                        args: WorkflowTaskCreateOpsgenieAlertArgs,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowTaskCreateOpsgenieAlert(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        task_params: Optional[WorkflowTaskCreateOpsgenieAlertTaskParamsArgs] = 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 NewWorkflowTaskCreateOpsgenieAlert(ctx *Context, name string, args WorkflowTaskCreateOpsgenieAlertArgs, opts ...ResourceOption) (*WorkflowTaskCreateOpsgenieAlert, error)
    public WorkflowTaskCreateOpsgenieAlert(string name, WorkflowTaskCreateOpsgenieAlertArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskCreateOpsgenieAlert(String name, WorkflowTaskCreateOpsgenieAlertArgs args)
    public WorkflowTaskCreateOpsgenieAlert(String name, WorkflowTaskCreateOpsgenieAlertArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskCreateOpsgenieAlert
    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 WorkflowTaskCreateOpsgenieAlertArgs
    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 WorkflowTaskCreateOpsgenieAlertArgs
    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 WorkflowTaskCreateOpsgenieAlertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskCreateOpsgenieAlertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskCreateOpsgenieAlertArgs
    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 workflowTaskCreateOpsgenieAlertResource = new Rootly.WorkflowTaskCreateOpsgenieAlert("workflowTaskCreateOpsgenieAlertResource", new()
    {
        TaskParams = new Rootly.Inputs.WorkflowTaskCreateOpsgenieAlertTaskParamsArgs
        {
            Message = "string",
            Description = "string",
            Escalations = new[]
            {
                new Rootly.Inputs.WorkflowTaskCreateOpsgenieAlertTaskParamsEscalationArgs
                {
                    Id = "string",
                    Name = "string",
                },
            },
            Priority = "string",
            Schedules = new[]
            {
                new Rootly.Inputs.WorkflowTaskCreateOpsgenieAlertTaskParamsScheduleArgs
                {
                    Id = "string",
                    Name = "string",
                },
            },
            TaskType = "string",
            Teams = new[]
            {
                new Rootly.Inputs.WorkflowTaskCreateOpsgenieAlertTaskParamsTeamArgs
                {
                    Id = "string",
                    Name = "string",
                },
            },
            Users = new[]
            {
                new Rootly.Inputs.WorkflowTaskCreateOpsgenieAlertTaskParamsUserArgs
                {
                    Id = "string",
                    Name = "string",
                },
            },
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskCreateOpsgenieAlert(ctx, "workflowTaskCreateOpsgenieAlertResource", &rootly.WorkflowTaskCreateOpsgenieAlertArgs{
    	TaskParams: &rootly.WorkflowTaskCreateOpsgenieAlertTaskParamsArgs{
    		Message:     pulumi.String("string"),
    		Description: pulumi.String("string"),
    		Escalations: rootly.WorkflowTaskCreateOpsgenieAlertTaskParamsEscalationArray{
    			&rootly.WorkflowTaskCreateOpsgenieAlertTaskParamsEscalationArgs{
    				Id:   pulumi.String("string"),
    				Name: pulumi.String("string"),
    			},
    		},
    		Priority: pulumi.String("string"),
    		Schedules: rootly.WorkflowTaskCreateOpsgenieAlertTaskParamsScheduleArray{
    			&rootly.WorkflowTaskCreateOpsgenieAlertTaskParamsScheduleArgs{
    				Id:   pulumi.String("string"),
    				Name: pulumi.String("string"),
    			},
    		},
    		TaskType: pulumi.String("string"),
    		Teams: rootly.WorkflowTaskCreateOpsgenieAlertTaskParamsTeamArray{
    			&rootly.WorkflowTaskCreateOpsgenieAlertTaskParamsTeamArgs{
    				Id:   pulumi.String("string"),
    				Name: pulumi.String("string"),
    			},
    		},
    		Users: rootly.WorkflowTaskCreateOpsgenieAlertTaskParamsUserArray{
    			&rootly.WorkflowTaskCreateOpsgenieAlertTaskParamsUserArgs{
    				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 workflowTaskCreateOpsgenieAlertResource = new WorkflowTaskCreateOpsgenieAlert("workflowTaskCreateOpsgenieAlertResource", WorkflowTaskCreateOpsgenieAlertArgs.builder()
        .taskParams(WorkflowTaskCreateOpsgenieAlertTaskParamsArgs.builder()
            .message("string")
            .description("string")
            .escalations(WorkflowTaskCreateOpsgenieAlertTaskParamsEscalationArgs.builder()
                .id("string")
                .name("string")
                .build())
            .priority("string")
            .schedules(WorkflowTaskCreateOpsgenieAlertTaskParamsScheduleArgs.builder()
                .id("string")
                .name("string")
                .build())
            .taskType("string")
            .teams(WorkflowTaskCreateOpsgenieAlertTaskParamsTeamArgs.builder()
                .id("string")
                .name("string")
                .build())
            .users(WorkflowTaskCreateOpsgenieAlertTaskParamsUserArgs.builder()
                .id("string")
                .name("string")
                .build())
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_create_opsgenie_alert_resource = rootly.WorkflowTaskCreateOpsgenieAlert("workflowTaskCreateOpsgenieAlertResource",
        task_params={
            "message": "string",
            "description": "string",
            "escalations": [{
                "id": "string",
                "name": "string",
            }],
            "priority": "string",
            "schedules": [{
                "id": "string",
                "name": "string",
            }],
            "task_type": "string",
            "teams": [{
                "id": "string",
                "name": "string",
            }],
            "users": [{
                "id": "string",
                "name": "string",
            }],
        },
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskCreateOpsgenieAlertResource = new rootly.WorkflowTaskCreateOpsgenieAlert("workflowTaskCreateOpsgenieAlertResource", {
        taskParams: {
            message: "string",
            description: "string",
            escalations: [{
                id: "string",
                name: "string",
            }],
            priority: "string",
            schedules: [{
                id: "string",
                name: "string",
            }],
            taskType: "string",
            teams: [{
                id: "string",
                name: "string",
            }],
            users: [{
                id: "string",
                name: "string",
            }],
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskCreateOpsgenieAlert
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            description: string
            escalations:
                - id: string
                  name: string
            message: string
            priority: string
            schedules:
                - id: string
                  name: string
            taskType: string
            teams:
                - id: string
                  name: string
            users:
                - id: string
                  name: string
        workflowId: string
    

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

    TaskParams WorkflowTaskCreateOpsgenieAlertTaskParams
    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 WorkflowTaskCreateOpsgenieAlertTaskParamsArgs
    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 WorkflowTaskCreateOpsgenieAlertTaskParams
    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 WorkflowTaskCreateOpsgenieAlertTaskParams
    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 WorkflowTaskCreateOpsgenieAlertTaskParamsArgs
    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 WorkflowTaskCreateOpsgenieAlert 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 WorkflowTaskCreateOpsgenieAlert Resource

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

    WorkflowTaskCreateOpsgenieAlertTaskParams, WorkflowTaskCreateOpsgenieAlertTaskParamsArgs

    Message string
    Message of the alert
    Description string
    Description field of the alert that is generally used to provide a detailed information about the alert
    Escalations List<WorkflowTaskCreateOpsgenieAlertTaskParamsEscalation>
    Priority string
    Value must be one of P1, P2, P3, P4, P5, auto.
    Schedules List<WorkflowTaskCreateOpsgenieAlertTaskParamsSchedule>
    TaskType string
    Teams List<WorkflowTaskCreateOpsgenieAlertTaskParamsTeam>
    Users List<WorkflowTaskCreateOpsgenieAlertTaskParamsUser>
    Message string
    Message of the alert
    Description string
    Description field of the alert that is generally used to provide a detailed information about the alert
    Escalations []WorkflowTaskCreateOpsgenieAlertTaskParamsEscalation
    Priority string
    Value must be one of P1, P2, P3, P4, P5, auto.
    Schedules []WorkflowTaskCreateOpsgenieAlertTaskParamsSchedule
    TaskType string
    Teams []WorkflowTaskCreateOpsgenieAlertTaskParamsTeam
    Users []WorkflowTaskCreateOpsgenieAlertTaskParamsUser
    message String
    Message of the alert
    description String
    Description field of the alert that is generally used to provide a detailed information about the alert
    escalations List<WorkflowTaskCreateOpsgenieAlertTaskParamsEscalation>
    priority String
    Value must be one of P1, P2, P3, P4, P5, auto.
    schedules List<WorkflowTaskCreateOpsgenieAlertTaskParamsSchedule>
    taskType String
    teams List<WorkflowTaskCreateOpsgenieAlertTaskParamsTeam>
    users List<WorkflowTaskCreateOpsgenieAlertTaskParamsUser>
    message string
    Message of the alert
    description string
    Description field of the alert that is generally used to provide a detailed information about the alert
    escalations WorkflowTaskCreateOpsgenieAlertTaskParamsEscalation[]
    priority string
    Value must be one of P1, P2, P3, P4, P5, auto.
    schedules WorkflowTaskCreateOpsgenieAlertTaskParamsSchedule[]
    taskType string
    teams WorkflowTaskCreateOpsgenieAlertTaskParamsTeam[]
    users WorkflowTaskCreateOpsgenieAlertTaskParamsUser[]
    message String
    Message of the alert
    description String
    Description field of the alert that is generally used to provide a detailed information about the alert
    escalations List<Property Map>
    priority String
    Value must be one of P1, P2, P3, P4, P5, auto.
    schedules List<Property Map>
    taskType String
    teams List<Property Map>
    users List<Property Map>

    WorkflowTaskCreateOpsgenieAlertTaskParamsEscalation, WorkflowTaskCreateOpsgenieAlertTaskParamsEscalationArgs

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

    WorkflowTaskCreateOpsgenieAlertTaskParamsSchedule, WorkflowTaskCreateOpsgenieAlertTaskParamsScheduleArgs

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

    WorkflowTaskCreateOpsgenieAlertTaskParamsTeam, WorkflowTaskCreateOpsgenieAlertTaskParamsTeamArgs

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

    WorkflowTaskCreateOpsgenieAlertTaskParamsUser, WorkflowTaskCreateOpsgenieAlertTaskParamsUserArgs

    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