1. Packages
  2. Grafana Cloud
  3. API Docs
  4. MessageTemplate
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse

grafana.MessageTemplate

Explore with Pulumi AI

grafana logo
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse

    Manages Grafana Alerting message templates.

    This resource requires Grafana 9.1.0 or later.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as grafana from "@pulumiverse/grafana";
    
    const myTemplate = new grafana.MessageTemplate("myTemplate", {template: `{{define "My Reusable Template" }}
     template content
    {{ end }}
    `});
    
    import pulumi
    import pulumiverse_grafana as grafana
    
    my_template = grafana.MessageTemplate("myTemplate", template="""{{define "My Reusable Template" }}
     template content
    {{ end }}
    """)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-grafana/sdk/go/grafana"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := grafana.NewMessageTemplate(ctx, "myTemplate", &grafana.MessageTemplateArgs{
    			Template: pulumi.String("{{define \"My Reusable Template\" }}\n template content\n{{ end }}\n"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Grafana = Pulumiverse.Grafana;
    
    return await Deployment.RunAsync(() => 
    {
        var myTemplate = new Grafana.MessageTemplate("myTemplate", new()
        {
            Template = @"{{define ""My Reusable Template"" }}
     template content
    {{ end }}
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.grafana.MessageTemplate;
    import com.pulumi.grafana.MessageTemplateArgs;
    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) {
            var myTemplate = new MessageTemplate("myTemplate", MessageTemplateArgs.builder()        
                .template("""
    {{define "My Reusable Template" }}
     template content
    {{ end }}
                """)
                .build());
    
        }
    }
    
    resources:
      myTemplate:
        type: grafana:MessageTemplate
        properties:
          template: |
            {{define "My Reusable Template" }}
             template content
            {{ end }}        
    

    Create MessageTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MessageTemplate(name: string, args: MessageTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def MessageTemplate(resource_name: str,
                        args: MessageTemplateArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def MessageTemplate(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        template: Optional[str] = None,
                        disable_provenance: Optional[bool] = None,
                        name: Optional[str] = None,
                        org_id: Optional[str] = None)
    func NewMessageTemplate(ctx *Context, name string, args MessageTemplateArgs, opts ...ResourceOption) (*MessageTemplate, error)
    public MessageTemplate(string name, MessageTemplateArgs args, CustomResourceOptions? opts = null)
    public MessageTemplate(String name, MessageTemplateArgs args)
    public MessageTemplate(String name, MessageTemplateArgs args, CustomResourceOptions options)
    
    type: grafana:MessageTemplate
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    var messageTemplateResource = new Grafana.MessageTemplate("messageTemplateResource", new()
    {
        Template = "string",
        DisableProvenance = false,
        Name = "string",
        OrgId = "string",
    });
    
    example, err := grafana.NewMessageTemplate(ctx, "messageTemplateResource", &grafana.MessageTemplateArgs{
    	Template:          pulumi.String("string"),
    	DisableProvenance: pulumi.Bool(false),
    	Name:              pulumi.String("string"),
    	OrgId:             pulumi.String("string"),
    })
    
    var messageTemplateResource = new MessageTemplate("messageTemplateResource", MessageTemplateArgs.builder()
        .template("string")
        .disableProvenance(false)
        .name("string")
        .orgId("string")
        .build());
    
    message_template_resource = grafana.MessageTemplate("messageTemplateResource",
        template="string",
        disable_provenance=False,
        name="string",
        org_id="string")
    
    const messageTemplateResource = new grafana.MessageTemplate("messageTemplateResource", {
        template: "string",
        disableProvenance: false,
        name: "string",
        orgId: "string",
    });
    
    type: grafana:MessageTemplate
    properties:
        disableProvenance: false
        name: string
        orgId: string
        template: string
    

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

    Template string
    The content of the message template.
    DisableProvenance bool
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    Name string
    The name of the message template.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Template string
    The content of the message template.
    DisableProvenance bool
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    Name string
    The name of the message template.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    template String
    The content of the message template.
    disableProvenance Boolean
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    name String
    The name of the message template.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    template string
    The content of the message template.
    disableProvenance boolean
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    name string
    The name of the message template.
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    template str
    The content of the message template.
    disable_provenance bool
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    name str
    The name of the message template.
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    template String
    The content of the message template.
    disableProvenance Boolean
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    name String
    The name of the message template.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.

    Outputs

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

    Get an existing MessageTemplate 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?: MessageTemplateState, opts?: CustomResourceOptions): MessageTemplate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            disable_provenance: Optional[bool] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            template: Optional[str] = None) -> MessageTemplate
    func GetMessageTemplate(ctx *Context, name string, id IDInput, state *MessageTemplateState, opts ...ResourceOption) (*MessageTemplate, error)
    public static MessageTemplate Get(string name, Input<string> id, MessageTemplateState? state, CustomResourceOptions? opts = null)
    public static MessageTemplate get(String name, Output<String> id, MessageTemplateState 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:
    DisableProvenance bool
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    Name string
    The name of the message template.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Template string
    The content of the message template.
    DisableProvenance bool
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    Name string
    The name of the message template.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Template string
    The content of the message template.
    disableProvenance Boolean
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    name String
    The name of the message template.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    template String
    The content of the message template.
    disableProvenance boolean
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    name string
    The name of the message template.
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    template string
    The content of the message template.
    disable_provenance bool
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    name str
    The name of the message template.
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    template str
    The content of the message template.
    disableProvenance Boolean
    Allow modifying the message template from other sources than Terraform or the Grafana API.
    name String
    The name of the message template.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    template String
    The content of the message template.

    Import

    $ pulumi import grafana:index/messageTemplate:MessageTemplate name "{{ name }}"
    
    $ pulumi import grafana:index/messageTemplate:MessageTemplate name "{{ orgID }}:{{ name }}"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse