Notifier

Create a Notifier Resource

new Notifier(name: string, args: NotifierArgs, opts?: CustomResourceOptions);

def Notifier(resource_name, opts=None, annotations=None, cluster_id=None, description=None, labels=None, name=None, pagerduty_config=None, send_resolved=None, slack_config=None, smtp_config=None, webhook_config=None, wechat_config=None, __props__=None);

func NewNotifier(ctx *Context, name string, args NotifierArgs, opts ...ResourceOption) (*Notifier, error)

public Notifier(string name, NotifierArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NotifierArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

Notifier Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Notifier resource accepts the following input properties:

ClusterId string: The cluster id where create notifier (string)
Annotations Dictionary<string, object>: Annotations for notifier object (map)
Description string: The notifier description (string)
Labels Dictionary<string, object>: Labels for notifier object (map)
Name string: The name of the notifier (string)
PagerdutyConfig NotifierPagerdutyConfigArgs: Pagerduty config for notifier (list maxitems:1)
SendResolved bool: = (Optional) Enable the notifier to send resolved notifications. Default false (bool)
SlackConfig NotifierSlackConfigArgs: Slack config for notifier (list maxitems:1)
SmtpConfig NotifierSmtpConfigArgs: SMTP config for notifier (list maxitems:1)
WebhookConfig NotifierWebhookConfigArgs: Webhook config for notifier (list maxitems:1)
WechatConfig NotifierWechatConfigArgs: Wechat config for notifier (list maxitems:1)

ClusterId string: The cluster id where create notifier (string)
Annotations map[string]interface{}: Annotations for notifier object (map)
Description string: The notifier description (string)
Labels map[string]interface{}: Labels for notifier object (map)
Name string: The name of the notifier (string)
PagerdutyConfig NotifierPagerdutyConfig: Pagerduty config for notifier (list maxitems:1)
SendResolved bool: = (Optional) Enable the notifier to send resolved notifications. Default false (bool)
SlackConfig NotifierSlackConfig: Slack config for notifier (list maxitems:1)
SmtpConfig NotifierSmtpConfig: SMTP config for notifier (list maxitems:1)
WebhookConfig NotifierWebhookConfig: Webhook config for notifier (list maxitems:1)
WechatConfig NotifierWechatConfig: Wechat config for notifier (list maxitems:1)

clusterId string: The cluster id where create notifier (string)
annotations {[key: string]: any}: Annotations for notifier object (map)
description string: The notifier description (string)
labels {[key: string]: any}: Labels for notifier object (map)
name string: The name of the notifier (string)
pagerdutyConfig NotifierPagerdutyConfig: Pagerduty config for notifier (list maxitems:1)
sendResolved boolean: = (Optional) Enable the notifier to send resolved notifications. Default false (bool)
slackConfig NotifierSlackConfig: Slack config for notifier (list maxitems:1)
smtpConfig NotifierSmtpConfig: SMTP config for notifier (list maxitems:1)
webhookConfig NotifierWebhookConfig: Webhook config for notifier (list maxitems:1)
wechatConfig NotifierWechatConfig: Wechat config for notifier (list maxitems:1)

cluster_id str: The cluster id where create notifier (string)
annotations Dict[str, Any]: Annotations for notifier object (map)
description str: The notifier description (string)
labels Dict[str, Any]: Labels for notifier object (map)
name str: The name of the notifier (string)
pagerduty_config Dict[NotifierPagerdutyConfig]: Pagerduty config for notifier (list maxitems:1)
send_resolved bool: = (Optional) Enable the notifier to send resolved notifications. Default false (bool)
slack_config Dict[NotifierSlackConfig]: Slack config for notifier (list maxitems:1)
smtp_config Dict[NotifierSmtpConfig]: SMTP config for notifier (list maxitems:1)
webhook_config Dict[NotifierWebhookConfig]: Webhook config for notifier (list maxitems:1)
wechat_config Dict[NotifierWechatConfig]: Wechat config for notifier (list maxitems:1)

Outputs

All input properties are implicitly available as output properties. Additionally, the Notifier 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing Notifier Resource

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

static get(resource_name, id, opts=None, annotations=None, cluster_id=None, description=None, labels=None, name=None, pagerduty_config=None, send_resolved=None, slack_config=None, smtp_config=None, webhook_config=None, wechat_config=None, __props__=None);

func GetNotifier(ctx *Context, name string, id IDInput, state *NotifierState, opts ...ResourceOption) (*Notifier, error)

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

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.

The following state arguments are supported:

Annotations Dictionary<string, object>: Annotations for notifier object (map)
ClusterId string: The cluster id where create notifier (string)
Description string: The notifier description (string)
Labels Dictionary<string, object>: Labels for notifier object (map)
Name string: The name of the notifier (string)
PagerdutyConfig NotifierPagerdutyConfigArgs: Pagerduty config for notifier (list maxitems:1)
SendResolved bool: = (Optional) Enable the notifier to send resolved notifications. Default false (bool)
SlackConfig NotifierSlackConfigArgs: Slack config for notifier (list maxitems:1)
SmtpConfig NotifierSmtpConfigArgs: SMTP config for notifier (list maxitems:1)
WebhookConfig NotifierWebhookConfigArgs: Webhook config for notifier (list maxitems:1)
WechatConfig NotifierWechatConfigArgs: Wechat config for notifier (list maxitems:1)

Annotations map[string]interface{}: Annotations for notifier object (map)
ClusterId string: The cluster id where create notifier (string)
Description string: The notifier description (string)
Labels map[string]interface{}: Labels for notifier object (map)
Name string: The name of the notifier (string)
PagerdutyConfig NotifierPagerdutyConfig: Pagerduty config for notifier (list maxitems:1)
SendResolved bool: = (Optional) Enable the notifier to send resolved notifications. Default false (bool)
SlackConfig NotifierSlackConfig: Slack config for notifier (list maxitems:1)
SmtpConfig NotifierSmtpConfig: SMTP config for notifier (list maxitems:1)
WebhookConfig NotifierWebhookConfig: Webhook config for notifier (list maxitems:1)
WechatConfig NotifierWechatConfig: Wechat config for notifier (list maxitems:1)

annotations {[key: string]: any}: Annotations for notifier object (map)
clusterId string: The cluster id where create notifier (string)
description string: The notifier description (string)
labels {[key: string]: any}: Labels for notifier object (map)
name string: The name of the notifier (string)
pagerdutyConfig NotifierPagerdutyConfig: Pagerduty config for notifier (list maxitems:1)
sendResolved boolean: = (Optional) Enable the notifier to send resolved notifications. Default false (bool)
slackConfig NotifierSlackConfig: Slack config for notifier (list maxitems:1)
smtpConfig NotifierSmtpConfig: SMTP config for notifier (list maxitems:1)
webhookConfig NotifierWebhookConfig: Webhook config for notifier (list maxitems:1)
wechatConfig NotifierWechatConfig: Wechat config for notifier (list maxitems:1)

annotations Dict[str, Any]: Annotations for notifier object (map)
cluster_id str: The cluster id where create notifier (string)
description str: The notifier description (string)
labels Dict[str, Any]: Labels for notifier object (map)
name str: The name of the notifier (string)
pagerduty_config Dict[NotifierPagerdutyConfig]: Pagerduty config for notifier (list maxitems:1)
send_resolved bool: = (Optional) Enable the notifier to send resolved notifications. Default false (bool)
slack_config Dict[NotifierSlackConfig]: Slack config for notifier (list maxitems:1)
smtp_config Dict[NotifierSmtpConfig]: SMTP config for notifier (list maxitems:1)
webhook_config Dict[NotifierWebhookConfig]: Webhook config for notifier (list maxitems:1)
wechat_config Dict[NotifierWechatConfig]: Wechat config for notifier (list maxitems:1)

Supporting Types

NotifierPagerdutyConfig

See the input and output API doc for this type.

ServiceKey string: Pagerduty service key (string)
ProxyUrl string: Wechat proxy url (string)

ServiceKey string: Pagerduty service key (string)
ProxyUrl string: Wechat proxy url (string)

serviceKey string: Pagerduty service key (string)
proxyUrl string: Wechat proxy url (string)

serviceKey str: Pagerduty service key (string)
proxyUrl str: Wechat proxy url (string)

NotifierSlackConfig

See the input and output API doc for this type.

DefaultRecipient string: Wechat default recipient (string)
Url string: Webhook url (string)
ProxyUrl string: Wechat proxy url (string)

DefaultRecipient string: Wechat default recipient (string)
Url string: Webhook url (string)
ProxyUrl string: Wechat proxy url (string)

defaultRecipient string: Wechat default recipient (string)
url string: Webhook url (string)
proxyUrl string: Wechat proxy url (string)

defaultRecipient str: Wechat default recipient (string)
url str: Webhook url (string)
proxyUrl str: Wechat proxy url (string)

NotifierSmtpConfig

See the input and output API doc for this type.

DefaultRecipient string: Wechat default recipient (string)
Host string: SMTP host (string)
Port int: SMTP port (int)
Sender string: SMTP sender (string)
Password string: SMTP password (string)
Tls bool: SMTP tls. Default true (bool)
Username string: SMTP username (string)

DefaultRecipient string: Wechat default recipient (string)
Host string: SMTP host (string)
Port int: SMTP port (int)
Sender string: SMTP sender (string)
Password string: SMTP password (string)
Tls bool: SMTP tls. Default true (bool)
Username string: SMTP username (string)

defaultRecipient string: Wechat default recipient (string)
host string: SMTP host (string)
port number: SMTP port (int)
sender string: SMTP sender (string)
password string: SMTP password (string)
tls boolean: SMTP tls. Default true (bool)
username string: SMTP username (string)

defaultRecipient str: Wechat default recipient (string)
host str: SMTP host (string)
port float: SMTP port (int)
sender str: SMTP sender (string)
password str: SMTP password (string)
tls bool: SMTP tls. Default true (bool)
username str: SMTP username (string)

NotifierWebhookConfig

See the input and output API doc for this type.

Url string: Webhook url (string)
ProxyUrl string: Wechat proxy url (string)

Url string: Webhook url (string)
ProxyUrl string: Wechat proxy url (string)

url string: Webhook url (string)
proxyUrl string: Wechat proxy url (string)

url str: Webhook url (string)
proxyUrl str: Wechat proxy url (string)

NotifierWechatConfig

See the input and output API doc for this type.

Agent string: Wechat agent ID (string)
Corp string: Wechat corporation ID (string)
DefaultRecipient string: Wechat default recipient (string)
Secret string: Wechat agent ID (string)
ProxyUrl string: Wechat proxy url (string)
RecipientType string: Wechat recipient type. Allowed values: party | tag | user (string)

Agent string: Wechat agent ID (string)
Corp string: Wechat corporation ID (string)
DefaultRecipient string: Wechat default recipient (string)
Secret string: Wechat agent ID (string)
ProxyUrl string: Wechat proxy url (string)
RecipientType string: Wechat recipient type. Allowed values: party | tag | user (string)

agent string: Wechat agent ID (string)
corp string: Wechat corporation ID (string)
defaultRecipient string: Wechat default recipient (string)
secret string: Wechat agent ID (string)
proxyUrl string: Wechat proxy url (string)
recipientType string: Wechat recipient type. Allowed values: party | tag | user (string)

agent str: Wechat agent ID (string)
corp str: Wechat corporation ID (string)
defaultRecipient str: Wechat default recipient (string)
secret str: Wechat agent ID (string)
proxyUrl str: Wechat proxy url (string)
recipientType str: Wechat recipient type. Allowed values: party | tag | user (string)

Package Details

Repository: https://github.com/pulumi/pulumi-rancher2
License: Apache-2.0
Notes: This Pulumi package is based on the rancher2 Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Notifier

Create a Notifier Resource

Notifier Resource Properties

Inputs

Outputs

Look up an Existing Notifier Resource

Supporting Types

NotifierPagerdutyConfig

NotifierSlackConfig

NotifierSmtpConfig

NotifierWebhookConfig

NotifierWechatConfig

Package Details

On This Page