1. Packages
  2. Ibm Provider
  3. API Docs
  4. EnDestinationEventStreams
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.EnDestinationEventStreams

Explore with Pulumi AI

Create, update, or delete a IBM Event Streams destination by using IBM Cloud™ Event Notifications.

Example Usage

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

const esEnDestination = new ibm.EnDestinationEventStreams("esEnDestination", {
    instanceGuid: ibm_resource_instance.en_terraform_test_resource.guid,
    type: "event_streams",
    description: "Event Streams Destination for event notification",
    config: {
        params: {
            crn: "crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c131610c8:a292db6e-af78-4c0b-b3db-7d6794b40aeb::",
            endpoint: "https://n6627w6t7y62chudi.svc09.us-south.eventstreams.cloud.ibm.com",
            topic: "test_topic",
        },
    },
});
Copy
import pulumi
import pulumi_ibm as ibm

es_en_destination = ibm.EnDestinationEventStreams("esEnDestination",
    instance_guid=ibm_resource_instance["en_terraform_test_resource"]["guid"],
    type="event_streams",
    description="Event Streams Destination for event notification",
    config={
        "params": {
            "crn": "crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c131610c8:a292db6e-af78-4c0b-b3db-7d6794b40aeb::",
            "endpoint": "https://n6627w6t7y62chudi.svc09.us-south.eventstreams.cloud.ibm.com",
            "topic": "test_topic",
        },
    })
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.NewEnDestinationEventStreams(ctx, "esEnDestination", &ibm.EnDestinationEventStreamsArgs{
			InstanceGuid: pulumi.Any(ibm_resource_instance.En_terraform_test_resource.Guid),
			Type:         pulumi.String("event_streams"),
			Description:  pulumi.String("Event Streams Destination for event notification"),
			Config: &ibm.EnDestinationEventStreamsConfigArgs{
				Params: &ibm.EnDestinationEventStreamsConfigParamsArgs{
					Crn:      pulumi.String("crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c131610c8:a292db6e-af78-4c0b-b3db-7d6794b40aeb::"),
					Endpoint: pulumi.String("https://n6627w6t7y62chudi.svc09.us-south.eventstreams.cloud.ibm.com"),
					Topic:    pulumi.String("test_topic"),
				},
			},
		})
		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 esEnDestination = new Ibm.EnDestinationEventStreams("esEnDestination", new()
    {
        InstanceGuid = ibm_resource_instance.En_terraform_test_resource.Guid,
        Type = "event_streams",
        Description = "Event Streams Destination for event notification",
        Config = new Ibm.Inputs.EnDestinationEventStreamsConfigArgs
        {
            Params = new Ibm.Inputs.EnDestinationEventStreamsConfigParamsArgs
            {
                Crn = "crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c131610c8:a292db6e-af78-4c0b-b3db-7d6794b40aeb::",
                Endpoint = "https://n6627w6t7y62chudi.svc09.us-south.eventstreams.cloud.ibm.com",
                Topic = "test_topic",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.EnDestinationEventStreams;
import com.pulumi.ibm.EnDestinationEventStreamsArgs;
import com.pulumi.ibm.inputs.EnDestinationEventStreamsConfigArgs;
import com.pulumi.ibm.inputs.EnDestinationEventStreamsConfigParamsArgs;
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 esEnDestination = new EnDestinationEventStreams("esEnDestination", EnDestinationEventStreamsArgs.builder()
            .instanceGuid(ibm_resource_instance.en_terraform_test_resource().guid())
            .type("event_streams")
            .description("Event Streams Destination for event notification")
            .config(EnDestinationEventStreamsConfigArgs.builder()
                .params(EnDestinationEventStreamsConfigParamsArgs.builder()
                    .crn("crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c131610c8:a292db6e-af78-4c0b-b3db-7d6794b40aeb::")
                    .endpoint("https://n6627w6t7y62chudi.svc09.us-south.eventstreams.cloud.ibm.com")
                    .topic("test_topic")
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  esEnDestination:
    type: ibm:EnDestinationEventStreams
    properties:
      instanceGuid: ${ibm_resource_instance.en_terraform_test_resource.guid}
      type: event_streams
      description: Event Streams Destination for event notification
      config:
        params:
          crn: 'crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c131610c8:a292db6e-af78-4c0b-b3db-7d6794b40aeb::'
          endpoint: https://n6627w6t7y62chudi.svc09.us-south.eventstreams.cloud.ibm.com
          topic: test_topic
Copy

Create EnDestinationEventStreams Resource

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

Constructor syntax

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

@overload
def EnDestinationEventStreams(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              instance_guid: Optional[str] = None,
                              type: Optional[str] = None,
                              collect_failed_events: Optional[bool] = None,
                              config: Optional[EnDestinationEventStreamsConfigArgs] = None,
                              description: Optional[str] = None,
                              en_destination_event_streams_id: Optional[str] = None,
                              name: Optional[str] = None)
func NewEnDestinationEventStreams(ctx *Context, name string, args EnDestinationEventStreamsArgs, opts ...ResourceOption) (*EnDestinationEventStreams, error)
public EnDestinationEventStreams(string name, EnDestinationEventStreamsArgs args, CustomResourceOptions? opts = null)
public EnDestinationEventStreams(String name, EnDestinationEventStreamsArgs args)
public EnDestinationEventStreams(String name, EnDestinationEventStreamsArgs args, CustomResourceOptions options)
type: ibm:EnDestinationEventStreams
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. EnDestinationEventStreamsArgs
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. EnDestinationEventStreamsArgs
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. EnDestinationEventStreamsArgs
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. EnDestinationEventStreamsArgs
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. EnDestinationEventStreamsArgs
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 enDestinationEventStreamsResource = new Ibm.EnDestinationEventStreams("enDestinationEventStreamsResource", new()
{
    InstanceGuid = "string",
    Type = "string",
    CollectFailedEvents = false,
    Config = new Ibm.Inputs.EnDestinationEventStreamsConfigArgs
    {
        Params = new Ibm.Inputs.EnDestinationEventStreamsConfigParamsArgs
        {
            Crn = "string",
            Topic = "string",
            Endpoint = "string",
        },
    },
    Description = "string",
    EnDestinationEventStreamsId = "string",
    Name = "string",
});
Copy
example, err := ibm.NewEnDestinationEventStreams(ctx, "enDestinationEventStreamsResource", &ibm.EnDestinationEventStreamsArgs{
	InstanceGuid:        pulumi.String("string"),
	Type:                pulumi.String("string"),
	CollectFailedEvents: pulumi.Bool(false),
	Config: &ibm.EnDestinationEventStreamsConfigArgs{
		Params: &ibm.EnDestinationEventStreamsConfigParamsArgs{
			Crn:      pulumi.String("string"),
			Topic:    pulumi.String("string"),
			Endpoint: pulumi.String("string"),
		},
	},
	Description:                 pulumi.String("string"),
	EnDestinationEventStreamsId: pulumi.String("string"),
	Name:                        pulumi.String("string"),
})
Copy
var enDestinationEventStreamsResource = new EnDestinationEventStreams("enDestinationEventStreamsResource", EnDestinationEventStreamsArgs.builder()
    .instanceGuid("string")
    .type("string")
    .collectFailedEvents(false)
    .config(EnDestinationEventStreamsConfigArgs.builder()
        .params(EnDestinationEventStreamsConfigParamsArgs.builder()
            .crn("string")
            .topic("string")
            .endpoint("string")
            .build())
        .build())
    .description("string")
    .enDestinationEventStreamsId("string")
    .name("string")
    .build());
Copy
en_destination_event_streams_resource = ibm.EnDestinationEventStreams("enDestinationEventStreamsResource",
    instance_guid="string",
    type="string",
    collect_failed_events=False,
    config={
        "params": {
            "crn": "string",
            "topic": "string",
            "endpoint": "string",
        },
    },
    description="string",
    en_destination_event_streams_id="string",
    name="string")
Copy
const enDestinationEventStreamsResource = new ibm.EnDestinationEventStreams("enDestinationEventStreamsResource", {
    instanceGuid: "string",
    type: "string",
    collectFailedEvents: false,
    config: {
        params: {
            crn: "string",
            topic: "string",
            endpoint: "string",
        },
    },
    description: "string",
    enDestinationEventStreamsId: "string",
    name: "string",
});
Copy
type: ibm:EnDestinationEventStreams
properties:
    collectFailedEvents: false
    config:
        params:
            crn: string
            endpoint: string
            topic: string
    description: string
    enDestinationEventStreamsId: string
    instanceGuid: string
    name: string
    type: string
Copy

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

InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
Type This property is required. string
event_streams.
CollectFailedEvents bool
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
Config EnDestinationEventStreamsConfig

Payload describing a destination configuration.

Nested scheme for config:

Description string
The Destination description.
EnDestinationEventStreamsId string
(String) The unique identifier of the es_en_destination.
Name string
The Destintion name.
InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
Type This property is required. string
event_streams.
CollectFailedEvents bool
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
Config EnDestinationEventStreamsConfigArgs

Payload describing a destination configuration.

Nested scheme for config:

Description string
The Destination description.
EnDestinationEventStreamsId string
(String) The unique identifier of the es_en_destination.
Name string
The Destintion name.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
type This property is required. String
event_streams.
collectFailedEvents Boolean
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
config EnDestinationEventStreamsConfig

Payload describing a destination configuration.

Nested scheme for config:

description String
The Destination description.
enDestinationEventStreamsId String
(String) The unique identifier of the es_en_destination.
name String
The Destintion name.
instanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
type This property is required. string
event_streams.
collectFailedEvents boolean
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
config EnDestinationEventStreamsConfig

Payload describing a destination configuration.

Nested scheme for config:

description string
The Destination description.
enDestinationEventStreamsId string
(String) The unique identifier of the es_en_destination.
name string
The Destintion name.
instance_guid This property is required. str
Unique identifier for IBM Cloud Event Notifications instance.
type This property is required. str
event_streams.
collect_failed_events bool
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
config EnDestinationEventStreamsConfigArgs

Payload describing a destination configuration.

Nested scheme for config:

description str
The Destination description.
en_destination_event_streams_id str
(String) The unique identifier of the es_en_destination.
name str
The Destintion name.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
type This property is required. String
event_streams.
collectFailedEvents Boolean
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
config Property Map

Payload describing a destination configuration.

Nested scheme for config:

description String
The Destination description.
enDestinationEventStreamsId String
(String) The unique identifier of the es_en_destination.
name String
The Destintion name.

Outputs

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

DestinationId string
(String) The unique identifier of the created destination.
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.
UpdatedAt string
(String) Last updated time.
DestinationId string
(String) The unique identifier of the created destination.
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.
UpdatedAt string
(String) Last updated time.
destinationId String
(String) The unique identifier of the created destination.
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.
updatedAt String
(String) Last updated time.
destinationId string
(String) The unique identifier of the created destination.
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.
updatedAt string
(String) Last updated time.
destination_id str
(String) The unique identifier of the created destination.
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.
updated_at str
(String) Last updated time.
destinationId String
(String) The unique identifier of the created destination.
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.
updatedAt String
(String) Last updated time.

Look up Existing EnDestinationEventStreams Resource

Get an existing EnDestinationEventStreams 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?: EnDestinationEventStreamsState, opts?: CustomResourceOptions): EnDestinationEventStreams
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        collect_failed_events: Optional[bool] = None,
        config: Optional[EnDestinationEventStreamsConfigArgs] = None,
        description: Optional[str] = None,
        destination_id: Optional[str] = None,
        en_destination_event_streams_id: Optional[str] = None,
        instance_guid: Optional[str] = None,
        name: Optional[str] = None,
        subscription_count: Optional[float] = None,
        subscription_names: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None) -> EnDestinationEventStreams
func GetEnDestinationEventStreams(ctx *Context, name string, id IDInput, state *EnDestinationEventStreamsState, opts ...ResourceOption) (*EnDestinationEventStreams, error)
public static EnDestinationEventStreams Get(string name, Input<string> id, EnDestinationEventStreamsState? state, CustomResourceOptions? opts = null)
public static EnDestinationEventStreams get(String name, Output<String> id, EnDestinationEventStreamsState state, CustomResourceOptions options)
resources:  _:    type: ibm:EnDestinationEventStreams    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:
CollectFailedEvents bool
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
Config EnDestinationEventStreamsConfig

Payload describing a destination configuration.

Nested scheme for config:

Description string
The Destination description.
DestinationId string
(String) The unique identifier of the created destination.
EnDestinationEventStreamsId string
(String) The unique identifier of the es_en_destination.
InstanceGuid string
Unique identifier for IBM Cloud Event Notifications instance.
Name string
The Destintion name.
SubscriptionCount double
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
SubscriptionNames List<string>
(List) List of subscriptions.
Type string
event_streams.
UpdatedAt string
(String) Last updated time.
CollectFailedEvents bool
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
Config EnDestinationEventStreamsConfigArgs

Payload describing a destination configuration.

Nested scheme for config:

Description string
The Destination description.
DestinationId string
(String) The unique identifier of the created destination.
EnDestinationEventStreamsId string
(String) The unique identifier of the es_en_destination.
InstanceGuid string
Unique identifier for IBM Cloud Event Notifications instance.
Name string
The Destintion name.
SubscriptionCount float64
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
SubscriptionNames []string
(List) List of subscriptions.
Type string
event_streams.
UpdatedAt string
(String) Last updated time.
collectFailedEvents Boolean
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
config EnDestinationEventStreamsConfig

Payload describing a destination configuration.

Nested scheme for config:

description String
The Destination description.
destinationId String
(String) The unique identifier of the created destination.
enDestinationEventStreamsId String
(String) The unique identifier of the es_en_destination.
instanceGuid String
Unique identifier for IBM Cloud Event Notifications instance.
name String
The Destintion name.
subscriptionCount Double
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscriptionNames List<String>
(List) List of subscriptions.
type String
event_streams.
updatedAt String
(String) Last updated time.
collectFailedEvents boolean
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
config EnDestinationEventStreamsConfig

Payload describing a destination configuration.

Nested scheme for config:

description string
The Destination description.
destinationId string
(String) The unique identifier of the created destination.
enDestinationEventStreamsId string
(String) The unique identifier of the es_en_destination.
instanceGuid string
Unique identifier for IBM Cloud Event Notifications instance.
name string
The Destintion name.
subscriptionCount number
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscriptionNames string[]
(List) List of subscriptions.
type string
event_streams.
updatedAt string
(String) Last updated time.
collect_failed_events bool
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
config EnDestinationEventStreamsConfigArgs

Payload describing a destination configuration.

Nested scheme for config:

description str
The Destination description.
destination_id str
(String) The unique identifier of the created destination.
en_destination_event_streams_id str
(String) The unique identifier of the es_en_destination.
instance_guid str
Unique identifier for IBM Cloud Event Notifications instance.
name str
The Destintion name.
subscription_count float
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscription_names Sequence[str]
(List) List of subscriptions.
type str
event_streams.
updated_at str
(String) Last updated time.
collectFailedEvents Boolean
Toggle switch to enable collect failed event in Cloud Object Storage bucket.
config Property Map

Payload describing a destination configuration.

Nested scheme for config:

description String
The Destination description.
destinationId String
(String) The unique identifier of the created destination.
enDestinationEventStreamsId String
(String) The unique identifier of the es_en_destination.
instanceGuid String
Unique identifier for IBM Cloud Event Notifications instance.
name String
The Destintion name.
subscriptionCount Number
(Integer) Number of subscriptions.

  • Constraints: The minimum value is 0.
subscriptionNames List<String>
(List) List of subscriptions.
type String
event_streams.
updatedAt String
(String) Last updated time.

Supporting Types

EnDestinationEventStreamsConfig
, EnDestinationEventStreamsConfigArgs

params Property Map
Nested scheme for params:

EnDestinationEventStreamsConfigParams
, EnDestinationEventStreamsConfigParamsArgs

Crn This property is required. string
The instance CRN for Event Streams instance
Topic This property is required. string
Topic of Event Streams
Endpoint string
The endpoint for the Event Streams
Crn This property is required. string
The instance CRN for Event Streams instance
Topic This property is required. string
Topic of Event Streams
Endpoint string
The endpoint for the Event Streams
crn This property is required. String
The instance CRN for Event Streams instance
topic This property is required. String
Topic of Event Streams
endpoint String
The endpoint for the Event Streams
crn This property is required. string
The instance CRN for Event Streams instance
topic This property is required. string
Topic of Event Streams
endpoint string
The endpoint for the Event Streams
crn This property is required. str
The instance CRN for Event Streams instance
topic This property is required. str
Topic of Event Streams
endpoint str
The endpoint for the Event Streams
crn This property is required. String
The instance CRN for Event Streams instance
topic This property is required. String
Topic of Event Streams
endpoint String
The endpoint for the Event Streams

Import

You can import the ibm_en_destination_event_streams resource by using id.

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

<instance_guid>/<destination_id>

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

  • destination_id: A string. Unique identifier for Destination.

Example

$ pulumi import ibm:index/enDestinationEventStreams:EnDestinationEventStreams es_en_destination <instance_guid>/<destination_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.