Grafana v0.0.10, May 21 23

grafana.OncallIntegration

Explore with Pulumi AI

Create OncallIntegration Resource

new OncallIntegration(name: string, args: OncallIntegrationArgs, opts?: CustomResourceOptions);

@overload
def OncallIntegration(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      default_route: Optional[OncallIntegrationDefaultRouteArgs] = None,
                      name: Optional[str] = None,
                      team_id: Optional[str] = None,
                      templates: Optional[OncallIntegrationTemplatesArgs] = None,
                      type: Optional[str] = None)
@overload
def OncallIntegration(resource_name: str,
                      args: OncallIntegrationArgs,
                      opts: Optional[ResourceOptions] = None)

func NewOncallIntegration(ctx *Context, name string, args OncallIntegrationArgs, opts ...ResourceOption) (*OncallIntegration, error)

public OncallIntegration(string name, OncallIntegrationArgs args, CustomResourceOptions? opts = null)

public OncallIntegration(String name, OncallIntegrationArgs args)
public OncallIntegration(String name, OncallIntegrationArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args OncallIntegrationArgs: 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 OncallIntegrationArgs: 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 OncallIntegrationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args OncallIntegrationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

DefaultRoute Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationDefaultRouteArgs: The Default route for all alerts from the given integration
Type string: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.
Name string: The name of the service integration.
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
Templates Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationTemplatesArgs: Jinja2 templates for Alert payload.

DefaultRoute OncallIntegrationDefaultRouteArgs: The Default route for all alerts from the given integration
Type string: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.
Name string: The name of the service integration.
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
Templates OncallIntegrationTemplatesArgs: Jinja2 templates for Alert payload.

defaultRoute OncallIntegrationDefaultRouteArgs: The Default route for all alerts from the given integration
type String: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.
name String: The name of the service integration.
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
templates OncallIntegrationTemplatesArgs: Jinja2 templates for Alert payload.

defaultRoute OncallIntegrationDefaultRouteArgs: The Default route for all alerts from the given integration
type string: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.
name string: The name of the service integration.
teamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
templates OncallIntegrationTemplatesArgs: Jinja2 templates for Alert payload.

default_route OncallIntegrationDefaultRouteArgs: The Default route for all alerts from the given integration
type str: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.
name str: The name of the service integration.
team_id str: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
templates OncallIntegrationTemplatesArgs: Jinja2 templates for Alert payload.

defaultRoute Property Map: The Default route for all alerts from the given integration
type String: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.
name String: The name of the service integration.
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
templates Property Map: Jinja2 templates for Alert payload.

Outputs

All input properties are implicitly available as output properties. Additionally, the OncallIntegration resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Link string: The link for using in an integrated tool.

Id string: The provider-assigned unique ID for this managed resource.
Link string: The link for using in an integrated tool.

id String: The provider-assigned unique ID for this managed resource.
link String: The link for using in an integrated tool.

id string: The provider-assigned unique ID for this managed resource.
link string: The link for using in an integrated tool.

id str: The provider-assigned unique ID for this managed resource.
link str: The link for using in an integrated tool.

id String: The provider-assigned unique ID for this managed resource.
link String: The link for using in an integrated tool.

Look up Existing OncallIntegration Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_route: Optional[OncallIntegrationDefaultRouteArgs] = None,
        link: Optional[str] = None,
        name: Optional[str] = None,
        team_id: Optional[str] = None,
        templates: Optional[OncallIntegrationTemplatesArgs] = None,
        type: Optional[str] = None) -> OncallIntegration

func GetOncallIntegration(ctx *Context, name string, id IDInput, state *OncallIntegrationState, opts ...ResourceOption) (*OncallIntegration, error)

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

public static OncallIntegration get(String name, Output<String> id, OncallIntegrationState 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:

DefaultRoute Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationDefaultRouteArgs: The Default route for all alerts from the given integration
Link string: The link for using in an integrated tool.
Name string: The name of the service integration.
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
Templates Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationTemplatesArgs: Jinja2 templates for Alert payload.
Type string: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.

DefaultRoute OncallIntegrationDefaultRouteArgs: The Default route for all alerts from the given integration
Link string: The link for using in an integrated tool.
Name string: The name of the service integration.
TeamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
Templates OncallIntegrationTemplatesArgs: Jinja2 templates for Alert payload.
Type string: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.

defaultRoute OncallIntegrationDefaultRouteArgs: The Default route for all alerts from the given integration
link String: The link for using in an integrated tool.
name String: The name of the service integration.
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
templates OncallIntegrationTemplatesArgs: Jinja2 templates for Alert payload.
type String: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.

defaultRoute OncallIntegrationDefaultRouteArgs: The Default route for all alerts from the given integration
link string: The link for using in an integrated tool.
name string: The name of the service integration.
teamId string: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
templates OncallIntegrationTemplatesArgs: Jinja2 templates for Alert payload.
type string: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.

default_route OncallIntegrationDefaultRouteArgs: The Default route for all alerts from the given integration
link str: The link for using in an integrated tool.
name str: The name of the service integration.
team_id str: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
templates OncallIntegrationTemplatesArgs: Jinja2 templates for Alert payload.
type str: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.

defaultRoute Property Map: The Default route for all alerts from the given integration
link String: The link for using in an integrated tool.
name String: The name of the service integration.
teamId String: The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the grafana.getOncallTeam datasource.
templates Property Map: Jinja2 templates for Alert payload.
type String: The type of integration. Can be grafana, grafanaalerting, webhook, alertmanager, kapacitor, fabric, newrelic, datadog, pagerduty, pingdom, elastalert, amazonsns, curler, sentry, formattedwebhook, heartbeat, demo, manual, stackdriver, uptimerobot, sentryplatform, zabbix, prtg, slackchannel, inboundemail.

Supporting Types

OncallIntegrationDefaultRoute

EscalationChainId string: The ID of the escalation chain.
Id string: The ID of this resource.
Msteams Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationDefaultRouteMsteams: MS teams-specific settings for a route.
Slack Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationDefaultRouteSlack: Slack-specific settings for a route.
Telegram Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationDefaultRouteTelegram: Telegram-specific settings for a route.

EscalationChainId string: The ID of the escalation chain.
Id string: The ID of this resource.
Msteams OncallIntegrationDefaultRouteMsteams: MS teams-specific settings for a route.
Slack OncallIntegrationDefaultRouteSlack: Slack-specific settings for a route.
Telegram OncallIntegrationDefaultRouteTelegram: Telegram-specific settings for a route.

escalationChainId String: The ID of the escalation chain.
id String: The ID of this resource.
msteams OncallIntegrationDefaultRouteMsteams: MS teams-specific settings for a route.
slack OncallIntegrationDefaultRouteSlack: Slack-specific settings for a route.
telegram OncallIntegrationDefaultRouteTelegram: Telegram-specific settings for a route.

escalationChainId string: The ID of the escalation chain.
id string: The ID of this resource.
msteams OncallIntegrationDefaultRouteMsteams: MS teams-specific settings for a route.
slack OncallIntegrationDefaultRouteSlack: Slack-specific settings for a route.
telegram OncallIntegrationDefaultRouteTelegram: Telegram-specific settings for a route.

escalation_chain_id str: The ID of the escalation chain.
id str: The ID of this resource.
msteams OncallIntegrationDefaultRouteMsteams: MS teams-specific settings for a route.
slack OncallIntegrationDefaultRouteSlack: Slack-specific settings for a route.
telegram OncallIntegrationDefaultRouteTelegram: Telegram-specific settings for a route.

escalationChainId String: The ID of the escalation chain.
id String: The ID of this resource.
msteams Property Map: MS teams-specific settings for a route.
slack Property Map: Slack-specific settings for a route.
telegram Property Map: Telegram-specific settings for a route.

OncallIntegrationDefaultRouteMsteams

Enabled bool
Id string: The ID of this resource.

Enabled bool
Id string: The ID of this resource.

enabled Boolean
id String: The ID of this resource.

enabled boolean
id string: The ID of this resource.

enabled bool
id str: The ID of this resource.

enabled Boolean
id String: The ID of this resource.

OncallIntegrationDefaultRouteSlack

ChannelId string
Enabled bool

ChannelId string
Enabled bool

channelId String
enabled Boolean

channelId string
enabled boolean

channel_id str
enabled bool

channelId String
enabled Boolean

OncallIntegrationDefaultRouteTelegram

Enabled bool
Id string: The ID of this resource.

Enabled bool
Id string: The ID of this resource.

enabled Boolean
id String: The ID of this resource.

enabled boolean
id string: The ID of this resource.

enabled bool
id str: The ID of this resource.

enabled Boolean
id String: The ID of this resource.

OncallIntegrationTemplates

AcknowledgeSignal string: Template for sending a signal to acknowledge the Incident.
Email Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationTemplatesEmail: Templates for Email.
GroupingKey string: Template for the key by which alerts are grouped.
MicrosoftTeams Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationTemplatesMicrosoftTeams: Templates for Microsoft Teams.
PhoneCall Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationTemplatesPhoneCall: Templates for Phone Call.
ResolveSignal string: Template for sending a signal to resolve the Incident.
Slack Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationTemplatesSlack: Templates for Slack.
Sms Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationTemplatesSms: Templates for SMS.
SourceLink string: Template for a source link.
Telegram Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationTemplatesTelegram: Templates for Telegram.
Web Lbrlabs.PulumiPackage.Grafana.Inputs.OncallIntegrationTemplatesWeb: Templates for Web.

AcknowledgeSignal string: Template for sending a signal to acknowledge the Incident.
Email OncallIntegrationTemplatesEmail: Templates for Email.
GroupingKey string: Template for the key by which alerts are grouped.
MicrosoftTeams OncallIntegrationTemplatesMicrosoftTeams: Templates for Microsoft Teams.
PhoneCall OncallIntegrationTemplatesPhoneCall: Templates for Phone Call.
ResolveSignal string: Template for sending a signal to resolve the Incident.
Slack OncallIntegrationTemplatesSlack: Templates for Slack.
Sms OncallIntegrationTemplatesSms: Templates for SMS.
SourceLink string: Template for a source link.
Telegram OncallIntegrationTemplatesTelegram: Templates for Telegram.
Web OncallIntegrationTemplatesWeb: Templates for Web.

acknowledgeSignal String: Template for sending a signal to acknowledge the Incident.
email OncallIntegrationTemplatesEmail: Templates for Email.
groupingKey String: Template for the key by which alerts are grouped.
microsoftTeams OncallIntegrationTemplatesMicrosoftTeams: Templates for Microsoft Teams.
phoneCall OncallIntegrationTemplatesPhoneCall: Templates for Phone Call.
resolveSignal String: Template for sending a signal to resolve the Incident.
slack OncallIntegrationTemplatesSlack: Templates for Slack.
sms OncallIntegrationTemplatesSms: Templates for SMS.
sourceLink String: Template for a source link.
telegram OncallIntegrationTemplatesTelegram: Templates for Telegram.
web OncallIntegrationTemplatesWeb: Templates for Web.

acknowledgeSignal string: Template for sending a signal to acknowledge the Incident.
email OncallIntegrationTemplatesEmail: Templates for Email.
groupingKey string: Template for the key by which alerts are grouped.
microsoftTeams OncallIntegrationTemplatesMicrosoftTeams: Templates for Microsoft Teams.
phoneCall OncallIntegrationTemplatesPhoneCall: Templates for Phone Call.
resolveSignal string: Template for sending a signal to resolve the Incident.
slack OncallIntegrationTemplatesSlack: Templates for Slack.
sms OncallIntegrationTemplatesSms: Templates for SMS.
sourceLink string: Template for a source link.
telegram OncallIntegrationTemplatesTelegram: Templates for Telegram.
web OncallIntegrationTemplatesWeb: Templates for Web.

acknowledge_signal str: Template for sending a signal to acknowledge the Incident.
email OncallIntegrationTemplatesEmail: Templates for Email.
grouping_key str: Template for the key by which alerts are grouped.
microsoft_teams OncallIntegrationTemplatesMicrosoftTeams: Templates for Microsoft Teams.
phone_call OncallIntegrationTemplatesPhoneCall: Templates for Phone Call.
resolve_signal str: Template for sending a signal to resolve the Incident.
slack OncallIntegrationTemplatesSlack: Templates for Slack.
sms OncallIntegrationTemplatesSms: Templates for SMS.
source_link str: Template for a source link.
telegram OncallIntegrationTemplatesTelegram: Templates for Telegram.
web OncallIntegrationTemplatesWeb: Templates for Web.

acknowledgeSignal String: Template for sending a signal to acknowledge the Incident.
email Property Map: Templates for Email.
groupingKey String: Template for the key by which alerts are grouped.
microsoftTeams Property Map: Templates for Microsoft Teams.
phoneCall Property Map: Templates for Phone Call.
resolveSignal String: Template for sending a signal to resolve the Incident.
slack Property Map: Templates for Slack.
sms Property Map: Templates for SMS.
sourceLink String: Template for a source link.
telegram Property Map: Templates for Telegram.
web Property Map: Templates for Web.

OncallIntegrationTemplatesEmail

Message string
Title string

Message string
Title string

message String
title String

message string
title string

message str
title str

message String
title String

OncallIntegrationTemplatesMicrosoftTeams

ImageUrl string
Message string
Title string

ImageUrl string
Message string
Title string

imageUrl String
message String
title String

imageUrl string
message string
title string

image_url str
message str
title str

imageUrl String
message String
title String

OncallIntegrationTemplatesPhoneCall

Title string

Title string

title String

title string

title str

title String

OncallIntegrationTemplatesSlack

ImageUrl string
Message string
Title string

ImageUrl string
Message string
Title string

imageUrl String
message String
title String

imageUrl string
message string
title string

image_url str
message str
title str

imageUrl String
message String
title String

OncallIntegrationTemplatesSms

Title string

Title string

title String

title string

title str

title String

OncallIntegrationTemplatesTelegram

ImageUrl string
Message string
Title string

ImageUrl string
Message string
Title string

imageUrl String
message String
title String

imageUrl string
message string
title string

image_url str
message str
title str

imageUrl String
message String
title String

OncallIntegrationTemplatesWeb

ImageUrl string
Message string
Title string

ImageUrl string
Message string
Title string

imageUrl String
message String
title String

imageUrl string
message string
title string

image_url str
message str
title str

imageUrl String
message String
title String

Import

 $ pulumi import grafana:index/oncallIntegration:OncallIntegration integration_name {{integration_id}}

Package Details

Repository: grafana lbrlabs/pulumi-grafana
License: Apache-2.0
Notes: This Pulumi package is based on the grafana Terraform Provider.