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

rootly.WorkflowTaskInviteToSlackChannel

Explore with Pulumi AI

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

    Manages workflow invite_to_slack_channel task.

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rootly.WorkflowIncident;
    import com.pulumi.rootly.WorkflowIncidentArgs;
    import com.pulumi.rootly.inputs.WorkflowIncidentTriggerParamsArgs;
    import com.pulumi.rootly.WorkflowTaskInviteToSlackChannel;
    import com.pulumi.rootly.WorkflowTaskInviteToSlackChannelArgs;
    import com.pulumi.rootly.inputs.WorkflowTaskInviteToSlackChannelTaskParamsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var inviteToIncidentChannel = new WorkflowIncident("inviteToIncidentChannel", WorkflowIncidentArgs.builder()        
                .description("Invite Slack User Groups e.g. @oncall-infra to the incident channel.")
                .triggerParams(WorkflowIncidentTriggerParamsArgs.builder()
                    .triggers("incident_created")
                    .incidentStatuses("started")
                    .incidentConditionStatus("IS")
                    .build())
                .enabled(true)
                .build());
    
            var inviteToSlackChannel = new WorkflowTaskInviteToSlackChannel("inviteToSlackChannel", WorkflowTaskInviteToSlackChannelArgs.builder()        
                .workflowId(inviteToIncidentChannel.id())
                .skipOnFailure(false)
                .enabled(true)
                .taskParams(WorkflowTaskInviteToSlackChannelTaskParamsArgs.builder()
                    .name("Invite to Slack channel")
                    .channel(Map.ofEntries(
                        Map.entry("id", "C06A4RZR9"),
                        Map.entry("name", "Channel 1")
                    ))
                    .build())
                .build());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      inviteToIncidentChannel:
        type: rootly:WorkflowIncident
        properties:
          description: Invite Slack User Groups e.g. @oncall-infra to the incident channel.
          triggerParams:
            triggers:
              - incident_created
            incidentStatuses:
              - started
            incidentConditionStatus: IS
          enabled: true
      inviteToSlackChannel:
        type: rootly:WorkflowTaskInviteToSlackChannel
        properties:
          workflowId: ${inviteToIncidentChannel.id}
          skipOnFailure: false
          enabled: true
          taskParams:
            name: Invite to Slack channel
            channel:
              id: C06A4RZR9
              name: Channel 1
    

    Create WorkflowTaskInviteToSlackChannel Resource

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

    Constructor syntax

    new WorkflowTaskInviteToSlackChannel(name: string, args: WorkflowTaskInviteToSlackChannelArgs, opts?: CustomResourceOptions);
    @overload
    def WorkflowTaskInviteToSlackChannel(resource_name: str,
                                         args: WorkflowTaskInviteToSlackChannelArgs,
                                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkflowTaskInviteToSlackChannel(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         task_params: Optional[WorkflowTaskInviteToSlackChannelTaskParamsArgs] = 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 NewWorkflowTaskInviteToSlackChannel(ctx *Context, name string, args WorkflowTaskInviteToSlackChannelArgs, opts ...ResourceOption) (*WorkflowTaskInviteToSlackChannel, error)
    public WorkflowTaskInviteToSlackChannel(string name, WorkflowTaskInviteToSlackChannelArgs args, CustomResourceOptions? opts = null)
    public WorkflowTaskInviteToSlackChannel(String name, WorkflowTaskInviteToSlackChannelArgs args)
    public WorkflowTaskInviteToSlackChannel(String name, WorkflowTaskInviteToSlackChannelArgs args, CustomResourceOptions options)
    
    type: rootly:WorkflowTaskInviteToSlackChannel
    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 WorkflowTaskInviteToSlackChannelArgs
    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 WorkflowTaskInviteToSlackChannelArgs
    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 WorkflowTaskInviteToSlackChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskInviteToSlackChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskInviteToSlackChannelArgs
    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 workflowTaskInviteToSlackChannelResource = new Rootly.WorkflowTaskInviteToSlackChannel("workflowTaskInviteToSlackChannelResource", new()
    {
        TaskParams = new Rootly.Inputs.WorkflowTaskInviteToSlackChannelTaskParamsArgs
        {
            Channel = 
            {
                { "string", "any" },
            },
            SlackUserGroups = new[]
            {
                new Rootly.Inputs.WorkflowTaskInviteToSlackChannelTaskParamsSlackUserGroupArgs
                {
                    Id = "string",
                    Name = "string",
                },
            },
            SlackUsers = new[]
            {
                new Rootly.Inputs.WorkflowTaskInviteToSlackChannelTaskParamsSlackUserArgs
                {
                    Id = "string",
                    Name = "string",
                },
            },
            TaskType = "string",
        },
        WorkflowId = "string",
        Enabled = false,
        Name = "string",
        Position = 0,
        SkipOnFailure = false,
    });
    
    example, err := rootly.NewWorkflowTaskInviteToSlackChannel(ctx, "workflowTaskInviteToSlackChannelResource", &rootly.WorkflowTaskInviteToSlackChannelArgs{
    	TaskParams: &rootly.WorkflowTaskInviteToSlackChannelTaskParamsArgs{
    		Channel: pulumi.Map{
    			"string": pulumi.Any("any"),
    		},
    		SlackUserGroups: rootly.WorkflowTaskInviteToSlackChannelTaskParamsSlackUserGroupArray{
    			&rootly.WorkflowTaskInviteToSlackChannelTaskParamsSlackUserGroupArgs{
    				Id:   pulumi.String("string"),
    				Name: pulumi.String("string"),
    			},
    		},
    		SlackUsers: rootly.WorkflowTaskInviteToSlackChannelTaskParamsSlackUserArray{
    			&rootly.WorkflowTaskInviteToSlackChannelTaskParamsSlackUserArgs{
    				Id:   pulumi.String("string"),
    				Name: 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 workflowTaskInviteToSlackChannelResource = new WorkflowTaskInviteToSlackChannel("workflowTaskInviteToSlackChannelResource", WorkflowTaskInviteToSlackChannelArgs.builder()
        .taskParams(WorkflowTaskInviteToSlackChannelTaskParamsArgs.builder()
            .channel(Map.of("string", "any"))
            .slackUserGroups(WorkflowTaskInviteToSlackChannelTaskParamsSlackUserGroupArgs.builder()
                .id("string")
                .name("string")
                .build())
            .slackUsers(WorkflowTaskInviteToSlackChannelTaskParamsSlackUserArgs.builder()
                .id("string")
                .name("string")
                .build())
            .taskType("string")
            .build())
        .workflowId("string")
        .enabled(false)
        .name("string")
        .position(0)
        .skipOnFailure(false)
        .build());
    
    workflow_task_invite_to_slack_channel_resource = rootly.WorkflowTaskInviteToSlackChannel("workflowTaskInviteToSlackChannelResource",
        task_params=rootly.WorkflowTaskInviteToSlackChannelTaskParamsArgs(
            channel={
                "string": "any",
            },
            slack_user_groups=[rootly.WorkflowTaskInviteToSlackChannelTaskParamsSlackUserGroupArgs(
                id="string",
                name="string",
            )],
            slack_users=[rootly.WorkflowTaskInviteToSlackChannelTaskParamsSlackUserArgs(
                id="string",
                name="string",
            )],
            task_type="string",
        ),
        workflow_id="string",
        enabled=False,
        name="string",
        position=0,
        skip_on_failure=False)
    
    const workflowTaskInviteToSlackChannelResource = new rootly.WorkflowTaskInviteToSlackChannel("workflowTaskInviteToSlackChannelResource", {
        taskParams: {
            channel: {
                string: "any",
            },
            slackUserGroups: [{
                id: "string",
                name: "string",
            }],
            slackUsers: [{
                id: "string",
                name: "string",
            }],
            taskType: "string",
        },
        workflowId: "string",
        enabled: false,
        name: "string",
        position: 0,
        skipOnFailure: false,
    });
    
    type: rootly:WorkflowTaskInviteToSlackChannel
    properties:
        enabled: false
        name: string
        position: 0
        skipOnFailure: false
        taskParams:
            channel:
                string: any
            slackUserGroups:
                - id: string
                  name: string
            slackUsers:
                - id: string
                  name: string
            taskType: string
        workflowId: string
    

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

    TaskParams WorkflowTaskInviteToSlackChannelTaskParams
    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 WorkflowTaskInviteToSlackChannelTaskParamsArgs
    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 WorkflowTaskInviteToSlackChannelTaskParams
    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 WorkflowTaskInviteToSlackChannelTaskParams
    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 WorkflowTaskInviteToSlackChannelTaskParamsArgs
    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 WorkflowTaskInviteToSlackChannel 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 WorkflowTaskInviteToSlackChannel Resource

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

    WorkflowTaskInviteToSlackChannelTaskParams, WorkflowTaskInviteToSlackChannelTaskParamsArgs

    channel Map<Any>
    Map must contain two fields, id and name.
    slackUserGroups List<Property Map>
    slackUsers List<Property Map>
    taskType String

    WorkflowTaskInviteToSlackChannelTaskParamsSlackUser, WorkflowTaskInviteToSlackChannelTaskParamsSlackUserArgs

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

    WorkflowTaskInviteToSlackChannelTaskParamsSlackUserGroup, WorkflowTaskInviteToSlackChannelTaskParamsSlackUserGroupArgs

    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