1. Packages
  2. Ibm Provider
  3. API Docs
  4. getEnPreDefinedTemplate
ibm 1.83.0-beta0 published on Monday, Sep 15, 2025 by ibm-cloud

ibm.getEnPreDefinedTemplate

Explore with Pulumi AI

ibm logo
ibm 1.83.0-beta0 published on Monday, Sep 15, 2025 by ibm-cloud

    Provides a read-only data source to retrieve information about an en_pre_defined_template. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const enPreDefinedTemplate = ibm.getEnPreDefinedTemplate({
        instanceGuid: "instance_id",
        templateId: "en_pre_defined_template_id",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    en_pre_defined_template = ibm.get_en_pre_defined_template(instance_guid="instance_id",
        template_id="en_pre_defined_template_id")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.GetEnPreDefinedTemplate(ctx, &ibm.GetEnPreDefinedTemplateArgs{
    			InstanceGuid: "instance_id",
    			TemplateId:   "en_pre_defined_template_id",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var enPreDefinedTemplate = Ibm.GetEnPreDefinedTemplate.Invoke(new()
        {
            InstanceGuid = "instance_id",
            TemplateId = "en_pre_defined_template_id",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetEnPreDefinedTemplateArgs;
    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 enPreDefinedTemplate = IbmFunctions.getEnPreDefinedTemplate(GetEnPreDefinedTemplateArgs.builder()
                .instanceGuid("instance_id")
                .templateId("en_pre_defined_template_id")
                .build());
    
        }
    }
    
    variables:
      enPreDefinedTemplate:
        fn::invoke:
          function: ibm:getEnPreDefinedTemplate
          arguments:
            instanceGuid: instance_id
            templateId: en_pre_defined_template_id
    

    Using getEnPreDefinedTemplate

    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 getEnPreDefinedTemplate(args: GetEnPreDefinedTemplateArgs, opts?: InvokeOptions): Promise<GetEnPreDefinedTemplateResult>
    function getEnPreDefinedTemplateOutput(args: GetEnPreDefinedTemplateOutputArgs, opts?: InvokeOptions): Output<GetEnPreDefinedTemplateResult>
    def get_en_pre_defined_template(id: Optional[str] = None,
                                    instance_guid: Optional[str] = None,
                                    template_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetEnPreDefinedTemplateResult
    def get_en_pre_defined_template_output(id: Optional[pulumi.Input[str]] = None,
                                    instance_guid: Optional[pulumi.Input[str]] = None,
                                    template_id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetEnPreDefinedTemplateResult]
    func GetEnPreDefinedTemplate(ctx *Context, args *GetEnPreDefinedTemplateArgs, opts ...InvokeOption) (*GetEnPreDefinedTemplateResult, error)
    func GetEnPreDefinedTemplateOutput(ctx *Context, args *GetEnPreDefinedTemplateOutputArgs, opts ...InvokeOption) GetEnPreDefinedTemplateResultOutput

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

    public static class GetEnPreDefinedTemplate 
    {
        public static Task<GetEnPreDefinedTemplateResult> InvokeAsync(GetEnPreDefinedTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetEnPreDefinedTemplateResult> Invoke(GetEnPreDefinedTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEnPreDefinedTemplateResult> getEnPreDefinedTemplate(GetEnPreDefinedTemplateArgs args, InvokeOptions options)
    public static Output<GetEnPreDefinedTemplateResult> getEnPreDefinedTemplate(GetEnPreDefinedTemplateArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getEnPreDefinedTemplate:getEnPreDefinedTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    TemplateId string
    Unique identifier for Template.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    Id string
    The unique identifier of the en_pre_defined_template.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    TemplateId string
    Unique identifier for Template.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    Id string
    The unique identifier of the en_pre_defined_template.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    templateId String
    Unique identifier for Template.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    id String
    The unique identifier of the en_pre_defined_template.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    templateId string
    Unique identifier for Template.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    id string
    The unique identifier of the en_pre_defined_template.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    template_id str
    Unique identifier for Template.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    id str
    The unique identifier of the en_pre_defined_template.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    templateId String
    Unique identifier for Template.

    • Constraints: The maximum length is 32 characters. The minimum length is 32 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.
    id String
    The unique identifier of the en_pre_defined_template.

    getEnPreDefinedTemplate Result

    The following output properties are available:

    Description string
    (String) Template description.

    • Constraints: The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    Id string
    The unique identifier of the en_pre_defined_template.
    InstanceGuid string
    Name string
    (String) Template name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    Params string
    (String) base64 encoded template body
    Source string
    (String) The type of source.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    TemplateId string
    Type string
    (String) The type of template.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    UpdatedAt string
    (String) Updated at.
    Description string
    (String) Template description.

    • Constraints: The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    Id string
    The unique identifier of the en_pre_defined_template.
    InstanceGuid string
    Name string
    (String) Template name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    Params string
    (String) base64 encoded template body
    Source string
    (String) The type of source.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    TemplateId string
    Type string
    (String) The type of template.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    UpdatedAt string
    (String) Updated at.
    description String
    (String) Template description.

    • Constraints: The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    id String
    The unique identifier of the en_pre_defined_template.
    instanceGuid String
    name String
    (String) Template name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    params String
    (String) base64 encoded template body
    source String
    (String) The type of source.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    templateId String
    type String
    (String) The type of template.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    updatedAt String
    (String) Updated at.
    description string
    (String) Template description.

    • Constraints: The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    id string
    The unique identifier of the en_pre_defined_template.
    instanceGuid string
    name string
    (String) Template name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    params string
    (String) base64 encoded template body
    source string
    (String) The type of source.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    templateId string
    type string
    (String) The type of template.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    updatedAt string
    (String) Updated at.
    description str
    (String) Template description.

    • Constraints: The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    id str
    The unique identifier of the en_pre_defined_template.
    instance_guid str
    name str
    (String) Template name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    params str
    (String) base64 encoded template body
    source str
    (String) The type of source.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    template_id str
    type str
    (String) The type of template.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    updated_at str
    (String) Updated at.
    description String
    (String) Template description.

    • Constraints: The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    id String
    The unique identifier of the en_pre_defined_template.
    instanceGuid String
    name String
    (String) Template name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.
    params String
    (String) base64 encoded template body
    source String
    (String) The type of source.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    templateId String
    type String
    (String) The type of template.

    • Constraints: The minimum length is 1 character. The value must match regular expression /.*/.
    updatedAt String
    (String) Updated at.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.83.0-beta0 published on Monday, Sep 15, 2025 by ibm-cloud