1. Packages
  2. Rancher2
  3. API Docs
  4. getNotifier
Rancher 2 v6.1.1 published on Friday, May 10, 2024 by Pulumi

rancher2.getNotifier

Explore with Pulumi AI

rancher2 logo
Rancher 2 v6.1.1 published on Friday, May 10, 2024 by Pulumi

    Use this data source to retrieve information about a Rancher v2 notifier.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as rancher2 from "@pulumi/rancher2";
    
    const foo = rancher2.getNotifier({
        name: "foo",
        clusterId: "<cluster_id>",
    });
    
    import pulumi
    import pulumi_rancher2 as rancher2
    
    foo = rancher2.get_notifier(name="foo",
        cluster_id="<cluster_id>")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-rancher2/sdk/v6/go/rancher2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rancher2.LookupNotifier(ctx, &rancher2.LookupNotifierArgs{
    			Name:      "foo",
    			ClusterId: "<cluster_id>",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Rancher2 = Pulumi.Rancher2;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Rancher2.GetNotifier.Invoke(new()
        {
            Name = "foo",
            ClusterId = "<cluster_id>",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.rancher2.Rancher2Functions;
    import com.pulumi.rancher2.inputs.GetNotifierArgs;
    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 foo = Rancher2Functions.getNotifier(GetNotifierArgs.builder()
                .name("foo")
                .clusterId("<cluster_id>")
                .build());
    
        }
    }
    
    variables:
      foo:
        fn::invoke:
          Function: rancher2:getNotifier
          Arguments:
            name: foo
            clusterId: <cluster_id>
    

    Using getNotifier

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNotifier(args: GetNotifierArgs, opts?: InvokeOptions): Promise<GetNotifierResult>
    function getNotifierOutput(args: GetNotifierOutputArgs, opts?: InvokeOptions): Output<GetNotifierResult>
    def get_notifier(cluster_id: Optional[str] = None,
                     dingtalk_config: Optional[GetNotifierDingtalkConfig] = None,
                     msteams_config: Optional[GetNotifierMsteamsConfig] = None,
                     name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNotifierResult
    def get_notifier_output(cluster_id: Optional[pulumi.Input[str]] = None,
                     dingtalk_config: Optional[pulumi.Input[GetNotifierDingtalkConfigArgs]] = None,
                     msteams_config: Optional[pulumi.Input[GetNotifierMsteamsConfigArgs]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetNotifierResult]
    func LookupNotifier(ctx *Context, args *LookupNotifierArgs, opts ...InvokeOption) (*LookupNotifierResult, error)
    func LookupNotifierOutput(ctx *Context, args *LookupNotifierOutputArgs, opts ...InvokeOption) LookupNotifierResultOutput

    > Note: This function is named LookupNotifier in the Go SDK.

    public static class GetNotifier 
    {
        public static Task<GetNotifierResult> InvokeAsync(GetNotifierArgs args, InvokeOptions? opts = null)
        public static Output<GetNotifierResult> Invoke(GetNotifierInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNotifierResult> getNotifier(GetNotifierArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: rancher2:index/getNotifier:getNotifier
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterId string
    The cluster id where create notifier (string)
    Name string
    The name of the notifier (string)
    DingtalkConfig GetNotifierDingtalkConfig
    (Computed) Dingtalk config for notifier (list maxitems:1)
    MsteamsConfig GetNotifierMsteamsConfig
    (Computed) MSTeams config for notifier (list maxitems:1)
    ClusterId string
    The cluster id where create notifier (string)
    Name string
    The name of the notifier (string)
    DingtalkConfig GetNotifierDingtalkConfig
    (Computed) Dingtalk config for notifier (list maxitems:1)
    MsteamsConfig GetNotifierMsteamsConfig
    (Computed) MSTeams config for notifier (list maxitems:1)
    clusterId String
    The cluster id where create notifier (string)
    name String
    The name of the notifier (string)
    dingtalkConfig GetNotifierDingtalkConfig
    (Computed) Dingtalk config for notifier (list maxitems:1)
    msteamsConfig GetNotifierMsteamsConfig
    (Computed) MSTeams config for notifier (list maxitems:1)
    clusterId string
    The cluster id where create notifier (string)
    name string
    The name of the notifier (string)
    dingtalkConfig GetNotifierDingtalkConfig
    (Computed) Dingtalk config for notifier (list maxitems:1)
    msteamsConfig GetNotifierMsteamsConfig
    (Computed) MSTeams config for notifier (list maxitems:1)
    cluster_id str
    The cluster id where create notifier (string)
    name str
    The name of the notifier (string)
    dingtalk_config GetNotifierDingtalkConfig
    (Computed) Dingtalk config for notifier (list maxitems:1)
    msteams_config GetNotifierMsteamsConfig
    (Computed) MSTeams config for notifier (list maxitems:1)
    clusterId String
    The cluster id where create notifier (string)
    name String
    The name of the notifier (string)
    dingtalkConfig Property Map
    (Computed) Dingtalk config for notifier (list maxitems:1)
    msteamsConfig Property Map
    (Computed) MSTeams config for notifier (list maxitems:1)

    getNotifier Result

    The following output properties are available:

    Annotations Dictionary<string, object>
    (Computed) Annotations for notifier object (map)
    ClusterId string
    Description string
    (Computed) The notifier description (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels Dictionary<string, object>
    (Computed) Labels for notifier object (map)
    Name string
    PagerdutyConfig GetNotifierPagerdutyConfig
    (Computed) Pagerduty config for notifier (list maxitems:1)
    SlackConfig GetNotifierSlackConfig
    (Computed) Slack config for notifier (list maxitems:1)
    SmtpConfig GetNotifierSmtpConfig
    (Computed) SMTP config for notifier (list maxitems:1)
    WebhookConfig GetNotifierWebhookConfig
    (Computed) Webhook config for notifier (list maxitems:1)
    WechatConfig GetNotifierWechatConfig
    (Computed) Wechat config for notifier (list maxitems:1)
    DingtalkConfig GetNotifierDingtalkConfig
    (Computed) Dingtalk config for notifier (list maxitems:1)
    MsteamsConfig GetNotifierMsteamsConfig
    (Computed) MSTeams config for notifier (list maxitems:1)
    Annotations map[string]interface{}
    (Computed) Annotations for notifier object (map)
    ClusterId string
    Description string
    (Computed) The notifier description (string)
    Id string
    The provider-assigned unique ID for this managed resource.
    Labels map[string]interface{}
    (Computed) Labels for notifier object (map)
    Name string
    PagerdutyConfig GetNotifierPagerdutyConfig
    (Computed) Pagerduty config for notifier (list maxitems:1)
    SlackConfig GetNotifierSlackConfig
    (Computed) Slack config for notifier (list maxitems:1)
    SmtpConfig GetNotifierSmtpConfig
    (Computed) SMTP config for notifier (list maxitems:1)
    WebhookConfig GetNotifierWebhookConfig
    (Computed) Webhook config for notifier (list maxitems:1)
    WechatConfig GetNotifierWechatConfig
    (Computed) Wechat config for notifier (list maxitems:1)
    DingtalkConfig GetNotifierDingtalkConfig
    (Computed) Dingtalk config for notifier (list maxitems:1)
    MsteamsConfig GetNotifierMsteamsConfig
    (Computed) MSTeams config for notifier (list maxitems:1)
    annotations Map<String,Object>
    (Computed) Annotations for notifier object (map)
    clusterId String
    description String
    (Computed) The notifier description (string)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<String,Object>
    (Computed) Labels for notifier object (map)
    name String
    pagerdutyConfig GetNotifierPagerdutyConfig
    (Computed) Pagerduty config for notifier (list maxitems:1)
    slackConfig GetNotifierSlackConfig
    (Computed) Slack config for notifier (list maxitems:1)
    smtpConfig GetNotifierSmtpConfig
    (Computed) SMTP config for notifier (list maxitems:1)
    webhookConfig GetNotifierWebhookConfig
    (Computed) Webhook config for notifier (list maxitems:1)
    wechatConfig GetNotifierWechatConfig
    (Computed) Wechat config for notifier (list maxitems:1)
    dingtalkConfig GetNotifierDingtalkConfig
    (Computed) Dingtalk config for notifier (list maxitems:1)
    msteamsConfig GetNotifierMsteamsConfig
    (Computed) MSTeams config for notifier (list maxitems:1)
    annotations {[key: string]: any}
    (Computed) Annotations for notifier object (map)
    clusterId string
    description string
    (Computed) The notifier description (string)
    id string
    The provider-assigned unique ID for this managed resource.
    labels {[key: string]: any}
    (Computed) Labels for notifier object (map)
    name string
    pagerdutyConfig GetNotifierPagerdutyConfig
    (Computed) Pagerduty config for notifier (list maxitems:1)
    slackConfig GetNotifierSlackConfig
    (Computed) Slack config for notifier (list maxitems:1)
    smtpConfig GetNotifierSmtpConfig
    (Computed) SMTP config for notifier (list maxitems:1)
    webhookConfig GetNotifierWebhookConfig
    (Computed) Webhook config for notifier (list maxitems:1)
    wechatConfig GetNotifierWechatConfig
    (Computed) Wechat config for notifier (list maxitems:1)
    dingtalkConfig GetNotifierDingtalkConfig
    (Computed) Dingtalk config for notifier (list maxitems:1)
    msteamsConfig GetNotifierMsteamsConfig
    (Computed) MSTeams config for notifier (list maxitems:1)
    annotations Mapping[str, Any]
    (Computed) Annotations for notifier object (map)
    cluster_id str
    description str
    (Computed) The notifier description (string)
    id str
    The provider-assigned unique ID for this managed resource.
    labels Mapping[str, Any]
    (Computed) Labels for notifier object (map)
    name str
    pagerduty_config GetNotifierPagerdutyConfig
    (Computed) Pagerduty config for notifier (list maxitems:1)
    slack_config GetNotifierSlackConfig
    (Computed) Slack config for notifier (list maxitems:1)
    smtp_config GetNotifierSmtpConfig
    (Computed) SMTP config for notifier (list maxitems:1)
    webhook_config GetNotifierWebhookConfig
    (Computed) Webhook config for notifier (list maxitems:1)
    wechat_config GetNotifierWechatConfig
    (Computed) Wechat config for notifier (list maxitems:1)
    dingtalk_config GetNotifierDingtalkConfig
    (Computed) Dingtalk config for notifier (list maxitems:1)
    msteams_config GetNotifierMsteamsConfig
    (Computed) MSTeams config for notifier (list maxitems:1)
    annotations Map<Any>
    (Computed) Annotations for notifier object (map)
    clusterId String
    description String
    (Computed) The notifier description (string)
    id String
    The provider-assigned unique ID for this managed resource.
    labels Map<Any>
    (Computed) Labels for notifier object (map)
    name String
    pagerdutyConfig Property Map
    (Computed) Pagerduty config for notifier (list maxitems:1)
    slackConfig Property Map
    (Computed) Slack config for notifier (list maxitems:1)
    smtpConfig Property Map
    (Computed) SMTP config for notifier (list maxitems:1)
    webhookConfig Property Map
    (Computed) Webhook config for notifier (list maxitems:1)
    wechatConfig Property Map
    (Computed) Wechat config for notifier (list maxitems:1)
    dingtalkConfig Property Map
    (Computed) Dingtalk config for notifier (list maxitems:1)
    msteamsConfig Property Map
    (Computed) MSTeams config for notifier (list maxitems:1)

    Supporting Types

    GetNotifierDingtalkConfig

    Url string
    Webhook URL
    ProxyUrl string
    Dingtalk proxy URL
    Secret string
    Required for webhook with sign enabled
    Url string
    Webhook URL
    ProxyUrl string
    Dingtalk proxy URL
    Secret string
    Required for webhook with sign enabled
    url String
    Webhook URL
    proxyUrl String
    Dingtalk proxy URL
    secret String
    Required for webhook with sign enabled
    url string
    Webhook URL
    proxyUrl string
    Dingtalk proxy URL
    secret string
    Required for webhook with sign enabled
    url str
    Webhook URL
    proxy_url str
    Dingtalk proxy URL
    secret str
    Required for webhook with sign enabled
    url String
    Webhook URL
    proxyUrl String
    Dingtalk proxy URL
    secret String
    Required for webhook with sign enabled

    GetNotifierMsteamsConfig

    Url string
    Webhook URL
    ProxyUrl string
    MS teams proxy URL
    Url string
    Webhook URL
    ProxyUrl string
    MS teams proxy URL
    url String
    Webhook URL
    proxyUrl String
    MS teams proxy URL
    url string
    Webhook URL
    proxyUrl string
    MS teams proxy URL
    url str
    Webhook URL
    proxy_url str
    MS teams proxy URL
    url String
    Webhook URL
    proxyUrl String
    MS teams proxy URL

    GetNotifierPagerdutyConfig

    ServiceKey string
    Pagerduty service key
    ProxyUrl string
    Pagerduty proxy URL
    ServiceKey string
    Pagerduty service key
    ProxyUrl string
    Pagerduty proxy URL
    serviceKey String
    Pagerduty service key
    proxyUrl String
    Pagerduty proxy URL
    serviceKey string
    Pagerduty service key
    proxyUrl string
    Pagerduty proxy URL
    service_key str
    Pagerduty service key
    proxy_url str
    Pagerduty proxy URL
    serviceKey String
    Pagerduty service key
    proxyUrl String
    Pagerduty proxy URL

    GetNotifierSlackConfig

    DefaultRecipient string
    Slack default channel
    Url string
    Slack URL
    ProxyUrl string
    Slack proxy URL
    DefaultRecipient string
    Slack default channel
    Url string
    Slack URL
    ProxyUrl string
    Slack proxy URL
    defaultRecipient String
    Slack default channel
    url String
    Slack URL
    proxyUrl String
    Slack proxy URL
    defaultRecipient string
    Slack default channel
    url string
    Slack URL
    proxyUrl string
    Slack proxy URL
    default_recipient str
    Slack default channel
    url str
    Slack URL
    proxy_url str
    Slack proxy URL
    defaultRecipient String
    Slack default channel
    url String
    Slack URL
    proxyUrl String
    Slack proxy URL

    GetNotifierSmtpConfig

    DefaultRecipient string
    SMTP default recipient address
    Host string
    SMTP host
    Port int
    SMTP port
    Sender string
    SMTP sender
    Password string
    SMTP password
    Tls bool
    SMTP TLS
    Username string
    SMTP username
    DefaultRecipient string
    SMTP default recipient address
    Host string
    SMTP host
    Port int
    SMTP port
    Sender string
    SMTP sender
    Password string
    SMTP password
    Tls bool
    SMTP TLS
    Username string
    SMTP username
    defaultRecipient String
    SMTP default recipient address
    host String
    SMTP host
    port Integer
    SMTP port
    sender String
    SMTP sender
    password String
    SMTP password
    tls Boolean
    SMTP TLS
    username String
    SMTP username
    defaultRecipient string
    SMTP default recipient address
    host string
    SMTP host
    port number
    SMTP port
    sender string
    SMTP sender
    password string
    SMTP password
    tls boolean
    SMTP TLS
    username string
    SMTP username
    default_recipient str
    SMTP default recipient address
    host str
    SMTP host
    port int
    SMTP port
    sender str
    SMTP sender
    password str
    SMTP password
    tls bool
    SMTP TLS
    username str
    SMTP username
    defaultRecipient String
    SMTP default recipient address
    host String
    SMTP host
    port Number
    SMTP port
    sender String
    SMTP sender
    password String
    SMTP password
    tls Boolean
    SMTP TLS
    username String
    SMTP username

    GetNotifierWebhookConfig

    Url string
    Webhook URL
    ProxyUrl string
    Webhook proxy URL
    Url string
    Webhook URL
    ProxyUrl string
    Webhook proxy URL
    url String
    Webhook URL
    proxyUrl String
    Webhook proxy URL
    url string
    Webhook URL
    proxyUrl string
    Webhook proxy URL
    url str
    Webhook URL
    proxy_url str
    Webhook proxy URL
    url String
    Webhook URL
    proxyUrl String
    Webhook proxy URL

    GetNotifierWechatConfig

    Agent string
    Wechat application agent ID
    Corp string
    Wechat corporation ID
    DefaultRecipient string
    Wechat default channel
    Secret string
    Wechat application secret
    ProxyUrl string
    Wechat proxy URL
    RecipientType string
    Wechat recipient type
    Agent string
    Wechat application agent ID
    Corp string
    Wechat corporation ID
    DefaultRecipient string
    Wechat default channel
    Secret string
    Wechat application secret
    ProxyUrl string
    Wechat proxy URL
    RecipientType string
    Wechat recipient type
    agent String
    Wechat application agent ID
    corp String
    Wechat corporation ID
    defaultRecipient String
    Wechat default channel
    secret String
    Wechat application secret
    proxyUrl String
    Wechat proxy URL
    recipientType String
    Wechat recipient type
    agent string
    Wechat application agent ID
    corp string
    Wechat corporation ID
    defaultRecipient string
    Wechat default channel
    secret string
    Wechat application secret
    proxyUrl string
    Wechat proxy URL
    recipientType string
    Wechat recipient type
    agent str
    Wechat application agent ID
    corp str
    Wechat corporation ID
    default_recipient str
    Wechat default channel
    secret str
    Wechat application secret
    proxy_url str
    Wechat proxy URL
    recipient_type str
    Wechat recipient type
    agent String
    Wechat application agent ID
    corp String
    Wechat corporation ID
    defaultRecipient String
    Wechat default channel
    secret String
    Wechat application secret
    proxyUrl String
    Wechat proxy URL
    recipientType String
    Wechat recipient type

    Package Details

    Repository
    Rancher2 pulumi/pulumi-rancher2
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rancher2 Terraform Provider.
    rancher2 logo
    Rancher 2 v6.1.1 published on Friday, May 10, 2024 by Pulumi