Docs Packages
  1. Packages
  2. Rootly
  3. API Docs
  4. WorkflowTaskPublishIncident
Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly
rootlyhq/pulumi-rootly

rootly.WorkflowTaskPublishIncident

Explore with Pulumi AI

rootly logo
Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly
rootlyhq/pulumi-rootly

    Manages workflow publish_incident task.

    Create WorkflowTaskPublishIncident Resource

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

    Constructor syntax

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

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

    type: rootly:WorkflowTaskPublishIncident
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 WorkflowTaskPublishIncidentArgs
    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 WorkflowTaskPublishIncidentArgs
    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 WorkflowTaskPublishIncidentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskPublishIncidentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskPublishIncidentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var workflowTaskPublishIncidentResource = new Rootly.WorkflowTaskPublishIncident("workflowTaskPublishIncidentResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskPublishIncidentTaskParamsArgs
    {
        Incident = 
        {
            { "string", "any" },
        },
        PublicTitle = "string",
        Status = "string",
        StatusPageId = "string",
        Event = "string",
        IntegrationPayload = "string",
        NotifySubscribers = false,
        ShouldTweet = false,
        StatusPageTemplate = 
        {
            { "string", "any" },
        },
        TaskType = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});

    example, err := rootly.NewWorkflowTaskPublishIncident(ctx, "workflowTaskPublishIncidentResource", &rootly.WorkflowTaskPublishIncidentArgs{
	TaskParams: &rootly.WorkflowTaskPublishIncidentTaskParamsArgs{
		Incident: pulumi.Map{
			"string": pulumi.Any("any"),
		},
		PublicTitle:        pulumi.String("string"),
		Status:             pulumi.String("string"),
		StatusPageId:       pulumi.String("string"),
		Event:              pulumi.String("string"),
		IntegrationPayload: pulumi.String("string"),
		NotifySubscribers:  pulumi.Bool(false),
		ShouldTweet:        pulumi.Bool(false),
		StatusPageTemplate: pulumi.Map{
			"string": pulumi.Any("any"),
		},
		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 workflowTaskPublishIncidentResource = new WorkflowTaskPublishIncident("workflowTaskPublishIncidentResource", WorkflowTaskPublishIncidentArgs.builder()        
    .taskParams(WorkflowTaskPublishIncidentTaskParamsArgs.builder()
        .incident(Map.of("string", "any"))
        .publicTitle("string")
        .status("string")
        .statusPageId("string")
        .event("string")
        .integrationPayload("string")
        .notifySubscribers(false)
        .shouldTweet(false)
        .statusPageTemplate(Map.of("string", "any"))
        .taskType("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());

    workflow_task_publish_incident_resource = rootly.WorkflowTaskPublishIncident("workflowTaskPublishIncidentResource",
    task_params=rootly.WorkflowTaskPublishIncidentTaskParamsArgs(
        incident={
            "string": "any",
        },
        public_title="string",
        status="string",
        status_page_id="string",
        event="string",
        integration_payload="string",
        notify_subscribers=False,
        should_tweet=False,
        status_page_template={
            "string": "any",
        },
        task_type="string",
    ),
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)

    const workflowTaskPublishIncidentResource = new rootly.WorkflowTaskPublishIncident("workflowTaskPublishIncidentResource", {
    taskParams: {
        incident: {
            string: "any",
        },
        publicTitle: "string",
        status: "string",
        statusPageId: "string",
        event: "string",
        integrationPayload: "string",
        notifySubscribers: false,
        shouldTweet: false,
        statusPageTemplate: {
            string: "any",
        },
        taskType: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});

    type: rootly:WorkflowTaskPublishIncident
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        event: string
        incident:
            string: any
        integrationPayload: string
        notifySubscribers: false
        publicTitle: string
        shouldTweet: false
        status: string
        statusPageId: string
        statusPageTemplate:
            string: any
        taskType: string
    workflowId: string

    WorkflowTaskPublishIncident Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The WorkflowTaskPublishIncident resource accepts the following input properties:

    TaskParams WorkflowTaskPublishIncidentTaskParams
    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 WorkflowTaskPublishIncidentTaskParamsArgs
    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 WorkflowTaskPublishIncidentTaskParams
    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 WorkflowTaskPublishIncidentTaskParams
    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 WorkflowTaskPublishIncidentTaskParamsArgs
    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 WorkflowTaskPublishIncident 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 WorkflowTaskPublishIncident Resource

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

    WorkflowTaskPublishIncidentTaskParams, WorkflowTaskPublishIncidentTaskParamsArgs

    Incident Dictionary<string, object>
    Map must contain two fields, id and name.
    PublicTitle string
    Status string
    Value must be one of investigating, identified, monitoring, resolved, scheduled, in_progress, verifying, completed.
    StatusPageId string
    Event string
    Incident event description
    IntegrationPayload string
    Additional API Payload you can pass to statuspage.io for example. Can contain liquid markup and need to be valid JSON
    NotifySubscribers bool
    When true notifies subscribers of the status page by email/text. Value must be one of true or false
    ShouldTweet bool
    For Statuspage.io integrated pages auto publishes a tweet for your update. Value must be one of true or false
    StatusPageTemplate Dictionary<string, object>
    Map must contain two fields, id and name.
    TaskType string
    Incident map[string]interface{}
    Map must contain two fields, id and name.
    PublicTitle string
    Status string
    Value must be one of investigating, identified, monitoring, resolved, scheduled, in_progress, verifying, completed.
    StatusPageId string
    Event string
    Incident event description
    IntegrationPayload string
    Additional API Payload you can pass to statuspage.io for example. Can contain liquid markup and need to be valid JSON
    NotifySubscribers bool
    When true notifies subscribers of the status page by email/text. Value must be one of true or false
    ShouldTweet bool
    For Statuspage.io integrated pages auto publishes a tweet for your update. Value must be one of true or false
    StatusPageTemplate map[string]interface{}
    Map must contain two fields, id and name.
    TaskType string
    incident Map<String,Object>
    Map must contain two fields, id and name.
    publicTitle String
    status String
    Value must be one of investigating, identified, monitoring, resolved, scheduled, in_progress, verifying, completed.
    statusPageId String
    event String
    Incident event description
    integrationPayload String
    Additional API Payload you can pass to statuspage.io for example. Can contain liquid markup and need to be valid JSON
    notifySubscribers Boolean
    When true notifies subscribers of the status page by email/text. Value must be one of true or false
    shouldTweet Boolean
    For Statuspage.io integrated pages auto publishes a tweet for your update. Value must be one of true or false
    statusPageTemplate Map<String,Object>
    Map must contain two fields, id and name.
    taskType String
    incident {[key: string]: any}
    Map must contain two fields, id and name.
    publicTitle string
    status string
    Value must be one of investigating, identified, monitoring, resolved, scheduled, in_progress, verifying, completed.
    statusPageId string
    event string
    Incident event description
    integrationPayload string
    Additional API Payload you can pass to statuspage.io for example. Can contain liquid markup and need to be valid JSON
    notifySubscribers boolean
    When true notifies subscribers of the status page by email/text. Value must be one of true or false
    shouldTweet boolean
    For Statuspage.io integrated pages auto publishes a tweet for your update. Value must be one of true or false
    statusPageTemplate {[key: string]: any}
    Map must contain two fields, id and name.
    taskType string
    incident Mapping[str, Any]
    Map must contain two fields, id and name.
    public_title str
    status str
    Value must be one of investigating, identified, monitoring, resolved, scheduled, in_progress, verifying, completed.
    status_page_id str
    event str
    Incident event description
    integration_payload str
    Additional API Payload you can pass to statuspage.io for example. Can contain liquid markup and need to be valid JSON
    notify_subscribers bool
    When true notifies subscribers of the status page by email/text. Value must be one of true or false
    should_tweet bool
    For Statuspage.io integrated pages auto publishes a tweet for your update. Value must be one of true or false
    status_page_template Mapping[str, Any]
    Map must contain two fields, id and name.
    task_type str
    incident Map<Any>
    Map must contain two fields, id and name.
    publicTitle String
    status String
    Value must be one of investigating, identified, monitoring, resolved, scheduled, in_progress, verifying, completed.
    statusPageId String
    event String
    Incident event description
    integrationPayload String
    Additional API Payload you can pass to statuspage.io for example. Can contain liquid markup and need to be valid JSON
    notifySubscribers Boolean
    When true notifies subscribers of the status page by email/text. Value must be one of true or false
    shouldTweet Boolean
    For Statuspage.io integrated pages auto publishes a tweet for your update. Value must be one of true or false
    statusPageTemplate Map<Any>
    Map must contain two fields, id and name.
    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.2.1 published on Tuesday, Apr 2, 2024 by Rootly
    rootlyhq/pulumi-rootly