Docs Packages
  1. Packages
  2. Rootly
  3. API Docs
  4. WorkflowTaskGetAlerts
Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly
rootlyhq/pulumi-rootly

rootly.WorkflowTaskGetAlerts

Explore with Pulumi AI

rootly logo
Rootly v1.2.1 published on Tuesday, Apr 2, 2024 by Rootly
rootlyhq/pulumi-rootly

    Manages workflow get_alerts task.

    Create WorkflowTaskGetAlerts Resource

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

    Constructor syntax

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

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

    type: rootly:WorkflowTaskGetAlerts
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 WorkflowTaskGetAlertsArgs
    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 WorkflowTaskGetAlertsArgs
    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 WorkflowTaskGetAlertsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowTaskGetAlertsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowTaskGetAlertsArgs
    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 workflowTaskGetAlertsResource = new Rootly.WorkflowTaskGetAlerts("workflowTaskGetAlertsResource", new()
{
    TaskParams = new Rootly.Inputs.WorkflowTaskGetAlertsTaskParamsArgs
    {
        PastDuration = "string",
        EnvironmentIds = new[]
        {
            "string",
        },
        EnvironmentsImpactedByIncident = false,
        Labels = new[]
        {
            "string",
        },
        ParentMessageThreadTask = 
        {
            { "string", "any" },
        },
        PostToIncidentTimeline = false,
        PostToSlackChannels = new[]
        {
            new Rootly.Inputs.WorkflowTaskGetAlertsTaskParamsPostToSlackChannelArgs
            {
                Id = "string",
                Name = "string",
            },
        },
        ServiceIds = new[]
        {
            "string",
        },
        ServicesImpactedByIncident = false,
        Sources = new[]
        {
            "string",
        },
        TaskType = "string",
    },
    WorkflowId = "string",
    Enabled = false,
    Name = "string",
    Position = 0,
    SkipOnFailure = false,
});

    example, err := rootly.NewWorkflowTaskGetAlerts(ctx, "workflowTaskGetAlertsResource", &rootly.WorkflowTaskGetAlertsArgs{
	TaskParams: &rootly.WorkflowTaskGetAlertsTaskParamsArgs{
		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.WorkflowTaskGetAlertsTaskParamsPostToSlackChannelArray{
			&rootly.WorkflowTaskGetAlertsTaskParamsPostToSlackChannelArgs{
				Id:   pulumi.String("string"),
				Name: 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),
})

    var workflowTaskGetAlertsResource = new WorkflowTaskGetAlerts("workflowTaskGetAlertsResource", WorkflowTaskGetAlertsArgs.builder()        
    .taskParams(WorkflowTaskGetAlertsTaskParamsArgs.builder()
        .pastDuration("string")
        .environmentIds("string")
        .environmentsImpactedByIncident(false)
        .labels("string")
        .parentMessageThreadTask(Map.of("string", "any"))
        .postToIncidentTimeline(false)
        .postToSlackChannels(WorkflowTaskGetAlertsTaskParamsPostToSlackChannelArgs.builder()
            .id("string")
            .name("string")
            .build())
        .serviceIds("string")
        .servicesImpactedByIncident(false)
        .sources("string")
        .taskType("string")
        .build())
    .workflowId("string")
    .enabled(false)
    .name("string")
    .position(0)
    .skipOnFailure(false)
    .build());

    workflow_task_get_alerts_resource = rootly.WorkflowTaskGetAlerts("workflowTaskGetAlertsResource",
    task_params=rootly.WorkflowTaskGetAlertsTaskParamsArgs(
        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=[rootly.WorkflowTaskGetAlertsTaskParamsPostToSlackChannelArgs(
            id="string",
            name="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)

    const workflowTaskGetAlertsResource = new rootly.WorkflowTaskGetAlerts("workflowTaskGetAlertsResource", {
    taskParams: {
        pastDuration: "string",
        environmentIds: ["string"],
        environmentsImpactedByIncident: false,
        labels: ["string"],
        parentMessageThreadTask: {
            string: "any",
        },
        postToIncidentTimeline: false,
        postToSlackChannels: [{
            id: "string",
            name: "string",
        }],
        serviceIds: ["string"],
        servicesImpactedByIncident: false,
        sources: ["string"],
        taskType: "string",
    },
    workflowId: "string",
    enabled: false,
    name: "string",
    position: 0,
    skipOnFailure: false,
});

    type: rootly:WorkflowTaskGetAlerts
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
        serviceIds:
            - string
        servicesImpactedByIncident: false
        sources:
            - string
        taskType: string
    workflowId: string

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

    TaskParams WorkflowTaskGetAlertsTaskParams
    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 WorkflowTaskGetAlertsTaskParamsArgs
    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 WorkflowTaskGetAlertsTaskParams
    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 WorkflowTaskGetAlertsTaskParams
    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 WorkflowTaskGetAlertsTaskParamsArgs
    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 WorkflowTaskGetAlerts 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 WorkflowTaskGetAlerts Resource

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

    WorkflowTaskGetAlertsTaskParams, WorkflowTaskGetAlertsTaskParamsArgs

    PastDuration 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<WorkflowTaskGetAlertsTaskParamsPostToSlackChannel>
    ServiceIds List<string>
    ServicesImpactedByIncident bool
    Value must be one of true or false
    Sources List<string>
    TaskType string
    PastDuration 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 []WorkflowTaskGetAlertsTaskParamsPostToSlackChannel
    ServiceIds []string
    ServicesImpactedByIncident bool
    Value must be one of true or false
    Sources []string
    TaskType string
    pastDuration 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<WorkflowTaskGetAlertsTaskParamsPostToSlackChannel>
    serviceIds List<String>
    servicesImpactedByIncident Boolean
    Value must be one of true or false
    sources List<String>
    taskType String
    pastDuration 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 WorkflowTaskGetAlertsTaskParamsPostToSlackChannel[]
    serviceIds string[]
    servicesImpactedByIncident boolean
    Value must be one of true or false
    sources string[]
    taskType string
    past_duration 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[WorkflowTaskGetAlertsTaskParamsPostToSlackChannel]
    service_ids Sequence[str]
    services_impacted_by_incident bool
    Value must be one of true or false
    sources Sequence[str]
    task_type str
    pastDuration 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>
    serviceIds List<String>
    servicesImpactedByIncident Boolean
    Value must be one of true or false
    sources List<String>
    taskType String

    WorkflowTaskGetAlertsTaskParamsPostToSlackChannel, WorkflowTaskGetAlertsTaskParamsPostToSlackChannelArgs

    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.2.1 published on Tuesday, Apr 2, 2024 by Rootly
    rootlyhq/pulumi-rootly