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

ibm.getEnSubscriptionEmail

Explore with Pulumi AI

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,
});
Copy
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"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.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
	})
}
Copy
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,
    });

});
Copy
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());

    }
}
Copy
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}
Copy

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>
Copy
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]
Copy
func LookupEnSubscriptionEmail(ctx *Context, args *LookupEnSubscriptionEmailArgs, opts ...InvokeOption) (*LookupEnSubscriptionEmailResult, error)
func LookupEnSubscriptionEmailOutput(ctx *Context, args *LookupEnSubscriptionEmailOutputArgs, opts ...InvokeOption) LookupEnSubscriptionEmailResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetEnSubscriptionEmailResult> getEnSubscriptionEmail(GetEnSubscriptionEmailArgs args, InvokeOptions options)
public static Output<GetEnSubscriptionEmailResult> getEnSubscriptionEmail(GetEnSubscriptionEmailArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getEnSubscriptionEmail:getEnSubscriptionEmail
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
SubscriptionId This property is required. string
Unique identifier for Subscription.
Id string
The unique identifier of the email_subscription.
InstanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
SubscriptionId This property is required. string
Unique identifier for Subscription.
Id string
The unique identifier of the email_subscription.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
subscriptionId This property is required. String
Unique identifier for Subscription.
id String
The unique identifier of the email_subscription.
instanceGuid This property is required. string
Unique identifier for IBM Cloud Event Notifications instance.
subscriptionId This property is required. string
Unique identifier for Subscription.
id string
The unique identifier of the email_subscription.
instance_guid This property is required. str
Unique identifier for IBM Cloud Event Notifications instance.
subscription_id This property is required. str
Unique identifier for Subscription.
id str
The unique identifier of the email_subscription.
instanceGuid This property is required. String
Unique identifier for IBM Cloud Event Notifications instance.
subscriptionId This property is required. 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 This property is required. bool
(Boolean) Whether to add the notification payload to the email.
FromName This property is required. string
Inviteds This property is required. List<GetEnSubscriptionEmailAttributeInvited>
(List) The Email address for invitation.
ReplyToMail This property is required. string
(String) The email address to reply to.
ReplyToName This property is required. string
(String) The Email User Name to reply to.
Subscribeds This property is required. List<GetEnSubscriptionEmailAttributeSubscribed>
Unsubscribeds This property is required. List<GetEnSubscriptionEmailAttributeUnsubscribed>
(List) The Email address which has opted for unsusbscribtion from that topic.
AddNotificationPayload This property is required. bool
(Boolean) Whether to add the notification payload to the email.
FromName This property is required. string
Inviteds This property is required. []GetEnSubscriptionEmailAttributeInvited
(List) The Email address for invitation.
ReplyToMail This property is required. string
(String) The email address to reply to.
ReplyToName This property is required. string
(String) The Email User Name to reply to.
Subscribeds This property is required. []GetEnSubscriptionEmailAttributeSubscribed
Unsubscribeds This property is required. []GetEnSubscriptionEmailAttributeUnsubscribed
(List) The Email address which has opted for unsusbscribtion from that topic.
addNotificationPayload This property is required. Boolean
(Boolean) Whether to add the notification payload to the email.
fromName This property is required. String
inviteds This property is required. List<GetEnSubscriptionEmailAttributeInvited>
(List) The Email address for invitation.
replyToMail This property is required. String
(String) The email address to reply to.
replyToName This property is required. String
(String) The Email User Name to reply to.
subscribeds This property is required. List<GetEnSubscriptionEmailAttributeSubscribed>
unsubscribeds This property is required. List<GetEnSubscriptionEmailAttributeUnsubscribed>
(List) The Email address which has opted for unsusbscribtion from that topic.
addNotificationPayload This property is required. boolean
(Boolean) Whether to add the notification payload to the email.
fromName This property is required. string
inviteds This property is required. GetEnSubscriptionEmailAttributeInvited[]
(List) The Email address for invitation.
replyToMail This property is required. string
(String) The email address to reply to.
replyToName This property is required. string
(String) The Email User Name to reply to.
subscribeds This property is required. GetEnSubscriptionEmailAttributeSubscribed[]
unsubscribeds This property is required. GetEnSubscriptionEmailAttributeUnsubscribed[]
(List) The Email address which has opted for unsusbscribtion from that topic.
add_notification_payload This property is required. bool
(Boolean) Whether to add the notification payload to the email.
from_name This property is required. str
inviteds This property is required. Sequence[GetEnSubscriptionEmailAttributeInvited]
(List) The Email address for invitation.
reply_to_mail This property is required. str
(String) The email address to reply to.
reply_to_name This property is required. str
(String) The Email User Name to reply to.
subscribeds This property is required. Sequence[GetEnSubscriptionEmailAttributeSubscribed]
unsubscribeds This property is required. Sequence[GetEnSubscriptionEmailAttributeUnsubscribed]
(List) The Email address which has opted for unsusbscribtion from that topic.
addNotificationPayload This property is required. Boolean
(Boolean) Whether to add the notification payload to the email.
fromName This property is required. String
inviteds This property is required. List<Property Map>
(List) The Email address for invitation.
replyToMail This property is required. String
(String) The email address to reply to.
replyToName This property is required. String
(String) The Email User Name to reply to.
subscribeds This property is required. List<Property Map>
unsubscribeds This property is required. List<Property Map>
(List) The Email address which has opted for unsusbscribtion from that topic.

GetEnSubscriptionEmailAttributeInvited

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

GetEnSubscriptionEmailAttributeSubscribed

Email This property is required. string
UpdatedAt This property is required. string
(String) Last updated time.
Email This property is required. string
UpdatedAt This property is required. string
(String) Last updated time.
email This property is required. String
updatedAt This property is required. String
(String) Last updated time.
email This property is required. string
updatedAt This property is required. string
(String) Last updated time.
email This property is required. str
updated_at This property is required. str
(String) Last updated time.
email This property is required. String
updatedAt This property is required. String
(String) Last updated time.

GetEnSubscriptionEmailAttributeUnsubscribed

Email This property is required. string
UpdatedAt This property is required. string
(String) Last updated time.
Email This property is required. string
UpdatedAt This property is required. string
(String) Last updated time.
email This property is required. String
updatedAt This property is required. String
(String) Last updated time.
email This property is required. string
updatedAt This property is required. string
(String) Last updated time.
email This property is required. str
updated_at This property is required. str
(String) Last updated time.
email This property is required. String
updatedAt This property is required. 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.