Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. EnSubscriptionCustomEmail
Viewing docs for ibm 2.7.0
published on Wednesday, Oct 7, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.EnSubscriptionCustomEmail

ibm
Viewing docs for ibm 2.7.0
published on Wednesday, Oct 7, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

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

    Example Usage

    Subscription to Production Custom Email Destination

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

const productionEmailSubscription = new ibm.EnSubscriptionCustomEmail("production_email_subscription", {
    instanceGuid: enTerraformTestResource.guid,
    name: "Production Email Subscription",
    description: "Subscription for production email notifications",
    destinationId: productionDestination.destinationId,
    topicId: topic1.topicId,
    attributes: {
        addNotificationPayload: true,
        replyToMail: "support@example.com",
        replyToName: "Support Team",
        fromName: "Production Alerts",
        fromEmail: "alerts@example.com",
        inviteds: [
            "user1@example.com",
            "user2@example.com",
        ],
    },
});

    import pulumi
import pulumi_ibm as ibm

production_email_subscription = ibm.EnSubscriptionCustomEmail("production_email_subscription",
    instance_guid=en_terraform_test_resource["guid"],
    name="Production Email Subscription",
    description="Subscription for production email notifications",
    destination_id=production_destination["destinationId"],
    topic_id=topic1["topicId"],
    attributes={
        "add_notification_payload": True,
        "reply_to_mail": "support@example.com",
        "reply_to_name": "Support Team",
        "from_name": "Production Alerts",
        "from_email": "alerts@example.com",
        "inviteds": [
            "user1@example.com",
            "user2@example.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.NewEnSubscriptionCustomEmail(ctx, "production_email_subscription", &ibm.EnSubscriptionCustomEmailArgs{
			InstanceGuid:  pulumi.Any(enTerraformTestResource.Guid),
			Name:          pulumi.String("Production Email Subscription"),
			Description:   pulumi.String("Subscription for production email notifications"),
			DestinationId: pulumi.Any(productionDestination.DestinationId),
			TopicId:       pulumi.Any(topic1.TopicId),
			Attributes: &ibm.EnSubscriptionCustomEmailAttributesArgs{
				AddNotificationPayload: pulumi.Bool(true),
				ReplyToMail:            pulumi.String("support@example.com"),
				ReplyToName:            pulumi.String("Support Team"),
				FromName:               pulumi.String("Production Alerts"),
				FromEmail:              pulumi.String("alerts@example.com"),
				Inviteds: pulumi.StringArray{
					pulumi.String("user1@example.com"),
					pulumi.String("user2@example.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 productionEmailSubscription = new Ibm.EnSubscriptionCustomEmail("production_email_subscription", new()
    {
        InstanceGuid = enTerraformTestResource.Guid,
        Name = "Production Email Subscription",
        Description = "Subscription for production email notifications",
        DestinationId = productionDestination.DestinationId,
        TopicId = topic1.TopicId,
        Attributes = new Ibm.Inputs.EnSubscriptionCustomEmailAttributesArgs
        {
            AddNotificationPayload = true,
            ReplyToMail = "support@example.com",
            ReplyToName = "Support Team",
            FromName = "Production Alerts",
            FromEmail = "alerts@example.com",
            Inviteds = new[]
            {
                "user1@example.com",
                "user2@example.com",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.EnSubscriptionCustomEmail;
import com.pulumi.ibm.EnSubscriptionCustomEmailArgs;
import com.pulumi.ibm.inputs.EnSubscriptionCustomEmailAttributesArgs;
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 productionEmailSubscription = new EnSubscriptionCustomEmail("productionEmailSubscription", EnSubscriptionCustomEmailArgs.builder()
            .instanceGuid(enTerraformTestResource.guid())
            .name("Production Email Subscription")
            .description("Subscription for production email notifications")
            .destinationId(productionDestination.destinationId())
            .topicId(topic1.topicId())
            .attributes(EnSubscriptionCustomEmailAttributesArgs.builder()
                .addNotificationPayload(true)
                .replyToMail("support@example.com")
                .replyToName("Support Team")
                .fromName("Production Alerts")
                .fromEmail("alerts@example.com")
                .inviteds(                
                    "user1@example.com",
                    "user2@example.com")
                .build())
            .build());

    }
}

    resources:
  productionEmailSubscription:
    type: ibm:EnSubscriptionCustomEmail
    name: production_email_subscription
    properties:
      instanceGuid: ${enTerraformTestResource.guid}
      name: Production Email Subscription
      description: Subscription for production email notifications
      destinationId: ${productionDestination.destinationId}
      topicId: ${topic1.topicId}
      attributes:
        addNotificationPayload: true
        replyToMail: support@example.com
        replyToName: Support Team
        fromName: Production Alerts
        fromEmail: alerts@example.com
        inviteds:
          - user1@example.com
          - user2@example.com

    Example coming soon!

    Subscription to Sandbox Custom Email Destination

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

const sandboxEmailSubscription = new ibm.EnSubscriptionCustomEmail("sandbox_email_subscription", {
    instanceGuid: enTerraformTestResource.guid,
    name: "Sandbox Email Subscription",
    description: "Subscription for testing email notifications",
    destinationId: sandboxDestination.destinationId,
    topicId: topic1.topicId,
    attributes: {
        addNotificationPayload: true,
        replyToMail: "test@example.com",
        replyToName: "Test Team",
        inviteds: [
            "tester1@example.com",
            "tester2@example.com",
        ],
    },
});

    import pulumi
import pulumi_ibm as ibm

sandbox_email_subscription = ibm.EnSubscriptionCustomEmail("sandbox_email_subscription",
    instance_guid=en_terraform_test_resource["guid"],
    name="Sandbox Email Subscription",
    description="Subscription for testing email notifications",
    destination_id=sandbox_destination["destinationId"],
    topic_id=topic1["topicId"],
    attributes={
        "add_notification_payload": True,
        "reply_to_mail": "test@example.com",
        "reply_to_name": "Test Team",
        "inviteds": [
            "tester1@example.com",
            "tester2@example.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.NewEnSubscriptionCustomEmail(ctx, "sandbox_email_subscription", &ibm.EnSubscriptionCustomEmailArgs{
			InstanceGuid:  pulumi.Any(enTerraformTestResource.Guid),
			Name:          pulumi.String("Sandbox Email Subscription"),
			Description:   pulumi.String("Subscription for testing email notifications"),
			DestinationId: pulumi.Any(sandboxDestination.DestinationId),
			TopicId:       pulumi.Any(topic1.TopicId),
			Attributes: &ibm.EnSubscriptionCustomEmailAttributesArgs{
				AddNotificationPayload: pulumi.Bool(true),
				ReplyToMail:            pulumi.String("test@example.com"),
				ReplyToName:            pulumi.String("Test Team"),
				Inviteds: pulumi.StringArray{
					pulumi.String("tester1@example.com"),
					pulumi.String("tester2@example.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 sandboxEmailSubscription = new Ibm.EnSubscriptionCustomEmail("sandbox_email_subscription", new()
    {
        InstanceGuid = enTerraformTestResource.Guid,
        Name = "Sandbox Email Subscription",
        Description = "Subscription for testing email notifications",
        DestinationId = sandboxDestination.DestinationId,
        TopicId = topic1.TopicId,
        Attributes = new Ibm.Inputs.EnSubscriptionCustomEmailAttributesArgs
        {
            AddNotificationPayload = true,
            ReplyToMail = "test@example.com",
            ReplyToName = "Test Team",
            Inviteds = new[]
            {
                "tester1@example.com",
                "tester2@example.com",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.EnSubscriptionCustomEmail;
import com.pulumi.ibm.EnSubscriptionCustomEmailArgs;
import com.pulumi.ibm.inputs.EnSubscriptionCustomEmailAttributesArgs;
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 sandboxEmailSubscription = new EnSubscriptionCustomEmail("sandboxEmailSubscription", EnSubscriptionCustomEmailArgs.builder()
            .instanceGuid(enTerraformTestResource.guid())
            .name("Sandbox Email Subscription")
            .description("Subscription for testing email notifications")
            .destinationId(sandboxDestination.destinationId())
            .topicId(topic1.topicId())
            .attributes(EnSubscriptionCustomEmailAttributesArgs.builder()
                .addNotificationPayload(true)
                .replyToMail("test@example.com")
                .replyToName("Test Team")
                .inviteds(                
                    "tester1@example.com",
                    "tester2@example.com")
                .build())
            .build());

    }
}

    resources:
  sandboxEmailSubscription:
    type: ibm:EnSubscriptionCustomEmail
    name: sandbox_email_subscription
    properties:
      instanceGuid: ${enTerraformTestResource.guid}
      name: Sandbox Email Subscription
      description: Subscription for testing email notifications
      destinationId: ${sandboxDestination.destinationId}
      topicId: ${topic1.topicId}
      attributes:
        addNotificationPayload: true
        replyToMail: test@example.com
        replyToName: Test Team
        inviteds:
          - tester1@example.com
          - tester2@example.com

    Example coming soon!

    Updating Email Subscription (Production)

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

const productionEmailSubscription = new ibm.EnSubscriptionCustomEmail("production_email_subscription", {
    instanceGuid: enTerraformTestResource.guid,
    name: "Production Email Subscription Updated",
    description: "Updated subscription for production email notifications",
    destinationId: productionDestination.destinationId,
    topicId: topic1.topicId,
    attributes: {
        addNotificationPayload: true,
        replyToMail: "support@example.com",
        replyToName: "Support Team",
        fromName: "Production Alerts",
        fromEmail: "alerts@example.com",
        inviteds: [
            "existinguser@example.com",
            "newuser@example.com",
        ],
    },
});

    import pulumi
import pulumi_ibm as ibm

production_email_subscription = ibm.EnSubscriptionCustomEmail("production_email_subscription",
    instance_guid=en_terraform_test_resource["guid"],
    name="Production Email Subscription Updated",
    description="Updated subscription for production email notifications",
    destination_id=production_destination["destinationId"],
    topic_id=topic1["topicId"],
    attributes={
        "add_notification_payload": True,
        "reply_to_mail": "support@example.com",
        "reply_to_name": "Support Team",
        "from_name": "Production Alerts",
        "from_email": "alerts@example.com",
        "inviteds": [
            "existinguser@example.com",
            "newuser@example.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.NewEnSubscriptionCustomEmail(ctx, "production_email_subscription", &ibm.EnSubscriptionCustomEmailArgs{
			InstanceGuid:  pulumi.Any(enTerraformTestResource.Guid),
			Name:          pulumi.String("Production Email Subscription Updated"),
			Description:   pulumi.String("Updated subscription for production email notifications"),
			DestinationId: pulumi.Any(productionDestination.DestinationId),
			TopicId:       pulumi.Any(topic1.TopicId),
			Attributes: &ibm.EnSubscriptionCustomEmailAttributesArgs{
				AddNotificationPayload: pulumi.Bool(true),
				ReplyToMail:            pulumi.String("support@example.com"),
				ReplyToName:            pulumi.String("Support Team"),
				FromName:               pulumi.String("Production Alerts"),
				FromEmail:              pulumi.String("alerts@example.com"),
				Inviteds: pulumi.StringArray{
					pulumi.String("existinguser@example.com"),
					pulumi.String("newuser@example.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 productionEmailSubscription = new Ibm.EnSubscriptionCustomEmail("production_email_subscription", new()
    {
        InstanceGuid = enTerraformTestResource.Guid,
        Name = "Production Email Subscription Updated",
        Description = "Updated subscription for production email notifications",
        DestinationId = productionDestination.DestinationId,
        TopicId = topic1.TopicId,
        Attributes = new Ibm.Inputs.EnSubscriptionCustomEmailAttributesArgs
        {
            AddNotificationPayload = true,
            ReplyToMail = "support@example.com",
            ReplyToName = "Support Team",
            FromName = "Production Alerts",
            FromEmail = "alerts@example.com",
            Inviteds = new[]
            {
                "existinguser@example.com",
                "newuser@example.com",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.EnSubscriptionCustomEmail;
import com.pulumi.ibm.EnSubscriptionCustomEmailArgs;
import com.pulumi.ibm.inputs.EnSubscriptionCustomEmailAttributesArgs;
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 productionEmailSubscription = new EnSubscriptionCustomEmail("productionEmailSubscription", EnSubscriptionCustomEmailArgs.builder()
            .instanceGuid(enTerraformTestResource.guid())
            .name("Production Email Subscription Updated")
            .description("Updated subscription for production email notifications")
            .destinationId(productionDestination.destinationId())
            .topicId(topic1.topicId())
            .attributes(EnSubscriptionCustomEmailAttributesArgs.builder()
                .addNotificationPayload(true)
                .replyToMail("support@example.com")
                .replyToName("Support Team")
                .fromName("Production Alerts")
                .fromEmail("alerts@example.com")
                .inviteds(                
                    "existinguser@example.com",
                    "newuser@example.com")
                .build())
            .build());

    }
}

    resources:
  productionEmailSubscription:
    type: ibm:EnSubscriptionCustomEmail
    name: production_email_subscription
    properties:
      instanceGuid: ${enTerraformTestResource.guid}
      name: Production Email Subscription Updated
      description: Updated subscription for production email notifications
      destinationId: ${productionDestination.destinationId}
      topicId: ${topic1.topicId}
      attributes:
        addNotificationPayload: true
        replyToMail: support@example.com
        replyToName: Support Team
        fromName: Production Alerts
        fromEmail: alerts@example.com
        inviteds:
          - existinguser@example.com
          - newuser@example.com

    Example coming soon!

    Subscription Attributes Based on Destination Type

    The subscription attributes vary depending on whether the destination is a sandbox or production custom email destination:

    Production Destination Subscriptions

    When subscribing to a production custom email destination (is_sandbox = false):

    • Required attributes: from_name and from_email
    • These attributes identify the sender of the email
    • from_email must belong to the verified custom domain

    Sandbox Destination Subscriptions

    When subscribing to a sandbox custom email destination (is_sandbox = true):

    • Not required: from_name and from_email
    • These attributes should be omitted for sandbox subscriptions
    • Sandbox subscriptions are for testing and don’t require sender verification

    Common Attributes (Both Types)

    • reply_to_mail: Email address for replies
    • reply_to_name: Name for reply-to field
    • invited: List of recipient email addresses to manage. Add an address by adding it to this list; remove an address by removing it from this list.
    • add_notification_payload: Include notification payload in email
    • template_id_notification: Template for notifications (optional)
    • template_id_invitation: Template for invitations (optional)

    Create EnSubscriptionCustomEmail Resource

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

    Constructor syntax

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

@overload
def EnSubscriptionCustomEmail(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              attributes: Optional[EnSubscriptionCustomEmailAttributesArgs] = None,
                              destination_id: Optional[str] = None,
                              instance_guid: Optional[str] = None,
                              topic_id: Optional[str] = None,
                              description: Optional[str] = None,
                              en_subscription_custom_email_id: Optional[str] = None,
                              name: Optional[str] = None)
    func NewEnSubscriptionCustomEmail(ctx *Context, name string, args EnSubscriptionCustomEmailArgs, opts ...ResourceOption) (*EnSubscriptionCustomEmail, error)
    public EnSubscriptionCustomEmail(string name, EnSubscriptionCustomEmailArgs args, CustomResourceOptions? opts = null)
    public EnSubscriptionCustomEmail(String name, EnSubscriptionCustomEmailArgs args)
public EnSubscriptionCustomEmail(String name, EnSubscriptionCustomEmailArgs args, CustomResourceOptions options)

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


    resource "ibm_en_subscription_custom_email" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EnSubscriptionCustomEmailArgs
    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 EnSubscriptionCustomEmailArgs
    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 EnSubscriptionCustomEmailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnSubscriptionCustomEmailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnSubscriptionCustomEmailArgs
    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 enSubscriptionCustomEmailResource = new Ibm.EnSubscriptionCustomEmail("enSubscriptionCustomEmailResource", new()
{
    Attributes = new Ibm.Inputs.EnSubscriptionCustomEmailAttributesArgs
    {
        AddNotificationPayload = false,
        ReplyToMail = "string",
        ReplyToName = "string",
        FromEmail = "string",
        FromName = "string",
        Inviteds = new[]
        {
            "string",
        },
        Subscribeds = new[]
        {
            "string",
        },
        TemplateIdInvitation = "string",
        TemplateIdNotification = "string",
        Unsubscribeds = new[]
        {
            "string",
        },
    },
    DestinationId = "string",
    InstanceGuid = "string",
    TopicId = "string",
    Description = "string",
    EnSubscriptionCustomEmailId = "string",
    Name = "string",
});

    example, err := ibm.NewEnSubscriptionCustomEmail(ctx, "enSubscriptionCustomEmailResource", &ibm.EnSubscriptionCustomEmailArgs{
	Attributes: &ibm.EnSubscriptionCustomEmailAttributesArgs{
		AddNotificationPayload: pulumi.Bool(false),
		ReplyToMail:            pulumi.String("string"),
		ReplyToName:            pulumi.String("string"),
		FromEmail:              pulumi.String("string"),
		FromName:               pulumi.String("string"),
		Inviteds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Subscribeds: pulumi.StringArray{
			pulumi.String("string"),
		},
		TemplateIdInvitation:   pulumi.String("string"),
		TemplateIdNotification: 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"),
	EnSubscriptionCustomEmailId: pulumi.String("string"),
	Name:                        pulumi.String("string"),
})

    resource "ibm_en_subscription_custom_email" "enSubscriptionCustomEmailResource" {
  lifecycle {
    create_before_destroy = true
  }
  attributes = {
    add_notification_payload = false
    reply_to_mail            = "string"
    reply_to_name            = "string"
    from_email               = "string"
    from_name                = "string"
    inviteds                 = ["string"]
    subscribeds              = ["string"]
    template_id_invitation   = "string"
    template_id_notification = "string"
    unsubscribeds            = ["string"]
  }
  destination_id                  = "string"
  instance_guid                   = "string"
  topic_id                        = "string"
  description                     = "string"
  en_subscription_custom_email_id = "string"
  name                            = "string"
}

    var enSubscriptionCustomEmailResource = new EnSubscriptionCustomEmail("enSubscriptionCustomEmailResource", EnSubscriptionCustomEmailArgs.builder()
    .attributes(EnSubscriptionCustomEmailAttributesArgs.builder()
        .addNotificationPayload(false)
        .replyToMail("string")
        .replyToName("string")
        .fromEmail("string")
        .fromName("string")
        .inviteds("string")
        .subscribeds("string")
        .templateIdInvitation("string")
        .templateIdNotification("string")
        .unsubscribeds("string")
        .build())
    .destinationId("string")
    .instanceGuid("string")
    .topicId("string")
    .description("string")
    .enSubscriptionCustomEmailId("string")
    .name("string")
    .build());

    en_subscription_custom_email_resource = ibm.EnSubscriptionCustomEmail("enSubscriptionCustomEmailResource",
    attributes={
        "add_notification_payload": False,
        "reply_to_mail": "string",
        "reply_to_name": "string",
        "from_email": "string",
        "from_name": "string",
        "inviteds": ["string"],
        "subscribeds": ["string"],
        "template_id_invitation": "string",
        "template_id_notification": "string",
        "unsubscribeds": ["string"],
    },
    destination_id="string",
    instance_guid="string",
    topic_id="string",
    description="string",
    en_subscription_custom_email_id="string",
    name="string")

    const enSubscriptionCustomEmailResource = new ibm.EnSubscriptionCustomEmail("enSubscriptionCustomEmailResource", {
    attributes: {
        addNotificationPayload: false,
        replyToMail: "string",
        replyToName: "string",
        fromEmail: "string",
        fromName: "string",
        inviteds: ["string"],
        subscribeds: ["string"],
        templateIdInvitation: "string",
        templateIdNotification: "string",
        unsubscribeds: ["string"],
    },
    destinationId: "string",
    instanceGuid: "string",
    topicId: "string",
    description: "string",
    enSubscriptionCustomEmailId: "string",
    name: "string",
});

    type: ibm:EnSubscriptionCustomEmail
properties:
    attributes:
        addNotificationPayload: false
        fromEmail: string
        fromName: string
        inviteds:
            - string
        replyToMail: string
        replyToName: string
        subscribeds:
            - string
        templateIdInvitation: string
        templateIdNotification: string
        unsubscribeds:
            - string
    description: string
    destinationId: string
    enSubscriptionCustomEmailId: string
    instanceGuid: string
    name: string
    topicId: string

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

    Attributes EnSubscriptionCustomEmailAttributes

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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.
    EnSubscriptionCustomEmailId string
    (String) The unique identifier of the custom_domain_email_subscription.
    Name string
    Subscription name.
    Attributes EnSubscriptionCustomEmailAttributesArgs

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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.
    EnSubscriptionCustomEmailId string
    (String) The unique identifier of the custom_domain_email_subscription.
    Name string
    Subscription name.
    attributes object

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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_custom_email_id string
    (String) The unique identifier of the custom_domain_email_subscription.
    name string
    Subscription name.
    attributes EnSubscriptionCustomEmailAttributes

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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.
    enSubscriptionCustomEmailId String
    (String) The unique identifier of the custom_domain_email_subscription.
    name String
    Subscription name.
    attributes EnSubscriptionCustomEmailAttributes

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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.
    enSubscriptionCustomEmailId string
    (String) The unique identifier of the custom_domain_email_subscription.
    name string
    Subscription name.
    attributes EnSubscriptionCustomEmailAttributesArgs

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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_custom_email_id str
    (String) The unique identifier of the custom_domain_email_subscription.
    name str
    Subscription name.
    attributes Property Map

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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.
    enSubscriptionCustomEmailId String
    (String) The unique identifier of the custom_domain_email_subscription.
    name String
    Subscription name.

    Outputs

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

    DestinationName string
    (String) The Destination name.
    DestinationType string
    (String) The type of Destination.
    From string
    From Email ID (it will be displayed only in case of 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
    From Email ID (it will be displayed only in case of 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
    From Email ID (it will be displayed only in case of 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
    From Email ID (it will be displayed only in case of 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
    From Email ID (it will be displayed only in case of 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
    From Email ID (it will be displayed only in case of 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
    From Email ID (it will be displayed only in case of 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 EnSubscriptionCustomEmail Resource

    Get an existing EnSubscriptionCustomEmail 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?: EnSubscriptionCustomEmailState, opts?: CustomResourceOptions): EnSubscriptionCustomEmail
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attributes: Optional[EnSubscriptionCustomEmailAttributesArgs] = None,
        description: Optional[str] = None,
        destination_id: Optional[str] = None,
        destination_name: Optional[str] = None,
        destination_type: Optional[str] = None,
        en_subscription_custom_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) -> EnSubscriptionCustomEmail
    func GetEnSubscriptionCustomEmail(ctx *Context, name string, id IDInput, state *EnSubscriptionCustomEmailState, opts ...ResourceOption) (*EnSubscriptionCustomEmail, error)
    public static EnSubscriptionCustomEmail Get(string name, Input<string> id, EnSubscriptionCustomEmailState? state, CustomResourceOptions? opts = null)
    public static EnSubscriptionCustomEmail get(String name, Output<String> id, EnSubscriptionCustomEmailState state, CustomResourceOptions options)
    resources:  _:    type: ibm:EnSubscriptionCustomEmail    get:      id: ${id}
    import {
  to = ibm_en_subscription_custom_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 EnSubscriptionCustomEmailAttributes

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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.
    EnSubscriptionCustomEmailId string
    (String) The unique identifier of the custom_domain_email_subscription.
    From string
    From Email ID (it will be displayed only in case of 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 EnSubscriptionCustomEmailAttributesArgs

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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.
    EnSubscriptionCustomEmailId string
    (String) The unique identifier of the custom_domain_email_subscription.
    From string
    From Email ID (it will be displayed only in case of 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. The required attributes depend on the destination type (sandbox vs production).

    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_custom_email_id string
    (String) The unique identifier of the custom_domain_email_subscription.
    from string
    From Email ID (it will be displayed only in case of 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 EnSubscriptionCustomEmailAttributes

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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.
    enSubscriptionCustomEmailId String
    (String) The unique identifier of the custom_domain_email_subscription.
    from String
    From Email ID (it will be displayed only in case of 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 EnSubscriptionCustomEmailAttributes

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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.
    enSubscriptionCustomEmailId string
    (String) The unique identifier of the custom_domain_email_subscription.
    from string
    From Email ID (it will be displayed only in case of 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 EnSubscriptionCustomEmailAttributesArgs

    Subscription attributes. The required attributes depend on the destination type (sandbox vs production).

    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_custom_email_id str
    (String) The unique identifier of the custom_domain_email_subscription.
    from_ str
    From Email ID (it will be displayed only in case of 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. The required attributes depend on the destination type (sandbox vs production).

    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.
    enSubscriptionCustomEmailId String
    (String) The unique identifier of the custom_domain_email_subscription.
    from String
    From Email ID (it will be displayed only in case of 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

    EnSubscriptionCustomEmailAttributes, EnSubscriptionCustomEmailAttributesArgs

    AddNotificationPayload bool
    Whether to include the notification payload in the email. Default is false.
    ReplyToMail string
    The email address to reply to.
    ReplyToName string
    The email user name to reply to.
    Adds List<string>

    Deprecated: Deprecated

    FromEmail string
    The email address from which email is sourced. Must belong to the verified custom domain.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    FromName string
    The name of the email address from which email is sourced.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    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.
    TemplateIdInvitation string
    The template ID for invitation emails.
    TemplateIdNotification string
    The template ID for notification emails.
    Unsubscribeds List<string>
    Email addresses that have unsubscribed. Populated by the service; read-only.
    AddNotificationPayload bool
    Whether to include the notification payload in the email. Default is false.
    ReplyToMail string
    The email address to reply to.
    ReplyToName string
    The email user name to reply to.
    Adds []string

    Deprecated: Deprecated

    FromEmail string
    The email address from which email is sourced. Must belong to the verified custom domain.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    FromName string
    The name of the email address from which email is sourced.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    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.
    TemplateIdInvitation string
    The template ID for invitation emails.
    TemplateIdNotification string
    The template ID for notification emails.
    Unsubscribeds []string
    Email addresses that have unsubscribed. Populated by the service; read-only.
    add_notification_payload bool
    Whether to include the notification payload in the email. Default is false.
    reply_to_mail string
    The email address to reply to.
    reply_to_name string
    The email user name to reply to.
    adds list(string)

    Deprecated: Deprecated

    from_email string
    The email address from which email is sourced. Must belong to the verified custom domain.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    from_name string
    The name of the email address from which email is sourced.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    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.
    template_id_invitation string
    The template ID for invitation emails.
    template_id_notification string
    The template ID for notification emails.
    unsubscribeds list(string)
    Email addresses that have unsubscribed. Populated by the service; read-only.
    addNotificationPayload Boolean
    Whether to include the notification payload in the email. Default is false.
    replyToMail String
    The email address to reply to.
    replyToName String
    The email user name to reply to.
    adds List<String>

    Deprecated: Deprecated

    fromEmail String
    The email address from which email is sourced. Must belong to the verified custom domain.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    fromName String
    The name of the email address from which email is sourced.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    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.
    templateIdInvitation String
    The template ID for invitation emails.
    templateIdNotification String
    The template ID for notification emails.
    unsubscribeds List<String>
    Email addresses that have unsubscribed. Populated by the service; read-only.
    addNotificationPayload boolean
    Whether to include the notification payload in the email. Default is false.
    replyToMail string
    The email address to reply to.
    replyToName string
    The email user name to reply to.
    adds string[]

    Deprecated: Deprecated

    fromEmail string
    The email address from which email is sourced. Must belong to the verified custom domain.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    fromName string
    The name of the email address from which email is sourced.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    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.
    templateIdInvitation string
    The template ID for invitation emails.
    templateIdNotification string
    The template ID for notification emails.
    unsubscribeds string[]
    Email addresses that have unsubscribed. Populated by the service; read-only.
    add_notification_payload bool
    Whether to include the notification payload in the email. Default is false.
    reply_to_mail str
    The email address to reply to.
    reply_to_name str
    The email user name to reply to.
    adds Sequence[str]

    Deprecated: Deprecated

    from_email str
    The email address from which email is sourced. Must belong to the verified custom domain.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    from_name str
    The name of the email address from which email is sourced.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    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.
    template_id_invitation str
    The template ID for invitation emails.
    template_id_notification str
    The template ID for notification emails.
    unsubscribeds Sequence[str]
    Email addresses that have unsubscribed. Populated by the service; read-only.
    addNotificationPayload Boolean
    Whether to include the notification payload in the email. Default is false.
    replyToMail String
    The email address to reply to.
    replyToName String
    The email user name to reply to.
    adds List<String>

    Deprecated: Deprecated

    fromEmail String
    The email address from which email is sourced. Must belong to the verified custom domain.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    fromName String
    The name of the email address from which email is sourced.

    • Required for production destinations (is_sandbox = false)
    • Not used for sandbox destinations (is_sandbox = true)
    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.
    templateIdInvitation String
    The template ID for invitation emails.
    templateIdNotification String
    The template ID for notification emails.
    unsubscribeds List<String>
    Email addresses that have unsubscribed. Populated by the service; read-only.

    Import

    You can import the ibm_en_subscription_custom_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/enSubscriptionCustomEmail:EnSubscriptionCustomEmail custom_domain_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
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial