# Resource:<span pulumi-lang-nodejs=" honeycombio.BurnAlert
" pulumi-lang-dotnet=" honeycombio.BurnAlert " pulumi-lang-go=" BurnAlert " pulumi-lang-python=" BurnAlert " pulumi-lang-yaml=" honeycombio.BurnAlert " pulumi-lang-java=" honeycombio.BurnAlert “> honeycombio.BurnAlert Creates a burn alert.
For more information about burn alerts, check out Define Burn Alerts.
Example Usage
Basic Example - Exhaustion Time Burn Alert
import * as pulumi from "@pulumi/pulumi";
import * as honeycombio from "@pulumi/honeycombio";
const config = new pulumi.Config();
const dataset = config.require("dataset");
const sloId = config.require("sloId");
const exampleAlert = new honeycombio.BurnAlert("example_alert", {
alertType: "exhaustion_time",
exhaustionMinutes: 480,
description: "Exhaustion burn alert description",
dataset: dataset,
sloId: sloId,
recipients: [
{
type: "email",
target: "hello@example.com",
},
{
type: "slack",
target: "#example-channel",
},
],
});
import pulumi
import pulumi_honeycombio as honeycombio
config = pulumi.Config()
dataset = config.require("dataset")
slo_id = config.require("sloId")
example_alert = honeycombio.BurnAlert("example_alert",
alert_type="exhaustion_time",
exhaustion_minutes=480,
description="Exhaustion burn alert description",
dataset=dataset,
slo_id=slo_id,
recipients=[
{
"type": "email",
"target": "hello@example.com",
},
{
"type": "slack",
"target": "#example-channel",
},
])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
dataset := cfg.Require("dataset")
sloId := cfg.Require("sloId")
_, err := honeycombio.NewBurnAlert(ctx, "example_alert", &honeycombio.BurnAlertArgs{
AlertType: pulumi.String("exhaustion_time"),
ExhaustionMinutes: pulumi.Float64(480),
Description: pulumi.String("Exhaustion burn alert description"),
Dataset: pulumi.String(dataset),
SloId: pulumi.String(sloId),
Recipients: honeycombio.BurnAlertRecipientArray{
&honeycombio.BurnAlertRecipientArgs{
Type: pulumi.String("email"),
Target: pulumi.String("hello@example.com"),
},
&honeycombio.BurnAlertRecipientArgs{
Type: pulumi.String("slack"),
Target: pulumi.String("#example-channel"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var dataset = config.Require("dataset");
var sloId = config.Require("sloId");
var exampleAlert = new Honeycombio.BurnAlert("example_alert", new()
{
AlertType = "exhaustion_time",
ExhaustionMinutes = 480,
Description = "Exhaustion burn alert description",
Dataset = dataset,
SloId = sloId,
Recipients = new[]
{
new Honeycombio.Inputs.BurnAlertRecipientArgs
{
Type = "email",
Target = "hello@example.com",
},
new Honeycombio.Inputs.BurnAlertRecipientArgs
{
Type = "slack",
Target = "#example-channel",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.BurnAlert;
import com.pulumi.honeycombio.BurnAlertArgs;
import com.pulumi.honeycombio.inputs.BurnAlertRecipientArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var dataset = config.get("dataset");
final var sloId = config.get("sloId");
var exampleAlert = new BurnAlert("exampleAlert", BurnAlertArgs.builder()
.alertType("exhaustion_time")
.exhaustionMinutes(480.0)
.description("Exhaustion burn alert description")
.dataset(dataset)
.sloId(sloId)
.recipients(
BurnAlertRecipientArgs.builder()
.type("email")
.target("hello@example.com")
.build(),
BurnAlertRecipientArgs.builder()
.type("slack")
.target("#example-channel")
.build())
.build());
}
}
configuration:
dataset:
type: string
sloId:
type: string
resources:
exampleAlert:
type: honeycombio:BurnAlert
name: example_alert
properties:
alertType: exhaustion_time
exhaustionMinutes: 480
description: Exhaustion burn alert description
dataset: ${dataset}
sloId: ${sloId}
recipients:
- type: email
target: hello@example.com
- type: slack
target: '#example-channel'
Basic Example - Budget Rate Burn Alert
import * as pulumi from "@pulumi/pulumi";
import * as honeycombio from "@pulumi/honeycombio";
const config = new pulumi.Config();
const dataset = config.require("dataset");
const sloId = config.require("sloId");
const exampleAlert = new honeycombio.BurnAlert("example_alert", {
alertType: "budget_rate",
budgetRateWindowMinutes: 480,
budgetRateDecreasePercent: 1,
description: "my example description",
dataset: dataset,
sloId: sloId,
recipients: [{
type: "webhook",
target: "name of the webhook",
}],
});
import pulumi
import pulumi_honeycombio as honeycombio
config = pulumi.Config()
dataset = config.require("dataset")
slo_id = config.require("sloId")
example_alert = honeycombio.BurnAlert("example_alert",
alert_type="budget_rate",
budget_rate_window_minutes=480,
budget_rate_decrease_percent=1,
description="my example description",
dataset=dataset,
slo_id=slo_id,
recipients=[{
"type": "webhook",
"target": "name of the webhook",
}])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
dataset := cfg.Require("dataset")
sloId := cfg.Require("sloId")
_, err := honeycombio.NewBurnAlert(ctx, "example_alert", &honeycombio.BurnAlertArgs{
AlertType: pulumi.String("budget_rate"),
BudgetRateWindowMinutes: pulumi.Float64(480),
BudgetRateDecreasePercent: pulumi.Float64(1),
Description: pulumi.String("my example description"),
Dataset: pulumi.String(dataset),
SloId: pulumi.String(sloId),
Recipients: honeycombio.BurnAlertRecipientArray{
&honeycombio.BurnAlertRecipientArgs{
Type: pulumi.String("webhook"),
Target: pulumi.String("name of the webhook"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var dataset = config.Require("dataset");
var sloId = config.Require("sloId");
var exampleAlert = new Honeycombio.BurnAlert("example_alert", new()
{
AlertType = "budget_rate",
BudgetRateWindowMinutes = 480,
BudgetRateDecreasePercent = 1,
Description = "my example description",
Dataset = dataset,
SloId = sloId,
Recipients = new[]
{
new Honeycombio.Inputs.BurnAlertRecipientArgs
{
Type = "webhook",
Target = "name of the webhook",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.BurnAlert;
import com.pulumi.honeycombio.BurnAlertArgs;
import com.pulumi.honeycombio.inputs.BurnAlertRecipientArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var dataset = config.get("dataset");
final var sloId = config.get("sloId");
var exampleAlert = new BurnAlert("exampleAlert", BurnAlertArgs.builder()
.alertType("budget_rate")
.budgetRateWindowMinutes(480.0)
.budgetRateDecreasePercent(1.0)
.description("my example description")
.dataset(dataset)
.sloId(sloId)
.recipients(BurnAlertRecipientArgs.builder()
.type("webhook")
.target("name of the webhook")
.build())
.build());
}
}
configuration:
dataset:
type: string
sloId:
type: string
resources:
exampleAlert:
type: honeycombio:BurnAlert
name: example_alert
properties:
alertType: budget_rate
budgetRateWindowMinutes: 480
budgetRateDecreasePercent: 1
description: my example description
dataset: ${dataset}
sloId: ${sloId}
recipients:
- type: webhook
target: name of the webhook
Example - Exhaustion Time Burn Alert with PagerDuty Recipient and Severity
import * as pulumi from "@pulumi/pulumi";
import * as honeycombio from "@pulumi/honeycombio";
const config = new pulumi.Config();
const dataset = config.require("dataset");
const sloId = config.require("sloId");
const pdProd = honeycombio.getRecipient({
type: "pagerduty",
detailFilter: {
name: "integration_name",
value: "Prod On-Call",
},
});
const exampleAlert = new honeycombio.BurnAlert("example_alert", {
exhaustionMinutes: 60,
description: "Burn alert description",
dataset: dataset,
sloId: sloId,
recipients: [{
id: pdProd.then(pdProd => pdProd.id),
notificationDetails: [{
pagerdutySeverity: "critical",
}],
}],
});
import pulumi
import pulumi_honeycombio as honeycombio
config = pulumi.Config()
dataset = config.require("dataset")
slo_id = config.require("sloId")
pd_prod = honeycombio.get_recipient(type="pagerduty",
detail_filter={
"name": "integration_name",
"value": "Prod On-Call",
})
example_alert = honeycombio.BurnAlert("example_alert",
exhaustion_minutes=60,
description="Burn alert description",
dataset=dataset,
slo_id=slo_id,
recipients=[{
"id": pd_prod.id,
"notification_details": [{
"pagerduty_severity": "critical",
}],
}])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
dataset := cfg.Require("dataset")
sloId := cfg.Require("sloId")
pdProd, err := honeycombio.GetRecipient(ctx, &honeycombio.GetRecipientArgs{
Type: "pagerduty",
DetailFilter: honeycombio.GetRecipientDetailFilter{
Name: "integration_name",
Value: pulumi.StringRef("Prod On-Call"),
},
}, nil)
if err != nil {
return err
}
_, err = honeycombio.NewBurnAlert(ctx, "example_alert", &honeycombio.BurnAlertArgs{
ExhaustionMinutes: pulumi.Float64(60),
Description: pulumi.String("Burn alert description"),
Dataset: pulumi.String(dataset),
SloId: pulumi.String(sloId),
Recipients: honeycombio.BurnAlertRecipientArray{
&honeycombio.BurnAlertRecipientArgs{
Id: pulumi.String(pdProd.Id),
NotificationDetails: honeycombio.BurnAlertRecipientNotificationDetailArray{
&honeycombio.BurnAlertRecipientNotificationDetailArgs{
PagerdutySeverity: pulumi.String("critical"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var dataset = config.Require("dataset");
var sloId = config.Require("sloId");
var pdProd = Honeycombio.GetRecipient.Invoke(new()
{
Type = "pagerduty",
DetailFilter = new Honeycombio.Inputs.GetRecipientDetailFilterInputArgs
{
Name = "integration_name",
Value = "Prod On-Call",
},
});
var exampleAlert = new Honeycombio.BurnAlert("example_alert", new()
{
ExhaustionMinutes = 60,
Description = "Burn alert description",
Dataset = dataset,
SloId = sloId,
Recipients = new[]
{
new Honeycombio.Inputs.BurnAlertRecipientArgs
{
Id = pdProd.Apply(getRecipientResult => getRecipientResult.Id),
NotificationDetails = new[]
{
new Honeycombio.Inputs.BurnAlertRecipientNotificationDetailArgs
{
PagerdutySeverity = "critical",
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.HoneycombioFunctions;
import com.pulumi.honeycombio.inputs.GetRecipientArgs;
import com.pulumi.honeycombio.inputs.GetRecipientDetailFilterArgs;
import com.pulumi.honeycombio.BurnAlert;
import com.pulumi.honeycombio.BurnAlertArgs;
import com.pulumi.honeycombio.inputs.BurnAlertRecipientArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var dataset = config.get("dataset");
final var sloId = config.get("sloId");
final var pdProd = HoneycombioFunctions.getRecipient(GetRecipientArgs.builder()
.type("pagerduty")
.detailFilter(GetRecipientDetailFilterArgs.builder()
.name("integration_name")
.value("Prod On-Call")
.build())
.build());
var exampleAlert = new BurnAlert("exampleAlert", BurnAlertArgs.builder()
.exhaustionMinutes(60.0)
.description("Burn alert description")
.dataset(dataset)
.sloId(sloId)
.recipients(BurnAlertRecipientArgs.builder()
.id(pdProd.id())
.notificationDetails(BurnAlertRecipientNotificationDetailArgs.builder()
.pagerdutySeverity("critical")
.build())
.build())
.build());
}
}
configuration:
dataset:
type: string
sloId:
type: string
resources:
exampleAlert:
type: honeycombio:BurnAlert
name: example_alert
properties:
exhaustionMinutes: 60
description: Burn alert description
dataset: ${dataset}
sloId: ${sloId}
recipients:
- id: ${pdProd.id}
notificationDetails:
- pagerdutySeverity: critical
variables:
pdProd:
fn::invoke:
function: honeycombio:getRecipient
arguments:
type: pagerduty
detailFilter:
name: integration_name
value: Prod On-Call
Multi-dataset Burn Alert
$ pulumi import honeycombio:index/burnAlert:BurnAlert my_alert bc9XwOb2yJu
Create BurnAlert Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BurnAlert(name: string, args: BurnAlertArgs, opts?: CustomResourceOptions);@overload
def BurnAlert(resource_name: str,
args: BurnAlertArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BurnAlert(resource_name: str,
opts: Optional[ResourceOptions] = None,
slo_id: Optional[str] = None,
alert_type: Optional[str] = None,
budget_rate_decrease_percent: Optional[float] = None,
budget_rate_window_minutes: Optional[float] = None,
dataset: Optional[str] = None,
description: Optional[str] = None,
exhaustion_minutes: Optional[float] = None,
recipients: Optional[Sequence[BurnAlertRecipientArgs]] = None)func NewBurnAlert(ctx *Context, name string, args BurnAlertArgs, opts ...ResourceOption) (*BurnAlert, error)public BurnAlert(string name, BurnAlertArgs args, CustomResourceOptions? opts = null)
public BurnAlert(String name, BurnAlertArgs args)
public BurnAlert(String name, BurnAlertArgs args, CustomResourceOptions options)
type: honeycombio:BurnAlert
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 BurnAlertArgs
- 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 BurnAlertArgs
- 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 BurnAlertArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BurnAlertArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BurnAlertArgs
- 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 burnAlertResource = new Honeycombio.BurnAlert("burnAlertResource", new()
{
SloId = "string",
AlertType = "string",
BudgetRateDecreasePercent = 0,
BudgetRateWindowMinutes = 0,
Dataset = "string",
Description = "string",
ExhaustionMinutes = 0,
Recipients = new[]
{
new Honeycombio.Inputs.BurnAlertRecipientArgs
{
Id = "string",
NotificationDetails = new[]
{
new Honeycombio.Inputs.BurnAlertRecipientNotificationDetailArgs
{
PagerdutySeverity = "string",
Variables = new[]
{
new Honeycombio.Inputs.BurnAlertRecipientNotificationDetailVariableArgs
{
Name = "string",
Value = "string",
},
},
},
},
Target = "string",
Type = "string",
},
},
});
example, err := honeycombio.NewBurnAlert(ctx, "burnAlertResource", &honeycombio.BurnAlertArgs{
SloId: pulumi.String("string"),
AlertType: pulumi.String("string"),
BudgetRateDecreasePercent: pulumi.Float64(0),
BudgetRateWindowMinutes: pulumi.Float64(0),
Dataset: pulumi.String("string"),
Description: pulumi.String("string"),
ExhaustionMinutes: pulumi.Float64(0),
Recipients: honeycombio.BurnAlertRecipientArray{
&honeycombio.BurnAlertRecipientArgs{
Id: pulumi.String("string"),
NotificationDetails: honeycombio.BurnAlertRecipientNotificationDetailArray{
&honeycombio.BurnAlertRecipientNotificationDetailArgs{
PagerdutySeverity: pulumi.String("string"),
Variables: honeycombio.BurnAlertRecipientNotificationDetailVariableArray{
&honeycombio.BurnAlertRecipientNotificationDetailVariableArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
Target: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
})
var burnAlertResource = new BurnAlert("burnAlertResource", BurnAlertArgs.builder()
.sloId("string")
.alertType("string")
.budgetRateDecreasePercent(0.0)
.budgetRateWindowMinutes(0.0)
.dataset("string")
.description("string")
.exhaustionMinutes(0.0)
.recipients(BurnAlertRecipientArgs.builder()
.id("string")
.notificationDetails(BurnAlertRecipientNotificationDetailArgs.builder()
.pagerdutySeverity("string")
.variables(BurnAlertRecipientNotificationDetailVariableArgs.builder()
.name("string")
.value("string")
.build())
.build())
.target("string")
.type("string")
.build())
.build());
burn_alert_resource = honeycombio.BurnAlert("burnAlertResource",
slo_id="string",
alert_type="string",
budget_rate_decrease_percent=0,
budget_rate_window_minutes=0,
dataset="string",
description="string",
exhaustion_minutes=0,
recipients=[{
"id": "string",
"notification_details": [{
"pagerduty_severity": "string",
"variables": [{
"name": "string",
"value": "string",
}],
}],
"target": "string",
"type": "string",
}])
const burnAlertResource = new honeycombio.BurnAlert("burnAlertResource", {
sloId: "string",
alertType: "string",
budgetRateDecreasePercent: 0,
budgetRateWindowMinutes: 0,
dataset: "string",
description: "string",
exhaustionMinutes: 0,
recipients: [{
id: "string",
notificationDetails: [{
pagerdutySeverity: "string",
variables: [{
name: "string",
value: "string",
}],
}],
target: "string",
type: "string",
}],
});
type: honeycombio:BurnAlert
properties:
alertType: string
budgetRateDecreasePercent: 0
budgetRateWindowMinutes: 0
dataset: string
description: string
exhaustionMinutes: 0
recipients:
- id: string
notificationDetails:
- pagerdutySeverity: string
variables:
- name: string
value: string
target: string
type: string
sloId: string
BurnAlert 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 BurnAlert resource accepts the following input properties:
- Slo
Id string - The ID of the SLO that this Burn Alert is associated with.
- Alert
Type string - The alert type of this Burn Alert.
- Budget
Rate doubleDecrease Percent - The percent the budget has decreased over the budget rate window.
- Budget
Rate doubleWindow Minutes - The time period, in minutes, over which a budget rate will be calculated.
- Dataset string
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- Description string
- A description for this Burn Alert.
- Exhaustion
Minutes double - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- Recipients
List<Burn
Alert Recipient> - Zero or more recipients to notify when the resource fires.
- Slo
Id string - The ID of the SLO that this Burn Alert is associated with.
- Alert
Type string - The alert type of this Burn Alert.
- Budget
Rate float64Decrease Percent - The percent the budget has decreased over the budget rate window.
- Budget
Rate float64Window Minutes - The time period, in minutes, over which a budget rate will be calculated.
- Dataset string
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- Description string
- A description for this Burn Alert.
- Exhaustion
Minutes float64 - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- Recipients
[]Burn
Alert Recipient Args - Zero or more recipients to notify when the resource fires.
- slo
Id String - The ID of the SLO that this Burn Alert is associated with.
- alert
Type String - The alert type of this Burn Alert.
- budget
Rate DoubleDecrease Percent - The percent the budget has decreased over the budget rate window.
- budget
Rate DoubleWindow Minutes - The time period, in minutes, over which a budget rate will be calculated.
- dataset String
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- description String
- A description for this Burn Alert.
- exhaustion
Minutes Double - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- recipients
List<Burn
Alert Recipient> - Zero or more recipients to notify when the resource fires.
- slo
Id string - The ID of the SLO that this Burn Alert is associated with.
- alert
Type string - The alert type of this Burn Alert.
- budget
Rate numberDecrease Percent - The percent the budget has decreased over the budget rate window.
- budget
Rate numberWindow Minutes - The time period, in minutes, over which a budget rate will be calculated.
- dataset string
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- description string
- A description for this Burn Alert.
- exhaustion
Minutes number - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- recipients
Burn
Alert Recipient[] - Zero or more recipients to notify when the resource fires.
- slo_
id str - The ID of the SLO that this Burn Alert is associated with.
- alert_
type str - The alert type of this Burn Alert.
- budget_
rate_ floatdecrease_ percent - The percent the budget has decreased over the budget rate window.
- budget_
rate_ floatwindow_ minutes - The time period, in minutes, over which a budget rate will be calculated.
- dataset str
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- description str
- A description for this Burn Alert.
- exhaustion_
minutes float - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- recipients
Sequence[Burn
Alert Recipient Args] - Zero or more recipients to notify when the resource fires.
- slo
Id String - The ID of the SLO that this Burn Alert is associated with.
- alert
Type String - The alert type of this Burn Alert.
- budget
Rate NumberDecrease Percent - The percent the budget has decreased over the budget rate window.
- budget
Rate NumberWindow Minutes - The time period, in minutes, over which a budget rate will be calculated.
- dataset String
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- description String
- A description for this Burn Alert.
- exhaustion
Minutes Number - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- recipients List<Property Map>
- Zero or more recipients to notify when the resource fires.
Outputs
All input properties are implicitly available as output properties. Additionally, the BurnAlert 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 BurnAlert Resource
Get an existing BurnAlert 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?: BurnAlertState, opts?: CustomResourceOptions): BurnAlert@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alert_type: Optional[str] = None,
budget_rate_decrease_percent: Optional[float] = None,
budget_rate_window_minutes: Optional[float] = None,
dataset: Optional[str] = None,
description: Optional[str] = None,
exhaustion_minutes: Optional[float] = None,
recipients: Optional[Sequence[BurnAlertRecipientArgs]] = None,
slo_id: Optional[str] = None) -> BurnAlertfunc GetBurnAlert(ctx *Context, name string, id IDInput, state *BurnAlertState, opts ...ResourceOption) (*BurnAlert, error)public static BurnAlert Get(string name, Input<string> id, BurnAlertState? state, CustomResourceOptions? opts = null)public static BurnAlert get(String name, Output<String> id, BurnAlertState state, CustomResourceOptions options)resources: _: type: honeycombio:BurnAlert get: id: ${id}- 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.
- Alert
Type string - The alert type of this Burn Alert.
- Budget
Rate doubleDecrease Percent - The percent the budget has decreased over the budget rate window.
- Budget
Rate doubleWindow Minutes - The time period, in minutes, over which a budget rate will be calculated.
- Dataset string
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- Description string
- A description for this Burn Alert.
- Exhaustion
Minutes double - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- Recipients
List<Burn
Alert Recipient> - Zero or more recipients to notify when the resource fires.
- Slo
Id string - The ID of the SLO that this Burn Alert is associated with.
- Alert
Type string - The alert type of this Burn Alert.
- Budget
Rate float64Decrease Percent - The percent the budget has decreased over the budget rate window.
- Budget
Rate float64Window Minutes - The time period, in minutes, over which a budget rate will be calculated.
- Dataset string
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- Description string
- A description for this Burn Alert.
- Exhaustion
Minutes float64 - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- Recipients
[]Burn
Alert Recipient Args - Zero or more recipients to notify when the resource fires.
- Slo
Id string - The ID of the SLO that this Burn Alert is associated with.
- alert
Type String - The alert type of this Burn Alert.
- budget
Rate DoubleDecrease Percent - The percent the budget has decreased over the budget rate window.
- budget
Rate DoubleWindow Minutes - The time period, in minutes, over which a budget rate will be calculated.
- dataset String
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- description String
- A description for this Burn Alert.
- exhaustion
Minutes Double - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- recipients
List<Burn
Alert Recipient> - Zero or more recipients to notify when the resource fires.
- slo
Id String - The ID of the SLO that this Burn Alert is associated with.
- alert
Type string - The alert type of this Burn Alert.
- budget
Rate numberDecrease Percent - The percent the budget has decreased over the budget rate window.
- budget
Rate numberWindow Minutes - The time period, in minutes, over which a budget rate will be calculated.
- dataset string
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- description string
- A description for this Burn Alert.
- exhaustion
Minutes number - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- recipients
Burn
Alert Recipient[] - Zero or more recipients to notify when the resource fires.
- slo
Id string - The ID of the SLO that this Burn Alert is associated with.
- alert_
type str - The alert type of this Burn Alert.
- budget_
rate_ floatdecrease_ percent - The percent the budget has decreased over the budget rate window.
- budget_
rate_ floatwindow_ minutes - The time period, in minutes, over which a budget rate will be calculated.
- dataset str
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- description str
- A description for this Burn Alert.
- exhaustion_
minutes float - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- recipients
Sequence[Burn
Alert Recipient Args] - Zero or more recipients to notify when the resource fires.
- slo_
id str - The ID of the SLO that this Burn Alert is associated with.
- alert
Type String - The alert type of this Burn Alert.
- budget
Rate NumberDecrease Percent - The percent the budget has decreased over the budget rate window.
- budget
Rate NumberWindow Minutes - The time period, in minutes, over which a budget rate will be calculated.
- dataset String
- The dataset this Burn Alert is associated with. Will be deprecated in a future release.
- description String
- A description for this Burn Alert.
- exhaustion
Minutes Number - The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.
- recipients List<Property Map>
- Zero or more recipients to notify when the resource fires.
- slo
Id String - The ID of the SLO that this Burn Alert is associated with.
Supporting Types
BurnAlertRecipient, BurnAlertRecipientArgs
- Id string
- The ID of an existing recipient.
- Notification
Details List<BurnAlert Recipient Notification Detail> - Additional details to send along with the notification.
- Target string
- Target of the notification, this has another meaning depending on the type of recipient.
- Type string
- The type of the notification recipient.
- Id string
- The ID of an existing recipient.
- Notification
Details []BurnAlert Recipient Notification Detail - Additional details to send along with the notification.
- Target string
- Target of the notification, this has another meaning depending on the type of recipient.
- Type string
- The type of the notification recipient.
- id String
- The ID of an existing recipient.
- notification
Details List<BurnAlert Recipient Notification Detail> - Additional details to send along with the notification.
- target String
- Target of the notification, this has another meaning depending on the type of recipient.
- type String
- The type of the notification recipient.
- id string
- The ID of an existing recipient.
- notification
Details BurnAlert Recipient Notification Detail[] - Additional details to send along with the notification.
- target string
- Target of the notification, this has another meaning depending on the type of recipient.
- type string
- The type of the notification recipient.
- id str
- The ID of an existing recipient.
- notification_
details Sequence[BurnAlert Recipient Notification Detail] - Additional details to send along with the notification.
- target str
- Target of the notification, this has another meaning depending on the type of recipient.
- type str
- The type of the notification recipient.
- id String
- The ID of an existing recipient.
- notification
Details List<Property Map> - Additional details to send along with the notification.
- target String
- Target of the notification, this has another meaning depending on the type of recipient.
- type String
- The type of the notification recipient.
BurnAlertRecipientNotificationDetail, BurnAlertRecipientNotificationDetailArgs
- Pagerduty
Severity string - The severity to set with the PagerDuty notification. If no severity is provided, 'critical' is assumed.
- Variables
List<Burn
Alert Recipient Notification Detail Variable> - The variables to set with the webhook notification.
- Pagerduty
Severity string - The severity to set with the PagerDuty notification. If no severity is provided, 'critical' is assumed.
- Variables
[]Burn
Alert Recipient Notification Detail Variable - The variables to set with the webhook notification.
- pagerduty
Severity String - The severity to set with the PagerDuty notification. If no severity is provided, 'critical' is assumed.
- variables
List<Burn
Alert Recipient Notification Detail Variable> - The variables to set with the webhook notification.
- pagerduty
Severity string - The severity to set with the PagerDuty notification. If no severity is provided, 'critical' is assumed.
- variables
Burn
Alert Recipient Notification Detail Variable[] - The variables to set with the webhook notification.
- pagerduty_
severity str - The severity to set with the PagerDuty notification. If no severity is provided, 'critical' is assumed.
- variables
Sequence[Burn
Alert Recipient Notification Detail Variable] - The variables to set with the webhook notification.
- pagerduty
Severity String - The severity to set with the PagerDuty notification. If no severity is provided, 'critical' is assumed.
- variables List<Property Map>
- The variables to set with the webhook notification.
BurnAlertRecipientNotificationDetailVariable, BurnAlertRecipientNotificationDetailVariableArgs
Package Details
- Repository
- honeycombio honeycombio/terraform-provider-honeycombio
- License
- Notes
- This Pulumi package is based on the
honeycombioTerraform Provider.
