Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getEnSubscriptionCustomEmail
Viewing docs for ibm 2.9.0
published on Thursday, Nov 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.getEnSubscriptionCustomEmail

ibm
Viewing docs for ibm 2.9.0
published on Thursday, Nov 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source for Custom Email subscription. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

    Example Usage

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

const customDomainEmailSubscription = ibm.getEnSubscriptionCustomEmail({
    instanceGuid: enTerraformTestResource.guid,
    subscriptionId: subscriptioncustomemail.subscriptionId,
});

    import pulumi
import pulumi_ibm as ibm

custom_domain_email_subscription = ibm.get_en_subscription_custom_email(instance_guid=en_terraform_test_resource["guid"],
    subscription_id=subscriptioncustomemail["subscriptionId"])

    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.LookupEnSubscriptionCustomEmail(ctx, &ibm.LookupEnSubscriptionCustomEmailArgs{
			InstanceGuid:   enTerraformTestResource.Guid,
			SubscriptionId: subscriptioncustomemail.SubscriptionId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var customDomainEmailSubscription = Ibm.GetEnSubscriptionCustomEmail.Invoke(new()
    {
        InstanceGuid = enTerraformTestResource.Guid,
        SubscriptionId = subscriptioncustomemail.SubscriptionId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetEnSubscriptionCustomEmailArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var customDomainEmailSubscription = IbmFunctions.getEnSubscriptionCustomEmail(GetEnSubscriptionCustomEmailArgs.builder()
            .instanceGuid(enTerraformTestResource.guid())
            .subscriptionId(subscriptioncustomemail.subscriptionId())
            .build());

    }
}

    variables:
  customDomainEmailSubscription:
    fn::invoke:
      function: ibm:getEnSubscriptionCustomEmail
      arguments:
        instanceGuid: ${enTerraformTestResource.guid}
        subscriptionId: ${subscriptioncustomemail.subscriptionId}

    Example coming soon!

    Using getEnSubscriptionCustomEmail

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEnSubscriptionCustomEmail(args: GetEnSubscriptionCustomEmailArgs, opts?: InvokeOptions): Promise<GetEnSubscriptionCustomEmailResult>
function getEnSubscriptionCustomEmailOutput(args: GetEnSubscriptionCustomEmailOutputArgs, opts?: InvokeOutputOptions): Output<GetEnSubscriptionCustomEmailResult>
    def get_en_subscription_custom_email(id: Optional[str] = None,
                                     instance_guid: Optional[str] = None,
                                     subscription_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetEnSubscriptionCustomEmailResult
def get_en_subscription_custom_email_output(id: pulumi.Input[Optional[str]] = None,
                                     instance_guid: pulumi.Input[Optional[str]] = None,
                                     subscription_id: pulumi.Input[Optional[str]] = None,
                                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetEnSubscriptionCustomEmailResult]
    func LookupEnSubscriptionCustomEmail(ctx *Context, args *LookupEnSubscriptionCustomEmailArgs, opts ...InvokeOption) (*LookupEnSubscriptionCustomEmailResult, error)
func LookupEnSubscriptionCustomEmailOutput(ctx *Context, args *LookupEnSubscriptionCustomEmailOutputArgs, opts ...InvokeOption) LookupEnSubscriptionCustomEmailResultOutput

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

    public static class GetEnSubscriptionCustomEmail 
{
    public static Task<GetEnSubscriptionCustomEmailResult> InvokeAsync(GetEnSubscriptionCustomEmailArgs args, InvokeOptions? opts = null)
    public static Output<GetEnSubscriptionCustomEmailResult> Invoke(GetEnSubscriptionCustomEmailInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetEnSubscriptionCustomEmailResult> Invoke(GetEnSubscriptionCustomEmailInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetEnSubscriptionCustomEmailResult> getEnSubscriptionCustomEmail(GetEnSubscriptionCustomEmailArgs args, InvokeOptions options)
public static Output<GetEnSubscriptionCustomEmailResult> getEnSubscriptionCustomEmail(GetEnSubscriptionCustomEmailArgs args, InvokeOptions options)
public static Output<GetEnSubscriptionCustomEmailResult> getEnSubscriptionCustomEmail(GetEnSubscriptionCustomEmailArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: ibm:index/getEnSubscriptionCustomEmail:getEnSubscriptionCustomEmail
  arguments:
    # arguments dictionary
    data "ibm_get_en_subscription_custom_email" "name" {
    # arguments
}

    The following arguments are supported:

    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    SubscriptionId string
    Unique identifier for Subscription.
    Id string
    The unique identifier of the email_subscription.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    SubscriptionId string
    Unique identifier for Subscription.
    Id string
    The unique identifier of the email_subscription.
    instance_guid string
    Unique identifier for IBM Cloud Event Notifications instance.
    subscription_id string
    Unique identifier for Subscription.
    id string
    The unique identifier of the email_subscription.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    subscriptionId String
    Unique identifier for Subscription.
    id String
    The unique identifier of the email_subscription.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    subscriptionId string
    Unique identifier for Subscription.
    id string
    The unique identifier of the email_subscription.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    subscription_id str
    Unique identifier for Subscription.
    id str
    The unique identifier of the email_subscription.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    subscriptionId String
    Unique identifier for Subscription.
    id String
    The unique identifier of the email_subscription.

    getEnSubscriptionCustomEmail Result

    The following output properties are available:

    Attributes List<GetEnSubscriptionCustomEmailAttribute>
    (List)
    Description string
    (String) Subscription description.
    DestinationId string
    (String) The destination ID.
    Id string
    The unique identifier of the email_subscription.
    InstanceGuid string
    Name string
    (String) Subscription name.
    SubscriptionId string
    TopicId string
    (String) Topic ID.
    UpdatedAt string
    (String) Last updated time.
    Attributes []GetEnSubscriptionCustomEmailAttribute
    (List)
    Description string
    (String) Subscription description.
    DestinationId string
    (String) The destination ID.
    Id string
    The unique identifier of the email_subscription.
    InstanceGuid string
    Name string
    (String) Subscription name.
    SubscriptionId string
    TopicId string
    (String) Topic ID.
    UpdatedAt string
    (String) Last updated time.
    attributes list(object)
    (List)
    description string
    (String) Subscription description.
    destination_id string
    (String) The destination ID.
    id string
    The unique identifier of the email_subscription.
    instance_guid string
    name string
    (String) Subscription name.
    subscription_id string
    topic_id string
    (String) Topic ID.
    updated_at string
    (String) Last updated time.
    attributes List<GetEnSubscriptionCustomEmailAttribute>
    (List)
    description String
    (String) Subscription description.
    destinationId String
    (String) The destination ID.
    id String
    The unique identifier of the email_subscription.
    instanceGuid String
    name String
    (String) Subscription name.
    subscriptionId String
    topicId String
    (String) Topic ID.
    updatedAt String
    (String) Last updated time.
    attributes GetEnSubscriptionCustomEmailAttribute[]
    (List)
    description string
    (String) Subscription description.
    destinationId string
    (String) The destination ID.
    id string
    The unique identifier of the email_subscription.
    instanceGuid string
    name string
    (String) Subscription name.
    subscriptionId string
    topicId string
    (String) Topic ID.
    updatedAt string
    (String) Last updated time.
    attributes Sequence[GetEnSubscriptionCustomEmailAttribute]
    (List)
    description str
    (String) Subscription description.
    destination_id str
    (String) The destination ID.
    id str
    The unique identifier of the email_subscription.
    instance_guid str
    name str
    (String) Subscription name.
    subscription_id str
    topic_id str
    (String) Topic ID.
    updated_at str
    (String) Last updated time.
    attributes List<Property Map>
    (List)
    description String
    (String) Subscription description.
    destinationId String
    (String) The destination ID.
    id String
    The unique identifier of the email_subscription.
    instanceGuid String
    name String
    (String) Subscription name.
    subscriptionId String
    topicId String
    (String) Topic ID.
    updatedAt String
    (String) Last updated time.

    Supporting Types

    GetEnSubscriptionCustomEmailAttribute

    AddNotificationPayload bool
    (Boolean) Whether to add the notification payload to the email.
    FromEmail string
    (String) The email from where it is sourced.
    FromName string
    (String) The name of email address from which email is sourced.
    Inviteds List<GetEnSubscriptionCustomEmailAttributeInvited>
    (List) The email addresses for invitation.
    ReplyToMail string
    (String) The email address to reply to.
    ReplyToName string
    (String) The Email User Name to reply to.
    Subscribeds List<GetEnSubscriptionCustomEmailAttributeSubscribed>
    (List) The email addresses that are subscribed to the topic.
    TemplateIdInvitation string
    (String) The template id for invitation.
    TemplateIdNotification string
    (String) The template id for notification.
    Unsubscribeds List<GetEnSubscriptionCustomEmailAttributeUnsubscribed>
    (List) The email addresses that have opted out of subscription from the topic.
    AddNotificationPayload bool
    (Boolean) Whether to add the notification payload to the email.
    FromEmail string
    (String) The email from where it is sourced.
    FromName string
    (String) The name of email address from which email is sourced.
    Inviteds []GetEnSubscriptionCustomEmailAttributeInvited
    (List) The email addresses for invitation.
    ReplyToMail string
    (String) The email address to reply to.
    ReplyToName string
    (String) The Email User Name to reply to.
    Subscribeds []GetEnSubscriptionCustomEmailAttributeSubscribed
    (List) The email addresses that are subscribed to the topic.
    TemplateIdInvitation string
    (String) The template id for invitation.
    TemplateIdNotification string
    (String) The template id for notification.
    Unsubscribeds []GetEnSubscriptionCustomEmailAttributeUnsubscribed
    (List) The email addresses that have opted out of subscription from the topic.
    add_notification_payload bool
    (Boolean) Whether to add the notification payload to the email.
    from_email string
    (String) The email from where it is sourced.
    from_name string
    (String) The name of email address from which email is sourced.
    inviteds list(object)
    (List) The email addresses for invitation.
    reply_to_mail string
    (String) The email address to reply to.
    reply_to_name string
    (String) The Email User Name to reply to.
    subscribeds list(object)
    (List) The email addresses that are subscribed to the topic.
    template_id_invitation string
    (String) The template id for invitation.
    template_id_notification string
    (String) The template id for notification.
    unsubscribeds list(object)
    (List) The email addresses that have opted out of subscription from the topic.
    addNotificationPayload Boolean
    (Boolean) Whether to add the notification payload to the email.
    fromEmail String
    (String) The email from where it is sourced.
    fromName String
    (String) The name of email address from which email is sourced.
    inviteds List<GetEnSubscriptionCustomEmailAttributeInvited>
    (List) The email addresses for invitation.
    replyToMail String
    (String) The email address to reply to.
    replyToName String
    (String) The Email User Name to reply to.
    subscribeds List<GetEnSubscriptionCustomEmailAttributeSubscribed>
    (List) The email addresses that are subscribed to the topic.
    templateIdInvitation String
    (String) The template id for invitation.
    templateIdNotification String
    (String) The template id for notification.
    unsubscribeds List<GetEnSubscriptionCustomEmailAttributeUnsubscribed>
    (List) The email addresses that have opted out of subscription from the topic.
    addNotificationPayload boolean
    (Boolean) Whether to add the notification payload to the email.
    fromEmail string
    (String) The email from where it is sourced.
    fromName string
    (String) The name of email address from which email is sourced.
    inviteds GetEnSubscriptionCustomEmailAttributeInvited[]
    (List) The email addresses for invitation.
    replyToMail string
    (String) The email address to reply to.
    replyToName string
    (String) The Email User Name to reply to.
    subscribeds GetEnSubscriptionCustomEmailAttributeSubscribed[]
    (List) The email addresses that are subscribed to the topic.
    templateIdInvitation string
    (String) The template id for invitation.
    templateIdNotification string
    (String) The template id for notification.
    unsubscribeds GetEnSubscriptionCustomEmailAttributeUnsubscribed[]
    (List) The email addresses that have opted out of subscription from the topic.
    add_notification_payload bool
    (Boolean) Whether to add the notification payload to the email.
    from_email str
    (String) The email from where it is sourced.
    from_name str
    (String) The name of email address from which email is sourced.
    inviteds Sequence[GetEnSubscriptionCustomEmailAttributeInvited]
    (List) The email addresses for invitation.
    reply_to_mail str
    (String) The email address to reply to.
    reply_to_name str
    (String) The Email User Name to reply to.
    subscribeds Sequence[GetEnSubscriptionCustomEmailAttributeSubscribed]
    (List) The email addresses that are subscribed to the topic.
    template_id_invitation str
    (String) The template id for invitation.
    template_id_notification str
    (String) The template id for notification.
    unsubscribeds Sequence[GetEnSubscriptionCustomEmailAttributeUnsubscribed]
    (List) The email addresses that have opted out of subscription from the topic.
    addNotificationPayload Boolean
    (Boolean) Whether to add the notification payload to the email.
    fromEmail String
    (String) The email from where it is sourced.
    fromName String
    (String) The name of email address from which email is sourced.
    inviteds List<Property Map>
    (List) The email addresses for invitation.
    replyToMail String
    (String) The email address to reply to.
    replyToName String
    (String) The Email User Name to reply to.
    subscribeds List<Property Map>
    (List) The email addresses that are subscribed to the topic.
    templateIdInvitation String
    (String) The template id for invitation.
    templateIdNotification String
    (String) The template id for notification.
    unsubscribeds List<Property Map>
    (List) The email addresses that have opted out of subscription from the topic.

    GetEnSubscriptionCustomEmailAttributeInvited

    Email string
    (String) The invited email address.
    ExpiresAt string
    (String) The expiry date of the invitation mail.
    UpdatedAt string
    (String) Last updated time.
    Email string
    (String) The invited email address.
    ExpiresAt string
    (String) The expiry date of the invitation mail.
    UpdatedAt string
    (String) Last updated time.
    email string
    (String) The invited email address.
    expires_at string
    (String) The expiry date of the invitation mail.
    updated_at string
    (String) Last updated time.
    email String
    (String) The invited email address.
    expiresAt String
    (String) The expiry date of the invitation mail.
    updatedAt String
    (String) Last updated time.
    email string
    (String) The invited email address.
    expiresAt string
    (String) The expiry date of the invitation mail.
    updatedAt string
    (String) Last updated time.
    email str
    (String) The invited email address.
    expires_at str
    (String) The expiry date of the invitation mail.
    updated_at str
    (String) Last updated time.
    email String
    (String) The invited email address.
    expiresAt String
    (String) The expiry date of the invitation mail.
    updatedAt String
    (String) Last updated time.

    GetEnSubscriptionCustomEmailAttributeSubscribed

    Email string
    (String) The invited email address.
    UpdatedAt string
    (String) Last updated time.
    Email string
    (String) The invited email address.
    UpdatedAt string
    (String) Last updated time.
    email string
    (String) The invited email address.
    updated_at string
    (String) Last updated time.
    email String
    (String) The invited email address.
    updatedAt String
    (String) Last updated time.
    email string
    (String) The invited email address.
    updatedAt string
    (String) Last updated time.
    email str
    (String) The invited email address.
    updated_at str
    (String) Last updated time.
    email String
    (String) The invited email address.
    updatedAt String
    (String) Last updated time.

    GetEnSubscriptionCustomEmailAttributeUnsubscribed

    Email string
    (String) The invited email address.
    UpdatedAt string
    (String) Last updated time.
    Email string
    (String) The invited email address.
    UpdatedAt string
    (String) Last updated time.
    email string
    (String) The invited email address.
    updated_at string
    (String) Last updated time.
    email String
    (String) The invited email address.
    updatedAt String
    (String) Last updated time.
    email string
    (String) The invited email address.
    updatedAt string
    (String) Last updated time.
    email str
    (String) The invited email address.
    updated_at str
    (String) Last updated time.
    email String
    (String) The invited email address.
    updatedAt String
    (String) Last updated time.

    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.9.0
    published on Thursday, Nov 5, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial