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

rootly.WorkflowTaskSendDashboardReport

Explore with Pulumi AI

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

    Manages workflow send_dashboard_report task.

    Create WorkflowTaskSendDashboardReport Resource

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

    Constructor syntax

    new WorkflowTaskSendDashboardReport(name: string, args: WorkflowTaskSendDashboardReportArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskSendDashboardReport(resource_name: str,
                                        args: WorkflowTaskSendDashboardReportArgs,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowTaskSendDashboardReport(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        task_params: Optional[WorkflowTaskSendDashboardReportTaskParamsArgs] = 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 NewWorkflowTaskSendDashboardReport(ctx *Context, name string, args WorkflowTaskSendDashboardReportArgs, opts ...ResourceOption) (*WorkflowTaskSendDashboardReport, error)
    public WorkflowTaskSendDashboardReport(string name, WorkflowTaskSendDashboardReportArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskSendDashboardReport(String name, WorkflowTaskSendDashboardReportArgs args)
    public WorkflowTaskSendDashboardReport(String name, WorkflowTaskSendDashboardReportArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskSendDashboardReport
    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 WorkflowTaskSendDashboardReportArgs
    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 WorkflowTaskSendDashboardReportArgs
    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 WorkflowTaskSendDashboardReportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskSendDashboardReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskSendDashboardReportArgs
    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 workflowTaskSendDashboardReportResource = new Rootly.WorkflowTaskSendDashboardReport("workflowTaskSendDashboardReportResource", new()
    {
        TaskParams = new Rootly.Inputs.WorkflowTaskSendDashboardReportTaskParamsArgs
        {
            Body = "string",
            DashboardIds = new[]
            {
                "string",
            },
            Subject = "string",
            Tos = new[]
            {
                "string",
            },
            From = "string",
            Preheader = "string",
            TaskType = "string",
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskSendDashboardReport(ctx, "workflowTaskSendDashboardReportResource", &rootly.WorkflowTaskSendDashboardReportArgs{
    	TaskParams: &rootly.WorkflowTaskSendDashboardReportTaskParamsArgs{
    		Body: pulumi.String("string"),
    		DashboardIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Subject: pulumi.String("string"),
    		Tos: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		From:      pulumi.String("string"),
    		Preheader: 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 workflowTaskSendDashboardReportResource = new WorkflowTaskSendDashboardReport("workflowTaskSendDashboardReportResource", WorkflowTaskSendDashboardReportArgs.builder()
        .taskParams(WorkflowTaskSendDashboardReportTaskParamsArgs.builder()
            .body("string")
            .dashboardIds("string")
            .subject("string")
            .tos("string")
            .from("string")
            .preheader("string")
            .taskType("string")
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_send_dashboard_report_resource = rootly.WorkflowTaskSendDashboardReport("workflowTaskSendDashboardReportResource",
        task_params=rootly.WorkflowTaskSendDashboardReportTaskParamsArgs(
            body="string",
            dashboard_ids=["string"],
            subject="string",
            tos=["string"],
            from_="string",
            preheader="string",
            task_type="string",
        ),
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskSendDashboardReportResource = new rootly.WorkflowTaskSendDashboardReport("workflowTaskSendDashboardReportResource", {
        taskParams: {
            body: "string",
            dashboardIds: ["string"],
            subject: "string",
            tos: ["string"],
            from: "string",
            preheader: "string",
            taskType: "string",
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskSendDashboardReport
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            body: string
            dashboardIds:
                - string
            from: string
            preheader: string
            subject: string
            taskType: string
            tos:
                - string
        workflowId: string
    

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

    TaskParams WorkflowTaskSendDashboardReportTaskParams
    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 WorkflowTaskSendDashboardReportTaskParamsArgs
    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 WorkflowTaskSendDashboardReportTaskParams
    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 WorkflowTaskSendDashboardReportTaskParams
    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 WorkflowTaskSendDashboardReportTaskParamsArgs
    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 WorkflowTaskSendDashboardReport 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 WorkflowTaskSendDashboardReport Resource

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

    WorkflowTaskSendDashboardReportTaskParams, WorkflowTaskSendDashboardReportTaskParamsArgs

    Body string
    The email body
    DashboardIds List<string>
    Subject string
    The subject
    Tos List<string>
    From string
    The from email address. Need to use SMTP integration if different than rootly.com
    Preheader string
    The preheader
    TaskType string
    Body string
    The email body
    DashboardIds []string
    Subject string
    The subject
    Tos []string
    From string
    The from email address. Need to use SMTP integration if different than rootly.com
    Preheader string
    The preheader
    TaskType string
    body String
    The email body
    dashboardIds List<String>
    subject String
    The subject
    tos List<String>
    from String
    The from email address. Need to use SMTP integration if different than rootly.com
    preheader String
    The preheader
    taskType String
    body string
    The email body
    dashboardIds string[]
    subject string
    The subject
    tos string[]
    from string
    The from email address. Need to use SMTP integration if different than rootly.com
    preheader string
    The preheader
    taskType string
    body str
    The email body
    dashboard_ids Sequence[str]
    subject str
    The subject
    tos Sequence[str]
    from_ str
    The from email address. Need to use SMTP integration if different than rootly.com
    preheader str
    The preheader
    task_type str
    body String
    The email body
    dashboardIds List<String>
    subject String
    The subject
    tos List<String>
    from String
    The from email address. Need to use SMTP integration if different than rootly.com
    preheader String
    The preheader
    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