Skip to content

Commit d2f6165

Browse files
committed
Updated docs.
1 parent 1e4c058 commit d2f6165

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/resources/kibana_alerting_rule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Could not create API key - Unsupported scheme "ApiKey" for granting API Key
6363
- `actions` (Block List) An action that runs under defined conditions. (see [below for nested schema](#nestedblock--actions))
6464
- `alert_delay` (Number) A number that indicates how many consecutive runs need to meet the rule conditions for an alert to occur.
6565
- `enabled` (Boolean) Indicates if you want to run the rule on an interval basis.
66-
- `notify_when` (String) Defines how often alerts generate actions. Valid values include: `onActionGroupChange`: Actions run when the alert status changes; `onActiveAlert`: Actions run when the alert becomes active and at each check interval while the rule conditions are met; `onThrottleInterval`: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: This is a rule level property; if you update the rule in Kibana, it is automatically changed to use action-specific `notify_when` values.
66+
- `notify_when` (String) Deprecated in 8.13.0. Use the `notify_when` property in the action `frequency` object instead. Defines how often alerts generate actions. Valid values include: `onActionGroupChange`: Actions run when the alert status changes; `onActiveAlert`: Actions run when the alert becomes active and at each check interval while the rule conditions are met; `onThrottleInterval`: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: This is a rule level property; if you update the rule in Kibana, it is automatically changed to use action-specific `notify_when` values.
6767
- `rule_id` (String) A UUID v1 or v4 to use instead of a randomly generated ID.
6868
- `space_id` (String) An identifier for the space. If space_id is not provided, the default space is used.
6969
- `tags` (List of String) A list of tag names that are applied to the rule.
@@ -86,7 +86,7 @@ Required:
8686

8787
Optional:
8888

89-
- `frequency` (Block List, Max: 1) The parameters for the action, which are sent to the connector. (see [below for nested schema](#nestedblock--actions--frequency))
89+
- `frequency` (Block List, Max: 1) The properties that affect how often actions are generated. If the rule type supports setting summary to true, the action can be a summary of alerts at the specified notification interval. Otherwise, an action runs for each alert at the specified notification interval. NOTE: You cannot specify these parameters when `notify_when` or `throttle` are defined at the rule level. (see [below for nested schema](#nestedblock--actions--frequency))
9090
- `group` (String) The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names.
9191

9292
<a id="nestedblock--actions--frequency"></a>

internal/kibana/alerting.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func ResourceAlertingRule() *schema.Resource {
4646
ForceNew: true,
4747
},
4848
"notify_when": {
49-
Description: "Defines how often alerts generate actions. Valid values include: `onActionGroupChange`: Actions run when the alert status changes; `onActiveAlert`: Actions run when the alert becomes active and at each check interval while the rule conditions are met; `onThrottleInterval`: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: This is a rule level property; if you update the rule in Kibana, it is automatically changed to use action-specific `notify_when` values.",
49+
Description: "Deprecated in 8.13.0. Use the `notify_when` property in the action `frequency` object instead. Defines how often alerts generate actions. Valid values include: `onActionGroupChange`: Actions run when the alert status changes; `onActiveAlert`: Actions run when the alert becomes active and at each check interval while the rule conditions are met; `onThrottleInterval`: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: This is a rule level property; if you update the rule in Kibana, it is automatically changed to use action-specific `notify_when` values.",
5050
Type: schema.TypeString,
5151
Optional: true,
5252
ValidateFunc: validation.StringInSlice([]string{"onActionGroupChange", "onActiveAlert", "onThrottleInterval"}, false),
@@ -95,7 +95,7 @@ func ResourceAlertingRule() *schema.Resource {
9595
DiffSuppressFunc: utils.DiffJsonSuppress,
9696
},
9797
"frequency": {
98-
Description: "The parameters for the action, which are sent to the connector.",
98+
Description: "The properties that affect how often actions are generated. If the rule type supports setting summary to true, the action can be a summary of alerts at the specified notification interval. Otherwise, an action runs for each alert at the specified notification interval. NOTE: You cannot specify these parameters when `notify_when` or `throttle` are defined at the rule level.",
9999
Type: schema.TypeList,
100100
MinItems: 0,
101101
MaxItems: 1,

0 commit comments

Comments
 (0)