RulesetRule

An event rule allows you to set actions that should be taken on events that meet your designated rule criteria.

Create a RulesetRule Resource

new RulesetRule(name: string, args: RulesetRuleArgs, opts?: CustomResourceOptions);

def RulesetRule(resource_name, opts=None, actions=None, conditions=None, disabled=None, position=None, ruleset=None, time_frame=None, __props__=None);

func NewRulesetRule(ctx *Context, name string, args RulesetRuleArgs, opts ...ResourceOption) (*RulesetRule, error)

public RulesetRule(string name, RulesetRuleArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args RulesetRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RulesetRuleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RulesetRuleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

RulesetRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The RulesetRule resource accepts the following input properties:

Ruleset string: The ID of the ruleset that the rule belongs to.
Actions RulesetRuleActionsArgs: Actions to apply to an event if the conditions match.
Conditions RulesetRuleConditionsArgs: Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.
Disabled bool: Indicates whether the rule is disabled and would therefore not be evaluated.
Position int: Position/index of the rule within the ruleset.
TimeFrame RulesetRuleTimeFrameArgs: Settings for scheduling the rule.

Ruleset string: The ID of the ruleset that the rule belongs to.
Actions RulesetRuleActions: Actions to apply to an event if the conditions match.
Conditions RulesetRuleConditions: Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.
Disabled bool: Indicates whether the rule is disabled and would therefore not be evaluated.
Position int: Position/index of the rule within the ruleset.
TimeFrame RulesetRuleTimeFrame: Settings for scheduling the rule.

ruleset string: The ID of the ruleset that the rule belongs to.
actions RulesetRuleActions: Actions to apply to an event if the conditions match.
conditions RulesetRuleConditions: Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.
disabled boolean: Indicates whether the rule is disabled and would therefore not be evaluated.
position number: Position/index of the rule within the ruleset.
timeFrame RulesetRuleTimeFrame: Settings for scheduling the rule.

ruleset str: The ID of the ruleset that the rule belongs to.
actions Dict[RulesetRuleActions]: Actions to apply to an event if the conditions match.
conditions Dict[RulesetRuleConditions]: Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.
disabled bool: Indicates whether the rule is disabled and would therefore not be evaluated.
position float: Position/index of the rule within the ruleset.
time_frame Dict[RulesetRuleTimeFrame]: Settings for scheduling the rule.

Outputs

All input properties are implicitly available as output properties. Additionally, the RulesetRule 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing RulesetRule Resource

Get an existing RulesetRule 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?: RulesetRuleState, opts?: CustomResourceOptions): RulesetRule

static get(resource_name, id, opts=None, actions=None, conditions=None, disabled=None, position=None, ruleset=None, time_frame=None, __props__=None);

func GetRulesetRule(ctx *Context, name string, id IDInput, state *RulesetRuleState, opts ...ResourceOption) (*RulesetRule, error)

public static RulesetRule Get(string name, Input<string> id, RulesetRuleState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Actions RulesetRuleActionsArgs: Actions to apply to an event if the conditions match.
Conditions RulesetRuleConditionsArgs: Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.
Disabled bool: Indicates whether the rule is disabled and would therefore not be evaluated.
Position int: Position/index of the rule within the ruleset.
Ruleset string: The ID of the ruleset that the rule belongs to.
TimeFrame RulesetRuleTimeFrameArgs: Settings for scheduling the rule.

Actions RulesetRuleActions: Actions to apply to an event if the conditions match.
Conditions RulesetRuleConditions: Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.
Disabled bool: Indicates whether the rule is disabled and would therefore not be evaluated.
Position int: Position/index of the rule within the ruleset.
Ruleset string: The ID of the ruleset that the rule belongs to.
TimeFrame RulesetRuleTimeFrame: Settings for scheduling the rule.

actions RulesetRuleActions: Actions to apply to an event if the conditions match.
conditions RulesetRuleConditions: Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.
disabled boolean: Indicates whether the rule is disabled and would therefore not be evaluated.
position number: Position/index of the rule within the ruleset.
ruleset string: The ID of the ruleset that the rule belongs to.
timeFrame RulesetRuleTimeFrame: Settings for scheduling the rule.

actions Dict[RulesetRuleActions]: Actions to apply to an event if the conditions match.
conditions Dict[RulesetRuleConditions]: Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.
disabled bool: Indicates whether the rule is disabled and would therefore not be evaluated.
position float: Position/index of the rule within the ruleset.
ruleset str: The ID of the ruleset that the rule belongs to.
time_frame Dict[RulesetRuleTimeFrame]: Settings for scheduling the rule.

Supporting Types

RulesetRuleActions

Annotates List<RulesetRuleActionsAnnotateArgs>: Note added to the event.
EventActions List<RulesetRuleActionsEventActionArgs>
Extractions List<RulesetRuleActionsExtractionArgs>: Allows you to copy important data from one event field to another. Extraction rules must use valid RE2 regular expression syntax. Extraction objects consist of the following fields:
Priorities List<RulesetRuleActionsPriorityArgs>: The ID of the priority applied to the event.
Routes List<RulesetRuleActionsRouteArgs>: The ID of the service where the event will be routed.
Severities List<RulesetRuleActionsSeverityArgs>: The severity level of the event. Can be either info,error,warning, or critical.
Suppresses List<RulesetRuleActionsSuppressArgs>: Controls whether an alert is suppressed (does not create an incident).

Annotates []RulesetRuleActionsAnnotate: Note added to the event.
EventActions []RulesetRuleActionsEventAction
Extractions []RulesetRuleActionsExtraction: Allows you to copy important data from one event field to another. Extraction rules must use valid RE2 regular expression syntax. Extraction objects consist of the following fields:
Priorities []RulesetRuleActionsPriority: The ID of the priority applied to the event.
Routes []RulesetRuleActionsRoute: The ID of the service where the event will be routed.
Severities []RulesetRuleActionsSeverity: The severity level of the event. Can be either info,error,warning, or critical.
Suppresses []RulesetRuleActionsSuppress: Controls whether an alert is suppressed (does not create an incident).

annotates RulesetRuleActionsAnnotate[]: Note added to the event.
eventActions RulesetRuleActionsEventAction[]
extractions RulesetRuleActionsExtraction[]: Allows you to copy important data from one event field to another. Extraction rules must use valid RE2 regular expression syntax. Extraction objects consist of the following fields:
priorities RulesetRuleActionsPriority[]: The ID of the priority applied to the event.
routes RulesetRuleActionsRoute[]: The ID of the service where the event will be routed.
severities RulesetRuleActionsSeverity[]: The severity level of the event. Can be either info,error,warning, or critical.
suppresses RulesetRuleActionsSuppress[]: Controls whether an alert is suppressed (does not create an incident).

annotates List[RulesetRuleActionsAnnotate]: Note added to the event.
eventActions List[RulesetRuleActionsEventAction]
extractions List[RulesetRuleActionsExtraction]: Allows you to copy important data from one event field to another. Extraction rules must use valid RE2 regular expression syntax. Extraction objects consist of the following fields:
priorities List[RulesetRuleActionsPriority]: The ID of the priority applied to the event.
routes List[RulesetRuleActionsRoute]: The ID of the service where the event will be routed.
severities List[RulesetRuleActionsSeverity]: The severity level of the event. Can be either info,error,warning, or critical.
suppresses List[RulesetRuleActionsSuppress]: Controls whether an alert is suppressed (does not create an incident).

RulesetRuleActionsAnnotate

Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

value str: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

RulesetRuleActionsEventAction

Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

value str: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

RulesetRuleActionsExtraction

Regex string: The conditions that need to be met for the extraction to happen. * NOTE: A rule can have multiple extraction objects attributed to it.
Source string: Field where the data is being copied from.
Target string: Field where the data is being copied to.

Regex string: The conditions that need to be met for the extraction to happen. * NOTE: A rule can have multiple extraction objects attributed to it.
Source string: Field where the data is being copied from.
Target string: Field where the data is being copied to.

regex string: The conditions that need to be met for the extraction to happen. * NOTE: A rule can have multiple extraction objects attributed to it.
source string: Field where the data is being copied from.
target string: Field where the data is being copied to.

regex str: The conditions that need to be met for the extraction to happen. * NOTE: A rule can have multiple extraction objects attributed to it.
source str: Field where the data is being copied from.
target str: Field where the data is being copied to.

RulesetRuleActionsPriority

Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

value str: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

RulesetRuleActionsRoute

Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

value str: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

RulesetRuleActionsSeverity

Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

value str: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

RulesetRuleActionsSuppress

ThresholdTimeAmount int: The number value of the threshold_time_unit before an incident is created.
ThresholdTimeUnit string: The minutes,hours, or days that the threshold_time_amount should be measured.
ThresholdValue int: The number of alerts that should be suppressed.
Value bool: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

ThresholdTimeAmount int: The number value of the threshold_time_unit before an incident is created.
ThresholdTimeUnit string: The minutes,hours, or days that the threshold_time_amount should be measured.
ThresholdValue int: The number of alerts that should be suppressed.
Value bool: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

thresholdTimeAmount number: The number value of the threshold_time_unit before an incident is created.
thresholdTimeUnit string: The minutes,hours, or days that the threshold_time_amount should be measured.
thresholdValue number: The number of alerts that should be suppressed.
value boolean: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

thresholdTimeAmount float: The number value of the threshold_time_unit before an incident is created.
thresholdTimeUnit str: The minutes,hours, or days that the threshold_time_amount should be measured.
thresholdValue float: The number of alerts that should be suppressed.
value bool: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

RulesetRuleConditions

Operator string: Operator to combine sub-conditions. Can be and or or.
Subconditions List<RulesetRuleConditionsSubconditionArgs>: List of sub-conditions that define the the condition.

Operator string: Operator to combine sub-conditions. Can be and or or.
Subconditions []RulesetRuleConditionsSubcondition: List of sub-conditions that define the the condition.

operator string: Operator to combine sub-conditions. Can be and or or.
subconditions RulesetRuleConditionsSubcondition[]: List of sub-conditions that define the the condition.

operator str: Operator to combine sub-conditions. Can be and or or.
subconditions List[RulesetRuleConditionsSubcondition]: List of sub-conditions that define the the condition.

RulesetRuleConditionsSubcondition

Operator string: Type of operator to apply to the sub-condition. Can be exists,nexists,equals,nequals,contains,ncontains,matches, or nmatches.
Parameters List<RulesetRuleConditionsSubconditionParameterArgs>: Parameter for the sub-condition. It requires both a path and value to be set.

Operator string: Type of operator to apply to the sub-condition. Can be exists,nexists,equals,nequals,contains,ncontains,matches, or nmatches.
Parameters []RulesetRuleConditionsSubconditionParameter: Parameter for the sub-condition. It requires both a path and value to be set.

operator string: Type of operator to apply to the sub-condition. Can be exists,nexists,equals,nequals,contains,ncontains,matches, or nmatches.
parameters RulesetRuleConditionsSubconditionParameter[]: Parameter for the sub-condition. It requires both a path and value to be set.

operator str: Type of operator to apply to the sub-condition. Can be exists,nexists,equals,nequals,contains,ncontains,matches, or nmatches.
parameters List[RulesetRuleConditionsSubconditionParameter]: Parameter for the sub-condition. It requires both a path and value to be set.

RulesetRuleConditionsSubconditionParameter

Path string
Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

Path string
Value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

path string
value string: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

path str
value str: Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

RulesetRuleTimeFrame

ActiveBetweens List<RulesetRuleTimeFrameActiveBetweenArgs>: Values for executing the rule during a specific time period.
ScheduledWeeklies List<RulesetRuleTimeFrameScheduledWeeklyArgs>: Values for executing the rule on a recurring schedule.

ActiveBetweens []RulesetRuleTimeFrameActiveBetween: Values for executing the rule during a specific time period.
ScheduledWeeklies []RulesetRuleTimeFrameScheduledWeekly: Values for executing the rule on a recurring schedule.

activeBetweens RulesetRuleTimeFrameActiveBetween[]: Values for executing the rule during a specific time period.
scheduledWeeklies RulesetRuleTimeFrameScheduledWeekly[]: Values for executing the rule on a recurring schedule.

activeBetweens List[RulesetRuleTimeFrameActiveBetween]: Values for executing the rule during a specific time period.
scheduledWeeklies List[RulesetRuleTimeFrameScheduledWeekly]: Values for executing the rule on a recurring schedule.

RulesetRuleTimeFrameActiveBetween

EndTime int: Ending of the scheduled time when the rule should execute. Unix timestamp in milliseconds.
StartTime int: Time when the schedule will start. Unix timestamp in milliseconds. For example, if you have a rule with a start_time of 0 and a duration of 60,000 then that rule would be active from 00:00 to 00:01. If the start_time was 3,600,000 the it would be active starting at 01:00.

EndTime int: Ending of the scheduled time when the rule should execute. Unix timestamp in milliseconds.
StartTime int: Time when the schedule will start. Unix timestamp in milliseconds. For example, if you have a rule with a start_time of 0 and a duration of 60,000 then that rule would be active from 00:00 to 00:01. If the start_time was 3,600,000 the it would be active starting at 01:00.

endTime number: Ending of the scheduled time when the rule should execute. Unix timestamp in milliseconds.
startTime number: Time when the schedule will start. Unix timestamp in milliseconds. For example, if you have a rule with a start_time of 0 and a duration of 60,000 then that rule would be active from 00:00 to 00:01. If the start_time was 3,600,000 the it would be active starting at 01:00.

end_time float: Ending of the scheduled time when the rule should execute. Unix timestamp in milliseconds.
start_time float: Time when the schedule will start. Unix timestamp in milliseconds. For example, if you have a rule with a start_time of 0 and a duration of 60,000 then that rule would be active from 00:00 to 00:01. If the start_time was 3,600,000 the it would be active starting at 01:00.

RulesetRuleTimeFrameScheduledWeekly

Duration int: Length of time the schedule will be active. Unix timestamp in milliseconds.
StartTime int: Time when the schedule will start. Unix timestamp in milliseconds. For example, if you have a rule with a start_time of 0 and a duration of 60,000 then that rule would be active from 00:00 to 00:01. If the start_time was 3,600,000 the it would be active starting at 01:00.
Timezone string: Timezone for the given schedule.
Weekdays List<int>: An integer array representing which days during the week the rule executes. For example weekdays = [1,3,7] would execute on Monday, Wednesday and Sunday.

Duration int: Length of time the schedule will be active. Unix timestamp in milliseconds.
StartTime int: Time when the schedule will start. Unix timestamp in milliseconds. For example, if you have a rule with a start_time of 0 and a duration of 60,000 then that rule would be active from 00:00 to 00:01. If the start_time was 3,600,000 the it would be active starting at 01:00.
Timezone string: Timezone for the given schedule.
Weekdays []int: An integer array representing which days during the week the rule executes. For example weekdays = [1,3,7] would execute on Monday, Wednesday and Sunday.

duration number: Length of time the schedule will be active. Unix timestamp in milliseconds.
startTime number: Time when the schedule will start. Unix timestamp in milliseconds. For example, if you have a rule with a start_time of 0 and a duration of 60,000 then that rule would be active from 00:00 to 00:01. If the start_time was 3,600,000 the it would be active starting at 01:00.
timezone string: Timezone for the given schedule.
weekdays number[]: An integer array representing which days during the week the rule executes. For example weekdays = [1,3,7] would execute on Monday, Wednesday and Sunday.

duration float: Length of time the schedule will be active. Unix timestamp in milliseconds.
start_time float: Time when the schedule will start. Unix timestamp in milliseconds. For example, if you have a rule with a start_time of 0 and a duration of 60,000 then that rule would be active from 00:00 to 00:01. If the start_time was 3,600,000 the it would be active starting at 01:00.
timezone str: Timezone for the given schedule.
weekdays List[Integer]: An integer array representing which days during the week the rule executes. For example weekdays = [1,3,7] would execute on Monday, Wednesday and Sunday.

Package Details

Repository: https://github.com/pulumi/pulumi-pagerduty
License: Apache-2.0
Notes: This Pulumi package is based on the pagerduty Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud