Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. EnEventStreamsTemplate
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.EnEventStreamsTemplate

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create, update, or delete Event Streans Template by using IBM Cloud™ Event Notifications.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const esTemplate = new ibm.EnEventStreamsTemplate("esTemplate", {
    instanceGuid: ibm_resource_instance.en_terraform_test_resource.guid,
    type: "event_streams.notification",
    description: "Event Streams Template for Notifications",
    params: {
        body: "eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ==",
    },
});
Copy
import pulumi
import pulumi_ibm as ibm

es_template = ibm.EnEventStreamsTemplate("esTemplate",
    instance_guid=ibm_resource_instance["en_terraform_test_resource"]["guid"],
    type="event_streams.notification",
    description="Event Streams Template for Notifications",
    params={
        "body": "eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ==",
    })
Copy
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.NewEnEventStreamsTemplate(ctx, "esTemplate", &ibm.EnEventStreamsTemplateArgs{
			InstanceGuid: pulumi.Any(ibm_resource_instance.En_terraform_test_resource.Guid),
			Type:         pulumi.String("event_streams.notification"),
			Description:  pulumi.String("Event Streams Template for Notifications"),
			Params: &ibm.EnEventStreamsTemplateParamsArgs{
				Body: pulumi.String("eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ=="),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var esTemplate = new Ibm.EnEventStreamsTemplate("esTemplate", new()
    {
        InstanceGuid = ibm_resource_instance.En_terraform_test_resource.Guid,
        Type = "event_streams.notification",
        Description = "Event Streams Template for Notifications",
        Params = new Ibm.Inputs.EnEventStreamsTemplateParamsArgs
        {
            Body = "eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ==",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.EnEventStreamsTemplate;
import com.pulumi.ibm.EnEventStreamsTemplateArgs;
import com.pulumi.ibm.inputs.EnEventStreamsTemplateParamsArgs;
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 esTemplate = new EnEventStreamsTemplate("esTemplate", EnEventStreamsTemplateArgs.builder()
            .instanceGuid(ibm_resource_instance.en_terraform_test_resource().guid())
            .type("event_streams.notification")
            .description("Event Streams Template for Notifications")
            .params(EnEventStreamsTemplateParamsArgs.builder()
                .body("eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ==")
                .build())
            .build());

    }
}
Copy
resources:
  esTemplate:
    type: ibm:EnEventStreamsTemplate
    properties:
      instanceGuid: ${ibm_resource_instance.en_terraform_test_resource.guid}
      type: event_streams.notification
      description: Event Streams Template for Notifications
      params:
        body: eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ==
Copy

Create EnEventStreamsTemplate Resource

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

Constructor syntax

new EnEventStreamsTemplate(name: string, args: EnEventStreamsTemplateArgs, opts?: CustomResourceOptions);
@overload
def EnEventStreamsTemplate(resource_name: str,
                           args: EnEventStreamsTemplateArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def EnEventStreamsTemplate(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           instance_guid: Optional[str] = None,
                           params: Optional[EnEventStreamsTemplateParamsArgs] = None,
                           type: Optional[str] = None,
                           description: Optional[str] = None,
                           en_event_streams_template_id: Optional[str] = None,
                           name: Optional[str] = None)
func NewEnEventStreamsTemplate(ctx *Context, name string, args EnEventStreamsTemplateArgs, opts ...ResourceOption) (*EnEventStreamsTemplate, error)
public EnEventStreamsTemplate(string name, EnEventStreamsTemplateArgs args, CustomResourceOptions? opts = null)
public EnEventStreamsTemplate(String name, EnEventStreamsTemplateArgs args)
public EnEventStreamsTemplate(String name, EnEventStreamsTemplateArgs args, CustomResourceOptions options)

type: ibm:EnEventStreamsTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EnEventStreamsTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EnEventStreamsTemplateArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EnEventStreamsTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EnEventStreamsTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EnEventStreamsTemplateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var enEventStreamsTemplateResource = new Ibm.EnEventStreamsTemplate("enEventStreamsTemplateResource", new()
{
    InstanceGuid = "string",
    Params = new Ibm.Inputs.EnEventStreamsTemplateParamsArgs
    {
        Body = "string",
    },
    Type = "string",
    Description = "string",
    EnEventStreamsTemplateId = "string",
    Name = "string",
});
Copy
example, err := ibm.NewEnEventStreamsTemplate(ctx, "enEventStreamsTemplateResource", &ibm.EnEventStreamsTemplateArgs{
InstanceGuid: pulumi.String("string"),
Params: &.EnEventStreamsTemplateParamsArgs{
Body: pulumi.String("string"),
},
Type: pulumi.String("string"),
Description: pulumi.String("string"),
EnEventStreamsTemplateId: pulumi.String("string"),
Name: pulumi.String("string"),
})
Copy
var enEventStreamsTemplateResource = new EnEventStreamsTemplate("enEventStreamsTemplateResource", EnEventStreamsTemplateArgs.builder()
    .instanceGuid("string")
    .params(EnEventStreamsTemplateParamsArgs.builder()
        .body("string")
        .build())
    .type("string")
    .description("string")
    .enEventStreamsTemplateId("string")
    .name("string")
    .build());
Copy
en_event_streams_template_resource = ibm.EnEventStreamsTemplate("enEventStreamsTemplateResource",
    instance_guid="string",
    params={
        "body": "string",
    },
    type="string",
    description="string",
    en_event_streams_template_id="string",
    name="string")
Copy
const enEventStreamsTemplateResource = new ibm.EnEventStreamsTemplate("enEventStreamsTemplateResource", {
    instanceGuid: "string",
    params: {
        body: "string",
    },
    type: "string",
    description: "string",
    enEventStreamsTemplateId: "string",
    name: "string",
});
Copy
type: ibm:EnEventStreamsTemplate
properties:
    description: string
    enEventStreamsTemplateId: string
    instanceGuid: string
    name: string
    params:
        body: string
    type: string
Copy

EnEventStreamsTemplate Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EnEventStreamsTemplate resource accepts the following input properties:

InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
Params This property is required. EnEventStreamsTemplateParams

Payload describing a template configuration

Nested scheme for params:

Type This property is required. string
event_streams.notification
Description string
The Template description.
EnEventStreamsTemplateId string
(String) The unique identifier of the es_template.
Name string
The Message Template.
InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
Params This property is required. EnEventStreamsTemplateParamsArgs

Payload describing a template configuration

Nested scheme for params:

Type This property is required. string
event_streams.notification
Description string
The Template description.
EnEventStreamsTemplateId string
(String) The unique identifier of the es_template.
Name string
The Message Template.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
params This property is required. EnEventStreamsTemplateParams

Payload describing a template configuration

Nested scheme for params:

type This property is required. String
event_streams.notification
description String
The Template description.
enEventStreamsTemplateId String
(String) The unique identifier of the es_template.
name String
The Message Template.
instanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
params This property is required. EnEventStreamsTemplateParams

Payload describing a template configuration

Nested scheme for params:

type This property is required. string
event_streams.notification
description string
The Template description.
enEventStreamsTemplateId string
(String) The unique identifier of the es_template.
name string
The Message Template.
instance_guid This property is required. str
Unique identifier for IBM Cloud Event Notifications instance.
params This property is required. EnEventStreamsTemplateParamsArgs

Payload describing a template configuration

Nested scheme for params:

type This property is required. str
event_streams.notification
description str
The Template description.
en_event_streams_template_id str
(String) The unique identifier of the es_template.
name str
The Message Template.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
params This property is required. Property Map

Payload describing a template configuration

Nested scheme for params:

type This property is required. String
event_streams.notification
description String
The Template description.
enEventStreamsTemplateId String
(String) The unique identifier of the es_template.
name String
The Message Template.

Outputs

All input properties are implicitly available as output properties. Additionally, the EnEventStreamsTemplate resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
SubscriptionCount double
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
SubscriptionNames List<string>
(List) List of subscriptions.
TemplateId string
(String) The unique identifier of the created Template.
UpdatedAt string
(String) Last updated time.
Id string
The provider-assigned unique ID for this managed resource.
SubscriptionCount float64
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
SubscriptionNames []string
(List) List of subscriptions.
TemplateId string
(String) The unique identifier of the created Template.
UpdatedAt string
(String) Last updated time.
id String
The provider-assigned unique ID for this managed resource.
subscriptionCount Double
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscriptionNames List<String>
(List) List of subscriptions.
templateId String
(String) The unique identifier of the created Template.
updatedAt String
(String) Last updated time.
id string
The provider-assigned unique ID for this managed resource.
subscriptionCount number
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscriptionNames string[]
(List) List of subscriptions.
templateId string
(String) The unique identifier of the created Template.
updatedAt string
(String) Last updated time.
id str
The provider-assigned unique ID for this managed resource.
subscription_count float
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscription_names Sequence[str]
(List) List of subscriptions.
template_id str
(String) The unique identifier of the created Template.
updated_at str
(String) Last updated time.
id String
The provider-assigned unique ID for this managed resource.
subscriptionCount Number
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscriptionNames List<String>
(List) List of subscriptions.
templateId String
(String) The unique identifier of the created Template.
updatedAt String
(String) Last updated time.

Look up Existing EnEventStreamsTemplate Resource

Get an existing EnEventStreamsTemplate 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?: EnEventStreamsTemplateState, opts?: CustomResourceOptions): EnEventStreamsTemplate
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        en_event_streams_template_id: Optional[str] = None,
        instance_guid: Optional[str] = None,
        name: Optional[str] = None,
        params: Optional[EnEventStreamsTemplateParamsArgs] = None,
        subscription_count: Optional[float] = None,
        subscription_names: Optional[Sequence[str]] = None,
        template_id: Optional[str] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None) -> EnEventStreamsTemplate
func GetEnEventStreamsTemplate(ctx *Context, name string, id IDInput, state *EnEventStreamsTemplateState, opts ...ResourceOption) (*EnEventStreamsTemplate, error)
public static EnEventStreamsTemplate Get(string name, Input<string> id, EnEventStreamsTemplateState? state, CustomResourceOptions? opts = null)
public static EnEventStreamsTemplate get(String name, Output<String> id, EnEventStreamsTemplateState state, CustomResourceOptions options)
resources:  _:    type: ibm:EnEventStreamsTemplate    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
The Template description.
EnEventStreamsTemplateId string
(String) The unique identifier of the es_template.
InstanceGuid string
Unique identifier for IBM Cloud Event Notifications instance.
Name string
The Message Template.
Params EnEventStreamsTemplateParams

Payload describing a template configuration

Nested scheme for params:

SubscriptionCount double
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
SubscriptionNames List<string>
(List) List of subscriptions.
TemplateId string
(String) The unique identifier of the created Template.
Type string
event_streams.notification
UpdatedAt string
(String) Last updated time.
Description string
The Template description.
EnEventStreamsTemplateId string
(String) The unique identifier of the es_template.
InstanceGuid string
Unique identifier for IBM Cloud Event Notifications instance.
Name string
The Message Template.
Params EnEventStreamsTemplateParamsArgs

Payload describing a template configuration

Nested scheme for params:

SubscriptionCount float64
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
SubscriptionNames []string
(List) List of subscriptions.
TemplateId string
(String) The unique identifier of the created Template.
Type string
event_streams.notification
UpdatedAt string
(String) Last updated time.
description String
The Template description.
enEventStreamsTemplateId String
(String) The unique identifier of the es_template.
instanceGuid String
Unique identifier for IBM Cloud Event Notifications instance.
name String
The Message Template.
params EnEventStreamsTemplateParams

Payload describing a template configuration

Nested scheme for params:

subscriptionCount Double
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscriptionNames List<String>
(List) List of subscriptions.
templateId String
(String) The unique identifier of the created Template.
type String
event_streams.notification
updatedAt String
(String) Last updated time.
description string
The Template description.
enEventStreamsTemplateId string
(String) The unique identifier of the es_template.
instanceGuid string
Unique identifier for IBM Cloud Event Notifications instance.
name string
The Message Template.
params EnEventStreamsTemplateParams

Payload describing a template configuration

Nested scheme for params:

subscriptionCount number
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscriptionNames string[]
(List) List of subscriptions.
templateId string
(String) The unique identifier of the created Template.
type string
event_streams.notification
updatedAt string
(String) Last updated time.
description str
The Template description.
en_event_streams_template_id str
(String) The unique identifier of the es_template.
instance_guid str
Unique identifier for IBM Cloud Event Notifications instance.
name str
The Message Template.
params EnEventStreamsTemplateParamsArgs

Payload describing a template configuration

Nested scheme for params:

subscription_count float
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscription_names Sequence[str]
(List) List of subscriptions.
template_id str
(String) The unique identifier of the created Template.
type str
event_streams.notification
updated_at str
(String) Last updated time.
description String
The Template description.
enEventStreamsTemplateId String
(String) The unique identifier of the es_template.
instanceGuid String
Unique identifier for IBM Cloud Event Notifications instance.
name String
The Message Template.
params Property Map

Payload describing a template configuration

Nested scheme for params:

subscriptionCount Number
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscriptionNames List<String>
(List) List of subscriptions.
templateId String
(String) The unique identifier of the created Template.
type String
event_streams.notification
updatedAt String
(String) Last updated time.

Supporting Types

EnEventStreamsTemplateParams
, EnEventStreamsTemplateParamsArgs

Body This property is required. string
The Body for Event Streams Template in base64 encoded format.
Body This property is required. string
The Body for Event Streams Template in base64 encoded format.
body This property is required. String
The Body for Event Streams Template in base64 encoded format.
body This property is required. string
The Body for Event Streams Template in base64 encoded format.
body This property is required. str
The Body for Event Streams Template in base64 encoded format.
body This property is required. String
The Body for Event Streams Template in base64 encoded format.

Import

You can import the ibm_en_event_streams_template resource by using id.

The id property can be formed from instance_guid, and template_id in the following format:

<instance_guid>/<template_id>

  • instance_guid: A string. Unique identifier for IBM Cloud Event Notifications instance.

  • template_id: A string. Unique identifier for Template.

Example

$ pulumi import ibm:index/enEventStreamsTemplate:EnEventStreamsTemplate es_template <instance_guid>/<template_id>
Copy

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

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm