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

ibm.getEnSubscriptionCustomSms

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 Custom SMS 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 customSmsSubscription = ibm.getEnSubscriptionCustomSms({
        instanceGuid: ibm_resource_instance.en_terraform_test_resource.guid,
        subscriptionId: ibm_en_subscription_custom_sms.subscription_custom_sms.subscription_id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    custom_sms_subscription = ibm.get_en_subscription_custom_sms(instance_guid=ibm_resource_instance["en_terraform_test_resource"]["guid"],
        subscription_id=ibm_en_subscription_custom_sms["subscription_custom_sms"]["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.LookupEnSubscriptionCustomSms(ctx, &ibm.LookupEnSubscriptionCustomSmsArgs{
    			InstanceGuid:   ibm_resource_instance.En_terraform_test_resource.Guid,
    			SubscriptionId: ibm_en_subscription_custom_sms.Subscription_custom_sms.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 customSmsSubscription = Ibm.GetEnSubscriptionCustomSms.Invoke(new()
        {
            InstanceGuid = ibm_resource_instance.En_terraform_test_resource.Guid,
            SubscriptionId = ibm_en_subscription_custom_sms.Subscription_custom_sms.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.GetEnSubscriptionCustomSmsArgs;
    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 customSmsSubscription = IbmFunctions.getEnSubscriptionCustomSms(GetEnSubscriptionCustomSmsArgs.builder()
                .instanceGuid(ibm_resource_instance.en_terraform_test_resource().guid())
                .subscriptionId(ibm_en_subscription_custom_sms.subscription_custom_sms().subscription_id())
                .build());
    
        }
    }
    
    variables:
      customSmsSubscription:
        fn::invoke:
          function: ibm:getEnSubscriptionCustomSms
          arguments:
            instanceGuid: ${ibm_resource_instance.en_terraform_test_resource.guid}
            subscriptionId: ${ibm_en_subscription_custom_sms.subscription_custom_sms.subscription_id}
    

    Using getEnSubscriptionCustomSms

    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 getEnSubscriptionCustomSms(args: GetEnSubscriptionCustomSmsArgs, opts?: InvokeOptions): Promise<GetEnSubscriptionCustomSmsResult>
    function getEnSubscriptionCustomSmsOutput(args: GetEnSubscriptionCustomSmsOutputArgs, opts?: InvokeOptions): Output<GetEnSubscriptionCustomSmsResult>
    def get_en_subscription_custom_sms(id: Optional[str] = None,
                                       instance_guid: Optional[str] = None,
                                       subscription_id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetEnSubscriptionCustomSmsResult
    def get_en_subscription_custom_sms_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[GetEnSubscriptionCustomSmsResult]
    func LookupEnSubscriptionCustomSms(ctx *Context, args *LookupEnSubscriptionCustomSmsArgs, opts ...InvokeOption) (*LookupEnSubscriptionCustomSmsResult, error)
    func LookupEnSubscriptionCustomSmsOutput(ctx *Context, args *LookupEnSubscriptionCustomSmsOutputArgs, opts ...InvokeOption) LookupEnSubscriptionCustomSmsResultOutput

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

    public static class GetEnSubscriptionCustomSms 
    {
        public static Task<GetEnSubscriptionCustomSmsResult> InvokeAsync(GetEnSubscriptionCustomSmsArgs args, InvokeOptions? opts = null)
        public static Output<GetEnSubscriptionCustomSmsResult> Invoke(GetEnSubscriptionCustomSmsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEnSubscriptionCustomSmsResult> getEnSubscriptionCustomSms(GetEnSubscriptionCustomSmsArgs args, InvokeOptions options)
    public static Output<GetEnSubscriptionCustomSmsResult> getEnSubscriptionCustomSms(GetEnSubscriptionCustomSmsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getEnSubscriptionCustomSms:getEnSubscriptionCustomSms
      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 custom_sms_subscription.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    SubscriptionId string
    Unique identifier for Subscription.
    Id string
    The unique identifier of the custom_sms_subscription.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    subscriptionId String
    Unique identifier for Subscription.
    id String
    The unique identifier of the custom_sms_subscription.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    subscriptionId string
    Unique identifier for Subscription.
    id string
    The unique identifier of the custom_sms_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 custom_sms_subscription.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    subscriptionId String
    Unique identifier for Subscription.
    id String
    The unique identifier of the custom_sms_subscription.

    getEnSubscriptionCustomSms Result

    The following output properties are available:

    Attributes List<GetEnSubscriptionCustomSmsAttribute>
    Description string
    (String) Subscription description.
    DestinationId string
    (String) The destination ID.
    Id string
    The unique identifier of the custom_sms_subscription.
    InstanceGuid string
    Name string
    (String) Subscription name.
    SubscriptionId string
    TopicId string
    (String) Topic ID.
    UpdatedAt string
    (String) Last updated time.
    Attributes []GetEnSubscriptionCustomSmsAttribute
    Description string
    (String) Subscription description.
    DestinationId string
    (String) The destination ID.
    Id string
    The unique identifier of the custom_sms_subscription.
    InstanceGuid string
    Name string
    (String) Subscription name.
    SubscriptionId string
    TopicId string
    (String) Topic ID.
    UpdatedAt string
    (String) Last updated time.
    attributes List<GetEnSubscriptionCustomSmsAttribute>
    description String
    (String) Subscription description.
    destinationId String
    (String) The destination ID.
    id String
    The unique identifier of the custom_sms_subscription.
    instanceGuid String
    name String
    (String) Subscription name.
    subscriptionId String
    topicId String
    (String) Topic ID.
    updatedAt String
    (String) Last updated time.
    attributes GetEnSubscriptionCustomSmsAttribute[]
    description string
    (String) Subscription description.
    destinationId string
    (String) The destination ID.
    id string
    The unique identifier of the custom_sms_subscription.
    instanceGuid string
    name string
    (String) Subscription name.
    subscriptionId string
    topicId string
    (String) Topic ID.
    updatedAt string
    (String) Last updated time.
    attributes Sequence[GetEnSubscriptionCustomSmsAttribute]
    description str
    (String) Subscription description.
    destination_id str
    (String) The destination ID.
    id str
    The unique identifier of the custom_sms_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>
    description String
    (String) Subscription description.
    destinationId String
    (String) The destination ID.
    id String
    The unique identifier of the custom_sms_subscription.
    instanceGuid String
    name String
    (String) Subscription name.
    subscriptionId String
    topicId String
    (String) Topic ID.
    updatedAt String
    (String) Last updated time.

    Supporting Types

    GetEnSubscriptionCustomSmsAttribute

    Inviteds []GetEnSubscriptionCustomSmsAttributeInvited
    (List) The phone number for invitation.
    Subscribeds []GetEnSubscriptionCustomSmsAttributeSubscribed
    Unsubscribeds []GetEnSubscriptionCustomSmsAttributeUnsubscribed
    (List) The phone number which has opted for unsusbscribtion from that topic.
    inviteds GetEnSubscriptionCustomSmsAttributeInvited[]
    (List) The phone number for invitation.
    subscribeds GetEnSubscriptionCustomSmsAttributeSubscribed[]
    unsubscribeds GetEnSubscriptionCustomSmsAttributeUnsubscribed[]
    (List) The phone number which has opted for unsusbscribtion from that topic.
    inviteds List<Property Map>
    (List) The phone number for invitation.
    subscribeds List<Property Map>
    unsubscribeds List<Property Map>
    (List) The phone number which has opted for unsusbscribtion from that topic.

    GetEnSubscriptionCustomSmsAttributeInvited

    ExpiresAt string
    PhoneNumber string
    UpdatedAt string
    (String) Last updated time.
    ExpiresAt string
    PhoneNumber string
    UpdatedAt string
    (String) Last updated time.
    expiresAt String
    phoneNumber String
    updatedAt String
    (String) Last updated time.
    expiresAt string
    phoneNumber string
    updatedAt string
    (String) Last updated time.
    expires_at str
    phone_number str
    updated_at str
    (String) Last updated time.
    expiresAt String
    phoneNumber String
    updatedAt String
    (String) Last updated time.

    GetEnSubscriptionCustomSmsAttributeSubscribed

    PhoneNumber string
    UpdatedAt string
    (String) Last updated time.
    PhoneNumber string
    UpdatedAt string
    (String) Last updated time.
    phoneNumber String
    updatedAt String
    (String) Last updated time.
    phoneNumber string
    updatedAt string
    (String) Last updated time.
    phone_number str
    updated_at str
    (String) Last updated time.
    phoneNumber String
    updatedAt String
    (String) Last updated time.

    GetEnSubscriptionCustomSmsAttributeUnsubscribed

    PhoneNumber string
    UpdatedAt string
    (String) Last updated time.
    PhoneNumber string
    UpdatedAt string
    (String) Last updated time.
    phoneNumber String
    updatedAt String
    (String) Last updated time.
    phoneNumber string
    updatedAt string
    (String) Last updated time.
    phone_number str
    updated_at str
    (String) Last updated time.
    phoneNumber 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