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

rootly.WorkflowTaskGetPulses

Explore with Pulumi AI

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

Manages workflow get_pulses task.

Create WorkflowTaskGetPulses Resource

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

Constructor syntax

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

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

type: rootly:WorkflowTaskGetPulses
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkflowTaskGetPulsesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkflowTaskGetPulsesArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkflowTaskGetPulsesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkflowTaskGetPulsesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkflowTaskGetPulsesArgs
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 workflowTaskGetPulsesResource = new Rootly.WorkflowTaskGetPulses("workflowTaskGetPulsesResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskGetPulsesTaskParamsArgs
    {
        PastDuration = "string",
        EnvironmentIds = new[]
        {
            "string",
        },
        EnvironmentsImpactedByIncident = false,
        Labels = new[]
        {
            "string",
        },
        ParentMessageThreadTask = 
        {
            { "string", "any" },
        },
        PostToIncidentTimeline = false,
        PostToSlackChannels = new[]
        {
            new Rootly.Inputs.WorkflowTaskGetPulsesTaskParamsPostToSlackChannelArgs
            {
                Id = "string",
                Name = "string",
            },
        },
        Refs = new[]
        {
            "string",
        },
        ServiceIds = new[]
        {
            "string",
        },
        ServicesImpactedByIncident = false,
        Sources = new[]
        {
            "string",
        },
        TaskType = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});
Copy
example, err := rootly.NewWorkflowTaskGetPulses(ctx, "workflowTaskGetPulsesResource", &rootly.WorkflowTaskGetPulsesArgs{
	TaskParams: &rootly.WorkflowTaskGetPulsesTaskParamsArgs{
		PastDuration: pulumi.String("string"),
		EnvironmentIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		EnvironmentsImpactedByIncident: pulumi.Bool(false),
		Labels: pulumi.StringArray{
			pulumi.String("string"),
		},
		ParentMessageThreadTask: pulumi.Map{
			"string": pulumi.Any("any"),
		},
		PostToIncidentTimeline: pulumi.Bool(false),
		PostToSlackChannels: rootly.WorkflowTaskGetPulsesTaskParamsPostToSlackChannelArray{
			&rootly.WorkflowTaskGetPulsesTaskParamsPostToSlackChannelArgs{
				Id:   pulumi.String("string"),
				Name: pulumi.String("string"),
			},
		},
		Refs: pulumi.StringArray{
			pulumi.String("string"),
		},
		ServiceIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		ServicesImpactedByIncident: pulumi.Bool(false),
		Sources: pulumi.StringArray{
			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),
})
Copy
var workflowTaskGetPulsesResource = new WorkflowTaskGetPulses("workflowTaskGetPulsesResource", WorkflowTaskGetPulsesArgs.builder()
    .taskParams(WorkflowTaskGetPulsesTaskParamsArgs.builder()
        .pastDuration("string")
        .environmentIds("string")
        .environmentsImpactedByIncident(false)
        .labels("string")
        .parentMessageThreadTask(Map.of("string", "any"))
        .postToIncidentTimeline(false)
        .postToSlackChannels(WorkflowTaskGetPulsesTaskParamsPostToSlackChannelArgs.builder()
            .id("string")
            .name("string")
            .build())
        .refs("string")
        .serviceIds("string")
        .servicesImpactedByIncident(false)
        .sources("string")
        .taskType("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());
Copy
workflow_task_get_pulses_resource = rootly.WorkflowTaskGetPulses("workflowTaskGetPulsesResource",
    task_params={
        "past_duration": "string",
        "environment_ids": ["string"],
        "environments_impacted_by_incident": False,
        "labels": ["string"],
        "parent_message_thread_task": {
            "string": "any",
        },
        "post_to_incident_timeline": False,
        "post_to_slack_channels": [{
            "id": "string",
            "name": "string",
        }],
        "refs": ["string"],
        "service_ids": ["string"],
        "services_impacted_by_incident": False,
        "sources": ["string"],
        "task_type": "string",
    },
    workflow_id="string",
    enabled=False,
    name="string",
    position=0,
    skip_on_failure=False)
Copy
const workflowTaskGetPulsesResource = new rootly.WorkflowTaskGetPulses("workflowTaskGetPulsesResource", {
    taskParams: {
        pastDuration: "string",
        environmentIds: ["string"],
        environmentsImpactedByIncident: false,
        labels: ["string"],
        parentMessageThreadTask: {
            string: "any",
        },
        postToIncidentTimeline: false,
        postToSlackChannels: [{
            id: "string",
            name: "string",
        }],
        refs: ["string"],
        serviceIds: ["string"],
        servicesImpactedByIncident: false,
        sources: ["string"],
        taskType: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});
Copy
type: rootly:WorkflowTaskGetPulses
properties:
    enabled: false
    name: string
    position: 0
    skipOnFailure: false
    taskParams:
        environmentIds:
            - string
        environmentsImpactedByIncident: false
        labels:
            - string
        parentMessageThreadTask:
            string: any
        pastDuration: string
        postToIncidentTimeline: false
        postToSlackChannels:
            - id: string
              name: string
        refs:
            - string
        serviceIds:
            - string
        servicesImpactedByIncident: false
        sources:
            - string
        taskType: string
    workflowId: string
Copy

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

TaskParams This property is required. WorkflowTaskGetPulsesTaskParams
The parameters for this workflow task.
WorkflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskGetPulsesTaskParamsArgs
The parameters for this workflow task.
WorkflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskGetPulsesTaskParams
The parameters for this workflow task.
workflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskGetPulsesTaskParams
The parameters for this workflow task.
workflowId
This property is required.
Changes to this property will trigger replacement.
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 This property is required. WorkflowTaskGetPulsesTaskParamsArgs
The parameters for this workflow task.
workflow_id
This property is required.
Changes to this property will trigger replacement.
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 This property is required. Property Map
The parameters for this workflow task.
workflowId
This property is required.
Changes to this property will trigger replacement.
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 WorkflowTaskGetPulses 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 WorkflowTaskGetPulses Resource

Get an existing WorkflowTaskGetPulses 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?: WorkflowTaskGetPulsesState, opts?: CustomResourceOptions): WorkflowTaskGetPulses
@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[WorkflowTaskGetPulsesTaskParamsArgs] = None,
        workflow_id: Optional[str] = None) -> WorkflowTaskGetPulses
func GetWorkflowTaskGetPulses(ctx *Context, name string, id IDInput, state *WorkflowTaskGetPulsesState, opts ...ResourceOption) (*WorkflowTaskGetPulses, error)
public static WorkflowTaskGetPulses Get(string name, Input<string> id, WorkflowTaskGetPulsesState? state, CustomResourceOptions? opts = null)
public static WorkflowTaskGetPulses get(String name, Output<String> id, WorkflowTaskGetPulsesState state, CustomResourceOptions options)
resources:  _:    type: rootly:WorkflowTaskGetPulses    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 WorkflowTaskGetPulsesTaskParams
The parameters for this workflow task.
WorkflowId Changes to this property will trigger replacement. 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 WorkflowTaskGetPulsesTaskParamsArgs
The parameters for this workflow task.
WorkflowId Changes to this property will trigger replacement. 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 WorkflowTaskGetPulsesTaskParams
The parameters for this workflow task.
workflowId Changes to this property will trigger replacement. 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 WorkflowTaskGetPulsesTaskParams
The parameters for this workflow task.
workflowId Changes to this property will trigger replacement. 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 WorkflowTaskGetPulsesTaskParamsArgs
The parameters for this workflow task.
workflow_id Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
The ID of the parent workflow

Supporting Types

WorkflowTaskGetPulsesTaskParams
, WorkflowTaskGetPulsesTaskParamsArgs

PastDuration This property is required. string
How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
EnvironmentIds List<string>
EnvironmentsImpactedByIncident bool
Value must be one of true or false
Labels List<string>
ParentMessageThreadTask Dictionary<string, object>
Map must contain two fields, id and name. A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task
PostToIncidentTimeline bool
Value must be one of true or false
PostToSlackChannels List<WorkflowTaskGetPulsesTaskParamsPostToSlackChannel>
Refs List<string>
ServiceIds List<string>
ServicesImpactedByIncident bool
Value must be one of true or false
Sources List<string>
TaskType string
PastDuration This property is required. string
How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
EnvironmentIds []string
EnvironmentsImpactedByIncident bool
Value must be one of true or false
Labels []string
ParentMessageThreadTask map[string]interface{}
Map must contain two fields, id and name. A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task
PostToIncidentTimeline bool
Value must be one of true or false
PostToSlackChannels []WorkflowTaskGetPulsesTaskParamsPostToSlackChannel
Refs []string
ServiceIds []string
ServicesImpactedByIncident bool
Value must be one of true or false
Sources []string
TaskType string
pastDuration This property is required. String
How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
environmentIds List<String>
environmentsImpactedByIncident Boolean
Value must be one of true or false
labels List<String>
parentMessageThreadTask Map<String,Object>
Map must contain two fields, id and name. A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task
postToIncidentTimeline Boolean
Value must be one of true or false
postToSlackChannels List<WorkflowTaskGetPulsesTaskParamsPostToSlackChannel>
refs List<String>
serviceIds List<String>
servicesImpactedByIncident Boolean
Value must be one of true or false
sources List<String>
taskType String
pastDuration This property is required. string
How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
environmentIds string[]
environmentsImpactedByIncident boolean
Value must be one of true or false
labels string[]
parentMessageThreadTask {[key: string]: any}
Map must contain two fields, id and name. A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task
postToIncidentTimeline boolean
Value must be one of true or false
postToSlackChannels WorkflowTaskGetPulsesTaskParamsPostToSlackChannel[]
refs string[]
serviceIds string[]
servicesImpactedByIncident boolean
Value must be one of true or false
sources string[]
taskType string
past_duration This property is required. str
How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
environment_ids Sequence[str]
environments_impacted_by_incident bool
Value must be one of true or false
labels Sequence[str]
parent_message_thread_task Mapping[str, Any]
Map must contain two fields, id and name. A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task
post_to_incident_timeline bool
Value must be one of true or false
post_to_slack_channels Sequence[WorkflowTaskGetPulsesTaskParamsPostToSlackChannel]
refs Sequence[str]
service_ids Sequence[str]
services_impacted_by_incident bool
Value must be one of true or false
sources Sequence[str]
task_type str
pastDuration This property is required. String
How far back to fetch commits (in format '1 minute', '30 days', '3 months', etc.)
environmentIds List<String>
environmentsImpactedByIncident Boolean
Value must be one of true or false
labels List<String>
parentMessageThreadTask Map<Any>
Map must contain two fields, id and name. A hash where [id] is the task id of the parent task that sent a message, and [name] is the name of the parent task
postToIncidentTimeline Boolean
Value must be one of true or false
postToSlackChannels List<Property Map>
refs List<String>
serviceIds List<String>
servicesImpactedByIncident Boolean
Value must be one of true or false
sources List<String>
taskType String

WorkflowTaskGetPulsesTaskParamsPostToSlackChannel
, WorkflowTaskGetPulsesTaskParamsPostToSlackChannelArgs

Id This property is required. string
Name This property is required. string
Id This property is required. string
Name This property is required. string
id This property is required. String
name This property is required. String
id This property is required. string
name This property is required. string
id This property is required. str
name This property is required. str
id This property is required. String
name This property is required. String

Package Details

Repository
rootly rootlyhq/pulumi-rootly
License
Apache-2.0
Notes
This Pulumi package is based on the rootly Terraform Provider.
Rootly v1.5.0 published on Thursday, Apr 25, 2024 by Rootly
rootlyhq/pulumi-rootly