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
Alert
Channel Email Args :
- Opsgenie
Alert
Channel Opsgenie Args - Pagerduty
Alert
Channel Pagerduty Args - Send
Degraded bool . Possible values:
true
|false
.- Send
Failure bool . Possible values:
true
|false
.- Send
Recovery bool . Possible values:
true
|false
.- Slack
Alert
Channel Slack Args - Sms
Alert
Channel Sms Args :
- Ssl
Expiry bool . Possible values:
true
|false
.- Ssl
Expiry intThreshold . Possible values between 1 and 30. Default is
30
.- Webhook
Alert
Channel Webhook Args
- Email
Alert
Channel Email Args :
- Opsgenie
Alert
Channel Opsgenie Args - Pagerduty
Alert
Channel Pagerduty Args - Send
Degraded bool . Possible values:
true
|false
.- Send
Failure bool . Possible values:
true
|false
.- Send
Recovery bool . Possible values:
true
|false
.- Slack
Alert
Channel Slack Args - Sms
Alert
Channel Sms Args :
- Ssl
Expiry bool . Possible values:
true
|false
.- Ssl
Expiry intThreshold . Possible values between 1 and 30. Default is
30
.- Webhook
Alert
Channel Webhook Args
- email
Alert
Channel Email Args :
- opsgenie
Alert
Channel Opsgenie Args - pagerduty
Alert
Channel Pagerduty Args - send
Degraded Boolean . Possible values:
true
|false
.- send
Failure Boolean . Possible values:
true
|false
.- send
Recovery Boolean . Possible values:
true
|false
.- slack
Alert
Channel Slack Args - sms
Alert
Channel Sms Args :
- ssl
Expiry Boolean . Possible values:
true
|false
.- ssl
Expiry IntegerThreshold . Possible values between 1 and 30. Default is
30
.- webhook
Alert
Channel Webhook Args
- email
Alert
Channel Email Args :
- opsgenie
Alert
Channel Opsgenie Args - pagerduty
Alert
Channel Pagerduty Args - send
Degraded boolean . Possible values:
true
|false
.- send
Failure boolean . Possible values:
true
|false
.- send
Recovery boolean . Possible values:
true
|false
.- slack
Alert
Channel Slack Args - sms
Alert
Channel Sms Args :
- ssl
Expiry boolean . Possible values:
true
|false
.- ssl
Expiry numberThreshold . Possible values between 1 and 30. Default is
30
.- webhook
Alert
Channel Webhook Args
- email
Alert
Channel Email Args :
- opsgenie
Alert
Channel Opsgenie Args - pagerduty
Alert
Channel Pagerduty Args - send_
degraded bool . Possible values:
true
|false
.- send_
failure bool . Possible values:
true
|false
.- send_
recovery bool . Possible values:
true
|false
.- slack
Alert
Channel Slack Args - sms
Alert
Channel Sms Args :
- ssl_
expiry bool . Possible values:
true
|false
.- ssl_
expiry_ intthreshold . Possible values between 1 and 30. Default is
30
.- webhook
Alert
Channel Webhook Args
- email Property Map
:
- opsgenie Property Map
- pagerduty Property Map
- send
Degraded Boolean . Possible values:
true
|false
.- send
Failure Boolean . Possible values:
true
|false
.- send
Recovery Boolean . Possible values:
true
|false
.- slack Property Map
- sms Property Map
:
- ssl
Expiry Boolean . Possible values:
true
|false
.- ssl
Expiry NumberThreshold . 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.
- Email
Alert
Channel Email Args :
- Opsgenie
Alert
Channel Opsgenie Args - Pagerduty
Alert
Channel Pagerduty Args - Send
Degraded bool . Possible values:
true
|false
.- Send
Failure bool . Possible values:
true
|false
.- Send
Recovery bool . Possible values:
true
|false
.- Slack
Alert
Channel Slack Args - Sms
Alert
Channel Sms Args :
- Ssl
Expiry bool . Possible values:
true
|false
.- Ssl
Expiry intThreshold . Possible values between 1 and 30. Default is
30
.- Webhook
Alert
Channel Webhook Args
- Email
Alert
Channel Email Args :
- Opsgenie
Alert
Channel Opsgenie Args - Pagerduty
Alert
Channel Pagerduty Args - Send
Degraded bool . Possible values:
true
|false
.- Send
Failure bool . Possible values:
true
|false
.- Send
Recovery bool . Possible values:
true
|false
.- Slack
Alert
Channel Slack Args - Sms
Alert
Channel Sms Args :
- Ssl
Expiry bool . Possible values:
true
|false
.- Ssl
Expiry intThreshold . Possible values between 1 and 30. Default is
30
.- Webhook
Alert
Channel Webhook Args
- email
Alert
Channel Email Args :
- opsgenie
Alert
Channel Opsgenie Args - pagerduty
Alert
Channel Pagerduty Args - send
Degraded Boolean . Possible values:
true
|false
.- send
Failure Boolean . Possible values:
true
|false
.- send
Recovery Boolean . Possible values:
true
|false
.- slack
Alert
Channel Slack Args - sms
Alert
Channel Sms Args :
- ssl
Expiry Boolean . Possible values:
true
|false
.- ssl
Expiry IntegerThreshold . Possible values between 1 and 30. Default is
30
.- webhook
Alert
Channel Webhook Args
- email
Alert
Channel Email Args :
- opsgenie
Alert
Channel Opsgenie Args - pagerduty
Alert
Channel Pagerduty Args - send
Degraded boolean . Possible values:
true
|false
.- send
Failure boolean . Possible values:
true
|false
.- send
Recovery boolean . Possible values:
true
|false
.- slack
Alert
Channel Slack Args - sms
Alert
Channel Sms Args :
- ssl
Expiry boolean . Possible values:
true
|false
.- ssl
Expiry numberThreshold . Possible values between 1 and 30. Default is
30
.- webhook
Alert
Channel Webhook Args
- email
Alert
Channel Email Args :
- opsgenie
Alert
Channel Opsgenie Args - pagerduty
Alert
Channel Pagerduty Args - send_
degraded bool . Possible values:
true
|false
.- send_
failure bool . Possible values:
true
|false
.- send_
recovery bool . Possible values:
true
|false
.- slack
Alert
Channel Slack Args - sms
Alert
Channel Sms Args :
- ssl_
expiry bool . Possible values:
true
|false
.- ssl_
expiry_ intthreshold . Possible values between 1 and 30. Default is
30
.- webhook
Alert
Channel Webhook Args
- email Property Map
:
- opsgenie Property Map
- pagerduty Property Map
- send
Degraded Boolean . Possible values:
true
|false
.- send
Failure Boolean . Possible values:
true
|false
.- send
Recovery Boolean . Possible values:
true
|false
.- slack Property Map
- sms Property Map
:
- ssl
Expiry Boolean . Possible values:
true
|false
.- ssl
Expiry NumberThreshold . 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
AlertChannelPagerduty
- Service
Key string Pagerduty's service integration key.
- Account string
Pagerduty's account name.
- Service
Name string Pagerduty's service name.
- Service
Key string Pagerduty's service integration key.
- Account string
Pagerduty's account name.
- Service
Name string Pagerduty's service name.
- service
Key String Pagerduty's service integration key.
- account String
Pagerduty's account name.
- service
Name String Pagerduty's service name.
- service
Key string Pagerduty's service integration key.
- account string
Pagerduty's account name.
- service
Name 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.
- service
Key String Pagerduty's service integration key.
- account String
Pagerduty's account name.
- service
Name String Pagerduty's service name.
AlertChannelSlack
AlertChannelSms
AlertChannelWebhook
- Name string
Webhook's channel name.
- Url string
.
- Headers Dictionary<string, object>
.
- Method string
Default is
POST
.- Query
Parameters Dictionary<string, object> .
- Template string
.
- Webhook
Secret string .
- Name string
Webhook's channel name.
- Url string
.
- Headers map[string]interface{}
.
- Method string
Default is
POST
.- Query
Parameters map[string]interface{} .
- Template string
.
- Webhook
Secret string .
- name String
Webhook's channel name.
- url String
.
- headers
Map
.
- method String
Default is
POST
.- query
Parameters Map .
- template String
.
- webhook
Secret String .
- name string
Webhook's channel name.
- url string
.
- headers {[key: string]: any}
.
- method string
Default is
POST
.- query
Parameters {[key: string]: any} .
- template string
.
- webhook
Secret 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
.- query
Parameters Map .
- template String
.
- webhook
Secret String .
Package Details
- Repository
- https://github.com/checkly/pulumi-checkly
- License
- MIT
- Notes
This Pulumi package is based on the
checkly
Terraform Provider.