1. Packages
  2. Ibm Provider
  3. API Docs
  4. getEnSubscriptionEmail
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getEnSubscriptionEmail

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Provides a read-only data source for 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 emailSubscription = ibm.getEnSubscriptionEmail({
        instanceGuid: ibm_resource_instance.en_terraform_test_resource.guid,
        subscriptionId: ibm_en_subscription_email.subscriptionemail.subscription_id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    email_subscription = ibm.get_en_subscription_email(instance_guid=ibm_resource_instance["en_terraform_test_resource"]["guid"],
        subscription_id=ibm_en_subscription_email["subscriptionemail"]["subscription_id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.LookupEnSubscriptionEmail(ctx, &ibm.LookupEnSubscriptionEmailArgs{
    			InstanceGuid:   ibm_resource_instance.En_terraform_test_resource.Guid,
    			SubscriptionId: ibm_en_subscription_email.Subscriptionemail.Subscription_id,
    		}, 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 emailSubscription = Ibm.GetEnSubscriptionEmail.Invoke(new()
        {
            InstanceGuid = ibm_resource_instance.En_terraform_test_resource.Guid,
            SubscriptionId = ibm_en_subscription_email.Subscriptionemail.Subscription_id,
        });
    
    });
    
    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.GetEnSubscriptionEmailArgs;
    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 emailSubscription = IbmFunctions.getEnSubscriptionEmail(GetEnSubscriptionEmailArgs.builder()
                .instanceGuid(ibm_resource_instance.en_terraform_test_resource().guid())
                .subscriptionId(ibm_en_subscription_email.subscriptionemail().subscription_id())
                .build());
    
        }
    }
    
    variables:
      emailSubscription:
        fn::invoke:
          function: ibm:getEnSubscriptionEmail
          arguments:
            instanceGuid: ${ibm_resource_instance.en_terraform_test_resource.guid}
            subscriptionId: ${ibm_en_subscription_email.subscriptionemail.subscription_id}
    

    Using getEnSubscriptionEmail

    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 getEnSubscriptionEmail(args: GetEnSubscriptionEmailArgs, opts?: InvokeOptions): Promise<GetEnSubscriptionEmailResult>
    function getEnSubscriptionEmailOutput(args: GetEnSubscriptionEmailOutputArgs, opts?: InvokeOptions): Output<GetEnSubscriptionEmailResult>
    def get_en_subscription_email(id: Optional[str] = None,
                                  instance_guid: Optional[str] = None,
                                  subscription_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetEnSubscriptionEmailResult
    def get_en_subscription_email_output(id: Optional[pulumi.Input[str]] = None,
                                  instance_guid: Optional[pulumi.Input[str]] = None,
                                  subscription_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetEnSubscriptionEmailResult]
    func LookupEnSubscriptionEmail(ctx *Context, args *LookupEnSubscriptionEmailArgs, opts ...InvokeOption) (*LookupEnSubscriptionEmailResult, error)
    func LookupEnSubscriptionEmailOutput(ctx *Context, args *LookupEnSubscriptionEmailOutputArgs, opts ...InvokeOption) LookupEnSubscriptionEmailResultOutput

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

    public static class GetEnSubscriptionEmail 
    {
        public static Task<GetEnSubscriptionEmailResult> InvokeAsync(GetEnSubscriptionEmailArgs args, InvokeOptions? opts = null)
        public static Output<GetEnSubscriptionEmailResult> Invoke(GetEnSubscriptionEmailInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEnSubscriptionEmailResult> getEnSubscriptionEmail(GetEnSubscriptionEmailArgs args, InvokeOptions options)
    public static Output<GetEnSubscriptionEmailResult> getEnSubscriptionEmail(GetEnSubscriptionEmailArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getEnSubscriptionEmail:getEnSubscriptionEmail
      arguments:
        # arguments dictionary

    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.
    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.

    getEnSubscriptionEmail Result

    The following output properties are available:

    Attributes List<GetEnSubscriptionEmailAttribute>
    (Required, 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 []GetEnSubscriptionEmailAttribute
    (Required, 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<GetEnSubscriptionEmailAttribute>
    (Required, 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 GetEnSubscriptionEmailAttribute[]
    (Required, 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[GetEnSubscriptionEmailAttribute]
    (Required, 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>
    (Required, 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

    GetEnSubscriptionEmailAttribute

    AddNotificationPayload bool
    (Boolean) Whether to add the notification payload to the email.
    FromName string
    Inviteds List<GetEnSubscriptionEmailAttributeInvited>
    (List) The Email address for invitation.
    ReplyToMail string
    (String) The email address to reply to.
    ReplyToName string
    (String) The Email User Name to reply to.
    Subscribeds List<GetEnSubscriptionEmailAttributeSubscribed>
    Unsubscribeds List<GetEnSubscriptionEmailAttributeUnsubscribed>
    (List) The Email address which has opted for unsusbscribtion from that topic.
    AddNotificationPayload bool
    (Boolean) Whether to add the notification payload to the email.
    FromName string
    Inviteds []GetEnSubscriptionEmailAttributeInvited
    (List) The Email address for invitation.
    ReplyToMail string
    (String) The email address to reply to.
    ReplyToName string
    (String) The Email User Name to reply to.
    Subscribeds []GetEnSubscriptionEmailAttributeSubscribed
    Unsubscribeds []GetEnSubscriptionEmailAttributeUnsubscribed
    (List) The Email address which has opted for unsusbscribtion from that topic.
    addNotificationPayload Boolean
    (Boolean) Whether to add the notification payload to the email.
    fromName String
    inviteds List<GetEnSubscriptionEmailAttributeInvited>
    (List) The Email address for invitation.
    replyToMail String
    (String) The email address to reply to.
    replyToName String
    (String) The Email User Name to reply to.
    subscribeds List<GetEnSubscriptionEmailAttributeSubscribed>
    unsubscribeds List<GetEnSubscriptionEmailAttributeUnsubscribed>
    (List) The Email address which has opted for unsusbscribtion from that topic.
    addNotificationPayload boolean
    (Boolean) Whether to add the notification payload to the email.
    fromName string
    inviteds GetEnSubscriptionEmailAttributeInvited[]
    (List) The Email address for invitation.
    replyToMail string
    (String) The email address to reply to.
    replyToName string
    (String) The Email User Name to reply to.
    subscribeds GetEnSubscriptionEmailAttributeSubscribed[]
    unsubscribeds GetEnSubscriptionEmailAttributeUnsubscribed[]
    (List) The Email address which has opted for unsusbscribtion from that topic.
    add_notification_payload bool
    (Boolean) Whether to add the notification payload to the email.
    from_name str
    inviteds Sequence[GetEnSubscriptionEmailAttributeInvited]
    (List) The Email address 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[GetEnSubscriptionEmailAttributeSubscribed]
    unsubscribeds Sequence[GetEnSubscriptionEmailAttributeUnsubscribed]
    (List) The Email address which has opted for unsusbscribtion from that topic.
    addNotificationPayload Boolean
    (Boolean) Whether to add the notification payload to the email.
    fromName String
    inviteds List<Property Map>
    (List) The Email address 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>
    unsubscribeds List<Property Map>
    (List) The Email address which has opted for unsusbscribtion from that topic.

    GetEnSubscriptionEmailAttributeInvited

    Email string
    ExpiresAt string
    UpdatedAt string
    (String) Last updated time.
    Email string
    ExpiresAt string
    UpdatedAt string
    (String) Last updated time.
    email String
    expiresAt String
    updatedAt String
    (String) Last updated time.
    email string
    expiresAt string
    updatedAt string
    (String) Last updated time.
    email str
    expires_at str
    updated_at str
    (String) Last updated time.
    email String
    expiresAt String
    updatedAt String
    (String) Last updated time.

    GetEnSubscriptionEmailAttributeSubscribed

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

    GetEnSubscriptionEmailAttributeUnsubscribed

    Email string
    UpdatedAt string
    (String) Last updated time.
    Email string
    UpdatedAt string
    (String) Last updated time.
    email String
    updatedAt String
    (String) Last updated time.
    email string
    updatedAt string
    (String) Last updated time.
    email str
    updated_at str
    (String) Last updated time.
    email String
    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 logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud