Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rootly
  3. API Docs
  4. WorkflowSimple
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly

rootly.WorkflowSimple

Explore with Pulumi AI

rootly logo
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly

    Create WorkflowSimple Resource

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

    Constructor syntax

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

@overload
def WorkflowSimple(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cause_ids: Optional[Sequence[str]] = None,
                   command: Optional[str] = None,
                   command_feedback_enabled: Optional[bool] = None,
                   description: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   environment_ids: Optional[Sequence[str]] = None,
                   functionality_ids: Optional[Sequence[str]] = None,
                   group_ids: Optional[Sequence[str]] = None,
                   incident_role_ids: Optional[Sequence[str]] = None,
                   incident_type_ids: Optional[Sequence[str]] = None,
                   name: Optional[str] = None,
                   position: Optional[int] = None,
                   repeat_every_duration: Optional[str] = None,
                   repeat_ons: Optional[Sequence[str]] = None,
                   service_ids: Optional[Sequence[str]] = None,
                   severity_ids: Optional[Sequence[str]] = None,
                   slug: Optional[str] = None,
                   trigger_params: Optional[WorkflowSimpleTriggerParamsArgs] = None,
                   wait: Optional[str] = None,
                   workflow_group_id: Optional[str] = None)
    func NewWorkflowSimple(ctx *Context, name string, args *WorkflowSimpleArgs, opts ...ResourceOption) (*WorkflowSimple, error)
    public WorkflowSimple(string name, WorkflowSimpleArgs? args = null, CustomResourceOptions? opts = null)
    public WorkflowSimple(String name, WorkflowSimpleArgs args)
public WorkflowSimple(String name, WorkflowSimpleArgs args, CustomResourceOptions options)

    type: rootly:WorkflowSimple
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 WorkflowSimpleArgs
    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 WorkflowSimpleArgs
    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 WorkflowSimpleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowSimpleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowSimpleArgs
    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 workflowSimpleResource = new Rootly.WorkflowSimple("workflowSimpleResource", new()
{
    CauseIds = new[]
    {
        "string",
    },
    Command = "string",
    CommandFeedbackEnabled = false,
    Description = "string",
    Enabled = false,
    EnvironmentIds = new[]
    {
        "string",
    },
    FunctionalityIds = new[]
    {
        "string",
    },
    GroupIds = new[]
    {
        "string",
    },
    IncidentRoleIds = new[]
    {
        "string",
    },
    IncidentTypeIds = new[]
    {
        "string",
    },
    Name = "string",
    Position = 0,
    RepeatEveryDuration = "string",
    RepeatOns = new[]
    {
        "string",
    },
    ServiceIds = new[]
    {
        "string",
    },
    SeverityIds = new[]
    {
        "string",
    },
    Slug = "string",
    TriggerParams = new Rootly.Inputs.WorkflowSimpleTriggerParamsArgs
    {
        TriggerType = "string",
        Triggers = new[]
        {
            "string",
        },
    },
    Wait = "string",
    WorkflowGroupId = "string",
});

    example, err := rootly.NewWorkflowSimple(ctx, "workflowSimpleResource", &rootly.WorkflowSimpleArgs{
	CauseIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Command:                pulumi.String("string"),
	CommandFeedbackEnabled: pulumi.Bool(false),
	Description:            pulumi.String("string"),
	Enabled:                pulumi.Bool(false),
	EnvironmentIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	FunctionalityIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	GroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncidentRoleIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncidentTypeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:                pulumi.String("string"),
	Position:            pulumi.Int(0),
	RepeatEveryDuration: pulumi.String("string"),
	RepeatOns: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServiceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SeverityIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Slug: pulumi.String("string"),
	TriggerParams: &rootly.WorkflowSimpleTriggerParamsArgs{
		TriggerType: pulumi.String("string"),
		Triggers: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Wait:            pulumi.String("string"),
	WorkflowGroupId: pulumi.String("string"),
})

    var workflowSimpleResource = new WorkflowSimple("workflowSimpleResource", WorkflowSimpleArgs.builder()
    .causeIds("string")
    .command("string")
    .commandFeedbackEnabled(false)
    .description("string")
    .enabled(false)
    .environmentIds("string")
    .functionalityIds("string")
    .groupIds("string")
    .incidentRoleIds("string")
    .incidentTypeIds("string")
    .name("string")
    .position(0)
    .repeatEveryDuration("string")
    .repeatOns("string")
    .serviceIds("string")
    .severityIds("string")
    .slug("string")
    .triggerParams(WorkflowSimpleTriggerParamsArgs.builder()
        .triggerType("string")
        .triggers("string")
        .build())
    .wait("string")
    .workflowGroupId("string")
    .build());

    workflow_simple_resource = rootly.WorkflowSimple("workflowSimpleResource",
    cause_ids=["string"],
    command="string",
    command_feedback_enabled=False,
    description="string",
    enabled=False,
    environment_ids=["string"],
    functionality_ids=["string"],
    group_ids=["string"],
    incident_role_ids=["string"],
    incident_type_ids=["string"],
    name="string",
    position=0,
    repeat_every_duration="string",
    repeat_ons=["string"],
    service_ids=["string"],
    severity_ids=["string"],
    slug="string",
    trigger_params={
        "trigger_type": "string",
        "triggers": ["string"],
    },
    wait="string",
    workflow_group_id="string")

    const workflowSimpleResource = new rootly.WorkflowSimple("workflowSimpleResource", {
    causeIds: ["string"],
    command: "string",
    commandFeedbackEnabled: false,
    description: "string",
    enabled: false,
    environmentIds: ["string"],
    functionalityIds: ["string"],
    groupIds: ["string"],
    incidentRoleIds: ["string"],
    incidentTypeIds: ["string"],
    name: "string",
    position: 0,
    repeatEveryDuration: "string",
    repeatOns: ["string"],
    serviceIds: ["string"],
    severityIds: ["string"],
    slug: "string",
    triggerParams: {
        triggerType: "string",
        triggers: ["string"],
    },
    wait: "string",
    workflowGroupId: "string",
});

    type: rootly:WorkflowSimple
properties:
    causeIds:
        - string
    command: string
    commandFeedbackEnabled: false
    description: string
    enabled: false
    environmentIds:
        - string
    functionalityIds:
        - string
    groupIds:
        - string
    incidentRoleIds:
        - string
    incidentTypeIds:
        - string
    name: string
    position: 0
    repeatEveryDuration: string
    repeatOns:
        - string
    serviceIds:
        - string
    severityIds:
        - string
    slug: string
    triggerParams:
        triggerType: string
        triggers:
            - string
    wait: string
    workflowGroupId: string

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

    CauseIds List<string>
    Command string
    Workflow command
    CommandFeedbackEnabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    Description string
    The description of the workflow
    Enabled bool
    EnvironmentIds List<string>
    FunctionalityIds List<string>
    GroupIds List<string>
    IncidentRoleIds List<string>
    IncidentTypeIds List<string>
    Name string
    The title of the workflow
    Position int
    The order which the workflow should run with other workflows.
    RepeatEveryDuration string
    Repeat workflow every duration
    RepeatOns List<string>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    ServiceIds List<string>
    SeverityIds List<string>
    Slug string
    The slug of the workflow
    TriggerParams WorkflowSimpleTriggerParams
    Wait string
    Wait this duration before executing
    WorkflowGroupId string
    The group this workflow belongs to.
    CauseIds []string
    Command string
    Workflow command
    CommandFeedbackEnabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    Description string
    The description of the workflow
    Enabled bool
    EnvironmentIds []string
    FunctionalityIds []string
    GroupIds []string
    IncidentRoleIds []string
    IncidentTypeIds []string
    Name string
    The title of the workflow
    Position int
    The order which the workflow should run with other workflows.
    RepeatEveryDuration string
    Repeat workflow every duration
    RepeatOns []string
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    ServiceIds []string
    SeverityIds []string
    Slug string
    The slug of the workflow
    TriggerParams WorkflowSimpleTriggerParamsArgs
    Wait string
    Wait this duration before executing
    WorkflowGroupId string
    The group this workflow belongs to.
    causeIds List<String>
    command String
    Workflow command
    commandFeedbackEnabled Boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    description String
    The description of the workflow
    enabled Boolean
    environmentIds List<String>
    functionalityIds List<String>
    groupIds List<String>
    incidentRoleIds List<String>
    incidentTypeIds List<String>
    name String
    The title of the workflow
    position Integer
    The order which the workflow should run with other workflows.
    repeatEveryDuration String
    Repeat workflow every duration
    repeatOns List<String>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds List<String>
    severityIds List<String>
    slug String
    The slug of the workflow
    triggerParams WorkflowSimpleTriggerParams
    wait_ String
    Wait this duration before executing
    workflowGroupId String
    The group this workflow belongs to.
    causeIds string[]
    command string
    Workflow command
    commandFeedbackEnabled boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    description string
    The description of the workflow
    enabled boolean
    environmentIds string[]
    functionalityIds string[]
    groupIds string[]
    incidentRoleIds string[]
    incidentTypeIds string[]
    name string
    The title of the workflow
    position number
    The order which the workflow should run with other workflows.
    repeatEveryDuration string
    Repeat workflow every duration
    repeatOns string[]
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds string[]
    severityIds string[]
    slug string
    The slug of the workflow
    triggerParams WorkflowSimpleTriggerParams
    wait string
    Wait this duration before executing
    workflowGroupId string
    The group this workflow belongs to.
    cause_ids Sequence[str]
    command str
    Workflow command
    command_feedback_enabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    description str
    The description of the workflow
    enabled bool
    environment_ids Sequence[str]
    functionality_ids Sequence[str]
    group_ids Sequence[str]
    incident_role_ids Sequence[str]
    incident_type_ids Sequence[str]
    name str
    The title of the workflow
    position int
    The order which the workflow should run with other workflows.
    repeat_every_duration str
    Repeat workflow every duration
    repeat_ons Sequence[str]
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    service_ids Sequence[str]
    severity_ids Sequence[str]
    slug str
    The slug of the workflow
    trigger_params WorkflowSimpleTriggerParamsArgs
    wait str
    Wait this duration before executing
    workflow_group_id str
    The group this workflow belongs to.
    causeIds List<String>
    command String
    Workflow command
    commandFeedbackEnabled Boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    description String
    The description of the workflow
    enabled Boolean
    environmentIds List<String>
    functionalityIds List<String>
    groupIds List<String>
    incidentRoleIds List<String>
    incidentTypeIds List<String>
    name String
    The title of the workflow
    position Number
    The order which the workflow should run with other workflows.
    repeatEveryDuration String
    Repeat workflow every duration
    repeatOns List<String>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds List<String>
    severityIds List<String>
    slug String
    The slug of the workflow
    triggerParams Property Map
    wait String
    Wait this duration before executing
    workflowGroupId String
    The group this workflow belongs to.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkflowSimple 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 WorkflowSimple Resource

    Get an existing WorkflowSimple 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?: WorkflowSimpleState, opts?: CustomResourceOptions): WorkflowSimple
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cause_ids: Optional[Sequence[str]] = None,
        command: Optional[str] = None,
        command_feedback_enabled: Optional[bool] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        environment_ids: Optional[Sequence[str]] = None,
        functionality_ids: Optional[Sequence[str]] = None,
        group_ids: Optional[Sequence[str]] = None,
        incident_role_ids: Optional[Sequence[str]] = None,
        incident_type_ids: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        position: Optional[int] = None,
        repeat_every_duration: Optional[str] = None,
        repeat_ons: Optional[Sequence[str]] = None,
        service_ids: Optional[Sequence[str]] = None,
        severity_ids: Optional[Sequence[str]] = None,
        slug: Optional[str] = None,
        trigger_params: Optional[WorkflowSimpleTriggerParamsArgs] = None,
        wait: Optional[str] = None,
        workflow_group_id: Optional[str] = None) -> WorkflowSimple
    func GetWorkflowSimple(ctx *Context, name string, id IDInput, state *WorkflowSimpleState, opts ...ResourceOption) (*WorkflowSimple, error)
    public static WorkflowSimple Get(string name, Input<string> id, WorkflowSimpleState? state, CustomResourceOptions? opts = null)
    public static WorkflowSimple get(String name, Output<String> id, WorkflowSimpleState 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:
    CauseIds List<string>
    Command string
    Workflow command
    CommandFeedbackEnabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    Description string
    The description of the workflow
    Enabled bool
    EnvironmentIds List<string>
    FunctionalityIds List<string>
    GroupIds List<string>
    IncidentRoleIds List<string>
    IncidentTypeIds List<string>
    Name string
    The title of the workflow
    Position int
    The order which the workflow should run with other workflows.
    RepeatEveryDuration string
    Repeat workflow every duration
    RepeatOns List<string>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    ServiceIds List<string>
    SeverityIds List<string>
    Slug string
    The slug of the workflow
    TriggerParams WorkflowSimpleTriggerParams
    Wait string
    Wait this duration before executing
    WorkflowGroupId string
    The group this workflow belongs to.
    CauseIds []string
    Command string
    Workflow command
    CommandFeedbackEnabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    Description string
    The description of the workflow
    Enabled bool
    EnvironmentIds []string
    FunctionalityIds []string
    GroupIds []string
    IncidentRoleIds []string
    IncidentTypeIds []string
    Name string
    The title of the workflow
    Position int
    The order which the workflow should run with other workflows.
    RepeatEveryDuration string
    Repeat workflow every duration
    RepeatOns []string
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    ServiceIds []string
    SeverityIds []string
    Slug string
    The slug of the workflow
    TriggerParams WorkflowSimpleTriggerParamsArgs
    Wait string
    Wait this duration before executing
    WorkflowGroupId string
    The group this workflow belongs to.
    causeIds List<String>
    command String
    Workflow command
    commandFeedbackEnabled Boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    description String
    The description of the workflow
    enabled Boolean
    environmentIds List<String>
    functionalityIds List<String>
    groupIds List<String>
    incidentRoleIds List<String>
    incidentTypeIds List<String>
    name String
    The title of the workflow
    position Integer
    The order which the workflow should run with other workflows.
    repeatEveryDuration String
    Repeat workflow every duration
    repeatOns List<String>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds List<String>
    severityIds List<String>
    slug String
    The slug of the workflow
    triggerParams WorkflowSimpleTriggerParams
    wait_ String
    Wait this duration before executing
    workflowGroupId String
    The group this workflow belongs to.
    causeIds string[]
    command string
    Workflow command
    commandFeedbackEnabled boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    description string
    The description of the workflow
    enabled boolean
    environmentIds string[]
    functionalityIds string[]
    groupIds string[]
    incidentRoleIds string[]
    incidentTypeIds string[]
    name string
    The title of the workflow
    position number
    The order which the workflow should run with other workflows.
    repeatEveryDuration string
    Repeat workflow every duration
    repeatOns string[]
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds string[]
    severityIds string[]
    slug string
    The slug of the workflow
    triggerParams WorkflowSimpleTriggerParams
    wait string
    Wait this duration before executing
    workflowGroupId string
    The group this workflow belongs to.
    cause_ids Sequence[str]
    command str
    Workflow command
    command_feedback_enabled bool
    This will notify you back when the workflow is starting. Value must be one of true or false
    description str
    The description of the workflow
    enabled bool
    environment_ids Sequence[str]
    functionality_ids Sequence[str]
    group_ids Sequence[str]
    incident_role_ids Sequence[str]
    incident_type_ids Sequence[str]
    name str
    The title of the workflow
    position int
    The order which the workflow should run with other workflows.
    repeat_every_duration str
    Repeat workflow every duration
    repeat_ons Sequence[str]
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    service_ids Sequence[str]
    severity_ids Sequence[str]
    slug str
    The slug of the workflow
    trigger_params WorkflowSimpleTriggerParamsArgs
    wait str
    Wait this duration before executing
    workflow_group_id str
    The group this workflow belongs to.
    causeIds List<String>
    command String
    Workflow command
    commandFeedbackEnabled Boolean
    This will notify you back when the workflow is starting. Value must be one of true or false
    description String
    The description of the workflow
    enabled Boolean
    environmentIds List<String>
    functionalityIds List<String>
    groupIds List<String>
    incidentRoleIds List<String>
    incidentTypeIds List<String>
    name String
    The title of the workflow
    position Number
    The order which the workflow should run with other workflows.
    repeatEveryDuration String
    Repeat workflow every duration
    repeatOns List<String>
    Repeat on weekdays. Value must be one of S, M, T, W, R, F, U.
    serviceIds List<String>
    severityIds List<String>
    slug String
    The slug of the workflow
    triggerParams Property Map
    wait String
    Wait this duration before executing
    workflowGroupId String
    The group this workflow belongs to.

    Supporting Types

    WorkflowSimpleTriggerParams, WorkflowSimpleTriggerParamsArgs

    TriggerType string
    Value must be one off simple.
    Triggers List<string>
    Actions that trigger the workflow. Value must be one of slack_command.
    TriggerType string
    Value must be one off simple.
    Triggers []string
    Actions that trigger the workflow. Value must be one of slack_command.
    triggerType String
    Value must be one off simple.
    triggers List<String>
    Actions that trigger the workflow. Value must be one of slack_command.
    triggerType string
    Value must be one off simple.
    triggers string[]
    Actions that trigger the workflow. Value must be one of slack_command.
    trigger_type str
    Value must be one off simple.
    triggers Sequence[str]
    Actions that trigger the workflow. Value must be one of slack_command.
    triggerType String
    Value must be one off simple.
    triggers List<String>
    Actions that trigger the workflow. Value must be one of slack_command.

    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
    rootlyhq/pulumi-rootly