1. Registry
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. EnSubscriptionEmail
Viewing docs for ibm 2.7.0
published on Wednesday, Oct 7, 2026 by ibm-cloud
ibm
Viewing docs for ibm 2.7.0
published on Wednesday, Oct 7, 2026 by ibm-cloud

    Create, update, or delete an Email subscription by using IBM Cloud™ Event Notifications.

    Example Usage

    Email Subscription Update

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const emailSubscription = new ibm.EnSubscriptionEmail("email_subscription", {
        instanceGuid: enTerraformTestResource.guid,
        name: "Email Certificate Subscription",
        description: "Subscription for Certificate expiration alert",
        destinationId: "email_destination_id",
        topicId: "topicId",
        attributes: {
            addNotificationPayload: true,
            replyToMail: "compliancealert@ibm.com",
            replyToName: "Compliance User",
            fromName: "en@ibm.com",
            inviteds: ["productionuser@ibm.com"],
        },
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    email_subscription = ibm.EnSubscriptionEmail("email_subscription",
        instance_guid=en_terraform_test_resource["guid"],
        name="Email Certificate Subscription",
        description="Subscription for Certificate expiration alert",
        destination_id="email_destination_id",
        topic_id="topicId",
        attributes={
            "add_notification_payload": True,
            "reply_to_mail": "compliancealert@ibm.com",
            "reply_to_name": "Compliance User",
            "from_name": "en@ibm.com",
            "inviteds": ["productionuser@ibm.com"],
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.NewEnSubscriptionEmail(ctx, "email_subscription", &ibm.EnSubscriptionEmailArgs{
    			InstanceGuid:  pulumi.Any(enTerraformTestResource.Guid),
    			Name:          pulumi.String("Email Certificate Subscription"),
    			Description:   pulumi.String("Subscription for Certificate expiration alert"),
    			DestinationId: pulumi.String("email_destination_id"),
    			TopicId:       pulumi.String("topicId"),
    			Attributes: &ibm.EnSubscriptionEmailAttributesArgs{
    				AddNotificationPayload: pulumi.Bool(true),
    				ReplyToMail:            pulumi.String("compliancealert@ibm.com"),
    				ReplyToName:            pulumi.String("Compliance User"),
    				FromName:               pulumi.String("en@ibm.com"),
    				Inviteds: pulumi.StringArray{
    					pulumi.String("productionuser@ibm.com"),
    				},
    			},
    		})
    		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 emailSubscription = new Ibm.EnSubscriptionEmail("email_subscription", new()
        {
            InstanceGuid = enTerraformTestResource.Guid,
            Name = "Email Certificate Subscription",
            Description = "Subscription for Certificate expiration alert",
            DestinationId = "email_destination_id",
            TopicId = "topicId",
            Attributes = new Ibm.Inputs.EnSubscriptionEmailAttributesArgs
            {
                AddNotificationPayload = true,
                ReplyToMail = "compliancealert@ibm.com",
                ReplyToName = "Compliance User",
                FromName = "en@ibm.com",
                Inviteds = new[]
                {
                    "productionuser@ibm.com",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.EnSubscriptionEmail;
    import com.pulumi.ibm.EnSubscriptionEmailArgs;
    import com.pulumi.ibm.inputs.EnSubscriptionEmailAttributesArgs;
    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 emailSubscription = new EnSubscriptionEmail("emailSubscription", EnSubscriptionEmailArgs.builder()
                .instanceGuid(enTerraformTestResource.guid())
                .name("Email Certificate Subscription")
                .description("Subscription for Certificate expiration alert")
                .destinationId("email_destination_id")
                .topicId("topicId")
                .attributes(EnSubscriptionEmailAttributesArgs.builder()
                    .addNotificationPayload(true)
                    .replyToMail("compliancealert@ibm.com")
                    .replyToName("Compliance User")
                    .fromName("en@ibm.com")
                    .inviteds("productionuser@ibm.com")
                    .build())
                .build());
    
        }
    }
    
    resources:
      emailSubscription:
        type: ibm:EnSubscriptionEmail
        name: email_subscription
        properties:
          instanceGuid: ${enTerraformTestResource.guid}
          name: Email Certificate Subscription
          description: Subscription for Certificate expiration alert
          destinationId: email_destination_id
          topicId: topicId
          attributes:
            addNotificationPayload: true
            replyToMail: compliancealert@ibm.com
            replyToName: Compliance User
            fromName: en@ibm.com
            inviteds:
              - productionuser@ibm.com
    
    Example coming soon!
    

    Create EnSubscriptionEmail Resource

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

    Constructor syntax

    new EnSubscriptionEmail(name: string, args: EnSubscriptionEmailArgs, opts?: CustomResourceOptions);
    @overload
    def EnSubscriptionEmail(resource_name: str,
                            args: EnSubscriptionEmailArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def EnSubscriptionEmail(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            attributes: Optional[EnSubscriptionEmailAttributesArgs] = None,
                            destination_id: Optional[str] = None,
                            instance_guid: Optional[str] = None,
                            topic_id: Optional[str] = None,
                            description: Optional[str] = None,
                            en_subscription_email_id: Optional[str] = None,
                            name: Optional[str] = None)
    func NewEnSubscriptionEmail(ctx *Context, name string, args EnSubscriptionEmailArgs, opts ...ResourceOption) (*EnSubscriptionEmail, error)
    public EnSubscriptionEmail(string name, EnSubscriptionEmailArgs args, CustomResourceOptions? opts = null)
    public EnSubscriptionEmail(String name, EnSubscriptionEmailArgs args)
    public EnSubscriptionEmail(String name, EnSubscriptionEmailArgs args, CustomResourceOptions options)
    
    type: ibm:EnSubscriptionEmail
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "ibm_en_subscription_email" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args EnSubscriptionEmailArgs
    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 EnSubscriptionEmailArgs
    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 EnSubscriptionEmailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnSubscriptionEmailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnSubscriptionEmailArgs
    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 enSubscriptionEmailResource = new Ibm.EnSubscriptionEmail("enSubscriptionEmailResource", new()
    {
        Attributes = new Ibm.Inputs.EnSubscriptionEmailAttributesArgs
        {
            AddNotificationPayload = false,
            FromName = "string",
            ReplyToMail = "string",
            ReplyToName = "string",
            Inviteds = new[]
            {
                "string",
            },
            Subscribeds = new[]
            {
                "string",
            },
            Unsubscribeds = new[]
            {
                "string",
            },
        },
        DestinationId = "string",
        InstanceGuid = "string",
        TopicId = "string",
        Description = "string",
        EnSubscriptionEmailId = "string",
        Name = "string",
    });
    
    example, err := ibm.NewEnSubscriptionEmail(ctx, "enSubscriptionEmailResource", &ibm.EnSubscriptionEmailArgs{
    	Attributes: &ibm.EnSubscriptionEmailAttributesArgs{
    		AddNotificationPayload: pulumi.Bool(false),
    		FromName:               pulumi.String("string"),
    		ReplyToMail:            pulumi.String("string"),
    		ReplyToName:            pulumi.String("string"),
    		Inviteds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Subscribeds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Unsubscribeds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	DestinationId:         pulumi.String("string"),
    	InstanceGuid:          pulumi.String("string"),
    	TopicId:               pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	EnSubscriptionEmailId: pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    })
    
    resource "ibm_en_subscription_email" "enSubscriptionEmailResource" {
      lifecycle {
        create_before_destroy = true
      }
      attributes = {
        add_notification_payload = false
        from_name                = "string"
        reply_to_mail            = "string"
        reply_to_name            = "string"
        inviteds                 = ["string"]
        subscribeds              = ["string"]
        unsubscribeds            = ["string"]
      }
      destination_id           = "string"
      instance_guid            = "string"
      topic_id                 = "string"
      description              = "string"
      en_subscription_email_id = "string"
      name                     = "string"
    }
    
    var enSubscriptionEmailResource = new EnSubscriptionEmail("enSubscriptionEmailResource", EnSubscriptionEmailArgs.builder()
        .attributes(EnSubscriptionEmailAttributesArgs.builder()
            .addNotificationPayload(false)
            .fromName("string")
            .replyToMail("string")
            .replyToName("string")
            .inviteds("string")
            .subscribeds("string")
            .unsubscribeds("string")
            .build())
        .destinationId("string")
        .instanceGuid("string")
        .topicId("string")
        .description("string")
        .enSubscriptionEmailId("string")
        .name("string")
        .build());
    
    en_subscription_email_resource = ibm.EnSubscriptionEmail("enSubscriptionEmailResource",
        attributes={
            "add_notification_payload": False,
            "from_name": "string",
            "reply_to_mail": "string",
            "reply_to_name": "string",
            "inviteds": ["string"],
            "subscribeds": ["string"],
            "unsubscribeds": ["string"],
        },
        destination_id="string",
        instance_guid="string",
        topic_id="string",
        description="string",
        en_subscription_email_id="string",
        name="string")
    
    const enSubscriptionEmailResource = new ibm.EnSubscriptionEmail("enSubscriptionEmailResource", {
        attributes: {
            addNotificationPayload: false,
            fromName: "string",
            replyToMail: "string",
            replyToName: "string",
            inviteds: ["string"],
            subscribeds: ["string"],
            unsubscribeds: ["string"],
        },
        destinationId: "string",
        instanceGuid: "string",
        topicId: "string",
        description: "string",
        enSubscriptionEmailId: "string",
        name: "string",
    });
    
    type: ibm:EnSubscriptionEmail
    properties:
        attributes:
            addNotificationPayload: false
            fromName: string
            inviteds:
                - string
            replyToMail: string
            replyToName: string
            subscribeds:
                - string
            unsubscribeds:
                - string
        description: string
        destinationId: string
        enSubscriptionEmailId: string
        instanceGuid: string
        name: string
        topicId: string
    

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

    Attributes EnSubscriptionEmailAttributes

    Subscription attributes.

    Nested scheme for attributes:

    DestinationId string
    Destination ID.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    TopicId string
    Topic ID.
    Description string
    Subscription description.
    EnSubscriptionEmailId string
    (String) The unique identifier of the email_subscription.
    Name string
    Subscription name.
    Attributes EnSubscriptionEmailAttributesArgs

    Subscription attributes.

    Nested scheme for attributes:

    DestinationId string
    Destination ID.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    TopicId string
    Topic ID.
    Description string
    Subscription description.
    EnSubscriptionEmailId string
    (String) The unique identifier of the email_subscription.
    Name string
    Subscription name.
    attributes object

    Subscription attributes.

    Nested scheme for attributes:

    destination_id string
    Destination ID.
    instance_guid string
    Unique identifier for IBM Cloud Event Notifications instance.
    topic_id string
    Topic ID.
    description string
    Subscription description.
    en_subscription_email_id string
    (String) The unique identifier of the email_subscription.
    name string
    Subscription name.
    attributes EnSubscriptionEmailAttributes

    Subscription attributes.

    Nested scheme for attributes:

    destinationId String
    Destination ID.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    topicId String
    Topic ID.
    description String
    Subscription description.
    enSubscriptionEmailId String
    (String) The unique identifier of the email_subscription.
    name String
    Subscription name.
    attributes EnSubscriptionEmailAttributes

    Subscription attributes.

    Nested scheme for attributes:

    destinationId string
    Destination ID.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    topicId string
    Topic ID.
    description string
    Subscription description.
    enSubscriptionEmailId string
    (String) The unique identifier of the email_subscription.
    name string
    Subscription name.
    attributes EnSubscriptionEmailAttributesArgs

    Subscription attributes.

    Nested scheme for attributes:

    destination_id str
    Destination ID.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    topic_id str
    Topic ID.
    description str
    Subscription description.
    en_subscription_email_id str
    (String) The unique identifier of the email_subscription.
    name str
    Subscription name.
    attributes Property Map

    Subscription attributes.

    Nested scheme for attributes:

    destinationId String
    Destination ID.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    topicId String
    Topic ID.
    description String
    Subscription description.
    enSubscriptionEmailId String
    (String) The unique identifier of the email_subscription.
    name String
    Subscription name.

    Outputs

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

    DestinationName string
    (String) The Destination name.
    DestinationType string
    (String) The type of Destination.
    From string
    (String) From Email ID (displayed only for smtp_ibm destination type).
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscriptionId string
    (String) The unique identifier of the created subscription.
    TopicName string
    (String) Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    DestinationName string
    (String) The Destination name.
    DestinationType string
    (String) The type of Destination.
    From string
    (String) From Email ID (displayed only for smtp_ibm destination type).
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscriptionId string
    (String) The unique identifier of the created subscription.
    TopicName string
    (String) Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    destination_name string
    (String) The Destination name.
    destination_type string
    (String) The type of Destination.
    from string
    (String) From Email ID (displayed only for smtp_ibm destination type).
    id string
    The provider-assigned unique ID for this managed resource.
    subscription_id string
    (String) The unique identifier of the created subscription.
    topic_name string
    (String) Name of the topic.
    updated_at string
    (String) Last updated time.
    destinationName String
    (String) The Destination name.
    destinationType String
    (String) The type of Destination.
    from String
    (String) From Email ID (displayed only for smtp_ibm destination type).
    id String
    The provider-assigned unique ID for this managed resource.
    subscriptionId String
    (String) The unique identifier of the created subscription.
    topicName String
    (String) Name of the topic.
    updatedAt String
    (String) Last updated time.
    destinationName string
    (String) The Destination name.
    destinationType string
    (String) The type of Destination.
    from string
    (String) From Email ID (displayed only for smtp_ibm destination type).
    id string
    The provider-assigned unique ID for this managed resource.
    subscriptionId string
    (String) The unique identifier of the created subscription.
    topicName string
    (String) Name of the topic.
    updatedAt string
    (String) Last updated time.
    destination_name str
    (String) The Destination name.
    destination_type str
    (String) The type of Destination.
    from_ str
    (String) From Email ID (displayed only for smtp_ibm destination type).
    id str
    The provider-assigned unique ID for this managed resource.
    subscription_id str
    (String) The unique identifier of the created subscription.
    topic_name str
    (String) Name of the topic.
    updated_at str
    (String) Last updated time.
    destinationName String
    (String) The Destination name.
    destinationType String
    (String) The type of Destination.
    from String
    (String) From Email ID (displayed only for smtp_ibm destination type).
    id String
    The provider-assigned unique ID for this managed resource.
    subscriptionId String
    (String) The unique identifier of the created subscription.
    topicName String
    (String) Name of the topic.
    updatedAt String
    (String) Last updated time.

    Look up Existing EnSubscriptionEmail Resource

    Get an existing EnSubscriptionEmail 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?: EnSubscriptionEmailState, opts?: CustomResourceOptions): EnSubscriptionEmail
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            attributes: Optional[EnSubscriptionEmailAttributesArgs] = None,
            description: Optional[str] = None,
            destination_id: Optional[str] = None,
            destination_name: Optional[str] = None,
            destination_type: Optional[str] = None,
            en_subscription_email_id: Optional[str] = None,
            from_: Optional[str] = None,
            instance_guid: Optional[str] = None,
            name: Optional[str] = None,
            subscription_id: Optional[str] = None,
            topic_id: Optional[str] = None,
            topic_name: Optional[str] = None,
            updated_at: Optional[str] = None) -> EnSubscriptionEmail
    func GetEnSubscriptionEmail(ctx *Context, name string, id IDInput, state *EnSubscriptionEmailState, opts ...ResourceOption) (*EnSubscriptionEmail, error)
    public static EnSubscriptionEmail Get(string name, Input<string> id, EnSubscriptionEmailState? state, CustomResourceOptions? opts = null)
    public static EnSubscriptionEmail get(String name, Output<String> id, EnSubscriptionEmailState state, CustomResourceOptions options)
    resources:  _:    type: ibm:EnSubscriptionEmail    get:      id: ${id}
    import {
      to = ibm_en_subscription_email.example
      id = "${id}"
    }
    
    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:
    Attributes EnSubscriptionEmailAttributes

    Subscription attributes.

    Nested scheme for attributes:

    Description string
    Subscription description.
    DestinationId string
    Destination ID.
    DestinationName string
    (String) The Destination name.
    DestinationType string
    (String) The type of Destination.
    EnSubscriptionEmailId string
    (String) The unique identifier of the email_subscription.
    From string
    (String) From Email ID (displayed only for smtp_ibm destination type).
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Name string
    Subscription name.
    SubscriptionId string
    (String) The unique identifier of the created subscription.
    TopicId string
    Topic ID.
    TopicName string
    (String) Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    Attributes EnSubscriptionEmailAttributesArgs

    Subscription attributes.

    Nested scheme for attributes:

    Description string
    Subscription description.
    DestinationId string
    Destination ID.
    DestinationName string
    (String) The Destination name.
    DestinationType string
    (String) The type of Destination.
    EnSubscriptionEmailId string
    (String) The unique identifier of the email_subscription.
    From string
    (String) From Email ID (displayed only for smtp_ibm destination type).
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Name string
    Subscription name.
    SubscriptionId string
    (String) The unique identifier of the created subscription.
    TopicId string
    Topic ID.
    TopicName string
    (String) Name of the topic.
    UpdatedAt string
    (String) Last updated time.
    attributes object

    Subscription attributes.

    Nested scheme for attributes:

    description string
    Subscription description.
    destination_id string
    Destination ID.
    destination_name string
    (String) The Destination name.
    destination_type string
    (String) The type of Destination.
    en_subscription_email_id string
    (String) The unique identifier of the email_subscription.
    from string
    (String) From Email ID (displayed only for smtp_ibm destination type).
    instance_guid string
    Unique identifier for IBM Cloud Event Notifications instance.
    name string
    Subscription name.
    subscription_id string
    (String) The unique identifier of the created subscription.
    topic_id string
    Topic ID.
    topic_name string
    (String) Name of the topic.
    updated_at string
    (String) Last updated time.
    attributes EnSubscriptionEmailAttributes

    Subscription attributes.

    Nested scheme for attributes:

    description String
    Subscription description.
    destinationId String
    Destination ID.
    destinationName String
    (String) The Destination name.
    destinationType String
    (String) The type of Destination.
    enSubscriptionEmailId String
    (String) The unique identifier of the email_subscription.
    from String
    (String) From Email ID (displayed only for smtp_ibm destination type).
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    name String
    Subscription name.
    subscriptionId String
    (String) The unique identifier of the created subscription.
    topicId String
    Topic ID.
    topicName String
    (String) Name of the topic.
    updatedAt String
    (String) Last updated time.
    attributes EnSubscriptionEmailAttributes

    Subscription attributes.

    Nested scheme for attributes:

    description string
    Subscription description.
    destinationId string
    Destination ID.
    destinationName string
    (String) The Destination name.
    destinationType string
    (String) The type of Destination.
    enSubscriptionEmailId string
    (String) The unique identifier of the email_subscription.
    from string
    (String) From Email ID (displayed only for smtp_ibm destination type).
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    name string
    Subscription name.
    subscriptionId string
    (String) The unique identifier of the created subscription.
    topicId string
    Topic ID.
    topicName string
    (String) Name of the topic.
    updatedAt string
    (String) Last updated time.
    attributes EnSubscriptionEmailAttributesArgs

    Subscription attributes.

    Nested scheme for attributes:

    description str
    Subscription description.
    destination_id str
    Destination ID.
    destination_name str
    (String) The Destination name.
    destination_type str
    (String) The type of Destination.
    en_subscription_email_id str
    (String) The unique identifier of the email_subscription.
    from_ str
    (String) From Email ID (displayed only for smtp_ibm destination type).
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    name str
    Subscription name.
    subscription_id str
    (String) The unique identifier of the created subscription.
    topic_id str
    Topic ID.
    topic_name str
    (String) Name of the topic.
    updated_at str
    (String) Last updated time.
    attributes Property Map

    Subscription attributes.

    Nested scheme for attributes:

    description String
    Subscription description.
    destinationId String
    Destination ID.
    destinationName String
    (String) The Destination name.
    destinationType String
    (String) The type of Destination.
    enSubscriptionEmailId String
    (String) The unique identifier of the email_subscription.
    from String
    (String) From Email ID (displayed only for smtp_ibm destination type).
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    name String
    Subscription name.
    subscriptionId String
    (String) The unique identifier of the created subscription.
    topicId String
    Topic ID.
    topicName String
    (String) Name of the topic.
    updatedAt String
    (String) Last updated time.

    Supporting Types

    EnSubscriptionEmailAttributes, EnSubscriptionEmailAttributesArgs

    AddNotificationPayload bool
    Whether to add the notification payload to the email.
    FromName string
    The email address from which email is sourced.
    ReplyToMail string
    The email address to reply to.
    ReplyToName string
    The name of the email address user to reply to.
    Adds List<string>

    Deprecated: Deprecated

    Inviteds List<string>
    The email addresses to invite. Add an address by adding it to this list; remove an address by removing it from this list.
    Removes List<string>

    Deprecated: Deprecated

    Subscribeds List<string>
    Email addresses that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    Unsubscribeds List<string>
    Email addresses that have unsubscribed. Populated by the service; read-only.
    AddNotificationPayload bool
    Whether to add the notification payload to the email.
    FromName string
    The email address from which email is sourced.
    ReplyToMail string
    The email address to reply to.
    ReplyToName string
    The name of the email address user to reply to.
    Adds []string

    Deprecated: Deprecated

    Inviteds []string
    The email addresses to invite. Add an address by adding it to this list; remove an address by removing it from this list.
    Removes []string

    Deprecated: Deprecated

    Subscribeds []string
    Email addresses that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    Unsubscribeds []string
    Email addresses that have unsubscribed. Populated by the service; read-only.
    add_notification_payload bool
    Whether to add the notification payload to the email.
    from_name string
    The email address from which email is sourced.
    reply_to_mail string
    The email address to reply to.
    reply_to_name string
    The name of the email address user to reply to.
    adds list(string)

    Deprecated: Deprecated

    inviteds list(string)
    The email addresses to invite. Add an address by adding it to this list; remove an address by removing it from this list.
    removes list(string)

    Deprecated: Deprecated

    subscribeds list(string)
    Email addresses that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    unsubscribeds list(string)
    Email addresses that have unsubscribed. Populated by the service; read-only.
    addNotificationPayload Boolean
    Whether to add the notification payload to the email.
    fromName String
    The email address from which email is sourced.
    replyToMail String
    The email address to reply to.
    replyToName String
    The name of the email address user to reply to.
    adds List<String>

    Deprecated: Deprecated

    inviteds List<String>
    The email addresses to invite. Add an address by adding it to this list; remove an address by removing it from this list.
    removes List<String>

    Deprecated: Deprecated

    subscribeds List<String>
    Email addresses that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    unsubscribeds List<String>
    Email addresses that have unsubscribed. Populated by the service; read-only.
    addNotificationPayload boolean
    Whether to add the notification payload to the email.
    fromName string
    The email address from which email is sourced.
    replyToMail string
    The email address to reply to.
    replyToName string
    The name of the email address user to reply to.
    adds string[]

    Deprecated: Deprecated

    inviteds string[]
    The email addresses to invite. Add an address by adding it to this list; remove an address by removing it from this list.
    removes string[]

    Deprecated: Deprecated

    subscribeds string[]
    Email addresses that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    unsubscribeds string[]
    Email addresses that have unsubscribed. Populated by the service; read-only.
    add_notification_payload bool
    Whether to add the notification payload to the email.
    from_name str
    The email address from which email is sourced.
    reply_to_mail str
    The email address to reply to.
    reply_to_name str
    The name of the email address user to reply to.
    adds Sequence[str]

    Deprecated: Deprecated

    inviteds Sequence[str]
    The email addresses to invite. Add an address by adding it to this list; remove an address by removing it from this list.
    removes Sequence[str]

    Deprecated: Deprecated

    subscribeds Sequence[str]
    Email addresses that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    unsubscribeds Sequence[str]
    Email addresses that have unsubscribed. Populated by the service; read-only.
    addNotificationPayload Boolean
    Whether to add the notification payload to the email.
    fromName String
    The email address from which email is sourced.
    replyToMail String
    The email address to reply to.
    replyToName String
    The name of the email address user to reply to.
    adds List<String>

    Deprecated: Deprecated

    inviteds List<String>
    The email addresses to invite. Add an address by adding it to this list; remove an address by removing it from this list.
    removes List<String>

    Deprecated: Deprecated

    subscribeds List<String>
    Email addresses that have accepted the invitation and are currently subscribed. Populated by the service; read-only.
    unsubscribeds List<String>
    Email addresses that have unsubscribed. Populated by the service; read-only.

    Import

    You can import the ibm_en_subscription_email resource by using id.

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

    <instance_guid>/<subscription_id>

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

    • subscription_id: A string. Unique identifier for Subscription.

    Example

    $ pulumi import ibm:index/enSubscriptionEmail:EnSubscriptionEmail email_en_subscription <instance_guid>/<subscription_id>
    

    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
    Viewing docs for ibm 2.7.0
    published on Wednesday, Oct 7, 2026 by ibm-cloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial