Checkly

Community
Package contributed by a community member
v0.0.1-alpha.4 published on Wednesday, Mar 16, 2022 by checkly

AlertChannel

# checkly.AlertChannel

The checkly.AlertChannel resource allows users to manage Checkly alert channels.

Checkly’s Alert Channels feature allows you to define global alerting channels for the checks in your account:

Example Usage

using Pulumi;
using Checkly = Pulumi.Checkly;

class MyStack : Stack
{
    public MyStack()
    {
        var emailAc = new Checkly.AlertChannel("emailAc", new Checkly.AlertChannelArgs
        {
            Email = new Checkly.Inputs.AlertChannelEmailArgs
            {
                Address = "john@example.com",
            },
            SendDegraded = true,
            SendFailure = false,
            SendRecovery = true,
            SslExpiry = true,
            SslExpiryThreshold = 22,
        });
    }

}
package main

import (
	"github.com/checkly/pulumi-checkly/sdk/go/checkly"
	"github.com/pulumi/pulumi-checkly/sdk/go/checkly"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkly.NewAlertChannel(ctx, "emailAc", &checkly.AlertChannelArgs{
			Email: &AlertChannelEmailArgs{
				Address: pulumi.String("john@example.com"),
			},
			SendDegraded:       pulumi.Bool(true),
			SendFailure:        pulumi.Bool(false),
			SendRecovery:       pulumi.Bool(true),
			SslExpiry:          pulumi.Bool(true),
			SslExpiryThreshold: pulumi.Int(22),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_checkly as checkly

email_ac = checkly.AlertChannel("emailAc",
    email=checkly.AlertChannelEmailArgs(
        address="john@example.com",
    ),
    send_degraded=True,
    send_failure=False,
    send_recovery=True,
    ssl_expiry=True,
    ssl_expiry_threshold=22)
import * as pulumi from "@pulumi/pulumi";
import * as checkly from "@pulumi/checkly";

const emailAc = new checkly.AlertChannel("email_ac", {
    email: {
        address: "john@example.com",
    },
    sendDegraded: true,
    sendFailure: false,
    sendRecovery: true,
    sslExpiry: true,
    sslExpiryThreshold: 22,
});

Coming soon!

Create a AlertChannel Resource

new AlertChannel(name: string, args?: AlertChannelArgs, opts?: CustomResourceOptions);
@overload
def AlertChannel(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 email: Optional[AlertChannelEmailArgs] = None,
                 opsgenie: Optional[AlertChannelOpsgenieArgs] = None,
                 pagerduty: Optional[AlertChannelPagerdutyArgs] = None,
                 send_degraded: Optional[bool] = None,
                 send_failure: Optional[bool] = None,
                 send_recovery: Optional[bool] = None,
                 slack: Optional[AlertChannelSlackArgs] = None,
                 sms: Optional[AlertChannelSmsArgs] = None,
                 ssl_expiry: Optional[bool] = None,
                 ssl_expiry_threshold: Optional[int] = None,
                 webhook: Optional[AlertChannelWebhookArgs] = None)
@overload
def AlertChannel(resource_name: str,
                 args: Optional[AlertChannelArgs] = None,
                 opts: Optional[ResourceOptions] = None)
func NewAlertChannel(ctx *Context, name string, args *AlertChannelArgs, opts ...ResourceOption) (*AlertChannel, error)
public AlertChannel(string name, AlertChannelArgs? args = null, CustomResourceOptions? opts = null)
public AlertChannel(String name, AlertChannelArgs args)
public AlertChannel(String name, AlertChannelArgs args, CustomResourceOptions options)
type: checkly:AlertChannel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

Email AlertChannelEmailArgs

:

Opsgenie AlertChannelOpsgenieArgs
Pagerduty AlertChannelPagerdutyArgs
SendDegraded bool

. Possible values: true | false.

SendFailure bool

. Possible values: true | false.

SendRecovery bool

. Possible values: true | false.

Slack AlertChannelSlackArgs
Sms AlertChannelSmsArgs

:

SslExpiry bool

. Possible values: true | false.

SslExpiryThreshold int

. Possible values between 1 and 30. Default is 30.

Webhook AlertChannelWebhookArgs
Email AlertChannelEmailArgs

:

Opsgenie AlertChannelOpsgenieArgs
Pagerduty AlertChannelPagerdutyArgs
SendDegraded bool

. Possible values: true | false.

SendFailure bool

. Possible values: true | false.

SendRecovery bool

. Possible values: true | false.

Slack AlertChannelSlackArgs
Sms AlertChannelSmsArgs

:

SslExpiry bool

. Possible values: true | false.

SslExpiryThreshold int

. Possible values between 1 and 30. Default is 30.

Webhook AlertChannelWebhookArgs
email AlertChannelEmailArgs

:

opsgenie AlertChannelOpsgenieArgs
pagerduty AlertChannelPagerdutyArgs
sendDegraded Boolean

. Possible values: true | false.

sendFailure Boolean

. Possible values: true | false.

sendRecovery Boolean

. Possible values: true | false.

slack AlertChannelSlackArgs
sms AlertChannelSmsArgs

:

sslExpiry Boolean

. Possible values: true | false.

sslExpiryThreshold Integer

. Possible values between 1 and 30. Default is 30.

webhook AlertChannelWebhookArgs
email AlertChannelEmailArgs

:

opsgenie AlertChannelOpsgenieArgs
pagerduty AlertChannelPagerdutyArgs
sendDegraded boolean

. Possible values: true | false.

sendFailure boolean

. Possible values: true | false.

sendRecovery boolean

. Possible values: true | false.

slack AlertChannelSlackArgs
sms AlertChannelSmsArgs

:

sslExpiry boolean

. Possible values: true | false.

sslExpiryThreshold number

. Possible values between 1 and 30. Default is 30.

webhook AlertChannelWebhookArgs
email AlertChannelEmailArgs

:

opsgenie AlertChannelOpsgenieArgs
pagerduty AlertChannelPagerdutyArgs
send_degraded bool

. Possible values: true | false.

send_failure bool

. Possible values: true | false.

send_recovery bool

. Possible values: true | false.

slack AlertChannelSlackArgs
sms AlertChannelSmsArgs

:

ssl_expiry bool

. Possible values: true | false.

ssl_expiry_threshold int

. Possible values between 1 and 30. Default is 30.

webhook AlertChannelWebhookArgs
email Property Map

:

opsgenie Property Map
pagerduty Property Map
sendDegraded Boolean

. Possible values: true | false.

sendFailure Boolean

. Possible values: true | false.

sendRecovery Boolean

. Possible values: true | false.

slack Property Map
sms Property Map

:

sslExpiry Boolean

. Possible values: true | false.

sslExpiryThreshold Number

. Possible values between 1 and 30. Default is 30.

webhook Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the AlertChannel 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 an Existing AlertChannel Resource

Get an existing AlertChannel 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?: AlertChannelState, opts?: CustomResourceOptions): AlertChannel
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        email: Optional[AlertChannelEmailArgs] = None,
        opsgenie: Optional[AlertChannelOpsgenieArgs] = None,
        pagerduty: Optional[AlertChannelPagerdutyArgs] = None,
        send_degraded: Optional[bool] = None,
        send_failure: Optional[bool] = None,
        send_recovery: Optional[bool] = None,
        slack: Optional[AlertChannelSlackArgs] = None,
        sms: Optional[AlertChannelSmsArgs] = None,
        ssl_expiry: Optional[bool] = None,
        ssl_expiry_threshold: Optional[int] = None,
        webhook: Optional[AlertChannelWebhookArgs] = None) -> AlertChannel
func GetAlertChannel(ctx *Context, name string, id IDInput, state *AlertChannelState, opts ...ResourceOption) (*AlertChannel, error)
public static AlertChannel Get(string name, Input<string> id, AlertChannelState? state, CustomResourceOptions? opts = null)
public static AlertChannel get(String name, Output<String> id, AlertChannelState 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:
Email AlertChannelEmailArgs

:

Opsgenie AlertChannelOpsgenieArgs
Pagerduty AlertChannelPagerdutyArgs
SendDegraded bool

. Possible values: true | false.

SendFailure bool

. Possible values: true | false.

SendRecovery bool

. Possible values: true | false.

Slack AlertChannelSlackArgs
Sms AlertChannelSmsArgs

:

SslExpiry bool

. Possible values: true | false.

SslExpiryThreshold int

. Possible values between 1 and 30. Default is 30.

Webhook AlertChannelWebhookArgs
Email AlertChannelEmailArgs

:

Opsgenie AlertChannelOpsgenieArgs
Pagerduty AlertChannelPagerdutyArgs
SendDegraded bool

. Possible values: true | false.

SendFailure bool

. Possible values: true | false.

SendRecovery bool

. Possible values: true | false.

Slack AlertChannelSlackArgs
Sms AlertChannelSmsArgs

:

SslExpiry bool

. Possible values: true | false.

SslExpiryThreshold int

. Possible values between 1 and 30. Default is 30.

Webhook AlertChannelWebhookArgs
email AlertChannelEmailArgs

:

opsgenie AlertChannelOpsgenieArgs
pagerduty AlertChannelPagerdutyArgs
sendDegraded Boolean

. Possible values: true | false.

sendFailure Boolean

. Possible values: true | false.

sendRecovery Boolean

. Possible values: true | false.

slack AlertChannelSlackArgs
sms AlertChannelSmsArgs

:

sslExpiry Boolean

. Possible values: true | false.

sslExpiryThreshold Integer

. Possible values between 1 and 30. Default is 30.

webhook AlertChannelWebhookArgs
email AlertChannelEmailArgs

:

opsgenie AlertChannelOpsgenieArgs
pagerduty AlertChannelPagerdutyArgs
sendDegraded boolean

. Possible values: true | false.

sendFailure boolean

. Possible values: true | false.

sendRecovery boolean

. Possible values: true | false.

slack AlertChannelSlackArgs
sms AlertChannelSmsArgs

:

sslExpiry boolean

. Possible values: true | false.

sslExpiryThreshold number

. Possible values between 1 and 30. Default is 30.

webhook AlertChannelWebhookArgs
email AlertChannelEmailArgs

:

opsgenie AlertChannelOpsgenieArgs
pagerduty AlertChannelPagerdutyArgs
send_degraded bool

. Possible values: true | false.

send_failure bool

. Possible values: true | false.

send_recovery bool

. Possible values: true | false.

slack AlertChannelSlackArgs
sms AlertChannelSmsArgs

:

ssl_expiry bool

. Possible values: true | false.

ssl_expiry_threshold int

. Possible values between 1 and 30. Default is 30.

webhook AlertChannelWebhookArgs
email Property Map

:

opsgenie Property Map
pagerduty Property Map
sendDegraded Boolean

. Possible values: true | false.

sendFailure Boolean

. Possible values: true | false.

sendRecovery Boolean

. Possible values: true | false.

slack Property Map
sms Property Map

:

sslExpiry Boolean

. Possible values: true | false.

sslExpiryThreshold Number

. Possible values between 1 and 30. Default is 30.

webhook Property Map

Supporting Types

AlertChannelEmail

Address string

the email address of this email alert channel.

Address string

the email address of this email alert channel.

address String

the email address of this email alert channel.

address string

the email address of this email alert channel.

address str

the email address of this email alert channel.

address String

the email address of this email alert channel.

AlertChannelOpsgenie

ApiKey string

.

Name string

Webhook's channel name.

Priority string

.

Region string

.

ApiKey string

.

Name string

Webhook's channel name.

Priority string

.

Region string

.

apiKey String

.

name String

Webhook's channel name.

priority String

.

region String

.

apiKey string

.

name string

Webhook's channel name.

priority string

.

region string

.

api_key str

.

name str

Webhook's channel name.

priority str

.

region str

.

apiKey String

.

name String

Webhook's channel name.

priority String

.

region String

.

AlertChannelPagerduty

ServiceKey string

Pagerduty's service integration key.

Account string

Pagerduty's account name.

ServiceName string

Pagerduty's service name.

ServiceKey string

Pagerduty's service integration key.

Account string

Pagerduty's account name.

ServiceName string

Pagerduty's service name.

serviceKey String

Pagerduty's service integration key.

account String

Pagerduty's account name.

serviceName String

Pagerduty's service name.

serviceKey string

Pagerduty's service integration key.

account string

Pagerduty's account name.

serviceName string

Pagerduty's service name.

service_key str

Pagerduty's service integration key.

account str

Pagerduty's account name.

service_name str

Pagerduty's service name.

serviceKey String

Pagerduty's service integration key.

account String

Pagerduty's account name.

serviceName String

Pagerduty's service name.

AlertChannelSlack

Channel string

Slack's channel name.

Url string

.

Channel string

Slack's channel name.

Url string

.

channel String

Slack's channel name.

url String

.

channel string

Slack's channel name.

url string

.

channel str

Slack's channel name.

url str

.

channel String

Slack's channel name.

url String

.

AlertChannelSms

Name string

Webhook's channel name.

Number string

Mobile number to receive alerts.

Name string

Webhook's channel name.

Number string

Mobile number to receive alerts.

name String

Webhook's channel name.

number String

Mobile number to receive alerts.

name string

Webhook's channel name.

number string

Mobile number to receive alerts.

name str

Webhook's channel name.

number str

Mobile number to receive alerts.

name String

Webhook's channel name.

number String

Mobile number to receive alerts.

AlertChannelWebhook

Name string

Webhook's channel name.

Url string

.

Headers Dictionary<string, object>

.

Method string

Default is POST.

QueryParameters Dictionary<string, object>

.

Template string

.

WebhookSecret string

.

Name string

Webhook's channel name.

Url string

.

Headers map[string]interface{}

.

Method string

Default is POST.

QueryParameters map[string]interface{}

.

Template string

.

WebhookSecret string

.

name String

Webhook's channel name.

url String

.

headers Map

.

method String

Default is POST.

queryParameters Map

.

template String

.

webhookSecret String

.

name string

Webhook's channel name.

url string

.

headers {[key: string]: any}

.

method string

Default is POST.

queryParameters {[key: string]: any}

.

template string

.

webhookSecret string

.

name str

Webhook's channel name.

url str

.

headers Mapping[str, Any]

.

method str

Default is POST.

query_parameters Mapping[str, Any]

.

template str

.

webhook_secret str

.

name String

Webhook's channel name.

url String

.

headers Map

.

method String

Default is POST.

queryParameters Map

.

template String

.

webhookSecret String

.

Package Details

Repository
https://github.com/checkly/pulumi-checkly
License
MIT
Notes

This Pulumi package is based on the checkly Terraform Provider.