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

rootly.WorkflowTaskSendEmail

Explore with Pulumi AI

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

    Manages workflow send_email task.

    Create WorkflowTaskSendEmail Resource

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

    Constructor syntax

    new WorkflowTaskSendEmail(name: string, args: WorkflowTaskSendEmailArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskSendEmail(resource_name: str,
                              args: WorkflowTaskSendEmailArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowTaskSendEmail(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              task_params: Optional[WorkflowTaskSendEmailTaskParamsArgs] = 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 NewWorkflowTaskSendEmail(ctx *Context, name string, args WorkflowTaskSendEmailArgs, opts ...ResourceOption) (*WorkflowTaskSendEmail, error)
    public WorkflowTaskSendEmail(string name, WorkflowTaskSendEmailArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskSendEmail(String name, WorkflowTaskSendEmailArgs args)
    public WorkflowTaskSendEmail(String name, WorkflowTaskSendEmailArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskSendEmail
    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 WorkflowTaskSendEmailArgs
    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 WorkflowTaskSendEmailArgs
    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 WorkflowTaskSendEmailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskSendEmailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskSendEmailArgs
    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 workflowTaskSendEmailResource = new Rootly.WorkflowTaskSendEmail("workflowTaskSendEmailResource", new()
    {
        TaskParams = new Rootly.Inputs.WorkflowTaskSendEmailTaskParamsArgs
        {
            Body = "string",
            Subject = "string",
            Tos = new[]
            {
                "string",
            },
            Bccs = new[]
            {
                "string",
            },
            Ccs = new[]
            {
                "string",
            },
            CustomLogoUrl = "string",
            From = "string",
            IncludeFooter = false,
            IncludeHeader = false,
            Preheader = "string",
            TaskType = "string",
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskSendEmail(ctx, "workflowTaskSendEmailResource", &rootly.WorkflowTaskSendEmailArgs{
    	TaskParams: &rootly.WorkflowTaskSendEmailTaskParamsArgs{
    		Body:    pulumi.String("string"),
    		Subject: pulumi.String("string"),
    		Tos: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Bccs: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Ccs: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		CustomLogoUrl: pulumi.String("string"),
    		From:          pulumi.String("string"),
    		IncludeFooter: pulumi.Bool(false),
    		IncludeHeader: pulumi.Bool(false),
    		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 workflowTaskSendEmailResource = new WorkflowTaskSendEmail("workflowTaskSendEmailResource", WorkflowTaskSendEmailArgs.builder()
        .taskParams(WorkflowTaskSendEmailTaskParamsArgs.builder()
            .body("string")
            .subject("string")
            .tos("string")
            .bccs("string")
            .ccs("string")
            .customLogoUrl("string")
            .from("string")
            .includeFooter(false)
            .includeHeader(false)
            .preheader("string")
            .taskType("string")
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_send_email_resource = rootly.WorkflowTaskSendEmail("workflowTaskSendEmailResource",
        task_params=rootly.WorkflowTaskSendEmailTaskParamsArgs(
            body="string",
            subject="string",
            tos=["string"],
            bccs=["string"],
            ccs=["string"],
            custom_logo_url="string",
            from_="string",
            include_footer=False,
            include_header=False,
            preheader="string",
            task_type="string",
        ),
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskSendEmailResource = new rootly.WorkflowTaskSendEmail("workflowTaskSendEmailResource", {
        taskParams: {
            body: "string",
            subject: "string",
            tos: ["string"],
            bccs: ["string"],
            ccs: ["string"],
            customLogoUrl: "string",
            from: "string",
            includeFooter: false,
            includeHeader: false,
            preheader: "string",
            taskType: "string",
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskSendEmail
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            bccs:
                - string
            body: string
            ccs:
                - string
            customLogoUrl: string
            from: string
            includeFooter: false
            includeHeader: false
            preheader: string
            subject: string
            taskType: string
            tos:
                - string
        workflowId: string
    

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

    TaskParams WorkflowTaskSendEmailTaskParams
    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 WorkflowTaskSendEmailTaskParamsArgs
    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 WorkflowTaskSendEmailTaskParams
    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 WorkflowTaskSendEmailTaskParams
    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 WorkflowTaskSendEmailTaskParamsArgs
    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 WorkflowTaskSendEmail 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 WorkflowTaskSendEmail Resource

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

    WorkflowTaskSendEmailTaskParams, WorkflowTaskSendEmailTaskParamsArgs

    Body string
    The email body
    Subject string
    The subject
    Tos List<string>
    Bccs List<string>
    Ccs List<string>
    CustomLogoUrl string
    URL to your custom email logo
    From string
    The from email address. Need to use SMTP integration if different than rootly.com
    IncludeFooter bool
    Value must be one of true or false
    IncludeHeader bool
    Value must be one of true or false
    Preheader string
    The preheader
    TaskType string
    Body string
    The email body
    Subject string
    The subject
    Tos []string
    Bccs []string
    Ccs []string
    CustomLogoUrl string
    URL to your custom email logo
    From string
    The from email address. Need to use SMTP integration if different than rootly.com
    IncludeFooter bool
    Value must be one of true or false
    IncludeHeader bool
    Value must be one of true or false
    Preheader string
    The preheader
    TaskType string
    body String
    The email body
    subject String
    The subject
    tos List<String>
    bccs List<String>
    ccs List<String>
    customLogoUrl String
    URL to your custom email logo
    from String
    The from email address. Need to use SMTP integration if different than rootly.com
    includeFooter Boolean
    Value must be one of true or false
    includeHeader Boolean
    Value must be one of true or false
    preheader String
    The preheader
    taskType String
    body string
    The email body
    subject string
    The subject
    tos string[]
    bccs string[]
    ccs string[]
    customLogoUrl string
    URL to your custom email logo
    from string
    The from email address. Need to use SMTP integration if different than rootly.com
    includeFooter boolean
    Value must be one of true or false
    includeHeader boolean
    Value must be one of true or false
    preheader string
    The preheader
    taskType string
    body str
    The email body
    subject str
    The subject
    tos Sequence[str]
    bccs Sequence[str]
    ccs Sequence[str]
    custom_logo_url str
    URL to your custom email logo
    from_ str
    The from email address. Need to use SMTP integration if different than rootly.com
    include_footer bool
    Value must be one of true or false
    include_header bool
    Value must be one of true or false
    preheader str
    The preheader
    task_type str
    body String
    The email body
    subject String
    The subject
    tos List<String>
    bccs List<String>
    ccs List<String>
    customLogoUrl String
    URL to your custom email logo
    from String
    The from email address. Need to use SMTP integration if different than rootly.com
    includeFooter Boolean
    Value must be one of true or false
    includeHeader Boolean
    Value must be one of true or false
    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